jflex

Class Emitter

java.lang.Object

jflex.Emitter

Direct Known Subclasses:

JavaEmitter, ScalaEmitter

public abstract class Emitter
extends Object

This class manages the actual code generation, putting the scanner together, filling in skeleton sections etc. Table compression, String packing etc. is also done here.

Version:

JFlex 1.7.0-SNAPSHOT

Author:

Gerwin Klein

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<Action,Integer>	actionTable maps actions to their switch label
protected boolean[]	colKilled
protected int[]	colMap
protected DFA	dfa
protected static int	FINAL
protected File	inputFile
protected CharClassInterval[]	intervals
protected boolean[]	isTransition
protected static Pattern	JAVADOC_COMMENT_AND_MAYBE_ANNOTATIONS_PATTERN
protected static int	NOLOOK
protected int	numCols
protected int	numRows
protected PrintWriter	out
protected LexParse	parser
protected boolean[]	rowKilled
protected int[]	rowMap
protected LexScan	scanner
protected Skeleton	skel

Constructor Summary

Constructors

Constructor and Description
Emitter()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	emit() Main Emitter method.
protected abstract void	emitActions()
abstract void	emitActionTable()
protected abstract void	emitAttributes()
protected abstract int	emitCharMapArray() Returns the number of elements in the packed char map array, or zero if the char map array will be not be packed.
protected abstract void	emitCharMapArrayUnPacked()
protected abstract void	emitCharMapInitFunction(int packedCharMapPairs)
protected abstract void	emitClassCode()
protected abstract void	emitClassName()
protected abstract void	emitConstructorDecl()
protected abstract void	emitConstructorDecl(boolean printCtorArgs)
protected void	emitCtorArgs()
protected abstract void	emitDoEOF()
protected abstract void	emitDynamicInit()
protected abstract void	emitEOFVal()
protected abstract void	emitGetRowMapNext()
protected void	emitHeader()
protected abstract void	emitLexFunctHeader()
protected abstract void	emitLexicalStates()
protected abstract void	emitLookBuffer()
protected abstract void	emitMain()
protected abstract void	emitNextInput()
protected abstract void	emitNoMatch()
protected abstract void	emitRowMapArray()
protected abstract void	emitScanError()
protected abstract void	emitUserCode()
static boolean	endsWithJavadoc(StringBuilder usercode) Try to find out if user code ends with a javadoc comment, maybe followed by one or more annotations
protected String	escapify(String s) Escapes all " ' \ tabs and newlines
protected void	findActionStates()
static String	getBaseName(String className) Computes base name of the class name.
protected boolean	hasGenLookAhead()
static File	normalize(String name, File input) Constructs a file in Options.getDir() or in the same directory as another file.
protected void	print(int i)
protected void	print(int i, int tab)
protected void	print(String line)
protected void	println()
protected void	println(int i)
protected void	println(String line)
protected void	printUC(int c) Print number as octal/unicode escaped string character.
protected void	reduceColumns()
protected void	reduceRows()
protected abstract void	setupEOFCode() Set up EOF code section according to scanner.eofcode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

JAVADOC_COMMENT_AND_MAYBE_ANNOTATIONS_PATTERN

protected static final Pattern JAVADOC_COMMENT_AND_MAYBE_ANNOTATIONS_PATTERN

FINAL

protected static final int FINAL

See Also:

Constant Field Values

NOLOOK

protected static final int NOLOOK

See Also:

Constant Field Values

inputFile

protected File inputFile

out

protected PrintWriter out

skel

protected Skeleton skel

scanner

protected LexScan scanner

parser

protected LexParse parser

dfa

protected DFA dfa

isTransition

protected boolean[] isTransition

numRows

protected int numRows

rowMap

protected int[] rowMap

rowKilled

protected boolean[] rowKilled

numCols

protected int numCols

colMap

protected int[] colMap

colKilled

protected boolean[] colKilled

actionTable

protected Map<Action,Integer> actionTable

maps actions to their switch label

intervals

protected CharClassInterval[] intervals

Constructor Detail

Emitter

public Emitter()

Method Detail

getBaseName

public static String getBaseName(String className)

Computes base name of the class name. Needs to take into account generics.

Parameters:

className - Class name for which to construct the base name

Returns:

the

See Also:

LexScan.className

normalize

public static File normalize(String name,
             File input)

Constructs a file in Options.getDir() or in the same directory as another file. Makes a backup if the file already exists.

Parameters:

name - the name (without path) of the file

input - fall back location if path = null (expected to be a file in the directory to write to)

Returns:

The constructed File

println

protected void println()

println

protected void println(String line)

println

protected void println(int i)

print

protected void print(String line)

print

protected void print(int i)

print

protected void print(int i,
         int tab)

hasGenLookAhead

protected boolean hasGenLookAhead()

emitLookBuffer

protected abstract void emitLookBuffer()

emitScanError

protected abstract void emitScanError()

emitMain

protected abstract void emitMain()

emitNoMatch

protected abstract void emitNoMatch()

emitNextInput

protected abstract void emitNextInput()

emitHeader

protected void emitHeader()

emitUserCode

protected abstract void emitUserCode()

emitClassName

protected abstract void emitClassName()

endsWithJavadoc

public static boolean endsWithJavadoc(StringBuilder usercode)

Try to find out if user code ends with a javadoc comment, maybe followed by one or more annotations

Parameters:

usercode - the user code

Returns:

true if it ends with a javadoc comment and zero or more annotations

emitLexicalStates

protected abstract void emitLexicalStates()

emitDynamicInit

protected abstract void emitDynamicInit()

emitCharMapInitFunction

protected abstract void emitCharMapInitFunction(int packedCharMapPairs)

emitCharMapArrayUnPacked

protected abstract void emitCharMapArrayUnPacked()

emitCharMapArray

protected abstract int emitCharMapArray()

Returns the number of elements in the packed char map array, or zero if the char map array will be not be packed. This will be more than intervals.length if the count for any of the values is more than 0xFFFF, since the number of char map array entries per value is ceil(count / 0xFFFF)

printUC

protected void printUC(int c)

Print number as octal/unicode escaped string character.

Parameters:

c - the value to print

emitRowMapArray

protected abstract void emitRowMapArray()

emitAttributes

protected abstract void emitAttributes()

emitClassCode

protected abstract void emitClassCode()

emitConstructorDecl

protected abstract void emitConstructorDecl()

emitConstructorDecl

protected abstract void emitConstructorDecl(boolean printCtorArgs)

emitCtorArgs

protected void emitCtorArgs()

emitDoEOF

protected abstract void emitDoEOF()

emitLexFunctHeader

protected abstract void emitLexFunctHeader()

emitGetRowMapNext

protected abstract void emitGetRowMapNext()

escapify

protected String escapify(String s)

Escapes all " ' \ tabs and newlines

Parameters:

s - The string to escape

Returns:

The escaped string

emitActionTable

public abstract void emitActionTable()

emitActions

protected abstract void emitActions()

emitEOFVal

protected abstract void emitEOFVal()

findActionStates

protected void findActionStates()

reduceColumns

protected void reduceColumns()

reduceRows

protected void reduceRows()

setupEOFCode

protected abstract void setupEOFCode()

Set up EOF code section according to scanner.eofcode

emit

public abstract void emit()

Main Emitter method.