GlueGen Runtime 2.3.2 · com.jogamp.gluegen.cgram.types.CompoundType

Modifier and Type	Field and Description
private boolean	bodyParsed
private ArrayList<Field>	fields
private final String	structName
private boolean	visiting

Access	Constructor and Description
pack-priv	CompoundType(final String name, final SizeThunk size, final int cvAttributes, final String structName, final ASTLocusTag astLocus)
pack-priv	CompoundType(final CompoundType o, final int cvAttributes, final ASTLocusTag astLocus)

Method Summary

Modifier and Type	Method and Description
public void	addAliasedName(final String the new alias to be added, maybe `null` origName) Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.addAliasedName. Add the given `origName` to the list of `aliases` if not equal `current-name`.
public void	addField(final Field f) Adds a field to this type.
public CompoundType	asCompound() Overrides com.jogamp.gluegen.cgram.types.Type.asCompound. Casts this to a CompoundType or returns null if not a CompoundType.
public static CompoundType	create(final String struct name of this CompoundType, i.e. the "foo" in the construct `struct foo { int a, ... };` or `struct foo;` even for anonymous structs. structName, final SizeThunk size, final CompoundTypeKind kind, final int cvAttributes, final ASTLocusTag astLocus)
protected boolean	equalSemanticsImpl(final Type arg) Implements abstract com.jogamp.gluegen.cgram.types.Type.equalSemanticsImpl.
protected boolean	equalsImpl(final Type arg) Implements abstract com.jogamp.gluegen.cgram.types.Type.equalsImpl.
public Set<String>	getAliasedNames() Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.getAliasedNames. Return all aliases for this symbol, i.e. original names, for this symbol.
public String	getAliasedString() Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.getAliasedString. Return this object's `toString()` wrapped w/ the `current-name` and all `aliases`.
public String	getCName(final boolean includeCVAttrs) Overrides com.jogamp.gluegen.cgram.types.Type.getCName. Returns the name of this type, optionally including const/volatile attributes.
public Field	getField(final int i) Returns the ith field of this type.
pack-priv ArrayList<Field>	getFields()
public int	getNumFields() Returns the number of fields in this type.
public String	getOrigName() Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.getOrigName. Return the original-name as set at creation.
public String	getStructName() Returns the struct name of this CompoundType, i.e. the "foo" in the construct "struct foo { ...
public String	getStructString()
public boolean	hasAliases() Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.hasAliases. Returns `true` if this symbol has aliases, i.e. either being `renamed` or `aliases-added`.
protected int	hashCodeImpl() Implements abstract com.jogamp.gluegen.cgram.types.Type.hashCodeImpl.
protected int	hashCodeSemanticsImpl() Implements abstract com.jogamp.gluegen.cgram.types.Type.hashCodeSemanticsImpl.
public abstract boolean	isStruct() Indicates whether this type was declared as a struct.
public abstract boolean	isUnion() Indicates whether this type was declared as a union.
public void	rename(final String the new `current-name`, maybe `null` newName) Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.rename. Rename this symbol with the given `newName` if not equal `current-name`.
public void	setBodyParsed() Indicates to this CompoundType that its body has been parsed and that no more `addField` operations will be made.
pack-priv void	setFields(final ArrayList<Field> fields)
public String	toString() Overrides com.jogamp.gluegen.cgram.types.Type.toString. Returns a string representation of this type.
public void	visit(final TypeVisitor arg) Overrides com.jogamp.gluegen.cgram.types.Type.visit. Traverse this `Type` and all of its component types; for example, the return type and argument types of a FunctionType.

Inherited from com.jogamp.gluegen.cgram.types.MemoryLayoutType:: isLayouted setLayouted

bodyParsed	back to summary
private boolean bodyParsed

fields	back to summary
private ArrayList<Field> fields

structName	back to summary
private final String structName

visiting	back to summary
private boolean visiting

CompoundType	back to summary
pack-priv CompoundType(final String name, final SizeThunk size, final int cvAttributes, final String structName, final ASTLocusTag astLocus)

CompoundType	back to summary
pack-priv CompoundType(final CompoundType o, final int cvAttributes, final ASTLocusTag astLocus)

Method Detail

addAliasedName back to summary

addAliasedName	back to summary
public void addAliasedName(final String origName) Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.addAliasedName. Doc from com.jogamp.gluegen.cgram.types.AliasedSymbol.addAliasedName. Add the given `origName` to the list of `aliases` if not equal `current-name`. Operation will be ignored if `newName` is `null`. Parameters origName:String the new alias to be added, maybe `null` Annotations @Override

public void addAliasedName(final String origName)

Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.addAliasedName.

Doc from com.jogamp.gluegen.cgram.types.AliasedSymbol.addAliasedName.

Add the given origName to the list of aliases if not equal current-name.

Operation will be ignored if newName is null.

Parameters

origName:String: the new alias to be added, maybe null

Annotations

@Override

addField	back to summary
public void addField(final Field f) Adds a field to this type.

asCompound	back to summary
public CompoundType asCompound() Overrides com.jogamp.gluegen.cgram.types.Type.asCompound. Doc from com.jogamp.gluegen.cgram.types.Type.asCompound. Casts this to a CompoundType or returns null if not a CompoundType. Annotations @Override

asCompound

back to summary

public CompoundType asCompound()

Overrides com.jogamp.gluegen.cgram.types.Type.asCompound.

Doc from com.jogamp.gluegen.cgram.types.Type.asCompound.

Casts this to a CompoundType or returns null if not a CompoundType.

Annotations

@Override

create	back to summary
public static CompoundType create(final String structName, final SizeThunk size, final CompoundTypeKind kind, final int cvAttributes, final ASTLocusTag astLocus) Parameters structName:String struct name of this CompoundType, i.e. the "foo" in the construct `struct foo { int a, ... };` or `struct foo;` even for anonymous structs.

equalSemanticsImpl	back to summary
protected boolean equalSemanticsImpl(final Type arg) Implements abstract com.jogamp.gluegen.cgram.types.Type.equalSemanticsImpl. Annotations @Override

equalSemanticsImpl

back to summary

protected boolean equalSemanticsImpl(final Type arg)

Implements abstract com.jogamp.gluegen.cgram.types.Type.equalSemanticsImpl.

Annotations

@Override

equalsImpl	back to summary
protected boolean equalsImpl(final Type arg) Implements abstract com.jogamp.gluegen.cgram.types.Type.equalsImpl. Annotations @Override

equalsImpl

back to summary

protected boolean equalsImpl(final Type arg)

Implements abstract com.jogamp.gluegen.cgram.types.Type.equalsImpl.

Annotations

@Override

getAliasedNames back to summary

getAliasedNames	back to summary
public Set<String> getAliasedNames() Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.getAliasedNames. Doc from com.jogamp.gluegen.cgram.types.AliasedSymbol.getAliasedNames. Return all aliases for this symbol, i.e. original names, for this symbol. Inclusive `original-name`, if `renamed`, Exclusive `current-name`. May return `null` or a zero sized `Set` for no aliases. Annotations @Override

public Set<String> getAliasedNames()

Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.getAliasedNames.

Doc from com.jogamp.gluegen.cgram.types.AliasedSymbol.getAliasedNames.

Return all aliases for this symbol, i.e. original names, for this symbol.

Inclusive original-name, if renamed,

Exclusive current-name.

May return null or a zero sized Set for no aliases.

Annotations

@Override

getAliasedString back to summary

getAliasedString	back to summary
public String getAliasedString() Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.getAliasedString. Doc from com.jogamp.gluegen.cgram.types.AliasedSymbol.getAliasedString. Return this object's `toString()` wrapped w/ the `current-name` and all `aliases`. Annotations @Override

public String getAliasedString()

Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.getAliasedString.

Doc from com.jogamp.gluegen.cgram.types.AliasedSymbol.getAliasedString.

Return this object's toString() wrapped w/ the current-name and all aliases.

Annotations

@Override

getCName	back to summary
public String getCName(final boolean includeCVAttrs) Overrides com.jogamp.gluegen.cgram.types.Type.getCName. Doc from com.jogamp.gluegen.cgram.types.Type.getCName. Returns the name of this type, optionally including const/volatile attributes. The returned string is suitable for use as a type specifier for native C. Annotations @Override

getCName

back to summary

public String getCName(final boolean includeCVAttrs)

Overrides com.jogamp.gluegen.cgram.types.Type.getCName.

Doc from com.jogamp.gluegen.cgram.types.Type.getCName.

Returns the name of this type, optionally including const/volatile attributes. The returned string is suitable for use as a type specifier for native C.

Annotations

@Override

getField	back to summary
public Field getField(final int i) Returns the ith field of this type.

getFields	back to summary
pack-priv ArrayList<Field> getFields()

getNumFields	back to summary
public int getNumFields() Returns the number of fields in this type.

getOrigName	back to summary
public String getOrigName() Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.getOrigName. Doc from com.jogamp.gluegen.cgram.types.AliasedSymbol.getOrigName. Return the original-name as set at creation. Annotations @Override

getOrigName

back to summary

public String getOrigName()

Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.getOrigName.

Doc from com.jogamp.gluegen.cgram.types.AliasedSymbol.getOrigName.

