1runtime(3)                          ANTLR3C                         runtime(3)
2
3
4

NAME

6       runtime - .TH "runtime" 3 "Wed Oct 13 2010" "Version 3.1.2" "ANTLR3C"
7

NAME

9       runtime - If you are familiar with Doxygen generated documentation,
10       then the layout of the files, typedefs and so on will be familiar to
11       you.
12
13       However there is also additional structure applied that helps the
14       programmer to see how the runtime is made up.
15

Modules

17       Under the Modules menu tree you will find the entry API Classes. This
18       section is further divided into typedefs and structs and the standard
19       runtime supplied interface implementation methods.
20
21       The typedefs are the types that you declare in your code and which are
22       returned by the 'constructors' such as antlr3AsciiFileStreamNew(). The
23       underlying structures document the data elements of the type and what a
24       function pointer installed in any particular slot should do.
25
26       The default implementations are the static methods within the default
27       implementation file for a 'class', which are installed by the runtime
28       when a default instance of one the typedefs (classes) is created.
29
30       When navigating the source code, find the typedef you want to consult
31       and inspect the documentation for its function pointers, then look at
32       the documentation for the default methods that implement that 'method'.
33
34       For example, under 'API Typedefs and Structs' you will find 'Base
35       Recognizer Definition', which tells you all the methods that belong to
36       this interface. Under 'API Implementation Functions', you will find
37       'Base Recognizer Implementation', which documents the actual functions
38       that are installed to implement the class methods.
39
40       From here, the documentation should be obvious. If it is not, then you
41       could try reading the actual source code, but please don;t email the
42       author directly, but use the ANTLR Interest email group, which you
43       should probably have signed up for if you have read this far into the C
44       runtime documentation.
45
46
47
48Version 3.1.2                   Wed Oct 13 2010                     runtime(3)
Impressum