org.bytedeco.javacpp.tools

Class Info

java.lang.Object

org.bytedeco.javacpp.tools.Info

public class Info
extends Object

Holds information useful to the Parser and associated with C++ identifiers. Info objects are meant to be added by the user to an InfoMap passed as argument to InfoMapper.map(InfoMap). A class inheriting from the latter becomes a kind of configuration file entirely written in Java.

For usage examples, one can refer to the source code of the default values defined in the initializer of InfoMap.defaults.

Author:

Samuel Audet

Field Summary

Fields

Modifier and Type	Field and Description
(package private) String[]	annotations Additional Java annotations that should prefix the identifiers on output.
(package private) String	base Allows to override the base class of pointerTypes.
(package private) boolean	cast Annotates Java identifiers with @Cast containing C++ identifier names cppNames.
(package private) String[]	cppNames A list of C++ identifiers or expressions to which this info is to be bound.
(package private) String	cppText Replaces the code associated with the declaration of C++ identifiers, before parsing.
(package private) String[]	cppTypes A list of C++ types that supply information missing from macros, templates, etc.
(package private) boolean	define Indicates expressions of conditional macro groups to parse, or templates to specialize.
(package private) String[]	javaNames The Java identifiers to output corresponding to the C++ identifiers of cppNames.
(package private) String	javaText Outputs the given code, instead of the result parsed from the declaration of C++ identifiers.
(package private) String[]	pointerTypes A list of (usually) Pointer Java subclasses to be used to map C++ pointer types.
(package private) boolean	skip Skips entirely all the code associated with the C++ identifiers.
(package private) boolean	translate Attempts to translate naively the statements of variable-like macros to Java.
(package private) String[]	valueTypes A list of (usually) primitive Java types to be used to map C++ value types.

Constructor Summary

Constructors

Constructor and Description
Info()
Info(Info i)
Info(String... cppNames)

Method Summary

Methods

Modifier and Type	Method and Description
Info	annotations(String... annotations)
Info	base(String base)
Info	cast()
Info	cast(boolean cast)
Info	cppNames(String... cppNames)
Info	cppText(String cppText)
Info	cppTypes(String... cppTypes)
Info	define()
Info	define(boolean define)
Info	javaNames(String... javaNames)
Info	javaText(String javaText)
Info	pointerTypes(String... pointerTypes)
Info	skip()
Info	skip(boolean skip)
Info	translate()
Info	translate(boolean translate)
Info	valueTypes(String... valueTypes)

Methods inherited from class java.lang.Object

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

Field Detail

cppNames

String[] cppNames

A list of C++ identifiers or expressions to which this info is to be bound. Usually set via the constructor parameter of Info(String...).

javaNames

String[] javaNames

The Java identifiers to output corresponding to the C++ identifiers of cppNames. By default, the names of C++ identifiers cppNames are used.

annotations

String[] annotations

Additional Java annotations that should prefix the identifiers on output.

cppTypes

String[] cppTypes

A list of C++ types that supply information missing from macros, templates, etc. By default, identifiers with missing type information are skipped, except for variable-like macros for which the type is guessed based on the expression.

valueTypes

String[] valueTypes

A list of (usually) primitive Java types to be used to map C++ value types. By default, pointerTypes prefixed with @ByVal are used.

pointerTypes

String[] pointerTypes

A list of (usually) Pointer Java subclasses to be used to map C++ pointer types. By default, the names of the C++ types cppNames are used.

cast

boolean cast

Annotates Java identifiers with @Cast containing C++ identifier names cppNames.

define

boolean define

Indicates expressions of conditional macro groups to parse, or templates to specialize.

translate

boolean translate

Attempts to translate naively the statements of variable-like macros to Java.

skip

boolean skip

Skips entirely all the code associated with the C++ identifiers.

base

String base

Allows to override the base class of pointerTypes. Defaults to Pointer.

cppText

String cppText

Replaces the code associated with the declaration of C++ identifiers, before parsing.

javaText

String javaText

Outputs the given code, instead of the result parsed from the declaration of C++ identifiers.

Constructor Detail

Info

public Info()

Info

public Info(String... cppNames)

Info

public Info(Info i)

Method Detail

cppNames

public Info cppNames(String... cppNames)

javaNames

public Info javaNames(String... javaNames)

annotations

public Info annotations(String... annotations)

cppTypes

public Info cppTypes(String... cppTypes)

valueTypes

public Info valueTypes(String... valueTypes)

pointerTypes

public Info pointerTypes(String... pointerTypes)

cast

public Info cast()

cast

public Info cast(boolean cast)

define

public Info define()

define

public Info define(boolean define)

translate

public Info translate()

translate

public Info translate(boolean translate)

skip

public Info skip()

skip

public Info skip(boolean skip)

base

public Info base(String base)

cppText

public Info cppText(String cppText)

javaText

public Info javaText(String javaText)