GlueGen Runtime 2.3.2 · com.jogamp.gluegen.jcpp.Preprocessor

Modifier and Type	Field and Description
private static final Macro	__COUNTER__
private static final Macro	__FILE__
private static final Macro	__LINE__
private int	counter
private Token	expr_token
private final Set<Feature>	features
private VirtualFileSystem	filesystem
private List<String>	frameworkspath
private final List<VirtualFile>	includes
private final List<Source>	inputs
private static final Source	INTERNAL
private PreprocessorListener	listener
private final Logging.LoggerIf	LOG
private final Map<String, Macro>	macros
private final Set<String>	onceseenpaths
private List<String>	quoteincludepath
private Source	source
private Token	source_token
private final Stack<State>	states
private List<String>	sysincludepath
private final Set<Warning>	warnings

Access	Constructor and Description
public	Preprocessor()
public	Preprocessor(final Source initial)
public	Preprocessor(final File file) Equivalent to 'new Preprocessor(new `FileLexerSource`(file))'

Method Summary

Modifier and Type	Method and Description
private Token	_token()
public void	addFeature(final Feature f) Adds a feature to the feature-set of this Preprocessor.
public void	addFeatures(final Collection<Feature> f) Adds features to the feature-set of this Preprocessor.
public void	addFeatures(final Feature... f) Adds features to the feature-set of this Preprocessor.
public void	addInput(final Source source) Adds input for the Preprocessor.
public void	addInput(final File file) Adds input for the Preprocessor.
public void	addMacro(final Macro m) Adds a Macro to this Preprocessor.
public void	addMacro(final String name, final String value) Defines the given name as a macro.
public void	addMacro(final String name) Defines the given name as a macro, with the value `1`.
public void	addWarning(final Warning w) Adds a warning to the warning-set of this Preprocessor.
public void	addWarnings(final Collection<Warning> w) Adds warnings to the warning-set of this Preprocessor.
public void	close() Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
private Token	define()
protected void	error(final int line, final int column, final String msg) Handles an error.
protected void	error(final Token tok, final String msg) Handles an error.
private void	error(final Token pptok, final boolean is_error)
pack-priv List<Token>	expand(final List<Token> arg) Expands an argument.
private Token	expanded_token()
private Token	expanded_token_nonwhite()
private long	expr(final int priority)
private int	expr_priority(final Token op)
private Token	expr_token()
private void	expr_untoken(final Token tok)
public boolean	getFeature(final Feature f) Returns true if the given feature is in the feature-set of this Preprocessor.
public Set<Feature>	getFeatures() Returns the feature-set for this Preprocessor.
public VirtualFileSystem	getFileSystem() Returns the VirtualFileSystem used by this Preprocessor.
public List<String>	getFrameworksPath() Returns the Objective-C frameworks path used by this Preprocessor.
public List<? extends VirtualFile>	getIncludes() Returns the list of `VirtualFiles` which have been included by this Preprocessor.
public PreprocessorListener	getListener() Returns the PreprocessorListener which handles events for this Preprocessor.
public Macro	getMacro(final String name) Returns the named macro.
public Map<String, Macro>	getMacros() Returns the Map of Macros parsed during the run of this Preprocessor.
public List<Macro>	getMacros(final boolean if `true` and if macro is not `function-like`, i.e. a constant, the returned macro will be expanded. expand) Returns a list of `Macro`s.
public List<String>	getQuoteIncludePath() Returns the user include-path of this Preprocessor.
public Source	getSource() Returns the top Source on the input stack.
public List<String>	getSystemIncludePath() Returns the system include-path of this Preprocessor.
public boolean	getWarning(final Warning w) Returns true if the given warning is in the warning-set of this Preprocessor.
public Set<Warning>	getWarnings() Returns the warning-set for this Preprocessor.
protected boolean	include(final VirtualFile file) Attempts to include the given file.
protected boolean	include(final Iterable<String> path, final String name) Includes a file from an include path, by name.
private void	include(final String parent, final int line, final String name, final boolean quoted, final boolean next) Handles an include directive.
private Token	include(final boolean next)
private boolean	isActive()
private boolean	isWhite(final Token tok)
private Token	line_token(final int line, final String name, final String extra)
private boolean	macro(final Macro m, final Token orig)
private Token	next_source()
protected Token	pop_source(final boolean linemarker) Pops a Source from the input stack.
protected void	pop_source()
private void	pop_state()
protected void	pragma(final Token name, final List<Token> value)
private Token	pragma()
protected void	pragma_once(final Token name)
protected void	push_source(final Source source, final boolean autopop) Pushes a Source onto the input stack.
private void	push_state()
public void	setFileSystem(final VirtualFileSystem filesystem) Sets the VirtualFileSystem used by this Preprocessor.
public void	setFrameworksPath(final List<String> path) Sets the Objective-C frameworks path used by this Preprocessor.
public void	setListener(final PreprocessorListener listener) Sets the PreprocessorListener which handles events for this Preprocessor.
public void	setQuoteIncludePath(final List<String> path) Sets the user include path used by this Preprocessor.
public void	setSystemIncludePath(final List<String> path) Sets the system include path used by this Preprocessor.
private Token	source_skipline(final boolean white) Returns an NL or an EOF token.
private Token	source_token()
private Token	source_token_nonwhite()
private void	source_untoken(final Token tok)
public Token	token() Returns the next preprocessor token.
private Token	token_nonwhite()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
private Token	toWhitespace(final Token tok)
private Token	undef()
protected void	warning(final int line, final int column, final String msg) Handles a warning.
protected void	warning(final Token tok, final String msg) Handles a warning.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

