GlueGen Runtime 2.3.2 · com.jogamp.gluegen.structgen.CStructAnnotationProcessor

If the header file is absolute, the root path is the parent folder of the folder containing the package source, i.e.:

 Header: /gluegen/src/junit/com/jogamp/test/structgen/TestStruct01.h
 Root:   /gluegen/src/junit/..
 Root:   /gluegen/src

Otherwise the user.dir is being used as the root path and the relative header file is appended to it.

The property jogamp.gluegen.structgen.output allows setting a default outputPath for the generated sources, if the ProcessingEnvironment's structgen.output option is not set.

If the outputPath is relative, it is appended to the root path, otherwise it is taken as-is.

User can enable DEBUG while defining property jogamp.gluegen.structgen.debug.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	CStructAnnotationProcessor.AnnotationProcessorJavaStructEmitter

Field Summary

Modifier and Type	Field and Description
pack-priv static final boolean	DEBUG
private static final String	DEFAULT
private Elements	eltUtils
private Filer	filer
private static final Set<String>	generatedStructs
private Messager	messager
private String	outputPath
private static final String	STRUCTGENOUTPUT
private static final String	STRUCTGENOUTPUT_OPTION

Inherited from javax.annotation.processing.AbstractProcessor:: processingEnv

Constructor Summary

Access	Constructor and Description
public	CStructAnnotationProcessor()

Method Summary

Modifier and Type	Method and Description
private void	generateStructBinding(final Element element, final CStruct struct, final boolean isPackageOrType, final String rootOut, final String pakage, final File header, final String headerParent)
public void	init(final ProcessingEnvironment environment to access facilities the tool framework provides to the processor processingEnv) Overrides javax.annotation.processing.AbstractProcessor.init. Implements javax.annotation.processing.Processor.init. Initializes the processor with the processing environment.
private File	locateSource(final String packageName, final String relativeName)
public boolean	process(final Set<? extends TypeElement> the annotation interfaces requested to be processed annotations, final RoundEnvironment environment for information about the current and prior round env) Implements abstract javax.annotation.processing.AbstractProcessor.process. Implements javax.annotation.processing.Processor.process. Processes a set of annotation interfaces on root elements originating from the prior round and returns whether or not these annotation interfaces are claimed by this processor.
private void	processCStruct(final CStruct struct, final Element element, final String packageName, final String user_dir)

Inherited from javax.annotation.processing.AbstractProcessor:: getCompletions getSupportedAnnotationTypes getSupportedOptions getSupportedSourceVersion isInitialized

Field Detail

DEBUG	back to summary
pack-priv static final boolean DEBUG

DEFAULT	back to summary
private static final String DEFAULT

eltUtils	back to summary
private Elements eltUtils

filer	back to summary
private Filer filer

generatedStructs	back to summary
private static final Set<String> generatedStructs

messager	back to summary
private Messager messager

outputPath	back to summary
private String outputPath

STRUCTGENOUTPUT	back to summary
private static final String STRUCTGENOUTPUT

STRUCTGENOUTPUT_OPTION	back to summary
private static final String STRUCTGENOUTPUT_OPTION

Constructor Detail

CStructAnnotationProcessor	back to summary
public CStructAnnotationProcessor()

Method Detail

generateStructBinding	back to summary
private void generateStructBinding(final Element element, final CStruct struct, final boolean isPackageOrType, final String rootOut, final String pakage, final File header, final String headerParent) throws IOException

init	back to summary
public void init(final ProcessingEnvironment processingEnv) Overrides javax.annotation.processing.AbstractProcessor.init. Implements javax.annotation.processing.Processor.init. Doc from javax.annotation.processing.AbstractProcessor.init. Initializes the processor with the processing environment. Parameters processingEnv:ProcessingEnvironment environment to access facilities the tool framework provides to the processor Annotations @Override

init

back to summary

public void init(final ProcessingEnvironment processingEnv)

Overrides javax.annotation.processing.AbstractProcessor.init.

Implements javax.annotation.processing.Processor.init.

Doc from javax.annotation.processing.AbstractProcessor.init.

Initializes the processor with the processing environment.

Parameters

processingEnv:ProcessingEnvironment: environment to access facilities the tool framework provides to the processor

Annotations

@Override

locateSource	back to summary
private File locateSource(final String packageName, final String relativeName)

process back to summary

process	back to summary
public boolean process(final Set<? extends TypeElement> annotations, final RoundEnvironment env) Implements abstract javax.annotation.processing.AbstractProcessor.process. Implements javax.annotation.processing.Processor.process. Doc from javax.annotation.processing.AbstractProcessor.process. Processes a set of annotation interfaces on root elements originating from the prior round and returns whether or not these annotation interfaces are claimed by this processor. If `true` is returned, the annotation interfaces are claimed and subsequent processors will not be asked to process them; if `false` is returned, the annotation interfaces are unclaimed and subsequent processors may be asked to process them. A processor may always return the same boolean value or may vary the result based on its own chosen criteria. The input set will be empty if the processor supports `"*"` and the root elements have no annotations. A `Processor` must gracefully handle an empty set of annotations. Parameters annotations:Set<? extends TypeElement> the annotation interfaces requested to be processed env:RoundEnvironment environment for information about the current and prior round Returns:boolean Doc from javax.annotation.processing.Processor.process. whether or not the set of annotation interfaces are claimed by this processor Annotations @Override

public boolean process(final Set<? extends TypeElement> annotations, final RoundEnvironment env)

Implements abstract javax.annotation.processing.AbstractProcessor.process.

Implements javax.annotation.processing.Processor.process.

Doc from javax.annotation.processing.AbstractProcessor.process.

Processes a set of annotation interfaces on root elements originating from the prior round and returns whether or not these annotation interfaces are claimed by this processor. If true is returned, the annotation interfaces are claimed and subsequent processors will not be asked to process them; if false is returned, the annotation interfaces are unclaimed and subsequent processors may be asked to process them. A processor may always return the same boolean value or may vary the result based on its own chosen criteria.

The input set will be empty if the processor supports "*" and the root elements have no annotations. A Processor must gracefully handle an empty set of annotations.

Parameters

annotations:Set<? extends TypeElement>: the annotation interfaces requested to be processed
env:RoundEnvironment: environment for information about the current and prior round

Returns:boolean

Doc from javax.annotation.processing.Processor.process.

whether or not the set of annotation interfaces are claimed by this processor

Annotations

@Override

processCStruct	back to summary
private void processCStruct(final CStruct struct, final Element element, final String packageName, final String user_dir)

public Class CStructAnnotationProcessor

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class CStructAnnotationProcessor.AnnotationProcessorJavaStructEmitter

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail