org.anarres.cpp

Class Preprocessor

java.lang.Object

org.anarres.cpp.Preprocessor

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class Preprocessor
extends java.lang.Object
implements java.io.Closeable

A C Preprocessor. The Preprocessor outputs a token stream which does not need re-lexing for C or C++. Alternatively, the output text may be reconstructed by concatenating the text values of the returned Tokens. (See CppReader, which does this.)

Constructor Summary

Constructors

Constructor and Description
Preprocessor()
Preprocessor(java.io.File file) Equivalent to 'new Preprocessor(new FileLexerSource(file))'
Preprocessor(Source initial)

Method Summary

Modifier and Type	Method and Description
void	addFeature(Feature f) Adds a feature to the feature-set of this Preprocessor.
void	addFeatures(java.util.Collection<Feature> f) Adds features to the feature-set of this Preprocessor.
void	addFeatures(Feature... f) Adds features to the feature-set of this Preprocessor.
void	addInput(java.io.File file) Adds input for the Preprocessor.
void	addInput(Source source) Adds input for the Preprocessor.
void	addMacro(Macro m) Adds a Macro to this Preprocessor.
void	addMacro(java.lang.String name) Defines the given name as a macro, with the value 1.
void	addMacro(java.lang.String name, java.lang.String value) Defines the given name as a macro.
void	addWarning(Warning w) Adds a warning to the warning-set of this Preprocessor.
void	addWarnings(java.util.Collection<Warning> w) Adds warnings to the warning-set of this Preprocessor.
void	close()
protected void	error(int line, int column, java.lang.String msg) Handles an error.
protected void	error(Token tok, java.lang.String msg) Handles an error.
boolean	getFeature(Feature f) Returns true if the given feature is in the feature-set of this Preprocessor.
java.util.Set<Feature>	getFeatures() Returns the feature-set for this Preprocessor.
VirtualFileSystem	getFileSystem() Returns the VirtualFileSystem used by this Preprocessor.
java.util.List<java.lang.String>	getFrameworksPath() Returns the Objective-C frameworks path used by this Preprocessor.
java.util.List<? extends VirtualFile>	getIncludes() Returns the list of VirtualFiles which have been included by this Preprocessor.
PreprocessorListener	getListener() Returns the PreprocessorListener which handles events for this Preprocessor.
Macro	getMacro(java.lang.String name) Returns the named macro.
java.util.Map<java.lang.String,Macro>	getMacros() Returns the Map of Macros parsed during the run of this Preprocessor.
java.util.List<java.lang.String>	getQuoteIncludePath() Returns the user include-path of this Preprocessor.
protected Source	getSource() Returns the top Source on the input stack.
java.util.List<java.lang.String>	getSystemIncludePath() Returns the system include-path of this Preprocessor.
boolean	getWarning(Warning w) Returns true if the given warning is in the warning-set of this Preprocessor.
java.util.Set<Warning>	getWarnings() Returns the warning-set for this Preprocessor.
protected boolean	include(java.lang.Iterable<java.lang.String> path, java.lang.String name) Attempts to include a file from an include path, by name.
protected boolean	include(VirtualFile file) Attempts to include the given file.
protected void	pop_source()
protected Token	pop_source(boolean linemarker) Pops a Source from the input stack.
protected void	pragma_once(Token name)
protected void	pragma(Token name, java.util.List<Token> value)
protected void	push_source(Source source, boolean autopop) Pushes a Source onto the input stack.
void	setFileSystem(VirtualFileSystem filesystem) Sets the VirtualFileSystem used by this Preprocessor.
void	setFrameworksPath(java.util.List<java.lang.String> path) Sets the Objective-C frameworks path used by this Preprocessor.
void	setListener(PreprocessorListener listener) Sets the PreprocessorListener which handles events for this Preprocessor.
void	setQuoteIncludePath(java.util.List<java.lang.String> path) Sets the user include path used by this Preprocessor.
void	setSystemIncludePath(java.util.List<java.lang.String> path) Sets the system include path used by this Preprocessor.
Token	token() Returns the next preprocessor token.
java.lang.String	toString()
protected void	warning(int line, int column, java.lang.String msg) Handles a warning.
protected void	warning(Token tok, java.lang.String msg) Handles a warning.

Methods inherited from class java.lang.Object

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

Constructor Detail