__COUNTER__	back to summary
private static final Macro __COUNTER__

__FILE__	back to summary
private static final Macro __FILE__

__LINE__	back to summary
private static final Macro __LINE__

counter	back to summary
private int counter

expr_token	back to summary
private Token expr_token Annotations @CheckForNull

features	back to summary
private final Set<Feature> features

filesystem	back to summary
private VirtualFileSystem filesystem

frameworkspath	back to summary
private List<String> frameworkspath

includes	back to summary
private final List<VirtualFile> includes

inputs	back to summary
private final List<Source> inputs

INTERNAL	back to summary
private static final Source INTERNAL

listener	back to summary
private PreprocessorListener listener

LOG	back to summary
private final Logging.LoggerIf LOG

macros	back to summary
private final Map<String, Macro> macros

onceseenpaths	back to summary
private final Set<String> onceseenpaths

quoteincludepath	back to summary
private List<String> quoteincludepath

source	back to summary
private Source source

source_token	back to summary
private Token source_token

states	back to summary
private final Stack<State> states

sysincludepath	back to summary
private List<String> sysincludepath

warnings	back to summary
private final Set<Warning> warnings

Preprocessor	back to summary
public Preprocessor()

Preprocessor	back to summary
public Preprocessor(final Source initial)

Preprocessor	back to summary
public Preprocessor(final File file) throws IOException Equivalent to 'new Preprocessor(new `FileLexerSource`(file))'

Method Detail

_token	back to summary
private Token _token() throws IOException, LexerException Annotations @Nonnull

addFeature	back to summary
public void addFeature(final Feature f) Adds a feature to the feature-set of this Preprocessor.

addFeatures	back to summary
public void addFeatures(final Collection<Feature> f) Adds features to the feature-set of this Preprocessor.

addFeatures	back to summary
public void addFeatures(final Feature... f) Adds features to the feature-set of this Preprocessor.

addInput	back to summary
public void addInput(final Source source) Adds input for the Preprocessor. Inputs are processed in the order in which they are added.

addInput back to summary

addInput	back to summary
public void addInput(final File file) throws IOException Adds input for the Preprocessor. See Also `addInput(Source)`

public void addInput(final File file) throws IOException

Adds input for the Preprocessor.

See Also: addInput(Source)

