Package com.sun.tools.corba.ee.idl

Class Preprocessor

java.lang.Object

com.sun.tools.corba.ee.idl.Preprocessor

public class Preprocessor
extends Object

This class should be extended if new pragmas are desired. If the preprocessor encounters a pragma name which it doesn't recognize (anything other than ID, prefix, or version), it calls the method otherPragmas. This is the only method which need be overridden. The Preprocessor base class has a number of utility-like methods which can be used by the overridden otherPragmas method.

Field Summary

Fields

Modifier and Type	Field	Description
private final Stack<Boolean>	alreadyProcessedABranch
private static String	indent
private boolean	lastWasMacroID
private Vector<String>	macros
private Parser	parser
private final Vector<PragmaHandler>	pragmaHandlers
private final Vector<SymtabEntry>	PragmaIDs
private Scanner	scanner
private Hashtable<String,String>	symbols
(package private) Token	token

Constructor Summary

Constructors

Constructor	Description
Preprocessor()	Public zero-argument constructor.

Method Summary

Modifier and Type	Method	Description
private Expression	andExpr(Expression e, SymtabEntry entry)
(package private) Expression	booleanConstExpr(SymtabEntry entry)
protected Object	clone()
(package private) void	closeScope(SymtabEntry entry)	This method is called when the parser encounters a right curly brace.
private void	constExpr()
(package private) String	currentToken()	Get the current token.
private void	define()
private Expression	definedExpr(SymtabEntry entry)
private void	elif()
private boolean	embedded(String string, int index, int endIndex)
private Expression	equalityExpr(Expression e, SymtabEntry entry)
(package private) String	expandMacro(String macroDef, Token t)
(package private) SymtabEntry	getEntryForName(String string)	This method, given an entry name, returns the entry with that name.
private String	getFilename(String name)
private Vector<String>	getParmValues()
(package private) String	getStringToEOL()	This method returns a string of all of the characters from the input file from the current position up to, but not including, the end-of-line character(s).
(package private) String	getUntil(char c)	This method returns a string of all of the characters from the input file from the current position up to, but not including, the given character.
private void	idPragma()
private void	ifClause()
private void	ifdef(boolean not)
private void	ifDefine(boolean inParens, boolean not)
private void	include()
private void	include2(IncludeEntry include)
private void	include3(IncludeEntry include)
private void	include4(IncludeEntry include, String filename)
(package private) void	init(Parser p)
private boolean	inQuotes(String string, int index)
private void	localPragma()
private void	localServantPragma()
private void	macro(Vector<String> parmNames)
private void	macroParms(Vector<String> parmNames)
private void	macroParms2(Vector<String> parmNames)
private void	macroParmValues(Vector<String> values)
private void	match(int type)
private void	miniMatch(int type)
(package private) String	nextToken()	This method returns the next token String from the input file.
private Expression	notExpr(SymtabEntry entry)
(package private) void	openScope(SymtabEntry entry)	This method is called when the parser encounters a left curly brace.
private Expression	orExpr(Expression e, SymtabEntry entry)
private void	otherPragmas(String pragmaType, String currentToken)
(package private) void	parseException(String message)	This method displays a Parser Exception complete with line number and position information with the given message string.
private void	pragma()
private void	prefixPragma()
(package private) Expression	primaryExpr(SymtabEntry entry)
(package private) Token	process(Token t)
(package private) void	registerPragma(PragmaHandler handler)
private String	removeDoublePound(String string)	Remove any occurrences of ##.
private String	replaceAll(String string, String from, String to)
(package private) SymtabEntry	scopedName()	This method assumes that the current token marks the beginning of a scoped name.
private void	skipToEndif()
private void	skipToEndiforElse()
(package private) void	skipToEOL()	Skip to the end of the line.
(package private) String	skipUntil(char c)	This method skips the data in the input file until the specified character is encountered, then it returns the next token.
private String	tokenToString()
private void	undefine()
private void	versionPragma()

Methods inherited from class java.lang.Object

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

Field Details

PragmaIDs

private final Vector<SymtabEntry> PragmaIDs

pragmaHandlers

private final Vector<PragmaHandler> pragmaHandlers

lastWasMacroID

private boolean lastWasMacroID

parser

private Parser parser

scanner

private Scanner scanner

symbols

private Hashtable<String,String> symbols

macros

private Vector<String> macros

alreadyProcessedABranch

private final Stack<Boolean> alreadyProcessedABranch

token

Token token

indent

private static String indent

Constructor Details

Preprocessor

Preprocessor()

Public zero-argument constructor.

Method Details

init

void init(Parser p)

clone

protected Object clone()

Overrides:

clone in class Object

process

Token process(Token t)
       throws IOException,
ParseException

Throws:

IOException

ParseException

include

private void include()
              throws IOException,
ParseException

Throws:

IOException

ParseException

include2

private void include2(IncludeEntry include)
               throws IOException,
ParseException

Throws:

IOException

ParseException

include3

private void include3(IncludeEntry include)
               throws IOException,
ParseException

Throws:

IOException

ParseException

include4

private void include4(IncludeEntry include,
 String filename)
               throws IOException,
ParseException

Throws:

IOException

ParseException

define

private void define()
             throws IOException,
ParseException

Throws:

IOException

ParseException

undefine

private void undefine()
               throws IOException,
ParseException

Throws:

IOException

ParseException

ifClause

private void ifClause()
               throws IOException,
ParseException

Throws:

IOException

ParseException

constExpr

private void constExpr()
                throws IOException,
ParseException

Throws:

IOException

ParseException

booleanConstExpr

Expression booleanConstExpr(SymtabEntry entry)
                     throws IOException,
ParseException

Throws:

IOException

ParseException

orExpr

private Expression orExpr(Expression e,
 SymtabEntry entry)
                   throws IOException,
ParseException

Throws:

IOException

ParseException

andExpr

private Expression andExpr(Expression e,
 SymtabEntry entry)
                    throws IOException,
ParseException

Throws:

IOException

ParseException

notExpr

private Expression notExpr(SymtabEntry entry)
                    throws IOException,
ParseException

Throws:

IOException

ParseException

definedExpr

private Expression definedExpr(SymtabEntry entry)
                        throws IOException,
ParseException

Throws:

IOException

ParseException

equalityExpr

private Expression equalityExpr(Expression e,
 SymtabEntry entry)
                         throws IOException,
ParseException

Throws:

IOException

ParseException

primaryExpr

Expression primaryExpr(SymtabEntry entry)
                throws IOException,
ParseException

Throws:

IOException

ParseException

ifDefine

private void ifDefine(boolean inParens,
 boolean not)
               throws IOException,
ParseException

Throws:

IOException

ParseException

ifdef

private void ifdef(boolean not)
            throws IOException,
ParseException

Throws:

IOException

ParseException

elif

private void elif()
           throws IOException,
ParseException

Throws:

IOException

ParseException

skipToEndiforElse

private void skipToEndiforElse()
                        throws IOException,
ParseException

Throws:

IOException

ParseException

skipToEndif

private void skipToEndif()
                  throws IOException,
ParseException

Throws:

IOException

ParseException

pragma

private void pragma()
             throws IOException,
ParseException

Throws:

IOException

ParseException

localPragma

private void localPragma()
                  throws IOException,
ParseException

Throws:

IOException

ParseException

localServantPragma

private void localServantPragma()
                         throws IOException,
ParseException

Throws:

IOException

ParseException

idPragma

private void idPragma()
               throws IOException,
ParseException

Throws:

IOException

ParseException

prefixPragma

private void prefixPragma()
                   throws IOException,
ParseException

Throws:

IOException

ParseException

versionPragma

private void versionPragma()
                    throws IOException,
ParseException

Throws:

IOException

ParseException

registerPragma

void registerPragma(PragmaHandler handler)

otherPragmas

private void otherPragmas(String pragmaType,
 String currentToken)
                   throws IOException

Throws:

IOException

currentToken

String currentToken()

Get the current token.

Returns:

the current token

getEntryForName

SymtabEntry getEntryForName(String string)

This method, given an entry name, returns the entry with that name. It can take fully or partially qualified names and returns the appropriate entry defined within the current scope. If no entry exists, null is returned.

Parameters:

string - entry name to look for

Returns:

entry with that name or null if no entry

getStringToEOL

String getStringToEOL()
               throws IOException

This method returns a string of all of the characters from the input file from the current position up to, but not including, the end-of-line character(s).

Returns:

String from current position

Throws:

IOException

getUntil

String getUntil(char c)
         throws IOException

This method returns a string of all of the characters from the input file from the current position up to, but not including, the given character. It encapsulates parenthesis and quoted strings, meaning it does not stop if the given character is found within parentheses or quotes. For instance, given the input of `start(inside)end', getUntil ('n') will return "start(inside)e"

Parameters:

c - token to read up to. The token itself will not be read.

Throws:

IOException

tokenToString

private String tokenToString()

nextToken

String nextToken()
          throws IOException

This method returns the next token String from the input file.

Returns:

the next token String

Throws:

IOException

scopedName

SymtabEntry scopedName()
                throws IOException

This method assumes that the current token marks the beginning of a scoped name. It then parses the subsequent identifier and double colon tokens, builds the scoped name, and finds the symbol table entry with that name.

Returns:

a SymtabEntry of the name

Throws:

IOException

skipToEOL

void skipToEOL()
        throws IOException

Skip to the end of the line.

Throws:

IOException

skipUntil

String skipUntil(char c)
          throws IOException

This method skips the data in the input file until the specified character is encountered, then it returns the next token.

Parameters:

c - token to indicate end of skipping

Throws:

IOException

parseException

void parseException(String message)

This method displays a Parser Exception complete with line number and position information with the given message string.

Parameters:

message - message to display as part of the Exception

See Also:

• Throwable.getMessage()

expandMacro

String expandMacro(String macroDef,
 Token t)
            throws IOException,
ParseException

Throws:

IOException

ParseException

miniMatch

private void miniMatch(int type)
                throws ParseException

Throws:

ParseException

getParmValues

private Vector<String> getParmValues()
                              throws IOException,
ParseException

Throws:

IOException

ParseException

macroParmValues

private void macroParmValues(Vector<String> values)
                      throws IOException,
ParseException

Throws:

IOException

ParseException

macro

private void macro(Vector<String> parmNames)
            throws IOException,
ParseException

Throws:

IOException

ParseException

macroParms

private void macroParms(Vector<String> parmNames)
                 throws IOException,
ParseException

Throws:

IOException

ParseException

macroParms2

private void macroParms2(Vector<String> parmNames)
                  throws IOException,
ParseException

Throws:

IOException

ParseException

replaceAll

private String replaceAll(String string,
 String from,
 String to)

embedded

private boolean embedded(String string,
 int index,
 int endIndex)

inQuotes

private boolean inQuotes(String string,
 int index)

removeDoublePound

private String removeDoublePound(String string)

Remove any occurrences of ##.

getFilename

private String getFilename(String name)
                    throws FileNotFoundException

Throws:

FileNotFoundException

match

private void match(int type)
            throws IOException,
ParseException

Throws:

IOException

ParseException

openScope

void openScope(SymtabEntry entry)

This method is called when the parser encounters a left curly brace. An extender of PragmaHandler may find scope information useful. For example, the prefix pragma takes effect as soon as it is encountered and stays in effect until the current scope is closed. If a similar pragma extension is desired, then the openScope and closeScope methods are available for overriding.

Parameters:

entry - the symbol table entry whose scope has just been opened. Be aware that, since the scope has just been entered, this entry is incomplete at this point.

closeScope

void closeScope(SymtabEntry entry)

This method is called when the parser encounters a right curly brace. An extender of PragmaHandler may find scope information useful. For example, the prefix pragma takes effect as soon as it is encountered and stays in effect until the current scope is closed. If a similar pragma extension is desired, then the openScope and closeScope methods are available for overriding.

Parameters:

entry - the symbol table entry whose scope has just been closed.