Return the original-name as set at creation.

Annotations

@Override

getStructName	back to summary
public String getStructName() Returns the struct name of this CompoundType, i.e. the "foo" in the construct "struct foo { ... };".

getStructString	back to summary
public String getStructString()

hasAliases back to summary

hasAliases	back to summary
public boolean hasAliases() Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.hasAliases. Doc from com.jogamp.gluegen.cgram.types.AliasedSymbol.hasAliases. Returns `true` if this symbol has aliases, i.e. either being `renamed` or `aliases-added`. Otherwise `false` is being returned. Annotations @Override

public boolean hasAliases()

Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.hasAliases.

Doc from com.jogamp.gluegen.cgram.types.AliasedSymbol.hasAliases.

Returns true if this symbol has aliases, i.e. either being renamed or aliases-added.

Otherwise false is being returned.

Annotations

@Override

hashCodeImpl	back to summary
protected int hashCodeImpl() Implements abstract com.jogamp.gluegen.cgram.types.Type.hashCodeImpl. Annotations @Override

hashCodeImpl

back to summary

protected int hashCodeImpl()

Implements abstract com.jogamp.gluegen.cgram.types.Type.hashCodeImpl.

Annotations

@Override

hashCodeSemanticsImpl	back to summary
protected int hashCodeSemanticsImpl() Implements abstract com.jogamp.gluegen.cgram.types.Type.hashCodeSemanticsImpl. Annotations @Override

hashCodeSemanticsImpl

back to summary

protected int hashCodeSemanticsImpl()

Implements abstract com.jogamp.gluegen.cgram.types.Type.hashCodeSemanticsImpl.

Annotations

@Override

isStruct	back to summary
public abstract boolean isStruct() Indicates whether this type was declared as a struct.

isUnion	back to summary
public abstract boolean isUnion() Indicates whether this type was declared as a union.

rename back to summary

rename	back to summary
public void rename(final String newName) Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.rename. Doc from com.jogamp.gluegen.cgram.types.AliasedSymbol.rename. Rename this symbol with the given `newName` if not equal `current-name`. Before renaming the `current-name` will be added to the list of `aliases`. while the given `newName` will be removed. Operation will be ignored if `newName` is `null`. Parameters newName:String the new `current-name`, maybe `null` Annotations @Override

public void rename(final String newName)

Implements com.jogamp.gluegen.cgram.types.AliasedSymbol.rename.

Doc from com.jogamp.gluegen.cgram.types.AliasedSymbol.rename.

Rename this symbol with the given newName if not equal current-name.

Before renaming the current-name will be added to the list of aliases. while the given newName will be removed.

Operation will be ignored if newName is null.

Parameters

newName:String: the new current-name, maybe null

Annotations

@Override

setBodyParsed back to summary

setBodyParsed	back to summary
public void setBodyParsed() throws IllegalStateException Indicates to this CompoundType that its body has been parsed and that no more `addField` operations will be made. Exceptions IllegalStateException: If called twice.

public void setBodyParsed() throws IllegalStateException

Indicates to this CompoundType that its body has been parsed and that no more addField operations will be made.

Exceptions

IllegalStateException:: If called twice.

setFields	back to summary
pack-priv void setFields(final ArrayList<Field> fields)

toString	back to summary
public String toString() Overrides com.jogamp.gluegen.cgram.types.Type.toString. Doc from com.jogamp.gluegen.cgram.types.Type.toString. Returns a string representation of this type. The returned string is suitable for use as a type specifier for native C. It does contain an expanded description of structs/unions, hence may not be suitable for type declarations. Returns:String Doc from java.lang.Object.toString. a string representation of the object Annotations @Override

toString

back to summary

public String toString()

Overrides com.jogamp.gluegen.cgram.types.Type.toString.

Doc from com.jogamp.gluegen.cgram.types.Type.toString.

Returns a string representation of this type. The returned string is suitable for use as a type specifier for native C. It does contain an expanded description of structs/unions, hence may not be suitable for type declarations.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

Annotations

@Override

visit back to summary

visit	back to summary
public void visit(final TypeVisitor arg) Overrides com.jogamp.gluegen.cgram.types.Type.visit. Doc from com.jogamp.gluegen.cgram.types.Type.visit. Traverse this `Type` and all of its component types; for example, the return type and argument types of a FunctionType. Annotations @Override

public void visit(final TypeVisitor arg)

Overrides com.jogamp.gluegen.cgram.types.Type.visit.

Doc from com.jogamp.gluegen.cgram.types.Type.visit.

Traverse this Type and all of its component types; for example, the return type and argument types of a FunctionType.

Annotations

@Override

public abstract Class CompoundType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail