1runtime(3) ANTLR3C runtime(3)
2
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. However there is also
9 additional structure applied that helps the programmer to see how the
10 runtime is made up.
11
13 Under the Modules menu tree you will find the entry API Classes. This
14 section is further divided into typedefs and structs and the standard
15 runtime supplied interface implementation methods.
16 The typedefs are the types that you declare in your code and which are
18 returned by the 'constructors' such as antlr38BitFileStreamNew(). The
19 underlying structures document the data elements of the type and what a
20 function pointer installed in any particular slot should do.
21 The default implementations are the static methods within the default
23 implementation file for a 'class', which are installed by the runtime
24 when a default instance of one the typedefs (classes) is created.
25 When navigating the source code, find the typedef you want to consult
27 and inspect the documentation for its function pointers, then look at
28 the documentation for the default methods that implement that 'method'.
29 For example, under 'API Typedefs and Structs' you will find 'Base
31 Recognizer Definition', which tells you all the methods that belong to
32 this interface. Under 'API Implementation Functions', you will find
33 'Base Recognizer Implementation', which documents the actual functions
34 that are installed to implement the class methods.
35 From here, the documentation should be obvious. If it is not, then you
37 could try reading the actual source code, but please don't email the
38 author directly, use the ANTLR Interest email group, which you should
39 probably have signed up for if you have read this far into the C
40 runtime documentation.
41Version 3.3.1 Tue Jan 28 2020 runtime(3)