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

Modifier and Type	Field and Description
pack-priv final ASTLocusTag	astLocus
private int	cachedHash
private int	cachedSemanticHash
private final int	cvAttributes
private boolean	hasCachedHash
private boolean	hasCachedSemanticHash
private boolean	isTypedef
private String	name
public final boolean	relaxedEqSem
private SizeThunk	size
private int	typedefCVAttributes

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

Method Summary

Modifier and Type	Method and Description
private static StringBuilder	append(final StringBuilder sb, final String val, final boolean prepComma)
public int	arrayDimension() Helper method for determining how many array dimentions this type represents (i.e., "char[][]" returns 2).
public ArrayType	asArray() Casts this to an ArrayType or returns null if not an ArrayType.
public BitType	asBit() Casts this to a BitType or returns null if not a BitType.
public CompoundType	asCompound() Casts this to a CompoundType or returns null if not a CompoundType.
public DoubleType	asDouble() Casts this to a DoubleType or returns null if not a DoubleType.
public EnumType	asEnum() Casts this to an EnumType or returns null if not an EnumType.
public FloatType	asFloat() Casts this to a FloatType or returns null if not a FloatType.
public FunctionType	asFunction() Casts this to a FunctionType or returns null if not a FunctionType.
public IntType	asInt() Casts this to an IntType or returns null if not an IntType.
public PointerType	asPointer() Casts this to a PointerType or returns null if not a PointerType.
public VoidType	asVoid() Casts this to a VoidType or returns null if not a VoidType.
protected final void	clearCache()
public Type	clone(final ASTLocusTag newLoc) Clones this instance using a new `ASTLocusTag`.
public final boolean	equals(final Object the reference object with which to compare. arg) Overrides java.lang.Object.equals. Equality test for Types inclusive its given `name`.
public final boolean	equalSemantics(final TypeComparator.SemanticEqualityOp arg) Implements com.jogamp.gluegen.cgram.types.TypeComparator.SemanticEqualityOp.equalSemantics. Semantic equality test for Types exclusive its given `name`.
protected abstract boolean	equalSemanticsImpl(final Type t)
protected abstract boolean	equalsImpl(final Type t)
public final ASTLocusTag	getASTLocusTag() Implements com.jogamp.gluegen.ASTLocusTag.ASTLocusTagProvider.getASTLocusTag. Returns this instance's `ASTLocusTag`, if available, otherwise returns `null`.
public Type	getBaseElementType() Helper method to returns the bottom-most element type of this type.
public final String	getCName() Returns the name of this type.
public String	getCName(final boolean includeCVAttrs) Returns the name of this type, optionally including const/volatile attributes.
public final int	getCVAttributes()
public final String	getCVAttributesString() Returns a string indicating the const/volatile attributes of this type.
public final String	getDebugString()
public final String	getName() Returns the name of this type.
public String	getName(final boolean includeCVAttrs) Returns the name of this type, optionally including const/volatile attributes.
public final SizeThunk	getSize() SizeThunk which computes size of this type in bytes.
public final long	getSize(final MachineDataInfo machDesc) Size of this type in bytes according to the given MachineDataInfo.
public Type	getTargetType() Helper method to returns the target type of this type, in case another type is being referenced.
pack-priv final int	getTypedefCVAttributes()
public final int	hashCode() Overrides java.lang.Object.hashCode. Hashcode for Types.
protected abstract int	hashCodeImpl()
public final int	hashCodeSemantics() Implements com.jogamp.gluegen.cgram.types.TypeComparator.SemanticEqualityOp.hashCodeSemantics. Semantic hashcode for Types exclusive its given `name`.
protected abstract int	hashCodeSemanticsImpl()
public boolean	isAnon()
public final boolean	isArray() Indicates whether this is an ArrayType.
public final boolean	isBaseTypeConst() Checks the base type of pointer-to-pointer, pointer, array or plain for const-ness.
public final boolean	isBit() Indicates whether this is a BitType.
public final boolean	isCompound() Indicates whether this is a CompoundType.
public final boolean	isConst() Indicates whether this type is const.
private final boolean	isConstRaw()
private final boolean	isConstTypedef()
public final boolean	isDouble() Indicates whether this is a DoubleType.
public final boolean	isEnum() Indicates whether this is an EnumType.
public final boolean	isFloat() Indicates whether this is a FloatType.
public final boolean	isFunction() Indicates whether this is a FunctionType.
public boolean	isFunctionPointer() Convenience routine indicating whether this Type is a pointer to a function.
public final boolean	isInt() Indicates whether this is an IntType.
public final boolean	isPointer() Indicates whether this is a PointerType.
public boolean	isPrimitive() Indicates whether this type is a primitive type.
public final boolean	isTypedef() Indicates whether this type is a typedef type, i.e. declared via `setTypedefName(String)`.
public final boolean	isVoid() Indicates whether this is a VoidType.
public final boolean	isVolatile() Indicates whether this type is volatile.
public final Type	newCVVariant(final int cvAttributes) Return a variant of this type matching the given const/volatile attributes.
pack-priv abstract Type	newVariantImpl(final boolean true if new variant is intended to have new cvAttributes newCVVariant, final int the cvAttributes to be used cvAttributes, final ASTLocusTag the `ASTLocusTag` to be used astLocus) Create a new variant of this type matching the given parameter Implementation must use `Type`'s copy-ctor: `Type(Type, int, ASTLocusTag)`!
private final int	objHash()
public int	pointerDepth() Helper method for determining how many pointer indirections this type represents (i.e., "void **" returns 2).
private final boolean	setName(final String name) Returns `true` if given `name` is not `null` and has a length > 0.
pack-priv final void	setSize(final SizeThunk size) Set the size of this type; only available for CompoundTypes.
pack-priv final void	setTypedef(final int typedefedCVAttributes)
public boolean	setTypedefName(final String name) Set the typedef name of this type and renders this type a typedef, if given `name` has a length.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of this type.
public void	visit(final TypeVisitor visitor) Traverse this `Type` and all of its component types; for example, the return type and argument types of a FunctionType.

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