addMacro	back to summary
public void addMacro(final Macro m) throws LexerException, IOException Adds a Macro to this Preprocessor. The given `Macro` object encapsulates both the name and the expansion.

addMacro	back to summary
public void addMacro(final String name, final 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.

addMacro	back to summary
public void addMacro(final 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")`.

addWarning	back to summary
public void addWarning(final Warning w) Adds a warning to the warning-set of this Preprocessor.

addWarnings	back to summary
public void addWarnings(final Collection<Warning> w) Adds warnings to the warning-set of this Preprocessor.

close back to summary

close	back to summary
public void close() throws IOException Implements java.io.Closeable.close. Doc from java.io.Closeable.close. Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in `AutoCloseable#close()`, cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the `Closeable` as closed, prior to throwing the `IOException`. Annotations @Override Exceptions IOException: if an I/O error occurs

public void close() throws IOException

Implements java.io.Closeable.close.

Doc from java.io.Closeable.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

define	back to summary
private Token define() throws IOException, LexerException

error	back to summary
protected void error(final int line, final int column, final String msg) throws LexerException Handles an error. If a PreprocessorListener is installed, it receives the error. Otherwise, an exception is thrown.

error back to summary

error	back to summary
protected void error(final Token tok, final String msg) throws LexerException Handles an error. If a PreprocessorListener is installed, it receives the error. Otherwise, an exception is thrown. See Also `error(int, int, String)`

protected void error(final Token tok, final String msg) throws LexerException

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

See Also: error(int, int, String)

error	back to summary
private void error(final Token pptok, final boolean is_error) throws IOException, LexerException

expand	back to summary
pack-priv List<Token> expand(final List<Token> arg) throws IOException, LexerException Expands an argument. Annotations @Nonnull

expand

back to summary

pack-priv List<Token> expand(final List<Token> arg) throws IOException, LexerException

Expands an argument.

Annotations

@Nonnull

expanded_token	back to summary
private Token expanded_token() throws IOException, LexerException Annotations @Nonnull

expanded_token_nonwhite	back to summary
private Token expanded_token_nonwhite() throws IOException, LexerException Annotations @Nonnull

expr	back to summary
private long expr(final int priority) throws IOException, LexerException

expr_priority	back to summary
private int expr_priority(final Token op)

expr_token	back to summary
private Token expr_token() throws IOException, LexerException Annotations @Nonnull

expr_untoken	back to summary
private void expr_untoken(final Token tok) throws LexerException

getFeature	back to summary
public boolean getFeature(final Feature f) Returns true if the given feature is in the feature-set of this Preprocessor.

getFeatures

back to summary

public Set<Feature> getFeatures()

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

Annotations

@Nonnull

getFileSystem

back to summary

public VirtualFileSystem getFileSystem()

Returns the VirtualFileSystem used by this Preprocessor.

Annotations

@Nonnull

getFrameworksPath

back to summary

public List<String> getFrameworksPath()

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

Annotations

@Nonnull

getIncludes back to summary

public 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).

Annotations

@Nonnull

getListener

back to summary

public PreprocessorListener getListener()

Returns the PreprocessorListener which handles events for this Preprocessor.

Annotations

@Nonnull

getMacro

back to summary

public Macro getMacro(final String name)

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

Annotations

@CheckForNull

getMacros

back to summary

public Map<String, Macro> getMacros()

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

Annotations

@Nonnull

getMacros back to summary

public List<Macro> getMacros(final boolean expand) throws IOException, LexerException

Returns a list of Macros.

Implementation returns a new list of copy-ctor Macros.

Parameters

expand:boolean: if true and if macro is not function-like, i.e. a constant, the returned macro will be expanded.

getQuoteIncludePath

back to summary

public List<String> getQuoteIncludePath()

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

Annotations

@Nonnull

getSource back to summary

public Source getSource()

Returns the top Source on the input stack.

See Also: Source, push_source(Source, boolean), pop_source()

getSystemIncludePath

back to summary

public List<String> getSystemIncludePath()

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

Annotations

@Nonnull

getWarning	back to summary
public boolean getWarning(final Warning w) Returns true if the given warning is in the warning-set of this Preprocessor.

getWarnings

back to summary

public Set<Warning> getWarnings()

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

Annotations

@Nonnull

include	back to summary
protected boolean include(final VirtualFile file) throws IOException, LexerException Attempts to include the given file. User code may override this method to implement a virtual file system.

include	back to summary
protected boolean include(final Iterable<String> path, final String name) throws IOException, LexerException Includes a file from an include path, by name.

include	back to summary
private void include(final String parent, final int line, final String name, final boolean quoted, final boolean next) throws IOException, LexerException Handles an include directive.

include	back to summary
private Token include(final boolean next) throws IOException, LexerException Annotations @Nonnull

isActive	back to summary
private boolean isActive()

isWhite	back to summary
private boolean isWhite(final Token tok)

line_token	back to summary
private Token line_token(final int line, final String name, final String extra) Annotations @Nonnull

macro	back to summary
private boolean macro(final Macro m, final Token orig) throws IOException, LexerException

next_source	back to summary
private Token next_source() Annotations @Nonnull

pop_source back to summary

protected Token pop_source(final boolean linemarker) throws IOException

Pops a Source from the input stack.

Annotations

@CheckForNull

pop_source	back to summary
protected void pop_source() throws IOException

pop_state	back to summary
private void pop_state() throws LexerException

pragma	back to summary
protected void pragma(final Token name, final List<Token> value) throws IOException, LexerException

pragma	back to summary
private Token pragma() throws IOException, LexerException Annotations @Nonnull

pragma_once	back to summary
protected void pragma_once(final Token name) throws IOException, LexerException

push_source back to summary

protected void push_source(final Source source, final boolean autopop)

Pushes a Source onto the input stack.

See Also: getSource(), pop_source()

push_state	back to summary
private void push_state()

setFileSystem	back to summary
public void setFileSystem(final VirtualFileSystem filesystem) Sets the VirtualFileSystem used by this Preprocessor.

setFrameworksPath	back to summary
public void setFrameworksPath(final List<String> path) Sets the Objective-C frameworks path used by this Preprocessor.

setListener	back to summary
public void setListener(final PreprocessorListener listener) Sets the PreprocessorListener which handles events for this Preprocessor. The listener is notified of warnings, errors and source changes, amongst other things.

setQuoteIncludePath	back to summary
public void setQuoteIncludePath(final List<String> path) Sets the user include path used by this Preprocessor.

setSystemIncludePath	back to summary
public void setSystemIncludePath(final List<String> path) Sets the system include path used by this Preprocessor.

source_skipline	back to summary
private Token source_skipline(final boolean white) throws IOException, LexerException Returns an NL or an EOF token. The metadata on the token will be correct, which is better than generating a new one. This method can, as of recent patches, return a P_LINE token.

source_token	back to summary
private Token source_token() throws IOException, LexerException Annotations @Nonnull

source_token_nonwhite	back to summary
private Token source_token_nonwhite() throws IOException, LexerException

source_untoken	back to summary
private void source_untoken(final Token tok)

token back to summary

public Token token() throws IOException, LexerException

Returns the next preprocessor token.

Annotations

@Nonnull

Exceptions

LexerException:: if a preprocessing error occurs.
InternalException:: if an unexpected error condition arises.

See Also

Token

token_nonwhite	back to summary
private Token token_nonwhite() throws IOException, LexerException Annotations @Nonnull

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations

@Override

toWhitespace	back to summary
private Token toWhitespace(final Token tok) Annotations @Nonnull

undef	back to summary
private Token undef() throws IOException, LexerException Annotations @Nonnull

warning	back to summary
protected void warning(final int line, final int column, final String msg) throws LexerException Handles a warning. If a PreprocessorListener is installed, it receives the warning. Otherwise, an exception is thrown.

warning back to summary

protected void warning(final Token tok, final String msg) throws LexerException

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

See Also: warning(int, int, String)

public Class Preprocessor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail