A C D E F G I L M N O P R S T V

A

acceptSymbol - Variable in class goldengine.java.FAState

actionAccept - Static variable in interface goldengine.java.ActionConstants

Input successfully parsed

actionConstant - Variable in class goldengine.java.LRAction

actionConstant This is the action that should be taken for this instance.

ActionConstants - interface goldengine.java.ActionConstants.

-------------------------------------------------------------------------------------------
Source File: ActionConstants.java
Author: Matthew Hawkins
Description: Set of Constants associated with what Action should be performed.

actionError - Static variable in interface goldengine.java.ActionConstants

Programmars see this often!

actionGoto - Static variable in interface goldengine.java.ActionConstants

Goto to a state on reduction

actionIndexForSymbol(int) - Method in class goldengine.java.LRActionTable

actionIndexForSymbol This method will return the index in the symbol table for the symbol in the action table specified by symbolIndex.

actionReduce - Static variable in interface goldengine.java.ActionConstants

Reduce by a specified rule

actionShift - Static variable in interface goldengine.java.ActionConstants

Shift a symbol and goto a state

add(String, String, String) - Method in class goldengine.java.VariableList

add This method will add a new variable to the list.

add(Symbol) - Method in class goldengine.java.SymbolList

add This method adds a symbol to the end of the list.

addEdge(String, int) - Method in class goldengine.java.FAState

addEdge This method will add an edge to the FAState.

addItem(Symbol) - Method in class goldengine.java.Rule

addItem This method will add a symbol to the Symbol list.

addItem(Symbol, int, int) - Method in class goldengine.java.LRActionTable

addItem This method will add a symbol to the action table.

C

clear() - Method in class goldengine.java.GOLDParser

clear This method clears every value in the parser engine.

clear() - Method in class goldengine.java.SimpleDatabase

clear This method will reset all the currently read fields.

clear() - Method in class goldengine.java.SymbolList

clear This method empties the list.

clearValues() - Method in class goldengine.java.VariableList

clearValues This method will set the name of each variable to "".

closeFile() - Method in class goldengine.java.GOLDParser

closeFile This method will close the source file.

closeFile() - Method in class goldengine.java.LookAheadStream

closeFile This method will close the source file.

closeFile() - Method in class goldengine.java.SimpleDatabase

closeFile This method will close the file and set the Buffer to null.

contains(String) - Method in class goldengine.java.FAEdge

contains Returns True if the characters are in the String passed in, false if not.

containsOneNonTerminal() - Method in class goldengine.java.Rule

containsOneNonTerminal #ver1.1# This method will check to see if the rule contains a non terminal.

count() - Method in class goldengine.java.LRActionTable

count

count() - Method in class goldengine.java.SymbolList

count This method will return the number of entries in the SymbolList.

count() - Method in class goldengine.java.VariableList

count This method returns the current number of variables.

currentLineNumber() - Method in class goldengine.java.GOLDParser

currentLineNumber Returns the current source file line number.

currentReduction() - Method in class goldengine.java.GOLDParser

currentReduction This method will return the current reduction.

currentToken() - Method in class goldengine.java.GOLDParser

currentToken This method returns the current Token.

D

definition() - Method in class goldengine.java.Rule

definition This method will return the right hand side of the rule, It does this by concatenating all the Symbols in the Symbol list.

done() - Method in class goldengine.java.LookAheadStream

done This method checks the next character to see if it is the end of the file.

done() - Method in class goldengine.java.SimpleDatabase

done This method will check to see if we have reached the end of the file.

E

edge(int) - Method in class goldengine.java.FAState

edge This method will return the edge at the specified index for this state.

edgeCount() - Method in class goldengine.java.FAState

edgeCount The number of edges in this FAState.

entryContentBoolean - Static variable in interface goldengine.java.EntryContentConstants

Defined as B - 1 byte, Value is 0 or 1

entryContentByte - Static variable in interface goldengine.java.EntryContentConstants

Defined as b

EntryContentConstants - interface goldengine.java.EntryContentConstants.

-------------------------------------------------------------------------------------------
Source File: EntryContentConstants.java
Author: Matthew Hawkins
Description: Set of Constants associated with the Compiled Grammar Table file records.

entryContentEmpty - Static variable in interface goldengine.java.EntryContentConstants

Defined as E

entryContentInteger - Static variable in interface goldengine.java.EntryContentConstants

Defined as I - Signed, 2 byte

entryContentString - Static variable in interface goldengine.java.EntryContentConstants

Defined as S - Unicode format

F

FAEdge - class goldengine.java.FAEdge.

-------------------------------------------------------------------------------------------
Source File: FAEdge.java
Author: Devin Cook, Matthew Hawkins
Description: Represents an edge for the DFA state.
-------------------------------------------------------------------------------------------
Revision List

FAEdge() - Constructor for class goldengine.java.FAEdge

FAState - class goldengine.java.FAState.

-------------------------------------------------------------------------------------------
Source File: FAState.java
Author: Devin Cook, Matthew Hawkins
Description: Represents a DFA state.
-------------------------------------------------------------------------------------------
Revision List

FAState() - Constructor for class goldengine.java.FAState

G

GenericParser - class goldengine.java.GenericParser.

-------------------------------------------------------------------------------------------
Source File: GenericParser.java
Author: Matthew Hawkins
Description: A Debugging class, takes in a set of files and runs the GOLDParser engine on them.
-------------------------------------------------------------------------------------------
Revision List

GenericParser() - Constructor for class goldengine.java.GenericParser

getChars() - Method in class goldengine.java.FAEdge

getChars Returns the set of characters associated with this edge

getComment() - Method in class goldengine.java.VariableType

getComment This method will get the comment of this variable.

getData() - Method in class goldengine.java.Token

getData This method will get the data of this Token.

getFileType() - Method in class goldengine.java.SimpleDatabase

getFileType This method will return what file type this Database instance can read.

getKind() - Method in class goldengine.java.Symbol

getKind This method gets the kind of symbol (defined in SymbolTypeConstants).

getKind() - Method in class goldengine.java.Token

getKind This method will get the kind of this Token.

getMember(int) - Method in class goldengine.java.SymbolList

getMember This method will return the Symbol at the specified index.

getMember(String) - Method in class goldengine.java.SymbolList

getMember This method will return the Symbol that has an equivalent name in the list.

getName() - Method in class goldengine.java.Symbol

getName This method gets the name of the symbol.

getName() - Method in class goldengine.java.Token

getName This method will get the name of this Token.

getName() - Method in class goldengine.java.VariableType

getName This method will get the name of this variable.

getNextRecord() - Method in class goldengine.java.SimpleDatabase

getNextRecord #ver1.1# This method will read the file for the next record, and place each field in the Vector to be retrieved later.

getParentRule() - Method in class goldengine.java.Reduction

getParentRule This method returns the rule associated with this Reduction.

getPSymbol() - Method in class goldengine.java.Token

getPSymbol This method will get the parent symbol of this Token.

getRuleNonTerminal() - Method in class goldengine.java.Rule

getRuleNonTerminal Will return the Non-Terminal Symbol associated with this Rule.

getState() - Method in class goldengine.java.Token

getState This method will get the State of this Token.

getSymbol() - Method in class goldengine.java.LRAction

getSymbol This method will return the symbol associated with this action.

getSymbolCount() - Method in class goldengine.java.Rule

getSymbolCount Will return how many symbols are contained in this Rule.

getSymbolIndex() - Method in class goldengine.java.LRAction

getSymbolIndex This method will return the index of the smybol in the symbol table.

getSymbols(int) - Method in class goldengine.java.Rule

getSymbols Will return the Symbol at the index specified.

getTableIndex() - Method in class goldengine.java.Rule

getTableIndex Will return what index the table index in this Rule is at.

getTableIndex() - Method in class goldengine.java.Symbol

getTableIndex This method gets the table index of this symbol.

getTableIndex() - Method in class goldengine.java.Token

getTableIndex This method will get the table index of this Token.

getTag() - Method in class goldengine.java.Reduction

getTag Will return the tag associated with this Reduction.

getTargetIndex() - Method in class goldengine.java.FAEdge

getTargetIndex Returns the index of the edge in the FAState

getText() - Method in class goldengine.java.Rule

getText This method uses the method name() and definiton() to create a String representing the entirety of this Rule.

getText() - Method in class goldengine.java.Symbol

getText This method will create a text representation of this Symbol.

getText() - Method in class goldengine.java.Token

getText This method will get the text of this Token.

getToken(int) - Method in class goldengine.java.GOLDParser

getToken If you require access to tokens in the stack before they are placed on the parse tree.

getToken(int) - Method in class goldengine.java.Reduction

getToken Will retrieve a Token at the specified index.

getTokenCount() - Method in class goldengine.java.Reduction

getTokenCount This method returns the number of tokens.

getTrimReductions() - Method in class goldengine.java.GOLDParser

getTrimReductions #ver1.1# This method will get whether or not we should trim the reductions.

getValue() - Method in class goldengine.java.VariableType

getValue This method will get the value of this variable.

getValue(String) - Method in class goldengine.java.VariableList

getValue This method will return the value of the variable with the same name as that specified.

getVisible() - Method in class goldengine.java.VariableType

getVisible This method will get whether or not this variable is public.

GOLDParser - class goldengine.java.GOLDParser.

-------------------------------------------------------------------------------------------
Source File: GenericParser.java
Author: Devin Cook, Matthew Hawkins
Description: The main parsing engine.
-------------------------------------------------------------------------------------------
Revision List

GOLDParser() - Constructor for class goldengine.java.GOLDParser

GOLDParser The constructor initiates some variables.

GPMessageConstants - interface goldengine.java.GPMessageConstants.

-------------------------------------------------------------------------------------------
Source File: GPMessageConstants.java
Author: Matthew Hawkins
Description: A set of constants associated with telling the user what the parsing engine has done.
-------------------------------------------------------------------------------------------
Revision List

gpMsgAccept - Static variable in interface goldengine.java.GPMessageConstants

Grammar complete

gpMsgCommentError - Static variable in interface goldengine.java.GPMessageConstants

Reached the end of the file - mostly due to being stuck in comment mode

gpMsgInternalError - Static variable in interface goldengine.java.GPMessageConstants

Something is wrong, very wrong

gpMsgLexicalError - Static variable in interface goldengine.java.GPMessageConstants

Token not recognized

gpMsgNotLoadedError - Static variable in interface goldengine.java.GPMessageConstants

No grammar is loaded

gpMsgReduction - Static variable in interface goldengine.java.GPMessageConstants

A rule is reduced

gpMsgSyntaxError - Static variable in interface goldengine.java.GPMessageConstants

Token is not expected

gpMsgTokenRead - Static variable in interface goldengine.java.GPMessageConstants

A new token is read

I

isEqual(Rule) - Method in class goldengine.java.Rule

isEqual #ver1.1# This method will check equality of two Rules - this and the one passed in.

isEqual(Symbol) - Method in class goldengine.java.Symbol

isEqual #ver1.1# This method will check equality of two Symbols - this and the one passed in.

item(int) - Method in class goldengine.java.LRActionTable

item This method will return the LRAction at the specified index.

L

loadCompiledGrammar(String) - Method in class goldengine.java.GOLDParser

loadCompiledGrammar This method will reset the GOLDParser engine before loading a new .cgt file into it.

LookAheadStream - class goldengine.java.LookAheadStream.

-------------------------------------------------------------------------------------------
Source File: LookAheadStream.java
Author: Matthew Hawkins
Description: A stream implementation that uses a PushbackReader, to read the source file character by character, and will place characters on a char buffer.

LookAheadStream() - Constructor for class goldengine.java.LookAheadStream

LRAction - class goldengine.java.LRAction.

-------------------------------------------------------------------------------------------
Source File: LRAction.java
Author: Devin Cook, Matthew Hawkins
Description: An LALR Action.
-------------------------------------------------------------------------------------------
Revision List

LRAction() - Constructor for class goldengine.java.LRAction

LRActionTable - class goldengine.java.LRActionTable.

-------------------------------------------------------------------------------------------
Source File: LRActionTable.java
Author: Devin Cook, Matthew Hawkins
Description: The table of LALR Actions associated with this grammar.
-------------------------------------------------------------------------------------------
Revision List

LRActionTable() - Constructor for class goldengine.java.LRActionTable

M

main(String[]) - Static method in class goldengine.java.GenericParser

N

name() - Method in class goldengine.java.Rule

name Will return a String consisting of the Rules name.

name(int) - Method in class goldengine.java.VariableList

name Return the name of the Variable at the specified index.

nextChar() - Method in class goldengine.java.LookAheadStream

nextChar This method will read one character (int) from the stream.

nextCharNotWhitespace() - Method in class goldengine.java.LookAheadStream

nextCharNotWhitespace A quick checker method which checks to see if the next character is whitespace.

O

openFile(String) - Method in class goldengine.java.GOLDParser

openFile This method will open the source file for reading.

openFile(String) - Method in class goldengine.java.LookAheadStream

openFile This method will open the source file to read.

openFile(String) - Method in class goldengine.java.SimpleDatabase

openFile This method will open the file for reading.

P

parameter(String) - Method in class goldengine.java.GOLDParser

parameter This method will return the value of a parameter that corresponds to the name passed in.

parse() - Method in class goldengine.java.GOLDParser

parse Will parse a token.

parseResultAccept - Static variable in interface goldengine.java.ParseResultConstants

ParseResultConstants - interface goldengine.java.ParseResultConstants.

-------------------------------------------------------------------------------------------
Source File: ParseResultConstants.java
Author: Matthew Hawkins
Description: Set of Constants associated with what Action should be performed after a parse.

parseResultInternalError - Static variable in interface goldengine.java.ParseResultConstants

parseResultReduceEliminated - Static variable in interface goldengine.java.ParseResultConstants

parseResultReduceNormal - Static variable in interface goldengine.java.ParseResultConstants

parseResultShift - Static variable in interface goldengine.java.ParseResultConstants

parseResultSyntaxError - Static variable in interface goldengine.java.ParseResultConstants

ParserException - exception goldengine.java.ParserException.

-------------------------------------------------------------------------------------------
Source File: ParserException.java
Author: Matthew Hawkins
Description: A specialised Exception class that will be thrown in all cases when a normal exception would of been thrown.
-------------------------------------------------------------------------------------------
Revision List

ParserException() - Constructor for class goldengine.java.ParserException

ParserException The default constructor gives a default message.

ParserException(String) - Constructor for class goldengine.java.ParserException

ParserException This constructor gives a user defined message.

popInputToken() - Method in class goldengine.java.GOLDParser

popInputToken This method should only be called if there is a lexical error and you need to pop an unexpected token out of the stack.

pushInputToken(Token) - Method in class goldengine.java.GOLDParser

pushInputToken This method should only be used if there is a syntax error.

R

read(int) - Method in class goldengine.java.LookAheadStream

read This method will return a String of length size.

readLine() - Method in class goldengine.java.LookAheadStream

readLine This method will read characters from the buffer until a line feed or carriage return is found.

recordIdCharSets - Static variable in interface goldengine.java.RecordIDConstants

Defined as C

recordIdComment - Static variable in interface goldengine.java.RecordIDConstants

Defined as !

RecordIDConstants - interface goldengine.java.RecordIDConstants.

-------------------------------------------------------------------------------------------
Source File: RecordIDConstants.java
Author: Matthew Hawkins
Description: A set of constants associated with the type of records in the cgt file.

recordIdDFAStates - Static variable in interface goldengine.java.RecordIDConstants

Defined as D

recordIdInitial - Static variable in interface goldengine.java.RecordIDConstants

Defined as I

recordIdLRTables - Static variable in interface goldengine.java.RecordIDConstants

Defined as L

recordIdParameters - Static variable in interface goldengine.java.RecordIDConstants

Defined as P

recordIdRules - Static variable in interface goldengine.java.RecordIDConstants

Defined as R

recordIdSymbols - Static variable in interface goldengine.java.RecordIDConstants

Defined as S

recordIdTableCounts - Static variable in interface goldengine.java.RecordIDConstants

Defined as T

reDim(int) - Method in class goldengine.java.SymbolList

reDim This is the equivalent of the ReDim method in VB.

Reduction - class goldengine.java.Reduction.