astLocus	back to summary
pack-priv final ASTLocusTag astLocus

cachedHash	back to summary
private int cachedHash

cachedSemanticHash	back to summary
private int cachedSemanticHash

cvAttributes	back to summary
private final int cvAttributes

hasCachedHash	back to summary
private boolean hasCachedHash

hasCachedSemanticHash	back to summary
private boolean hasCachedSemanticHash

isTypedef	back to summary
private boolean isTypedef

name	back to summary
private String name

relaxedEqSem	back to summary
public final boolean relaxedEqSem

size	back to summary
private SizeThunk size

typedefCVAttributes	back to summary
private int typedefCVAttributes

Type	back to summary
protected Type(final String name, final SizeThunk size, final int cvAttributes, final ASTLocusTag astLocus)

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

Method Detail

append	back to summary
private static StringBuilder append(final StringBuilder sb, final String val, final boolean prepComma)

arrayDimension	back to summary
public int arrayDimension() Helper method for determining how many array dimentions this type represents (i.e., "char[][]" returns 2). Returns 0 if this type is not an array type.

asArray	back to summary
public ArrayType asArray() Casts this to an ArrayType or returns null if not an ArrayType.

asBit	back to summary
public BitType asBit() Casts this to a BitType or returns null if not a BitType.

asCompound	back to summary
public CompoundType asCompound() Casts this to a CompoundType or returns null if not a CompoundType.

asDouble	back to summary
public DoubleType asDouble() Casts this to a DoubleType or returns null if not a DoubleType.

asEnum	back to summary
public EnumType asEnum() Casts this to an EnumType or returns null if not an EnumType.

asFloat	back to summary
public FloatType asFloat() Casts this to a FloatType or returns null if not a FloatType.

asFunction	back to summary
public FunctionType asFunction() Casts this to a FunctionType or returns null if not a FunctionType.

asInt	back to summary
public IntType asInt() Casts this to an IntType or returns null if not an IntType.

asPointer	back to summary
public PointerType asPointer() Casts this to a PointerType or returns null if not a PointerType.

asVoid	back to summary
public VoidType asVoid() Casts this to a VoidType or returns null if not a VoidType.

clearCache	back to summary
protected final void clearCache()

clone	back to summary
public Type clone(final ASTLocusTag newLoc) Clones this instance using a new `ASTLocusTag`.

equals back to summary

equals	back to summary
public final boolean equals(final Object arg) Overrides java.lang.Object.equals. Equality test for Types inclusive its given `name`. Parameters arg:Object Doc from java.lang.Object.equals. the reference object with which to compare. Returns:boolean Doc from java.lang.Object.equals. `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public final boolean equals(final Object arg)

Overrides java.lang.Object.equals.

Equality test for Types inclusive its given name.

Parameters

arg:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

equalSemantics back to summary

equalSemantics	back to summary
public final boolean equalSemantics(final TypeComparator.SemanticEqualityOp arg) Implements com.jogamp.gluegen.cgram.types.TypeComparator.SemanticEqualityOp.equalSemantics. Doc from com.jogamp.gluegen.cgram.types.TypeComparator.SemanticEqualityOp.equalSemantics. Semantic equality test for Types exclusive its given `name`. Annotations @Override

public final boolean equalSemantics(final TypeComparator.SemanticEqualityOp arg)

Implements com.jogamp.gluegen.cgram.types.TypeComparator.SemanticEqualityOp.equalSemantics.

Doc from com.jogamp.gluegen.cgram.types.TypeComparator.SemanticEqualityOp.equalSemantics.

Semantic equality test for Types exclusive its given name.

Annotations

@Override

equalSemanticsImpl	back to summary
protected abstract boolean equalSemanticsImpl(final Type t)

equalsImpl	back to summary
protected abstract boolean equalsImpl(final Type t)

getASTLocusTag back to summary

getASTLocusTag	back to summary
public final ASTLocusTag getASTLocusTag() Implements com.jogamp.gluegen.ASTLocusTag.ASTLocusTagProvider.getASTLocusTag. Doc from com.jogamp.gluegen.ASTLocusTag.ASTLocusTagProvider.getASTLocusTag. Returns this instance's `ASTLocusTag`, if available, otherwise returns `null`. Annotations @Override

public final ASTLocusTag getASTLocusTag()

Implements com.jogamp.gluegen.ASTLocusTag.ASTLocusTagProvider.getASTLocusTag.

Doc from com.jogamp.gluegen.ASTLocusTag.ASTLocusTagProvider.getASTLocusTag.

Returns this instance's ASTLocusTag, if available, otherwise returns null.

Annotations

@Override

getBaseElementType	back to summary
public Type getBaseElementType() Helper method to returns the bottom-most element type of this type. If this is a multidimensional array or pointer method returns the bottom-most element type, otherwise this.

getBaseElementType

back to summary

public Type getBaseElementType()

Helper method to returns the bottom-most element type of this type.

If this is a multidimensional array or pointer method returns the bottom-most element type, otherwise this.

getCName	back to summary
public final String getCName() Returns the name of this type. The returned string is suitable for use as a type specifier for native C. Does not include any const/volatile attributes.

getCName	back to summary
public String getCName(final boolean includeCVAttrs) 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.

getCVAttributes	back to summary
public final int getCVAttributes()

getCVAttributesString	back to summary
public final String getCVAttributesString() Returns a string indicating the const/volatile attributes of this type.

getDebugString	back to summary
public final String getDebugString()

getName	back to summary
public final String getName() Returns the name of this type. The returned string is suitable for use as a type specifier for Java. Does not include any const/volatile attributes.

getName	back to summary
public String getName(final boolean includeCVAttrs) Returns the name of this type, optionally including const/volatile attributes. The returned string is suitable for use as a type specifier for Java.

getSize	back to summary
public final SizeThunk getSize() SizeThunk which computes size of this type in bytes.

getSize	back to summary
public final long getSize(final MachineDataInfo machDesc) Size of this type in bytes according to the given MachineDataInfo.

getTargetType	back to summary
public Type getTargetType() Helper method to returns the target type of this type, in case another type is being referenced.

getTypedefCVAttributes	back to summary
pack-priv final int getTypedefCVAttributes()

hashCode	back to summary
public final int hashCode() Overrides java.lang.Object.hashCode. Hashcode for Types. Returns:int Doc from java.lang.Object.hashCode. a hash code value for this object Annotations @Override

hashCode

back to summary

public final int hashCode()

Overrides java.lang.Object.hashCode.

Hashcode for Types.

Returns:int

Doc from java.lang.Object.hashCode.

a hash code value for this object

Annotations

@Override

hashCodeImpl	back to summary
protected abstract int hashCodeImpl()

hashCodeSemantics back to summary

hashCodeSemantics	back to summary
public final int hashCodeSemantics() Implements com.jogamp.gluegen.cgram.types.TypeComparator.SemanticEqualityOp.hashCodeSemantics. Doc from com.jogamp.gluegen.cgram.types.TypeComparator.SemanticEqualityOp.hashCodeSemantics. Semantic hashcode for Types exclusive its given `name`. Annotations @Override

public final int hashCodeSemantics()

Implements com.jogamp.gluegen.cgram.types.TypeComparator.SemanticEqualityOp.hashCodeSemantics.

Doc from com.jogamp.gluegen.cgram.types.TypeComparator.SemanticEqualityOp.hashCodeSemantics.

Semantic hashcode for Types exclusive its given name.

Annotations

@Override

hashCodeSemanticsImpl	back to summary
protected abstract int hashCodeSemanticsImpl()

isAnon	back to summary
public boolean isAnon()

isArray	back to summary
public final boolean isArray() Indicates whether this is an ArrayType.

isBaseTypeConst	back to summary
public final boolean isBaseTypeConst() Checks the base type of pointer-to-pointer, pointer, array or plain for const-ness. Note Intermediate 'const' qualifier are not considered, e.g. const pointer.

isBit	back to summary
public final boolean isBit() Indicates whether this is a BitType.

isCompound	back to summary
public final boolean isCompound() Indicates whether this is a CompoundType.

isConst	back to summary
public final boolean isConst() Indicates whether this type is const.

isConstRaw	back to summary
private final boolean isConstRaw()

isConstTypedef	back to summary
private final boolean isConstTypedef()

isDouble	back to summary
public final boolean isDouble() Indicates whether this is a DoubleType.

isEnum	back to summary
public final boolean isEnum() Indicates whether this is an EnumType.

isFloat	back to summary
public final boolean isFloat() Indicates whether this is a FloatType.

isFunction	back to summary
public final boolean isFunction() Indicates whether this is a FunctionType.

isFunctionPointer	back to summary
public boolean isFunctionPointer() Convenience routine indicating whether this Type is a pointer to a function.

isInt	back to summary
public final boolean isInt() Indicates whether this is an IntType.

isPointer	back to summary
public final boolean isPointer() Indicates whether this is a PointerType.

isPrimitive	back to summary
public boolean isPrimitive() Indicates whether this type is a primitive type.

isTypedef	back to summary
public final boolean isTypedef() Indicates whether this type is a typedef type, i.e. declared via `setTypedefName(String)`.

isVoid	back to summary
public final boolean isVoid() Indicates whether this is a VoidType.

isVolatile	back to summary
public final boolean isVolatile() Indicates whether this type is volatile.

newCVVariant	back to summary
public final Type newCVVariant(final int cvAttributes) Return a variant of this type matching the given const/volatile attributes. May return this object if the attributes match.

newVariantImpl back to summary

pack-priv abstract Type newVariantImpl(final boolean newCVVariant, final int cvAttributes, final ASTLocusTag astLocus)

Create a new variant of this type matching the given parameter

Implementation must use Type's copy-ctor: Type(Type, int, ASTLocusTag)!

Parameters

newCVVariant:boolean: true if new variant is intended to have new cvAttributes
cvAttributes:int: the cvAttributes to be used
astLocus:ASTLocusTag: the ASTLocusTag to be used

objHash	back to summary
private final int objHash()

pointerDepth	back to summary
public int pointerDepth() Helper method for determining how many pointer indirections this type represents (i.e., "void **" returns 2). Returns 0 if this type is not a pointer type.

setName back to summary

private final boolean setName(final String name)

Returns true if given name is not null and has a length > 0. In this case this instance's names will be set to the internalized version.

Otherwise method returns false and this instance's name will be set to null.

Method issues clearCache(), to force re-evaluation of hashes.

setSize	back to summary
pack-priv final void setSize(final SizeThunk size) Set the size of this type; only available for CompoundTypes.

setTypedef	back to summary
pack-priv final void setTypedef(final int typedefedCVAttributes)

setTypedefName back to summary

public boolean setTypedefName(final String name)

Set the typedef name of this type and renders this type a typedef, if given name has a length.

Method issues clearCache(), to force re-evaluation of hashes.

toString

back to summary

public String toString()

Overrides java.lang.Object.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
public void visit(final TypeVisitor visitor) Traverse this `Type` and all of its component types; for example, the return type and argument types of a FunctionType.

public abstract Class Type

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail