org.bytedeco.javacpp.tools

Class Generator

java.lang.Object

org.bytedeco.javacpp.tools.Generator

public class Generator
extends java.lang.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

Constructor Summary

Constructors

Constructor and Description
Generator(Logger logger, java.util.Properties properties)
Generator(Logger logger, java.util.Properties properties, java.lang.String encoding)

Method Summary

Modifier and Type	Method and Description
boolean	generate(java.lang.String sourceFilename, java.lang.String headerFilename, java.lang.String loadSuffix, java.lang.String baseLoadSuffix, java.lang.String classPath, java.lang.Class<?>... classes)

Methods inherited from class java.lang.Object

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

Constructor Detail

Generator

public Generator(Logger logger,
                 java.util.Properties properties)

Generator

public Generator(Logger logger,
                 java.util.Properties properties,
                 java.lang.String encoding)

Method Detail

generate

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

Throws:

java.io.IOException