Top Description Fields Constructors Methods

com.jogamp.gluegen.jcpp

public Class Macro

Class Inheritance

extends Object

java.lang.Object
com.jogamp.gluegen.jcpp.Macro

Imports

java.util.ArrayList, .Iterator, .List

A macro object. This encapsulates a name, an argument count, and a token stream for replacement. The replacement token stream may contain the extra tokens Token#M_ARG and Token#M_STRING.

Field Summary

Modifier and Type	Field and Description
private List<String>	args
private boolean	hasPaste
private final String	name
private final Source	source
private List<Token>	tokens
private boolean	variadic

Constructor Summary

Access	Constructor and Description
public	Macro(final Source source, final String name)
public	Macro(final Macro o)
public	Macro(final Macro o, final List<Token> tokens)
private	Macro(final Macro o, final List<Token> tokens, final boolean copyTokens)
public	Macro(final String name)

Method Summary

Modifier and Type	Method and Description
public void	addPaste(final Token tok) Adds a "paste" operator to the expansion of this macro.
public void	addToken(final Token tok) Adds a token to the expansion of this macro.
public int	getArgs() Returns the number of arguments to this macro.
public String	getName() Returns the name of this macro.
public Source	getSource() Returns the Source from which this macro was parsed.
public String	getText()
pack-priv List<Token>	getTokens()
public boolean	hasPaste() Returns true if this macro contains a "paste" operator.
public boolean	isFunctionLike() Returns true if this is a function-like macro.
public boolean	isVariadic() Returns true if this is a variadic function-like macro.
pack-priv void	setArgs(final List<String> args) Sets the arguments to this macro.
public void	setVariadic(final boolean b) Sets the variadic flag on this Macro.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

Field Detail

args	back to summary
private List<String> args

hasPaste	back to summary
private boolean hasPaste

name	back to summary
private final String name

source	back to summary
private final Source source

tokens	back to summary
private List<Token> tokens

variadic	back to summary
private boolean variadic

Constructor Detail

Macro	back to summary
public Macro(final Source source, final String name)

Macro	back to summary
public Macro(final Macro o)

Macro	back to summary
public Macro(final Macro o, final List<Token> tokens)

Macro	back to summary
private Macro(final Macro o, final List<Token> tokens, final boolean copyTokens)

Macro	back to summary
public Macro(final String name)

Method Detail

addPaste	back to summary
public void addPaste(final Token tok) Adds a "paste" operator to the expansion of this macro. A paste operator causes the next token added to be pasted to the previous token when the macro is expanded. It is an error for a macro to end with a paste token.

addToken	back to summary
public void addToken(final Token tok) Adds a token to the expansion of this macro.

getArgs	back to summary
public int getArgs() Returns the number of arguments to this macro.

getName	back to summary
public String getName() Returns the name of this macro.

getSource	back to summary
public Source getSource() Returns the Source from which this macro was parsed. This method may return null if the macro was not parsed from a regular file.

getText	back to summary
public String getText()

getTokens	back to summary
pack-priv List<Token> getTokens()

hasPaste	back to summary
public boolean hasPaste() Returns true if this macro contains a "paste" operator.

isFunctionLike	back to summary
public boolean isFunctionLike() Returns true if this is a function-like macro.

isVariadic	back to summary
public boolean isVariadic() Returns true if this is a variadic function-like macro.

setArgs	back to summary
pack-priv void setArgs(final List<String> args) Sets the arguments to this macro.

setVariadic	back to summary
public void setVariadic(final boolean b) Sets the variadic flag on this Macro.

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