-------------------------------------------------------------------------------------------
Source File: Reduction.java
Author: Devin Cook, Matthew Hawkins
Description: A representation of a Reduction.

Reduction() - Constructor for class goldengine.java.Reduction

reset() - Method in class goldengine.java.GOLDParser

reset This method will reset the parser engine.

retrieve(int) - Method in class goldengine.java.SimpleDatabase

retrieve This method will retrieve a set of integers that have been read by the SimpleDatabase file.

retrieveDone() - Method in class goldengine.java.SimpleDatabase

retrieveDone This method checks to see if there no many fields or records to be read.

retrieveNext() - Method in class goldengine.java.SimpleDatabase

retrieveNext This method will retrieve an Object that has been read in by the SimpleDatabase.

Rule - class goldengine.java.Rule.

-------------------------------------------------------------------------------------------
Source File: Rule.java
Author: Devin Cook, Matthew Hawkins
Description: A representation of a rule associated with this grammar.
-------------------------------------------------------------------------------------------
Revision List

Rule() - Constructor for class goldengine.java.Rule

Rule Constructor: This constructor initialises this rule and creates a new SymbolList and the table index.

ruleTableCount() - Method in class goldengine.java.GOLDParser

ruleTableCount This method returns the total number of rules in the rule table.

ruleTableEntry(int) - Method in class goldengine.java.GOLDParser

ruleTableEntry This method will return a Rule at the specified index.

S

setChars(String) - Method in class goldengine.java.FAEdge

setChars Sets the characters of this edge to the String passed in.

setComment(String) - Method in class goldengine.java.VariableType

setComment This method will set the comment of this variable to that passed in.

setCurrentReduction(Reduction) - Method in class goldengine.java.GOLDParser

setCurrentReduction This method will set the current reduction to the one passed in.

setData(Object) - Method in class goldengine.java.Token

setData This method will set the data of this token to that passed in.

setFileType(String) - Method in class goldengine.java.SimpleDatabase

setFileType This method will identify what file can be read by the simple database.

setKind(int) - Method in class goldengine.java.Symbol

setKind This method sets the kind of the symbol (defined in SymbolTypeConstants).

setMember(int, Symbol) - Method in class goldengine.java.SymbolList

setMember This method will set the element at the specified index to the Symbol passed in.

setName(String) - Method in class goldengine.java.Symbol

setName This method sets the name of the symbol.

setName(String) - Method in class goldengine.java.VariableType

setName This method will set the name of this variable to that passed in.

setParentRule(Rule) - Method in class goldengine.java.Reduction

setParentRule Will set the Rule of this Reduction to the one passed in.

setParentSymbol(Symbol) - Method in class goldengine.java.Token

setParentSymbol This method will set the parent symbol of this token to that passed in.

setRuleNonTerminal(Symbol) - Method in class goldengine.java.Rule

setRuleNonTerminal Will setup the Non-Terminal symbol to that passed in.

setState(int) - Method in class goldengine.java.Token

setState This method will set the state of this token to that passed in.

setSymbol(Symbol) - Method in class goldengine.java.LRAction

setSymbol This method will set the symbol of this action.

setTableIndex(int) - Method in class goldengine.java.Rule

setTableIndex Will set the current table index to that passed in.

setTableIndex(int) - Method in class goldengine.java.Symbol

setTableIndex This method sets the table index of the symbol.

setTag(int) - Method in class goldengine.java.Reduction

setTag Will set the tag of this Reduction to that passed in.

setTargetIndex(int) - Method in class goldengine.java.FAEdge

setTargetIndex Sets the index in the FAState to the number passed in.

setToken(int, Token) - Method in class goldengine.java.Reduction

setToken Will place a Token at the specified index.

setTokenCount(int) - Method in class goldengine.java.Reduction

setTokenCount This method implicitly sets the number of tokens in this Reduction.

setTrimReductions(boolean) - Method in class goldengine.java.GOLDParser

setTrimReductions #ver1.1# This method will set the whether or not the program should trim the reductions.

setValue(String) - Method in class goldengine.java.VariableType

setValue This method will set the value of this variable to that passed in.

setValue(String, String) - Method in class goldengine.java.VariableList

setValue This method sets the value of a variable of the same name as that specified.

setVisible(boolean) - Method in class goldengine.java.VariableType

setVisible This method will set whether or not this variable is visible.

SimpleDatabase - class goldengine.java.SimpleDatabase.

-------------------------------------------------------------------------------------------
Source File: SimpleDatabase.java
Author: Devin Cook, Matthew Hawkins
Description: A class written to open a binary cgt file (written in VB), and read its contents for simple database records.
-------------------------------------------------------------------------------------------
Revision List

SimpleDatabase() - Constructor for class goldengine.java.SimpleDatabase

Symbol - class goldengine.java.Symbol.

-------------------------------------------------------------------------------------------
Source File: Symbol.java
Author: Devin Cook, Matthew Hawkins
Description: A representation of a symbol associated with this grammar.
-------------------------------------------------------------------------------------------
Revision List

Symbol() - Constructor for class goldengine.java.Symbol

Symbol The constructor simply initialises the table index.

SymbolList - class goldengine.java.SymbolList.

-------------------------------------------------------------------------------------------
Source File: SymbolList.java
Author: Devin Cook, Matthew Hawkins
Description: A holding class for Symbols, with special methods needed that a Vector can not fulfil.
-------------------------------------------------------------------------------------------
Revision List

SymbolList() - Constructor for class goldengine.java.SymbolList

symbolTableCount() - Method in class goldengine.java.GOLDParser

symbolTableCount This method returns the total number of symbols in the symbol table.

symbolTableEntry(int) - Method in class goldengine.java.GOLDParser

symbolTableEntry This method will return a Symbol at the specified index.

symbolTypeCommentEnd - Static variable in interface goldengine.java.SymbolTypeConstants

Comment end

symbolTypeCommentLine - Static variable in interface goldengine.java.SymbolTypeConstants

Comment line

symbolTypeCommentStart - Static variable in interface goldengine.java.SymbolTypeConstants

Comment start

SymbolTypeConstants - interface goldengine.java.SymbolTypeConstants.

-------------------------------------------------------------------------------------------
Source File: SymbolTypeConstants.java
Author: Matthew Hawkins
Description: A set of constants associated with what type a symbol is.

symbolTypeEnd - Static variable in interface goldengine.java.SymbolTypeConstants

End character (EOF)

symbolTypeError - Static variable in interface goldengine.java.SymbolTypeConstants

Error symbol

symbolTypeNonterminal - Static variable in interface goldengine.java.SymbolTypeConstants

Normal nonterminal

symbolTypeTerminal - Static variable in interface goldengine.java.SymbolTypeConstants

Normal terminal

symbolTypeWhitespace - Static variable in interface goldengine.java.SymbolTypeConstants

Type of terminal

T

Token - class goldengine.java.Token.

-------------------------------------------------------------------------------------------
Source File: Token.java
Author: Devin Cook, Matthew Hawkins
Description: A representation of a token associated with this grammar.
-------------------------------------------------------------------------------------------
Revision List

Token() - Constructor for class goldengine.java.Token

Token The constructor initialises the data of this Token.

tokenCount() - Method in class goldengine.java.GOLDParser

tokenCount This method will return the number of tokens in the stack.

V

value - Variable in class goldengine.java.LRAction

value The value of the action.

variableIndex(String) - Method in class goldengine.java.VariableList

variableIndex This method will return the index number of a variable that has the same name as that specified.

VariableList - class goldengine.java.VariableList.

-------------------------------------------------------------------------------------------
Source File: VariableList.java
Author: Devin Cook, Matthew Hawkins
Description: A holding class for VariableTypes, with special methods needed that a Vector can not fulfil.
-------------------------------------------------------------------------------------------
Revision List

VariableList() - Constructor for class goldengine.java.VariableList

VariableType - class goldengine.java.VariableType.

-------------------------------------------------------------------------------------------
Source File: VariableType.java
Author: Devin Cook, Matthew Hawkins
Description: A VariableType holds information specific to this grammar, from the author to whether or not it is case sensitive.
-------------------------------------------------------------------------------------------
Revision List

VariableType(String, String, String, boolean) - Constructor for class goldengine.java.VariableType

VariableType The constructor creates a new Variable.

A C D E F G I L M N O P R S T V