java.lang.Object
- com.jogamp.gluegen.cgram.types.AliasedSymbol.AliasedSymbolImpl
- - com.jogamp.gluegen.ConstantDefinition

All Implemented Interfaces:

ASTLocusTag.ASTLocusTagProvider, AliasedSymbol, TypeComparator.AliasedSemanticSymbol, TypeComparator.SemanticEqualityOp
```
public class ConstantDefinition
extends AliasedSymbol.AliasedSymbolImpl
implements TypeComparator.AliasedSemanticSymbol, ASTLocusTag.ASTLocusTagProvider
```
Represents a [native] constant expression, comprises the [native] expression, see getNativeExpr() and the optional ConstantDefinition.CNumber representation, see getNumber().
The representation of the equivalent java expression including the result type is covered by ConstantDefinition.JavaExpr, which can be computed via computeJavaExpr(Map).

This class and its sub-classes define and convert all native expressions to Java space.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`ConstantDefinition.CNumber`	A Number, either integer, optionally [long, unsigned], or floating point, optionally [double].
`static class`	`ConstantDefinition.JavaExpr`	A valid java expression, including its result type, usually generated from a native [C] expression, see `JavaExpr#create(ConstantDefinition)`.

Nested classes/interfaces inherited from interface com.jogamp.gluegen.cgram.types.AliasedSymbol
AliasedSymbol.AliasedSymbolImpl, AliasedSymbol.NoneAliasedSymbol

Field Summary

Fields
Modifier and Type	Field	Description
`static Pattern`	`patternCPPOperand`	One of: `+` `-` `*` `/` `\|` `&` `(` `)` `<<` `>>` `~`
`static Pattern`	`patternDecimalNumber`	Complete pattern for `floating point` number, compatible and described in `Double.valueOf(String)`.
`static Pattern`	`patternDecimalOrIntNumber`	Complete pattern for `floating point` and `integer` number, covering `patternDecimalNumber` and `patternIntegerNumber`.
`static Pattern`	`patternHexNumber`	Complete pattern for `hexadecimal` number, including an optional sign `[+-]` and optional suffixes `[uUlL]`.
`static Pattern`	`patternIntegerNumber`	Complete pattern for `integer` number, including an optional sign `[+-]` and optional suffixes `[uUlL]`.
`static long`	`UNSIGNED_INT_MAX_VALUE`
`static BigInteger`	`UNSIGNED_LONG_MAX_VALUE`

Constructor Summary

Constructors
Constructor	Description
`ConstantDefinition(String name, String nativeExpr, ConstantDefinition.CNumber number, ASTLocusTag astLocus)`	Constructor for plain const-values, non-enumerates.
`ConstantDefinition(String name, String nativeExpr, ConstantDefinition.CNumber number, String enumName, ASTLocusTag astLocus)`	Constructor for enumerates

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ConstantDefinition.JavaExpr`	`computeJavaExpr(Map<String,ConstantDefinition.JavaExpr> constMap)`	Computes the `java expression` based on this instance, see `JavaExpr#create(ConstantDefinition)`.
`static ConstantDefinition.CNumber`	`decodeANumber(String v)`	Returns either `decodeIntegerNumber(String)`, `decodeDecimalNumber(String)` or `null`.
`static ConstantDefinition.CNumber`	`decodeDecimalNumber(String v)`	If the given string `isDecimalNumber(String)`, return the decoded floating-point value, represented as a `ANumber` object, otherwise returns `null`.
`static ConstantDefinition.CNumber`	`decodeIntegerNumber(String v)`	If the given string `isIntegerNumber(String)`, return the decoded integer value, represented as a `ANumber`, otherwise returns `null`.
`boolean`	`equals(Object arg)`	Equality test by its given `name`.
`boolean`	`equalSemantics(TypeComparator.SemanticEqualityOp arg)`	Semantic equality test for Types exclusive its given `name`.
`ASTLocusTag`	`getASTLocusTag()`	Returns this instance's `ASTLocusTag`, if available, otherwise returns `null`.
`String`	`getEnumName()`	Returns `null` if this definition was not part of an enumeration, or if the enumeration is anonymous.
`String`	`getNativeExpr()`	Returns the original [native] expression.
`ConstantDefinition.CNumber`	`getNumber()`	Returns the parsed `ConstantDefinition.CNumber` of the `native expression`, or `null` if the latter does not comprise a single number, i.e.
`int`	`hashCode()`	Hash by its given `name`.
`int`	`hashCodeSemantics()`	Semantic hashcode for Types exclusive its given `name`.
`boolean`	`hasNumber()`	Returns `true` if this instance represents has a `number`, otherwise `false`.
`static boolean`	`isConstantExpression(String value)`
`static boolean`	`isCPPOperand(String s)`	Matches pattern for valid CPP operands, see `patternCPPOperand`.
`static boolean`	`isDecimalNumber(String s)`	Matches pattern for `floating point` number, compatible and described in `Double.valueOf(String)`.
`static boolean`	`isDecimalOrIntNumber(String s)`	Complete pattern for `floating point` and `integer` number, covering `patternDecimalNumber` and `patternIntegerNumber`.
`boolean`	`isEnum()`
`static boolean`	`isHexNumber(String s)`	Matches `patternHexNumber`.
`static boolean`	`isIdentifier(String value)`
`static boolean`	`isIntegerNumber(String s)`	Matches `isHexNumber(String)` or `patternIntegerNumber`.
`static boolean`	`isNumber(String s)`	Matches `isHexNumber(String)` or `isDecimalOrIntNumber(String)`.
`String`	`toString()`

Methods inherited from class com.jogamp.gluegen.cgram.types.AliasedSymbol.AliasedSymbolImpl
addAliasedName, getAliasedNames, getAliasedString, getName, getOrigName, hasAliases, rename

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.jogamp.gluegen.cgram.types.AliasedSymbol
addAliasedName, getAliasedNames, getAliasedString, getName, getOrigName, hasAliases, rename

- Field Detail
  - UNSIGNED_INT_MAX_VALUE
```
public static final long UNSIGNED_INT_MAX_VALUE
```
    See Also:
    
    Constant Field Values
  - UNSIGNED_LONG_MAX_VALUE
```
public static final BigInteger UNSIGNED_LONG_MAX_VALUE
```
  - patternHexNumber
```
public static Pattern patternHexNumber
```
    Complete pattern for hexadecimal number, including an optional sign [+-] and optional suffixes [uUlL].
  - patternDecimalNumber
```
public static final Pattern patternDecimalNumber
```
    Complete pattern for floating point number, compatible and described in Double.valueOf(String).
  - patternDecimalOrIntNumber
```
public static final Pattern patternDecimalOrIntNumber
```
    Complete pattern for floating point and integer number, covering patternDecimalNumber and patternIntegerNumber.
  - patternIntegerNumber
```
public static final Pattern patternIntegerNumber
```
    Complete pattern for integer number, including an optional sign [+-] and optional suffixes [uUlL].
  - patternCPPOperand
```
public static Pattern patternCPPOperand
```
    One of: + - * / | & ( ) << >> ~
    Expression excludes patternDecimalOrIntNumber.
- Constructor Detail
  - ConstantDefinition
```
public ConstantDefinition(String name,
                          String nativeExpr,
                          ConstantDefinition.CNumber number,
                          ASTLocusTag astLocus)
```
    Constructor for plain const-values, non-enumerates.
    
    Parameters:
    
    name - unique name of this constant expression
    
    nativeExpr - original [native] expression
    
    number - optional ConstantDefinition.CNumber representing this constant. If null, implementation attempts to derive a ConstantDefinition.CNumber of the given nativeExpr.
    
    astLocus - AST location of the represented constant.
  - ConstantDefinition
```
public ConstantDefinition(String name,
                          String nativeExpr,
                          ConstantDefinition.CNumber number,
                          String enumName,
                          ASTLocusTag astLocus)
```
    Constructor for enumerates
    
    Parameters:
    
    name - unique name of this constant expression
    
    nativeExpr - original [native] expression
    
    number - optional ConstantDefinition.CNumber representing this constant. If null, implementation attempts to derive a ConstantDefinition.CNumber of the given nativeExpr.
    
    enumName - optional name of the represented enumeration
    
    astLocus - AST location of the represented constant.
- Method Detail
  - getASTLocusTag
```
public ASTLocusTag getASTLocusTag()
```
    Description copied from interface: ASTLocusTag.ASTLocusTagProvider
    
    Returns this instance's ASTLocusTag, if available, otherwise returns null.
    
    Specified by:
    
    getASTLocusTag in interface ASTLocusTag.ASTLocusTagProvider
  - hashCode
