Top Description Fields Constructors Methods
com.jogamp.gluegen

public Class DebugEmitter

extends Object
implements GlueEmitter
Class Inheritance
All Implemented Interfaces
com.jogamp.gluegen.GlueEmitter
Imports
java.io.IOException, java.util.*, com.jogamp.gluegen.cgram.types.*
Debug emitter which prints the parsing results to standard output.

Field Summary

Modifier and TypeField and Description
protected JavaConfiguration
cfg

Constructor Summary

AccessConstructor and Description
public
DebugEmitter()

Method Summary

Modifier and TypeMethod and Description
public void
beginDefines()

Implements com.jogamp.gluegen.GlueEmitter.beginDefines.

public void
beginEmission(final GlueEmitterControls controls)

Implements com.jogamp.gluegen.GlueEmitter.beginEmission.

Begin the emission of glue code.
public void
beginFunctions(final TypeDictionary typedefDictionary, final TypeDictionary structDictionary, final Map<Type, Type> canonMap)

Implements com.jogamp.gluegen.GlueEmitter.beginFunctions.

public void
beginStructLayout()

Implements com.jogamp.gluegen.GlueEmitter.beginStructLayout.

Begins the process of computing field offsets and type sizes for the structs to be emitted.
public void
beginStructs(final TypeDictionary typedefDictionary, final TypeDictionary structDictionary, final Map<Type, Type> canonMap)

Implements com.jogamp.gluegen.GlueEmitter.beginStructs.

protected JavaConfiguration
createConfig()

Create the object that will read and store configuration information for this JavaEmitter.

public void
emitDefine(final ConstantDefinition def, final String
If optionalComment is non-null, the emitter can emit that string as a comment providing extra information about the define.
optionalComment)

Implements com.jogamp.gluegen.GlueEmitter.emitDefine.

public Iterator<FunctionSymbol>
emitFunctions(final List<FunctionSymbol> originalCFunctions)

Implements com.jogamp.gluegen.GlueEmitter.emitFunctions.

Emit glue code for the list of FunctionSymbols.
public void
emitSingleFunction(final FunctionSymbol sym)

public void
emitStruct(final CompoundType t, final Type typedefType)

Implements com.jogamp.gluegen.GlueEmitter.emitStruct.

Emit glue code for the given CompoundType.
public void
endDefines()

Implements com.jogamp.gluegen.GlueEmitter.endDefines.

public void
endEmission()

Implements com.jogamp.gluegen.GlueEmitter.endEmission.

Finish the emission of glue code.
public void
endFunctions()

Implements com.jogamp.gluegen.GlueEmitter.endFunctions.

public void
endStructLayout()

Implements com.jogamp.gluegen.GlueEmitter.endStructLayout.

Finishes the struct layout process.
public void
endStructs()

Implements com.jogamp.gluegen.GlueEmitter.endStructs.

public JavaConfiguration
getConfiguration()

Implements com.jogamp.gluegen.GlueEmitter.getConfiguration.

public void
layoutStruct(final CompoundType t)

Implements com.jogamp.gluegen.GlueEmitter.layoutStruct.

Lays out one struct which will be emitted later.
public void
readConfigurationFile(final String filename)

Implements com.jogamp.gluegen.GlueEmitter.readConfigurationFile.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

cfgback to summary
protected JavaConfiguration cfg

Constructor Detail

DebugEmitterback to summary
public DebugEmitter()

Method Detail

beginDefinesback to summary
public void beginDefines()

Implements com.jogamp.gluegen.GlueEmitter.beginDefines.

Annotations
@Override
beginEmissionback to summary
public void beginEmission(final GlueEmitterControls controls)

Implements com.jogamp.gluegen.GlueEmitter.beginEmission.

Doc from com.jogamp.gluegen.GlueEmitter.beginEmission.

Begin the emission of glue code. This might include opening files, emitting class headers, etc.

Annotations
@Override
beginFunctionsback to summary
public void beginFunctions(final TypeDictionary typedefDictionary, final TypeDictionary structDictionary, final Map<Type, Type> canonMap)

Implements com.jogamp.gluegen.GlueEmitter.beginFunctions.

Annotations
@Override
beginStructLayoutback to summary
public void beginStructLayout() throws Exception

Implements com.jogamp.gluegen.GlueEmitter.beginStructLayout.

Doc from com.jogamp.gluegen.GlueEmitter.beginStructLayout.

Begins the process of computing field offsets and type sizes for the structs to be emitted.

Annotations
@Override
beginStructsback to summary
public void beginStructs(final TypeDictionary typedefDictionary, final TypeDictionary structDictionary, final Map<Type, Type> canonMap)

Implements com.jogamp.gluegen.GlueEmitter.beginStructs.

Annotations
@Override
createConfigback to summary
protected JavaConfiguration createConfig()

Create the object that will read and store configuration information for this JavaEmitter.

emitDefineback to summary
public void emitDefine(final ConstantDefinition def, final String optionalComment)

Implements com.jogamp.gluegen.GlueEmitter.emitDefine.

Parameters
optionalComment:String

Doc from com.jogamp.gluegen.GlueEmitter.emitDefine.

If optionalComment is non-null, the emitter can emit that string as a comment providing extra information about the define.

Annotations
@Override
emitFunctionsback to summary
public Iterator<FunctionSymbol> emitFunctions(final List<FunctionSymbol> originalCFunctions) throws Exception

Implements com.jogamp.gluegen.GlueEmitter.emitFunctions.

Doc from com.jogamp.gluegen.GlueEmitter.emitFunctions.

Emit glue code for the list of FunctionSymbols.

Annotations
@Override
emitSingleFunctionback to summary
public void emitSingleFunction(final FunctionSymbol sym)
emitStructback to summary
public void emitStruct(final CompoundType t, final Type typedefType)

Implements com.jogamp.gluegen.GlueEmitter.emitStruct.

Doc from com.jogamp.gluegen.GlueEmitter.emitStruct.

Emit glue code for the given CompoundType. typedefType is provided when the CompoundType (e.g. "struct foo_t") has not been typedefed to anything but the type of "pointer to struct foo_t" has (e.g. "typedef struct foo_t {} *Foo"); in this case typedefType would be set to pointer type Foo.

Annotations
@Override
endDefinesback to summary
public void endDefines()

Implements com.jogamp.gluegen.GlueEmitter.endDefines.

Annotations
@Override
endEmissionback to summary
public void endEmission()

Implements com.jogamp.gluegen.GlueEmitter.endEmission.

Doc from com.jogamp.gluegen.GlueEmitter.endEmission.

Finish the emission of glue code. This might include closing files, closing open class definitions, etc.

Annotations
@Override
endFunctionsback to summary
public void endFunctions()

Implements com.jogamp.gluegen.GlueEmitter.endFunctions.

Annotations
@Override
endStructLayoutback to summary
public void endStructLayout() throws Exception

Implements com.jogamp.gluegen.GlueEmitter.endStructLayout.

Doc from com.jogamp.gluegen.GlueEmitter.endStructLayout.

Finishes the struct layout process.

Annotations
@Override
endStructsback to summary
public void endStructs()

Implements com.jogamp.gluegen.GlueEmitter.endStructs.

Annotations
@Override
getConfigurationback to summary
public JavaConfiguration getConfiguration()

Implements com.jogamp.gluegen.GlueEmitter.getConfiguration.

Annotations
@Override
layoutStructback to summary
public void layoutStruct(final CompoundType t) throws Exception

Implements com.jogamp.gluegen.GlueEmitter.layoutStruct.

Doc from com.jogamp.gluegen.GlueEmitter.layoutStruct.

Lays out one struct which will be emitted later.

Annotations
@Override
readConfigurationFileback to summary
public void readConfigurationFile(final String filename) throws IOException

Implements com.jogamp.gluegen.GlueEmitter.readConfigurationFile.

Annotations
@Override