-
Notifications
You must be signed in to change notification settings - Fork 0
/
libcodoc.h
292 lines (259 loc) · 11.3 KB
/
libcodoc.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
#ifndef __CO_DOC_H_
#define __CO_DOC_H_
#include <glib.h>
#include <libxml/parser.h>
typedef struct _COContext COContext;
typedef struct _COParameter COParameter;
typedef struct _COFunction COFunction;
typedef struct _COEnumerationValue COEnumerationValue;
typedef struct _COEnumeration COEnumeration;
typedef struct _COMember COMember;
typedef struct _COUnion COUnion;
typedef struct _COGlobal COGlobal;
typedef struct _COStructure COStructure;
typedef struct _COStructStub COStructStub;
typedef struct _CODatabase CODatabase;
typedef struct _COEntry COEntry;
typedef struct _COSection COSection;
typedef struct _COPrivacyInfo COPrivacyInfo;
struct _COPrivacyInfo
{
gboolean is_private;
};
/* Context for error messages. */
struct _COContext {
const char *file;
int lineno;
gboolean in_h_file;
COPrivacyInfo privacy_info;
};
void context_message(COContext *context,
const char *format,
...);
void context_warning(COContext *context,
const char *format,
...);
typedef enum
{
CO_ENTRY_FLAGS_PRIVATE = (1 << 0),
CO_ENTRY_FLAGS_GOT_IN_TEMPLATE = (1 << 1),
CO_ENTRY_FLAGS_GOT_IN_HFILE = (1 << 2)
} COEntryFlags;
/* note: 'blurb' is always a *list* of nodes */
struct _COParameter
{
char *type;
char *name;
xmlNode *blurb;
xmlNode *conflict;
COEntryFlags flags;
};
struct _COFunction {
char *name;
char *return_type;
int num_parameters;
COParameter **parameters;
xmlNode *blurb;
xmlNode *conflict;
COEntryFlags flags;
};
struct _COMember {
char *type;
char *name;
xmlNode *blurb;
xmlNode *conflict;
gboolean is_function;
int num_parameters;
COParameter **parameters;
COEntryFlags flags;
};
struct _COStructure {
char *name;
GHashTable *members;
xmlNode *blurb;
xmlNode *conflict;
/* these are in the order they appear, for static initializers. */
char **member_names;
COEntryFlags flags;
};
struct _COUnion {
char *name;
int num_objects;
char **type_name_pairs;
xmlNode *blurb;
xmlNode *conflict;
COEntryFlags flags;
};
struct _COEnumerationValue {
char *name;
xmlNode *blurb;
xmlNode *conflict;
COEntryFlags flags;
};
struct _COEnumeration {
char *name;
xmlNode *blurb;
xmlNode *conflict;
GHashTable *values;
COEntryFlags flags;
};
struct _COGlobal {
char *type;
char *name;
xmlNode *blurb;
xmlNode *conflict;
COEntryFlags flags;
};
struct _COStructStub {
char *name;
xmlNode *blurb;
xmlNode *conflict;
COEntryFlags flags;
};
struct _COEntry {
COEnumeration *enumeration;
COFunction *function;
COFunction *function_typedef;
COStructure *structure;
COGlobal *global;
COUnion *the_union; /* sigh, inconsistent b/c union is reserved */
COStructStub *struct_stub;
};
struct _COSection {
char *h_filename;
char *title;
GSList *first_entry;
GSList *last_entry;
xmlNode *blurb;
xmlNode *conflict;
COEntryFlags flags;
};
struct _CODatabase {
GHashTable *functions;
GHashTable *function_typedefs;
GHashTable *structures;
GHashTable *struct_stubs;
GHashTable *enumerations;
GHashTable *globals;
GHashTable *unions;
GHashTable *sections;
GHashTable *omissions;
GSList *first_section;
GSList *last_section;
GSList *subdirs;
char *cpp_flags;
char *output_doc_filename;
COSection *default_section;
};
CODatabase* co_database_new ();
CODatabase* co_database_load_xml (const char *filename);
CODatabase* co_database_load_old (const char *filename);
gboolean co_database_safe_save (CODatabase *database,
const char *filename);
gboolean co_database_merge (CODatabase *database,
const char *cpp_flags);
void co_database_destroy (CODatabase *database);
gboolean co_database_render (CODatabase *database);
void co_database_set_cpp_flags (CODatabase *database,
const char *cpp_flags);
void co_database_add_subdir (CODatabase *database,
const char *subdirs);
gboolean codoc_util_is_c_type (const char **pstr);
/* --- methods for building a database: note xml_blurb's ownership
* is transfered to the called function! */
void co_database_add_omission (CODatabase *database,
const char *omission);
void co_database_add_global (CODatabase *database,
const char *name,
const char *type,
xmlNode *blurb,
xmlNode *conflict,
COEntryFlags flags,
COContext *context);
void co_database_add_union (CODatabase *database,
const char *union_name,
int num_pairs,
char **type_name_pairs,
xmlNode *xml_blurb,
xmlNode *conflict,
COEntryFlags flags,
COContext *context);
void co_database_add_struct_stub (CODatabase *database,
const char *struct_name,
xmlNode *xml_blurb,
xmlNode *conflict,
COEntryFlags flags,
COContext *context);
void co_database_add_enum (CODatabase *database,
const char *enum_name,
xmlNode *xml_blurb,
xmlNode *conflict,
COEntryFlags flags,
COContext *context);
void co_database_add_enum_value (CODatabase *database,
const char *enum_name,
const char *value_name,
xmlNode *xml_blurb,
xmlNode *conflict,
COEntryFlags flags,
COContext *context);
void co_database_add_struct (CODatabase *database,
const char *struct_name,
xmlNode *xml_blurb,
xmlNode *conflict,
COEntryFlags flags,
COContext *context);
void co_database_add_struct_member (CODatabase *database,
const char *struct_name,
const char *member_name,
const char *member_type,
xmlNode *xml_blurb,
xmlNode *conflict,
COEntryFlags flags,
COContext *context);
void co_database_add_member_function (CODatabase *database,
const char *struct_name,
const char *name,
const char *return_type,
int num_parameters,
COParameter **parameters,
xmlNode *xml_blurb,
xmlNode *conflict,
COEntryFlags flags,
COContext *context);
void co_database_add_struct_member_param (CODatabase *database,
const char *struct_name,
const char *method_name,
int param_index,
const char *param_name,
const char *param_type,
xmlNode *xml_blurb,
xmlNode *conflict,
COEntryFlags flags,
COContext *context);
void co_database_new_section (CODatabase *database,
const char *h_filename,
const char *title,
xmlNode *xml_blurb,
xmlNode *conflict,
COEntryFlags flags,
COContext *context);
void co_database_add_function (CODatabase *database,
gboolean is_typedef,
const char *function_name,
const char *return_type,
xmlNode *xml_blurb,
xmlNode *conflict,
COEntryFlags flags,
COContext *context);
void co_database_add_function_param (CODatabase *database,
gboolean is_typedef,
const char *function_name,
int param_index,
const char *parameter_name,
const char *parameter_type,
xmlNode *xml_blurb,
xmlNode *conflict,
COEntryFlags flags,
COContext *context);
#endif