me.jaimegarza.syntax.language

Interface LanguageSupport

All Known Implementing Classes:

BaseLanguageSupport, C, Java, Javascript, Pascal

public interface LanguageSupport

Define the methods that are provided for each language. These methods are business-kind methods, and as such they are expected to have specific business-logic.

Author:

jaimegarza@gmail.com

Method Summary

Modifier and Type	Method and Description
void	emitLine(int line) emit #line in C
void	emitLine(int line, String filename) emit #line in C
void	generateCaseEnd() emit a case end statement
int	generateCaseStart(int lineNumber, String label, String comment) emit a case start
void	generateCodeGeneratorFooter() Generate the ending portion of the code generation
void	generateCodeGeneratorHeader() Output the top of the rules if needed
void	generateEdgeHeader(int tableSize) Generate the code for the edge table beginning
void	generateErrorToken(int recoveryToken, ErrorToken id, boolean isLast) Generates one entry for an error token
void	generateIntArrayComment(String comment) Output a comment in an array
void	generateIntArrayFooter() Output the end of an int array
void	generateIntArrayRow(int i, String comment, int index, int maxRows) Output a row in an integer array
boolean	generateLexerCode(FormattingPrintStream output, String lexerMode, Lexer lexer, Terminal token, int additionalIndent) Emit the code for the lexical part of the grammar
void	generateLexerFooter() Generate the bottom of the lexer
void	generateLexerHeader(List<String> modes) Emit the header of the lexer as needed.
void	generateLexerModeCase(String mode, int i) Generate the constant or 'define" for a given lexer mode
void	generateLexerModeDefinition(String mode, int i) Generate the constant or 'define" for a given lexer mode
void	generateLexerModeFooter(String mode) Emit a lexer function footer by mode
void	generateLexerModeHeader(String mode) Emit a lexer function header by mode
void	generateRecoveryTableHeader(int numberOfErrorTokens) The recovery table deals with tokens that can be used to recognize syntax context and can recover from errors.
void	generateRegexEnd(FormattingPrintStream output) Generate the bottom of a regex match in the scanner
void	generateRegexMatch(FormattingPrintStream output, int dfaNode) Generate if statement for a regular expression match
void	generateRegexReturn(FormattingPrintStream output, Terminal token) Generate the default return token for a regexp
boolean	generateRuleCode(Lexer lexer, EmbeddedCodeProcessor processor, int elementCount, String nonTerminalId, int sourceColumn) Parsing logic Scan the input stream until a rule set of actions end.
boolean	generateStructure(Lexer lexer) For yacc compatibility this is called the union, but it is really a structure
void	generateToken(Terminal id, boolean isLast) Generate the code for a given token
void	generateTokenDefinitions() Declare all the tokens
void	generateTokensHeader(int terminals) Generates the top part of the token definition
void	generateVertexHeader(int size) Generate the vertex header
void	generateVoidCodeGenerator() there was no code generated.
boolean	getDefaultIncludeFlag() tells me the default value for include file generation
int	getDefaultIndent() the deault indentation is language dependent
String	getExtensionSuffix() get the source extension
String	getId() get the short, one-letter, or two-letter identifier for this language.
String	getIncludeExtensionSuffix()
String	getLanguageCode() get the string that identifies the language.
String	getLexerModeRoutine(String lexerMode) Given a lexer mode, return the routine definition
int	getNumberOfSpacesPerIndent() number of spaces per indent
String	indent(FormattingPrintStream out, int n) Indents a number of separators, based on the number of spaces per indent.
String	indent(int n) Indents a number of separators, returning the string
void	printAction(int action, Action anAction) Emit one action
void	printActionHeader() emit the header of the action table
void	printCodeHeader() print the declarations for the rest of the code
void	printErrorEntry(int error) Add errors to the table
void	printErrorFooter() Close the error table
void	printErrorTableHeader() declare the error table
void	printGoTo(int gotoIndex, GoTo pGoto) Emit one go to
void	printGoToTableHeader() emit the goto table header
void	printGrammarTable() Output the whole grammar table
void	printMissingSkeleton(String filename) The skeleton was not found, say so.
void	printPackedState(int stateNumber) print a state in packed fashion
void	printParserErrors() Display the errors of the parser
void	printParsingTableHeader() Declare the parsing table
void	printTableRow(int symbolCounter, int[] parserLine, int stateNumber) print one row of the parsing table

