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

NAME

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

Modules

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