```
public final int hashCode()
```
    Hash by its given name.
    
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object arg)
```
    Equality test by its given name.
    
    Overrides:
    
    equals in class Object
  - hashCodeSemantics
```
public final int hashCodeSemantics()
```
    Description copied from interface: TypeComparator.SemanticEqualityOp
    
    Semantic hashcode for Types exclusive its given name.
    
    Specified by:
    
    hashCodeSemantics in interface TypeComparator.SemanticEqualityOp
    
    See Also:
    
    TypeComparator.SemanticEqualityOp.equalSemantics(SemanticEqualityOp)
  - equalSemantics
```
public final boolean equalSemantics(TypeComparator.SemanticEqualityOp arg)
```
    Description copied from interface: TypeComparator.SemanticEqualityOp
    
    Semantic equality test for Types exclusive its given name.
    
    Specified by:
    
    equalSemantics in interface TypeComparator.SemanticEqualityOp
    
    See Also:
    
    TypeComparator.SemanticEqualityOp.hashCodeSemantics()
  - getNativeExpr
```
public String getNativeExpr()
```
    Returns the original [native] expression.
  - getNumber
```
public ConstantDefinition.CNumber getNumber()
```
    Returns the parsed ConstantDefinition.CNumber of the native expression, or null if the latter does not comprise a single number, i.e. is a complex expression.
  - hasNumber
```
public boolean hasNumber()
```
    Returns true if this instance represents has a number, otherwise false.
  - getEnumName
```
public String getEnumName()
```
    Returns null if this definition was not part of an enumeration, or if the enumeration is anonymous.
  - isEnum
```
public boolean isEnum()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - computeJavaExpr
```
public final ConstantDefinition.JavaExpr computeJavaExpr(Map<String,ConstantDefinition.JavaExpr> constMap)
```
    Computes the java expression based on this instance, see JavaExpr#create(ConstantDefinition).
  - isConstantExpression
```
public static boolean isConstantExpression(String value)
```
  - isIdentifier
```
public static boolean isIdentifier(String value)
```
  - decodeANumber
```
public static ConstantDefinition.CNumber decodeANumber(String v)
```
    Returns either decodeIntegerNumber(String), decodeDecimalNumber(String) or null.
    
    Parameters:
    
    v -
  - decodeIntegerNumber
```
public static ConstantDefinition.CNumber decodeIntegerNumber(String v)
```
    If the given string isIntegerNumber(String), return the decoded integer value, represented as a ANumber, otherwise returns null.
    Method strips off sign prefix + and integer modifier suffixes [uUlL] before utilizing Long.decode(String).
    
    Parameters:
    
    v -
  - decodeDecimalNumber
```
public static ConstantDefinition.CNumber decodeDecimalNumber(String v)
```
    If the given string isDecimalNumber(String), return the decoded floating-point value, represented as a ANumber object, otherwise returns null.
    Method utilizes Double.valueOf(String).
    
    Parameters:
    
    v -
    
    isDouble - return value for double flag
  - isNumber
```
public static boolean isNumber(String s)
```
    Matches isHexNumber(String) or isDecimalOrIntNumber(String).
  - isIntegerNumber
```
public static boolean isIntegerNumber(String s)
```
    Matches isHexNumber(String) or patternIntegerNumber.
  - isHexNumber
```
public static boolean isHexNumber(String s)
```
    Matches patternHexNumber.
  - isDecimalNumber
```
public static boolean isDecimalNumber(String s)
```
    Matches pattern for floating point number, compatible and described in Double.valueOf(String).
  - isDecimalOrIntNumber
```
public static boolean isDecimalOrIntNumber(String s)
```
    Complete pattern for floating point and integer number, covering patternDecimalNumber and patternIntegerNumber.
  - isCPPOperand
```
public static boolean isCPPOperand(String s)
```
    Matches pattern for valid CPP operands, see patternCPPOperand.

Class ConstantDefinition

Nested Class Summary

Nested classes/interfaces inherited from interface com.jogamp.gluegen.cgram.types.AliasedSymbol

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.jogamp.gluegen.cgram.types.AliasedSymbol.AliasedSymbolImpl

Methods inherited from class java.lang.Object

Methods inherited from interface com.jogamp.gluegen.cgram.types.AliasedSymbol

Field Detail

UNSIGNED_INT_MAX_VALUE

UNSIGNED_LONG_MAX_VALUE

patternHexNumber

patternDecimalNumber

patternDecimalOrIntNumber

patternIntegerNumber

patternCPPOperand

Constructor Detail

ConstantDefinition

ConstantDefinition

Method Detail

getASTLocusTag

hashCode

equals

hashCodeSemantics

equalSemantics

getNativeExpr

getNumber

hasNumber

getEnumName

isEnum

toString

computeJavaExpr

isConstantExpression

isIdentifier

decodeANumber

decodeIntegerNumber

decodeDecimalNumber

isNumber

isIntegerNumber

isHexNumber

isDecimalNumber

isDecimalOrIntNumber

isCPPOperand