Method Detail

getLanguageCode

String getLanguageCode()

get the string that identifies the language. Used for bundling and perhaps other stuff (i.e. titles, etc.)

Returns:

the language code as a string

getId

String getId()

get the short, one-letter, or two-letter identifier for this language. Used in cmd line options.

Returns:

the id of the language

getExtensionSuffix

String getExtensionSuffix()

get the source extension

Returns:

the extension suffix for the language

getIncludeExtensionSuffix

String getIncludeExtensionSuffix()

Returns:

include file extension

getDefaultIncludeFlag

boolean getDefaultIncludeFlag()

tells me the default value for include file generation

Returns:

the default setting

getDefaultIndent

int getDefaultIndent()

the deault indentation is language dependent

emitLine

void emitLine(int line)

emit #line in C

Parameters:

line - is the line number

emitLine

void emitLine(int line,
              String filename)

emit #line in C

Parameters:

line - is the line number

filename - is the filename

getNumberOfSpacesPerIndent

int getNumberOfSpacesPerIndent()

number of spaces per indent

Returns:

the number of spaces per indent

indent

String indent(FormattingPrintStream out,
              int n)

Indents a number of separators, based on the number of spaces per indent.

Parameters:

out - is the output stream. it can be null

n - is the number of indentations

Returns:

the string with all the indents

indent

String indent(int n)

Indents a number of separators, returning the string

Parameters:

n - is the number of indentations

Returns:

the string with all the indents

generateCaseStart

int generateCaseStart(int lineNumber,
                      String label,
                      String comment)

emit a case start

Parameters:

lineNumber - the line number on the source

label - the label of the case statement

comment - is the comment of the case

Returns:

for indentation purposes the column where the case ended

generateCaseEnd

void generateCaseEnd()

emit a case end statement

generateRuleCode

boolean generateRuleCode(Lexer lexer,
                         EmbeddedCodeProcessor processor,
                         int elementCount,
                         String nonTerminalId,
                         int sourceColumn)

Parsing logic Scan the input stream until a rule set of actions end. The format for ending rules is language dependent

Parameters:

lexer - the element that will give me the lexical logic

processor - is the processor for rules

elementCount - the number of elements in the rule

nonTerminalId - the non terminal id for the rule

sourceColumn - is the column number

Returns:

true if OK

generateLexerHeader

void generateLexerHeader(List<String> modes)

Emit the header of the lexer as needed.

Parameters:

modes - is the list of forward modes

generateLexerModeHeader

void generateLexerModeHeader(String mode)

Emit a lexer function header by mode

Parameters:

mode - for the lexer mode

generateLexerModeFooter

void generateLexerModeFooter(String mode)

Emit a lexer function footer by mode

Parameters:

mode - for the lexer mode

generateLexerFooter

void generateLexerFooter()

Generate the bottom of the lexer

generateCodeGeneratorHeader

void generateCodeGeneratorHeader()

Output the top of the rules if needed

generateCodeGeneratorFooter

void generateCodeGeneratorFooter()

Generate the ending portion of the code generation

generateVoidCodeGenerator

void generateVoidCodeGenerator()

there was no code generated. Generate a good-for-nothing code generator routine.

generateRecoveryTableHeader

void generateRecoveryTableHeader(int numberOfErrorTokens)

The recovery table deals with tokens that can be used to recognize syntax context and can recover from errors.

Parameters:

numberOfErrorTokens - is the number of errors

generateStructure

boolean generateStructure(Lexer lexer)

For yacc compatibility this is called the union, but it is really a structure

Parameters:

lexer - is the lexical analyzer

Returns:

true if OK

generateErrorToken

void generateErrorToken(int recoveryToken,
                        ErrorToken id,
                        boolean isLast)

Generates one entry for an error token

Parameters:

recoveryToken - the recovery id

id - the ErrorToken

isLast - to check if this is the last

generateTokensHeader

void generateTokensHeader(int terminals)

Generates the top part of the token definition

Parameters:

terminals - is the number of terminal symbols

generateToken

void generateToken(Terminal id,
                   boolean isLast)

Generate the code for a given token

Parameters:

id - is the token itself

isLast - to determine the way to emit the last token

generateTokenDefinitions

void generateTokenDefinitions()

Declare all the tokens

generateLexerCode

boolean generateLexerCode(FormattingPrintStream output,
                          String lexerMode,
                          Lexer lexer,
                          Terminal token,
                          int additionalIndent)

Emit the code for the lexical part of the grammar

Parameters:

output - is the stream to write to

lexerMode - is the string representing the desired mode

lexer - is the lexer to obtain more characters

token - is the current token for which generation is attempted

additionalIndent - is the wanted indentation delta

Returns:

true if OK

printCodeHeader

void printCodeHeader()

print the declarations for the rest of the code

printTableRow

void printTableRow(int symbolCounter,
                   int[] parserLine,
                   int stateNumber)

print one row of the parsing table

Parameters:

symbolCounter - is the number of symbols

parserLine - is the array of lines

stateNumber - is the state number

printParsingTableHeader

void printParsingTableHeader()

Declare the parsing table

printPackedState

void printPackedState(int stateNumber)

print a state in packed fashion

Parameters:

stateNumber - is the id of the state

printErrorTableHeader

void printErrorTableHeader()

declare the error table

printErrorEntry

void printErrorEntry(int error)

Add errors to the table

Parameters:

error - is the error number

printErrorFooter

void printErrorFooter()

Close the error table

printActionHeader

void printActionHeader()

emit the header of the action table

printAction

void printAction(int action,
                 Action anAction)

Emit one action

Parameters:

action - the action id

anAction - the actual action

printGoToTableHeader

void printGoToTableHeader()

emit the goto table header

printGoTo

void printGoTo(int gotoIndex,
               GoTo pGoto)

Emit one go to

Parameters:

gotoIndex - the number of gotos

pGoto - the actual goto

printMissingSkeleton

void printMissingSkeleton(String filename)

The skeleton was not found, say so.

Parameters:

filename - the missing skeleton

printGrammarTable

void printGrammarTable()

Output the whole grammar table

printParserErrors

void printParserErrors()

Display the errors of the parser

generateLexerModeDefinition

void generateLexerModeDefinition(String mode,
                                 int i)

Generate the constant or 'define" for a given lexer mode

Parameters:

mode - is the mode of the lexer

i - is the index of the definition

generateLexerModeCase

void generateLexerModeCase(String mode,
                           int i)

Generate the constant or 'define" for a given lexer mode

Parameters:

mode - is the mode of the lexer

i - is the index of the definition

generateEdgeHeader

void generateEdgeHeader(int tableSize)

Generate the code for the edge table beginning

Parameters:

tableSize - is the size of the table

generateVertexHeader

void generateVertexHeader(int size)

Generate the vertex header

Parameters:

size - is the number of nodes

generateIntArrayRow

void generateIntArrayRow(int i,
                         String comment,
                         int index,
                         int maxRows)

Output a row in an integer array

Parameters:

i - is the integer to output

comment, - a comment to add, if any

index - is the row of this item

maxRows - is the size of the array. Used to determine commas, etc.

generateIntArrayComment

void generateIntArrayComment(String comment)

Output a comment in an array

Parameters:

comment - is the comment to output

generateIntArrayFooter

void generateIntArrayFooter()

Output the end of an int array

generateRegexMatch

void generateRegexMatch(FormattingPrintStream output,
                        int dfaNode)

Generate if statement for a regular expression match

Parameters:

output - is the code stream

dfaNode - is the starting dfa node to begin the match

generateRegexReturn

void generateRegexReturn(FormattingPrintStream output,
                         Terminal token)

Generate the default return token for a regexp

Parameters:

output - is the code stream

token - is the token that it returns

generateRegexEnd

void generateRegexEnd(FormattingPrintStream output)

Generate the bottom of a regex match in the scanner

Parameters:

output - is the code stream

getLexerModeRoutine

String getLexerModeRoutine(String lexerMode)

Given a lexer mode, return the routine definition

Parameters:

lexerMode - is the desired lexer mode

Returns:

the routine definition