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

NAME

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

Modules

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