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) String[]	docTags Documentation tags, where we keep only the ones that could be compatible between Javadoc and Doxygen.
(package private) InfoMap	infoMap
(package private) InfoMap	leafInfoMap
(package private) String	lineSeparator
(package private) Logger	logger
(package private) Properties	properties
(package private) TokenIndexer	tokens

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
(package private) Attribute	attribute()
(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) 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) boolean	enumeration(Context context, DeclarationList declList)
(package private) boolean	extern(Context context, DeclarationList declList)
(package private) boolean	function(Context context, DeclarationList declList)
(package private) boolean	group(Context context, DeclarationList declList)
(package private) boolean	macro(Context context, DeclarationList declList)
(package private) boolean	namespace(Context context, DeclarationList declList)
(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) TemplateMap	template(Context context)
(package private) Type[]	templateArguments(Context context)
(package private) String	translate(String text)
(package private) Type	type(Context context)
(package private) boolean	typedef(Context context, DeclarationList declList)
(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

infoMap

InfoMap infoMap

leafInfoMap

InfoMap leafInfoMap

tokens

TokenIndexer tokens

lineSeparator

String lineSeparator

docTags

String[] docTags

Documentation tags, where we keep only the ones that could be compatible between Javadoc and Doxygen.

Constructor Detail

Parser

public Parser(Logger logger,
              Properties properties)

Parser

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

Parser

Parser(Parser p,
       String text)

Method Detail

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

type

Type type(Context context)
   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()
              throws ParserException

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

Throws:

ParserException

commentAfter

String commentAfter()
             throws ParserException

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

Throws:

ParserException

attribute

Attribute attribute()
             throws ParserException

Throws:

ParserException

body

String body()
     throws ParserException

Throws:

ParserException

parameters

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

Throws:

ParserException

function

boolean function(Context context,
                 DeclarationList declList)
          throws ParserException

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

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