org.bytedeco.javacpp.tools

Class Parser

java.lang.Object

org.bytedeco.javacpp.tools.Parser

public class Parser
extends Object

The Parser, just like the Generator, is a mess that is not meant to support the entirety of C++, but an appropriate subset as used by typical C/C++ header files. To figure out what that subset is and what the output should be, the idea is to apply it on as many C/C++ libraries as possible, and patch the code as we go. At one point in time, when this prototype code appears to have stabilized, we can start to redesign it in a more meaningful way.

That said, to understand how it is supposed to function in its present state, one can step through the code at runtime: It is quite friendly to debuggers.

Moreover, it relies on Info objects created as part of the execution of InfoMapper.map(InfoMap). We can understand better how the parsing is supposed to get accomplished by studying that documentation as well.

To do: - Inherit constructors from helper classes, if possible - etc.

Author:

Samuel Audet

See Also:

Info, InfoMap, InfoMapper

Field Summary

Fields

Modifier and Type	Field and Description
(package private) Map<String,Map<Type,Boolean>>	downcasts Classes that have a base class appearing as a key in this map need a downcast constructor.
(package private) String	encoding
(package private) InfoMap	infoMap
(package private) InfoMap	leafInfoMap
(package private) String	lineSeparator
(package private) Logger	logger
(package private) Set<String>	polymorphicClasses Java names of classes recognized as polymorphic.
(package private) Properties	properties
(package private) TokenIndexer	tokens
(package private) Set<String>	upcasts Java names of classes needing upcast from their subclasses.

Constructor Summary

Constructors

Constructor and Description
Parser(Logger logger, Properties properties)
Parser(Logger logger, Properties properties, String encoding, String lineSeparator)
Parser(Parser p, String text)

Method Summary

Modifier and Type	Method and Description
(package private) void	addDowncast(String base, Type from, boolean virtual)
(package private) Attribute	attribute()
(package private) Attribute	attribute(boolean explicit)
(package private) String	body()
(package private) String	commentAfter() Converts Doxygen-like documentation comments placed after identifiers to Javadoc-style.
(package private) String	commentBefore() Converts Doxygen-like documentation comments placed before identifiers to Javadoc-style.
(package private) String	commentDoc(String s, int startIndex) Tries to adapt a Doxygen-style documentation comment to Javadoc-style.
(package private) static String	constructorName(String cppName) Constructors have 2 kinds of fully qualified name: the calling name of a constructor, used when calling the constructor, e.g.: NS::CN(int) and the declaration name, used when defining the constructor outside its class or when referencing a constructor with using to inherit constructors of base class.
(package private) void	containers(Context context, DeclarationList declList)
(package private) void	declarations(Context context, DeclarationList declList)
(package private) Declarator	declarator(Context context, String defaultName, int infoNumber, boolean useDefaults, int varNumber, boolean arrayAsPointer, boolean pointerAsArray)
(package private) static String	desugarVarargs(String s)
(package private) String	downcast(Type derived, Type base, boolean virtual)
(package private) boolean	enumeration(Context context, DeclarationList declList)
(package private) boolean	extern(Context context, DeclarationList declList)
(package private) static String	filterJavaAnnotations(String s)
(package private) boolean	function(Context context, DeclarationList declList)
(package private) Type	functionAfter(Context context, Declaration decl, Declarator dcl, Type type) Parse function declaration or definition after parameters: const, attributes, trailing type, pure virtual functions.
(package private) boolean	group(Context context, DeclarationList declList)
(package private) static String	incorporateConstAnnotation(String annotations, int constValueIndex, boolean constValue)
(package private) boolean	macro(Context context, DeclarationList declList)
(package private) boolean	namespace(Context context, DeclarationList declList)
private String	operator(Context context) Read and return the operator following an operator keyword: any of new, delete, + - * / % ^ & | ~ ! = < > += -= *= /= %= ^= &= |= << >> >>= <<= == != <= >= <=>(since C++20) && || ++ -- , ->* -> ( ) [ ] taking care of template arguments, if any.
(package private) Parameters	parameters(Context context, int infoNumber, boolean useDefaults)
(package private) void	parse(Context context, DeclarationList declList, String[] includePath, String include, boolean isCFile)
File[]	parse(File outputDirectory, String[] classPath, Class cls)
File[]	parse(String outputDirectory, String[] classPath, Class cls)
(package private) static String	removeAnnotations(String s)
(package private) static String[]	removeDuplicates(String[] a) De-deduplicate an array of strings, keeping order.
(package private) TemplateMap	template(Context context)
(package private) Type[]	templateArguments(Context context)
(package private) String	translate(String text)
(package private) Type	type(Context context)
(package private) Type	type(Context context, boolean definition)
(package private) boolean	typedef(Context context, DeclarationList declList)
(package private) String	upcast(Type derived, Type base, boolean override)
(package private) static String	upcastMethodName(String javaName)
(package private) boolean	using(Context context, DeclarationList declList)
(package private) boolean	variable(Context context, DeclarationList declList)

Methods inherited from class java.lang.Object

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

Field Detail

logger

final Logger logger

properties

final Properties properties

encoding

final String encoding

infoMap

InfoMap infoMap

leafInfoMap

InfoMap leafInfoMap

tokens

TokenIndexer tokens

lineSeparator

String lineSeparator

upcasts

Set<String> upcasts

Java names of classes needing upcast from their subclasses.

downcasts

Map<String,Map<Type,Boolean>> downcasts

Classes that have a base class appearing as a key in this map need a downcast constructor. The associated value gives the class to downcast from and whether the inheritance is virtual.

polymorphicClasses

Set<String> polymorphicClasses

Java names of classes recognized as polymorphic.

Constructor Detail

Parser

public Parser(Logger logger,
              Properties properties)

Parser

public Parser(Logger logger,
              Properties properties,
              String encoding,
              String lineSeparator)

Parser

Parser(Parser p,
       String text)

Method Detail

addDowncast

void addDowncast(String base,
                 Type from,
                 boolean virtual)

removeDuplicates

static String[] removeDuplicates(String[] a)

De-deduplicate an array of strings, keeping order.

removeAnnotations

static String removeAnnotations(String s)

desugarVarargs

static String desugarVarargs(String s)

filterJavaAnnotations

static String filterJavaAnnotations(String s)

upcastMethodName

static String upcastMethodName(String javaName)

constructorName

static String constructorName(String cppName)

Constructors have 2 kinds of fully qualified name: the calling name of a constructor, used when calling the constructor, e.g.: NS::CN(int) and the declaration name, used when defining the constructor outside its class or when referencing a constructor with using to inherit constructors of base class. NS::CN::CN(int) Declarator.cppName contains the calling name, and this method returns the declaration name. Keys in info map should use the declaration name, because the calling name cannot specify arguments in case of constructor templates, and to avoid confusion between classes and constructors info.

translate

String translate(String text)

containers

void containers(Context context,
                DeclarationList declList)
         throws ParserException

Throws:

ParserException

template

TemplateMap template(Context context)
              throws ParserException

Throws:

ParserException

templateArguments

Type[] templateArguments(Context context)
                  throws ParserException

Throws:

ParserException

operator

private String operator(Context context)
                 throws ParserException

Read and return the operator following an operator keyword: any of new, delete, + - * / % ^ & | ~ ! = < > += -= *= /= %= ^= &= |= << >> >>= <<= == != <= >= <=>(since C++20) && || ++ -- , ->* -> ( ) [ ] taking care of template arguments, if any.

Throws:

ParserException

type

Type type(Context context)
   throws ParserException

Throws:

ParserException

type

Type type(Context context,
          boolean definition)
   throws ParserException

Throws:

ParserException

declarator

Declarator declarator(Context context,
                      String defaultName,
                      int infoNumber,
                      boolean useDefaults,
                      int varNumber,
                      boolean arrayAsPointer,
                      boolean pointerAsArray)
               throws ParserException

Throws:

ParserException

commentDoc

String commentDoc(String s,
                  int startIndex)

Tries to adapt a Doxygen-style documentation comment to Javadoc-style.

commentBefore

String commentBefore()

Converts Doxygen-like documentation comments placed before identifiers to Javadoc-style. Also leaves as is non-documentation comments.

commentAfter

String commentAfter()

Converts Doxygen-like documentation comments placed after identifiers to Javadoc-style.

attribute

Attribute attribute()

attribute

Attribute attribute(boolean explicit)

body

String body()
     throws ParserException

Throws:

ParserException

parameters

Parameters parameters(Context context,
                      int infoNumber,
                      boolean useDefaults)
               throws ParserException

Throws:

ParserException

incorporateConstAnnotation

static String incorporateConstAnnotation(String annotations,
                                         int constValueIndex,
                                         boolean constValue)

function

boolean function(Context context,
                 DeclarationList declList)
          throws ParserException

Throws:

ParserException

functionAfter

Type functionAfter(Context context,
                   Declaration decl,
                   Declarator dcl,
                   Type type)
            throws ParserException

Parse function declaration or definition after parameters: const, attributes, trailing type, pure virtual functions. Updates dcl, decl and/or type accordingly.

Throws:

ParserException

variable

boolean variable(Context context,
                 DeclarationList declList)
          throws ParserException

Throws:

ParserException

macro

boolean macro(Context context,
              DeclarationList declList)
       throws ParserException

Throws:

ParserException

typedef

boolean typedef(Context context,
                DeclarationList declList)
         throws ParserException

Throws:

ParserException

using

boolean using(Context context,
              DeclarationList declList)
       throws ParserException

Throws:

ParserException

downcast

String downcast(Type derived,
                Type base,
                boolean virtual)

upcast

String upcast(Type derived,
              Type base,
              boolean override)

group

boolean group(Context context,
              DeclarationList declList)
       throws ParserException

Throws:

ParserException

enumeration

boolean enumeration(Context context,
                    DeclarationList declList)
             throws ParserException

Throws:

ParserException

namespace

boolean namespace(Context context,
                  DeclarationList declList)
           throws ParserException

Throws:

ParserException

extern

boolean extern(Context context,
               DeclarationList declList)
        throws ParserException

Throws:

ParserException

declarations

void declarations(Context context,
                  DeclarationList declList)
           throws ParserException

Throws:

ParserException

parse

void parse(Context context,
           DeclarationList declList,
           String[] includePath,
           String include,
           boolean isCFile)
    throws IOException,
           ParserException

Throws:

IOException

ParserException

parse

public File[] parse(String outputDirectory,
                    String[] classPath,
                    Class cls)
             throws IOException,
                    ParserException

Throws:

IOException

ParserException

parse

public File[] parse(File outputDirectory,
                    String[] classPath,
                    Class cls)
             throws IOException,
                    ParserException

Throws:

IOException

ParserException