org.bytedeco.javacpp.tools

Class Parser

java.lang.Object

org.bytedeco.javacpp.tools.Parser

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

See Also:

Info, InfoMap, InfoMapper

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	encoding
protected InfoMap	infoMap
protected InfoMap	leafInfoMap
protected java.lang.String	lineSeparator
protected Logger	logger
protected java.util.Properties	properties
protected org.bytedeco.javacpp.tools.TokenIndexer	tokens

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	containers(Context context, DeclarationList declList)
protected void	parse(Context context, DeclarationList declList, java.lang.String[] includePath, java.lang.String include, boolean isCFile)
java.io.File[]	parse(java.io.File outputDirectory, java.lang.String[] classPath, java.lang.Class cls)
java.io.File[]	parse(java.lang.String outputDirectory, java.lang.String[] classPath, java.lang.Class cls)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final Logger logger

properties

protected final java.util.Properties properties

encoding

protected final java.lang.String encoding

infoMap

protected InfoMap infoMap

leafInfoMap

protected InfoMap leafInfoMap

tokens

protected org.bytedeco.javacpp.tools.TokenIndexer tokens

lineSeparator

protected java.lang.String lineSeparator

Constructor Detail

Parser

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

Parser

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

Method Detail

containers

protected void containers(Context context,
                          DeclarationList declList)
                   throws ParserException

Throws:

ParserException

parse

protected void parse(Context context,
                     DeclarationList declList,
                     java.lang.String[] includePath,
                     java.lang.String include,
                     boolean isCFile)
              throws java.io.IOException,
                     ParserException

Throws:

java.io.IOException

ParserException

parse

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

Throws:

java.io.IOException

ParserException

parse

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

Throws:

java.io.IOException

ParserException