C Cross Referencing & Documentation tool. Version 1.5.
Definition of the different variables types that are used.
| Included in: | comment.c |
| cxref.c | |
| cxref.h | |
| file.c | |
| func.c | |
| html.c | |
| latex.c | |
| preproc.c | |
| rtf.c | |
| sgml.c | |
| slist.c | |
| type.c | |
| var.c | |
| warn-raw.c | |
| xref.c |
A function to add a pointer to the end of a linked list.
#define AddToLinkedList( dst, type, src )
typedef struct _Include* Include
typedef struct _Define* Define
typedef struct _Typedef* Typedef
typedef struct _Variable* Variable
typedef struct _Function* Function
typedef struct _StructUnion* StructUnion
typedef struct _StringList* StringList
| struct _StringList | |
| { | |
| int n; | The number of strings in the list. |
| char** s; | The strings. |
| } |
typedef struct _StringList2* StringList2
| struct _StringList2 | |
| { | |
| int n; | The number of strings in the list. |
| char** s1; | The first set of strings. |
| char** s2; | The second set of strings. |
| } |
| struct _File | |
| { | |
| char* comment; | The file comment. |
| char* name; | The name of the file. |
| Include includes; | A linked list of include files. |
| Define defines; | A linked list of #defines. |
| Typedef typedefs; | A linked list of type definitions. |
| Variable variables; | A linked list of variable definitions. |
| Function functions; | A linked list of function prototypes. |
| StringList inc_in; | The files that this file is included in. |
| StringList2 f_refs; | The functions that are referenced. |
| StringList2 v_refs; | The variables that are referenced. |
| } |
| struct _Include | |
| { | |
| char* comment; | The comment for the include file. |
| char* name; | The name of the included file. |
| int scope; | The type of file, LOCAL or GLOBAL. |
| Include includes; | The files that are include by this file. |
| Include next; | A pointer to the next item. |
| } |
| struct _Define | |
| { | |
| char* comment; | The comment for the #define. |
| char* name; | The name that is defined. |
| char* value; | The value that is defined (if simple). |
| StringList2 args; | The arguments to the #define function. |
| int lineno; | The line number that this definition appears on. |
| Define next; | A pointer to the next item. |
| } |
| struct _Typedef | |
| { | |
| char* comment; | The comment for the type definition. |
| char* name; | The name of the defined type. |
| char* type; | The type of the definition. |
| StructUnion sutype; | The type of the definition if it is a locally declared struct / union. |
| Typedef typexref; | The type of the definition if it is not locally declared or a repeat definition. |
| int lineno; | The line number that this type definition appears on. |
| Typedef next; | A pointer to the next item. |
| } |
| struct _Variable | |
| { | |
| char* comment; | The comment for the variable. |
| char* name; | The name of the variable. |
| char* type; | The type of the variable. |
| int scope; | The scope of the variable, STATIC, GLOBAL or EXTERNAL |
| char* defined; | The name of the file that the variable is defined in as global if extern here. |
| char* incfrom; | The name of the file that the variable is included from if any. |
| StringList2 visible; | The names of the files that the variable is visible in. |
| StringList2 used; | The names of the files that the variable is used in. |
| int lineno; | The line number that this variable definition appears on. |
| Variable next; | A pointer to the next item. |
| } |
| struct _Function | |
| { | |
| char* comment; | The comment for the function. |
| char* name; | The name of the function. |
| char* type; | The return type of the function. |
| char* cret; | A comment for the returned value. |
| char* protofile; | The name of the file where the function is prototyped |
| char* incfrom; | The name of the file that the function is included from if any. |
| StringList2 args; | The arguments to the function. |
| int scope; | The scope of the function, LOCAL or GLOBAL. |
| StringList protos; | The functions that are prototyped within this function. |
| StringList2 calls; | The functions that are called from this function. |
| StringList2 called; | The names of the functions that call this one. |
| StringList2 used; | The places that the function is used, (references not direct calls). |
| StringList2 v_refs; | The variables that are referenced from this function. |
| StringList2 f_refs; | The functions that are referenced from this function. |
| int lineno; | The line number that this function definition appears on. |
| Function next; | A pointer to the next item. |
| } |
| struct _StructUnion | |
| { | |
| char* comment; | The comment for the struct or union or simple component. |
| char* name; | The name of the struct or union or simple component. |
| int n_comp; | The number of sub-components (if none then it is simple). |
| StructUnion* comps; | The sub-components. |
| } |