Preprocessor

public Preprocessor()

Preprocessor

public Preprocessor(@Nonnull
                    Source initial)

Preprocessor

public Preprocessor(@Nonnull
                    java.io.File file)
             throws java.io.IOException

Equivalent to 'new Preprocessor(new FileLexerSource(file))'

Throws:

java.io.IOException

Method Detail

setFileSystem

public void setFileSystem(@Nonnull
                          VirtualFileSystem filesystem)

Sets the VirtualFileSystem used by this Preprocessor.

getFileSystem

@Nonnull
public VirtualFileSystem getFileSystem()

Returns the VirtualFileSystem used by this Preprocessor.

setListener

public void setListener(@Nonnull
                        PreprocessorListener listener)

Sets the PreprocessorListener which handles events for this Preprocessor. The listener is notified of warnings, errors and source changes, amongst other things.

getListener

@Nonnull
public PreprocessorListener getListener()

Returns the PreprocessorListener which handles events for this Preprocessor.

getFeatures

@Nonnull
public java.util.Set<Feature> getFeatures()

Returns the feature-set for this Preprocessor. This set may be freely modified by user code.

addFeature

public void addFeature(@Nonnull
                       Feature f)

Adds a feature to the feature-set of this Preprocessor.

addFeatures

public void addFeatures(@Nonnull
                        java.util.Collection<Feature> f)

Adds features to the feature-set of this Preprocessor.

addFeatures

public void addFeatures(Feature... f)

Adds features to the feature-set of this Preprocessor.

getFeature

public boolean getFeature(@Nonnull
                          Feature f)

Returns true if the given feature is in the feature-set of this Preprocessor.

getWarnings

@Nonnull
public java.util.Set<Warning> getWarnings()

Returns the warning-set for this Preprocessor. This set may be freely modified by user code.

addWarning

public void addWarning(@Nonnull
                       Warning w)

Adds a warning to the warning-set of this Preprocessor.

addWarnings

public void addWarnings(@Nonnull
                        java.util.Collection<Warning> w)

Adds warnings to the warning-set of this Preprocessor.

getWarning

public boolean getWarning(@Nonnull
                          Warning w)

Returns true if the given warning is in the warning-set of this Preprocessor.

addInput

public void addInput(@Nonnull
                     Source source)

Adds input for the Preprocessor. Inputs are processed in the order in which they are added.

addInput

public void addInput(@Nonnull
                     java.io.File file)
              throws java.io.IOException

Adds input for the Preprocessor.

Throws:

java.io.IOException

See Also:

addInput(Source)

error

protected void error(int line,
                     int column,
                     @Nonnull
                     java.lang.String msg)
              throws LexerException

Handles an error. If a PreprocessorListener is installed, it receives the error. Otherwise, an exception is thrown.

Throws:

LexerException

error

protected void error(@Nonnull
                     Token tok,
                     @Nonnull
                     java.lang.String msg)
              throws LexerException

Handles an error. If a PreprocessorListener is installed, it receives the error. Otherwise, an exception is thrown.

Throws:

LexerException

See Also:

error(int, int, String)

warning

protected void warning(int line,
                       int column,
                       @Nonnull
                       java.lang.String msg)
                throws LexerException

Handles a warning. If a PreprocessorListener is installed, it receives the warning. Otherwise, an exception is thrown.

Throws:

LexerException

warning

protected void warning(@Nonnull
                       Token tok,
                       @Nonnull
                       java.lang.String msg)
                throws LexerException

Handles a warning. If a PreprocessorListener is installed, it receives the warning. Otherwise, an exception is thrown.

Throws:

LexerException

See Also:

warning(int, int, String)

addMacro

public void addMacro(@Nonnull
                     Macro m)
              throws LexerException

Adds a Macro to this Preprocessor. The given Macro object encapsulates both the name and the expansion.

Throws:

LexerException - if the definition fails or is otherwise illegal.

addMacro

public void addMacro(@Nonnull
                     java.lang.String name,
                     @Nonnull
                     java.lang.String value)
              throws LexerException

Defines the given name as a macro. The String value is lexed into a token stream, which is used as the macro expansion.

Throws:

LexerException - if the definition fails or is otherwise illegal.

addMacro

public void addMacro(@Nonnull
                     java.lang.String name)
              throws LexerException

