Class Generator

java.lang.Object

org.bytedeco.javacpp.tools.Generator

public class Generator
extends Object

The Generator is where all the C++ source code that we need gets generated. It has not been designed in any meaningful way since the requirements were not well understood. It is basically a prototype and is really quite a mess. Now that we understand better what we need, it could use some refactoring.

When attempting to understand what the Generator does, try to run experiments and inspect the generated code: It is quite readable.

Moreover, although Generator is the one ultimately doing something with the various annotations it relies on, it was easier to describe the behavior its meant to have with them as part of the documentation of the annotations, so we can refer to them to understand more about how Generator should work:

See Also:

• Adapter
• Allocator
• ArrayAllocator
• ByPtr
• ByPtrPtr
• ByPtrRef
• ByRef
• ByVal
• Cast
• Const
• Convention
• CriticalRegion
• Function
• Index
• MemberGetter
• MemberSetter
• Name
• Namespace
• NoDeallocator
• NoException
• NoOffset
• Opaque
• Platform
• Raw
• ValueGetter
• ValueSetter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static enum	Generator.BooleanEnum
(package private) static enum	Generator.ByteEnum
(package private) static enum	Generator.IntEnum
(package private) static enum	Generator.LongEnum
(package private) static enum	Generator.ShortEnum

Field Summary

Fields

Modifier and Type	Field	Description
(package private) boolean	accessesEnums
(package private) Map<Method, MethodInformation>	annotationCache
(package private) IndexedSet<Class>	arrayDeallocators
(package private) static final List<Class>	baseClasses
(package private) Map<String,String>	callbacks
(package private) IndexedSet<Class>	deallocators
(package private) final String	encoding
(package private) IndexedSet<Class>	functions
(package private) IndexedSet<Class>	jclasses
(package private) static final String	JNI_VERSION
(package private) PrintWriter	jniConfigOut
(package private) final Logger	logger
(package private) boolean	mayThrowExceptions
(package private) Map<Class, Set<String>>	members
(package private) PrintWriter	out
(package private) PrintWriter	out2
(package private) boolean	passesStrings
(package private) final Properties	properties
(package private) PrintWriter	reflectConfigOut
(package private) boolean	usesAdapters
(package private) Map<Class, Set<String>>	virtualFunctions
(package private) Map<Class, Set<String>>	virtualMembers

Constructor Summary

Constructors

Constructor	Description
Generator(Logger logger, Properties properties)
Generator(Logger logger, Properties properties, String encoding)

Method Summary

Modifier and Type	Method	Description
(package private) AdapterInformation	adapterInformation(boolean out, String valueTypeName, Annotation... annotations)
(package private) AdapterInformation	adapterInformation(boolean out, MethodInformation methodInfo, int j)
(package private) static Allocator	allocator(Class<?> cls, Method method)
(package private) static int	allocatorMax(Class<?> cls, Method method)
(package private) static boolean	asUtf16(Annotation[] annotations)
(package private) static boolean	asUtf16(MethodInformation methodInfo, int j)
(package private) Annotation	behavior(Annotation... annotations)
(package private) Annotation	by(Annotation... annotations)
(package private) Annotation	by(MethodInformation methodInfo, int j)
(package private) void	call(MethodInformation methodInfo, String returnPrefix, boolean secondCall)
(package private) void	callback(Class<?> cls, Method callbackMethod, String callbackName, int allocatorMax, boolean needDefinition, MethodInformation methodInfo)
(package private) void	callbackAllocator(Class<?> cls, String callbackName, int allocatorMax)
(package private) String	cast(Class<?> type, Annotation... annotations)
(package private) String	cast(MethodInformation methodInfo, int j)
(package private) boolean	classes(boolean handleExceptions, boolean defineAdapters, boolean convertStrings, boolean declareEnums, String loadSuffix, String baseLoadSuffix, String classPath, Class<?>... classes)
(package private) static boolean	constFunction(Class<?> classType, Method functionMethod)
(package private) static String	constValueTypeName(String... typeName)
(package private) String[]	cppAnnotationTypeName(Class<?> type, Annotation... annotations)
(package private) String[]	cppCastTypeName(Class<?> type, Annotation... annotations)
(package private) String[]	cppFunctionTypeName(Method... functionMethods)
(package private) static String	cppScopeName(Class<?> type)
(package private) static String	cppScopeName(MethodInformation methodInfo)
(package private) String[]	cppTypeName(Class<?> type)
(package private) String[]	cppTypeName(Class<?> type, Annotation[] annotations)
(package private) String[]	cppTypeName(MethodInformation methodInfo, int j)
(package private) static String	createString(String ptr, String adapter, boolean asUtf16)
(package private) static boolean	criticalRegion(Class<?> cls, Method method)
(package private) String	enumValueType(Class<?> type)
(package private) static String	functionClassName(Class<?> cls)
(package private) static Method[]	functionMethods(Class<?> cls, boolean[] callbackAllocators)
boolean	generate(String sourceFilename, String jniConfigFilename, String reflectConfigFilename, String headerFilename, String loadSuffix, String baseLoadSuffix, String classPath, Class<?>... classes)
(package private) static String	getStringData(String str, boolean asUtf16)
(package private) static String	jniTypeName(Class type)
(package private) static String	mangle(String name)
(package private) MethodInformation	methodInformation(Method method)
(package private) boolean	methods(Class<?> cls)
(package private) static boolean	noexceptFunction(Class<?> classType, Method functionMethod)
(package private) static boolean	noException(Class<?> cls, Method method)
(package private) void	parametersAfter(MethodInformation methodInfo)
(package private) void	parametersBefore(MethodInformation methodInfo)
(package private) static String	releaseStringData(String str, String ptr, boolean asUtf16)
(package private) void	returnAfter(MethodInformation methodInfo)
(package private) String	returnBefore(MethodInformation methodInfo)
(package private) static String	signature(Class... types)
(package private) static String	valueTypeName(String... typeName)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

JNI_VERSION

static final String JNI_VERSION

See Also:

• Constant Field Values

baseClasses

static final List<Class> baseClasses

logger

final Logger logger

properties

final Properties properties

encoding

final String encoding

out

PrintWriter out

out2

PrintWriter out2

jniConfigOut

PrintWriter jniConfigOut

reflectConfigOut

PrintWriter reflectConfigOut

callbacks

Map<String,String> callbacks

functions

IndexedSet<Class> functions

deallocators

IndexedSet<Class> deallocators

arrayDeallocators

IndexedSet<Class> arrayDeallocators

jclasses

IndexedSet<Class> jclasses

members

Map<Class, Set<String>> members

virtualFunctions

Map<Class, Set<String>> virtualFunctions

virtualMembers

Map<Class, Set<String>> virtualMembers

annotationCache

Map<Method, MethodInformation> annotationCache

mayThrowExceptions

boolean mayThrowExceptions

usesAdapters

boolean usesAdapters

passesStrings

boolean passesStrings

accessesEnums

boolean accessesEnums

Constructor Details

Generator

public Generator(Logger logger,
 Properties properties)

Generator

public Generator(Logger logger,
 Properties properties,
 String encoding)

Method Details

generate

public boolean generate(String sourceFilename,
 String jniConfigFilename,
 String reflectConfigFilename,
 String headerFilename,
 String loadSuffix,
 String baseLoadSuffix,
 String classPath,
 Class<?>... classes)
                 throws IOException

Throws:

IOException

classes

boolean classes(boolean handleExceptions,
 boolean defineAdapters,
 boolean convertStrings,
 boolean declareEnums,
 String loadSuffix,
 String baseLoadSuffix,
 String classPath,
 Class<?>... classes)

methods

boolean methods(Class<?> cls)

parametersBefore

void parametersBefore(MethodInformation methodInfo)

returnBefore

String returnBefore(MethodInformation methodInfo)

call

void call(MethodInformation methodInfo,
 String returnPrefix,
 boolean secondCall)

returnAfter

void returnAfter(MethodInformation methodInfo)

parametersAfter

void parametersAfter(MethodInformation methodInfo)

callback

void callback(Class<?> cls,
 Method callbackMethod,
 String callbackName,
 int allocatorMax,
 boolean needDefinition,
 MethodInformation methodInfo)

callbackAllocator

void callbackAllocator(Class<?> cls,
 String callbackName,
 int allocatorMax)

functionClassName

static String functionClassName(Class<?> cls)

functionMethods

static Method[] functionMethods(Class<?> cls,
 boolean[] callbackAllocators)

methodInformation

MethodInformation methodInformation(Method method)

allocatorMax

static int allocatorMax(Class<?> cls,
 Method method)

allocator

static Allocator allocator(Class<?> cls,
 Method method)

criticalRegion

static boolean criticalRegion(Class<?> cls,
 Method method)

noException

static boolean noException(Class<?> cls,
 Method method)

adapterInformation

AdapterInformation adapterInformation(boolean out,
 MethodInformation methodInfo,
 int j)

adapterInformation

AdapterInformation adapterInformation(boolean out,
 String valueTypeName,
 Annotation... annotations)

cast

String cast(MethodInformation methodInfo,
 int j)

cast

String cast(Class<?> type,
 Annotation... annotations)

by

Annotation by(MethodInformation methodInfo,
 int j)

by

Annotation by(Annotation... annotations)

behavior

Annotation behavior(Annotation... annotations)

enumValueType

String enumValueType(Class<?> type)

asUtf16

static boolean asUtf16(MethodInformation methodInfo,
 int j)

asUtf16

static boolean asUtf16(Annotation[] annotations)

createString

static String createString(String ptr,
 String adapter,
 boolean asUtf16)

getStringData

static String getStringData(String str,
 boolean asUtf16)

releaseStringData

static String releaseStringData(String str,
 String ptr,
 boolean asUtf16)

constValueTypeName

static String constValueTypeName(String... typeName)

valueTypeName

static String valueTypeName(String... typeName)

constFunction

static boolean constFunction(Class<?> classType,
 Method functionMethod)

noexceptFunction

static boolean noexceptFunction(Class<?> classType,
 Method functionMethod)

cppAnnotationTypeName

String[] cppAnnotationTypeName(Class<?> type,
 Annotation... annotations)

cppCastTypeName

String[] cppCastTypeName(Class<?> type,
 Annotation... annotations)

cppTypeName

String[] cppTypeName(MethodInformation methodInfo,
 int j)

cppTypeName

String[] cppTypeName(Class<?> type)

cppTypeName

String[] cppTypeName(Class<?> type,
 Annotation[] annotations)

cppFunctionTypeName

String[] cppFunctionTypeName(Method... functionMethods)

cppScopeName

static String cppScopeName(MethodInformation methodInfo)

cppScopeName

static String cppScopeName(Class<?> type)

jniTypeName

static String jniTypeName(Class type)

signature

static String signature(Class... types)

mangle

static String mangle(String name)