org.bytedeco.javacpp.tools

Class Generator

java.lang.Object

org.bytedeco.javacpp.tools.Generator

All Implemented Interfaces:

Closeable, AutoCloseable

public class Generator
extends Object
implements Closeable

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:

Author:

Samuel Audet

See Also:

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

Field Summary

Fields

Modifier and Type	Field and Description
(package private) IndexedSet<Class>	arrayDeallocators
(package private) static List<Class>	baseClasses
(package private) IndexedSet<String>	callbacks
(package private) IndexedSet<Class>	deallocators
(package private) IndexedSet<Class>	functions
(package private) IndexedSet<Class>	jclasses
(package private) IndexedSet<Class>	jclassesInit
(package private) static String	JNI_VERSION
(package private) Logger	logger
(package private) boolean	mayThrowExceptions
(package private) HashMap<Class,LinkedList<String>>	members
(package private) PrintWriter	out
(package private) PrintWriter	out2
(package private) ClassProperties	properties
(package private) boolean	usesAdapters

Constructor Summary

Constructors

Constructor and Description
Generator(Logger logger, ClassProperties properties)

Method Summary

Methods

Modifier and Type	Method and Description
(package private) AdapterInformation	adapterInformation(boolean out, MethodInformation methodInfo, int j)
(package private) AdapterInformation	adapterInformation(boolean out, String valueTypeName, Annotation... annotations)
(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)
(package private) void	callback(Class<?> cls, Method callbackMethod, String callbackName, boolean needFunctor)
(package private) void	callbackAllocator(Class cls, String callbackName)
(package private) String	cast(Class<?> type, Annotation... annotations)
(package private) String	cast(MethodInformation methodInfo, int j)
(package private) boolean	checkPlatform(Class<?> cls)
(package private) boolean	checkPlatform(Platform platform)
(package private) boolean	classes(boolean handleExceptions, boolean defineAdapters, String classPath, Class<?>... classes)
void	close()
(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) static String	cppScopeName(Class<?> type)
(package private) static String	cppScopeName(MethodInformation methodInfo)
(package private) String[]	cppTypeName(Class<?> type)
(package private) static String	functionClassName(Class<?> cls)
(package private) static Method	functionMethod(Class<?> cls, boolean[] callbackAllocators)
boolean	generate(String sourceFilename, String headerFilename, String classPath, Class<?>... classes)
(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	noException(Class<?> cls, Method method)
(package private) void	parametersAfter(MethodInformation methodInfo)
(package private) void	parametersBefore(MethodInformation methodInfo)
(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 java.lang.Object

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

Field Detail

JNI_VERSION

static final String JNI_VERSION

See Also:

Constant Field Values

baseClasses

static final List<Class> baseClasses

logger

final Logger logger

properties

final ClassProperties properties

out

PrintWriter out

out2

PrintWriter out2

callbacks

IndexedSet<String> callbacks

functions

IndexedSet<Class> functions

deallocators

IndexedSet<Class> deallocators

arrayDeallocators

IndexedSet<Class> arrayDeallocators

jclasses

IndexedSet<Class> jclasses

jclassesInit

IndexedSet<Class> jclassesInit

members

HashMap<Class,LinkedList<String>> members

mayThrowExceptions

boolean mayThrowExceptions

usesAdapters

boolean usesAdapters

Constructor Detail

Generator

public Generator(Logger logger,
         ClassProperties properties)

Method Detail

generate

public boolean generate(String sourceFilename,
               String headerFilename,
               String classPath,
               Class<?>... classes)
                 throws FileNotFoundException

Throws:

FileNotFoundException

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

classes

boolean classes(boolean handleExceptions,
              boolean defineAdapters,
              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)

returnAfter

void returnAfter(MethodInformation methodInfo)

parametersAfter

void parametersAfter(MethodInformation methodInfo)

callback

void callback(Class<?> cls,
            Method callbackMethod,
            String callbackName,
            boolean needFunctor)

callbackAllocator

void callbackAllocator(Class cls,
                     String callbackName)

checkPlatform

boolean checkPlatform(Class<?> cls)

checkPlatform

boolean checkPlatform(Platform platform)

functionClassName

static String functionClassName(Class<?> cls)

functionMethod

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

methodInformation

MethodInformation methodInformation(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)

constValueTypeName

static String constValueTypeName(String... typeName)

valueTypeName

static String valueTypeName(String... typeName)

cppAnnotationTypeName

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

cppCastTypeName

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

cppTypeName

String[] cppTypeName(Class<?> type)

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)