Defines the given name as a macro, with the value 1. This is a convnience method, and is equivalent to addMacro(name, "1").

Throws:

LexerException - if the definition fails or is otherwise illegal.

setQuoteIncludePath

public void setQuoteIncludePath(@Nonnull
                                java.util.List<java.lang.String> path)

Sets the user include path used by this Preprocessor.

getQuoteIncludePath

@Nonnull
public java.util.List<java.lang.String> getQuoteIncludePath()

Returns the user include-path of this Preprocessor. This list may be freely modified by user code.

setSystemIncludePath

public void setSystemIncludePath(@Nonnull
                                 java.util.List<java.lang.String> path)

Sets the system include path used by this Preprocessor.

getSystemIncludePath

@Nonnull
public java.util.List<java.lang.String> getSystemIncludePath()

Returns the system include-path of this Preprocessor. This list may be freely modified by user code.

setFrameworksPath

public void setFrameworksPath(@Nonnull
                              java.util.List<java.lang.String> path)

Sets the Objective-C frameworks path used by this Preprocessor.

getFrameworksPath

@Nonnull
public java.util.List<java.lang.String> getFrameworksPath()

Returns the Objective-C frameworks path used by this Preprocessor. This list may be freely modified by user code.

getMacros

@Nonnull
public java.util.Map<java.lang.String,Macro> getMacros()

Returns the Map of Macros parsed during the run of this Preprocessor.

Returns:

The Map of macros currently defined.

getMacro

@CheckForNull
public Macro getMacro(@Nonnull
                                    java.lang.String name)

Returns the named macro. While you can modify the returned object, unexpected things might happen if you do.

Returns:

the Macro object, or null if not found.

getIncludes

@Nonnull
public java.util.List<? extends VirtualFile> getIncludes()

Returns the list of VirtualFiles which have been included by this Preprocessor. This does not include any Source provided to the constructor or addInput(java.io.File) or addInput(Source).

getSource

protected Source getSource()

Returns the top Source on the input stack.

Returns:

the top Source on the input stack.

See Also:

Source, push_source(Source,boolean), pop_source()

push_source

protected void push_source(@Nonnull
                           Source source,
                           boolean autopop)

Pushes a Source onto the input stack.

Parameters:

source - the new Source to push onto the top of the input stack.

autopop - if true, the Source is automatically removed from the input stack at EOF.

See Also:

getSource(), pop_source()

pop_source

@CheckForNull
protected Token pop_source(boolean linemarker)
                                  throws java.io.IOException

Pops a Source from the input stack.

Parameters:

linemarker - TODO: currently ignored, might be a bug?

Throws:

java.io.IOException - if an I/O error occurs.

See Also:

getSource(), push_source(Source,boolean)

pop_source

protected void pop_source()
                   throws java.io.IOException

Throws:

java.io.IOException

include

protected boolean include(@Nonnull
                          VirtualFile file)
                   throws java.io.IOException

Attempts to include the given file. User code may override this method to implement a virtual file system.

Parameters:

file - The VirtualFile to attempt to include.

Returns:

true if the file was successfully included, false otherwise.

Throws:

java.io.IOException - if an I/O error occurs.

include

protected boolean include(@Nonnull
                          java.lang.Iterable<java.lang.String> path,
                          @Nonnull
                          java.lang.String name)
                   throws java.io.IOException

Attempts to include a file from an include path, by name.

Parameters:

path - The list of virtual directories to search for the given name.

name - The name of the file to attempt to include.

Returns:

true if the file was successfully included, false otherwise.

Throws:

java.io.IOException - if an I/O error occurs.

pragma_once

protected void pragma_once(@Nonnull
                           Token name)
                    throws java.io.IOException,
                           LexerException

Throws:

java.io.IOException

LexerException

pragma

protected void pragma(@Nonnull
                      Token name,
                      @Nonnull
                      java.util.List<Token> value)
               throws java.io.IOException,
                      LexerException

Throws:

java.io.IOException

LexerException

token

@Nonnull
public Token token()
                     throws java.io.IOException,
                            LexerException

Returns the next preprocessor token.

Returns:

The next fully preprocessed token.

Throws:

java.io.IOException - if an I/O error occurs.

LexerException - if a preprocessing error occurs.

InternalException - if an unexpected error condition arises.

See Also:

Token

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException