summaryrefslogtreecommitdiff
path: root/include/dom/core/document.h
blob: 1fe97520ca214aa361ebf9a0296e0d1ffa7e07c9 (plain)
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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
/*
 * This file is part of libdom.
 * Licensed under the MIT License,
 *                http://www.opensource.org/licenses/mit-license.php
 * Copyright 2007 John-Mark Bell <jmb@netsurf-browser.org>
 */

#ifndef dom_core_document_h_
#define dom_core_document_h_

#include <stdbool.h>
#include <inttypes.h>
#include <stddef.h>
#include <stdint.h>

#include <dom/core/exceptions.h>
#include <dom/core/node.h>

struct dom_attr;
struct dom_cdata_section;
struct dom_characterdata;
struct dom_comment;
struct dom_configuration;
struct dom_document_fragment;
struct dom_document_type;
struct dom_element;
struct dom_entity_reference;
struct dom_implementation;
struct dom_node;
struct dom_nodelist;
struct dom_processing_instruction;
struct dom_string;
struct dom_text;
struct lwc_string_s;

typedef struct dom_document dom_document;

/* DOM Document vtable */
typedef struct dom_document_vtable {
	struct dom_node_vtable base;

	dom_exception (*dom_document_get_doctype)(struct dom_document *doc,
			struct dom_document_type **result);
	dom_exception (*dom_document_get_implementation)(
			struct dom_document *doc, 
			struct dom_implementation **result);
	dom_exception (*dom_document_get_document_element)(
			struct dom_document *doc, struct dom_element **result);
	dom_exception (*dom_document_create_element)(struct dom_document *doc,
			struct dom_string *tag_name, 
			struct dom_element **result);
	dom_exception (*dom_document_create_document_fragment)(
			struct dom_document *doc, 
			struct dom_document_fragment **result);
	dom_exception (*dom_document_create_text_node)(struct dom_document *doc,
			struct dom_string *data, struct dom_text **result);
	dom_exception (*dom_document_create_comment)(struct dom_document *doc,
			struct dom_string *data, struct dom_comment **result);
	dom_exception (*dom_document_create_cdata_section)(
			struct dom_document *doc, struct dom_string *data, 
			struct dom_cdata_section **result);
	dom_exception (*dom_document_create_processing_instruction)(
			struct dom_document *doc, struct dom_string *target,
			struct dom_string *data,
			struct dom_processing_instruction **result);
	dom_exception (*dom_document_create_attribute)(struct dom_document *doc,
			struct dom_string *name, struct dom_attr **result);
	dom_exception (*dom_document_create_entity_reference)(
			struct dom_document *doc, struct dom_string *name,
			struct dom_entity_reference **result);
	dom_exception (*dom_document_get_elements_by_tag_name)(
			struct dom_document *doc, struct dom_string *tagname, 
			struct dom_nodelist **result);
	dom_exception (*dom_document_import_node)(struct dom_document *doc,
			struct dom_node *node, bool deep, 
			struct dom_node **result);
	dom_exception (*dom_document_create_element_ns)(
			struct dom_document *doc, struct dom_string *namespace, 
			struct dom_string *qname, struct dom_element **result);
	dom_exception (*dom_document_create_attribute_ns)(
			struct dom_document *doc, struct dom_string *namespace, 
			struct dom_string *qname, struct dom_attr **result);
	dom_exception (*dom_document_get_elements_by_tag_name_ns)(
			struct dom_document *doc, struct dom_string *namespace,
			struct dom_string *localname, 
			struct dom_nodelist **result);
	dom_exception (*dom_document_get_element_by_id)(
			struct dom_document *doc, struct dom_string *id, 
			struct dom_element **result);
	dom_exception (*dom_document_get_input_encoding)(
			struct dom_document *doc, struct dom_string **result);
	dom_exception (*dom_document_get_xml_encoding)(struct dom_document *doc,
			struct dom_string **result);
	dom_exception (*dom_document_get_xml_standalone)(
			struct dom_document *doc, bool *result);
	dom_exception (*dom_document_set_xml_standalone)(
			struct dom_document *doc, bool standalone);
	dom_exception (*dom_document_get_xml_version)(struct dom_document *doc,
			struct dom_string **result);
	dom_exception (*dom_document_set_xml_version)(struct dom_document *doc,
			struct dom_string *version);
	dom_exception (*dom_document_get_strict_error_checking)(
			struct dom_document *doc, bool *result);
	dom_exception (*dom_document_set_strict_error_checking)(
			struct dom_document *doc, bool strict);
	dom_exception (*dom_document_get_uri)(struct dom_document *doc,
			struct dom_string **result);
	dom_exception (*dom_document_set_uri)(struct dom_document *doc,
			struct dom_string *uri);
	dom_exception (*dom_document_adopt_node)(struct dom_document *doc,
			struct dom_node *node, struct dom_node **result);
	dom_exception (*dom_document_get_dom_config)(struct dom_document *doc,
			struct dom_configuration **result);
	dom_exception (*dom_document_normalize)(struct dom_document *doc);
	dom_exception (*dom_document_rename_node)(struct dom_document *doc,
			struct dom_node *node, struct dom_string *namespace, 
			struct dom_string *qname, struct dom_node **result);
} dom_document_vtable;

static inline dom_exception dom_document_get_doctype(struct dom_document *doc,
		struct dom_document_type **result)
{
	return ((dom_document_vtable *) ((dom_node *) doc)->vtable)->
			dom_document_get_doctype(doc, result);
}
#define dom_document_get_doctype(d, r) dom_document_get_doctype( \
		(dom_document *) (d), (struct dom_document_type **) (r))

static inline dom_exception dom_document_get_implementation(
		struct dom_document *doc, struct dom_implementation **result)
{
	return ((dom_document_vtable *) ((dom_node *) doc)->vtable)->
			dom_document_get_implementation(doc, result);
}
#define dom_document_get_implementation(d, r) dom_document_get_implementation(\
		(dom_document *) (d), (struct dom_implementation **) (r))

static inline dom_exception dom_document_get_document_element(
		struct dom_document *doc, struct dom_element **result)
{
	return ((dom_document_vtable *) ((dom_node *) doc)->vtable)->
			dom_document_get_document_element(doc, result);
}
#define dom_document_get_document_element(d, r) \
		dom_document_get_document_element((dom_document *) (d), \
		(struct dom_element **) (r))

static inline dom_exception dom_document_create_element(
		struct dom_document *doc, struct dom_string *tag_name, 
		struct dom_element **result)
{
	return ((dom_document_vtable *) ((dom_node *) doc)->vtable)->
			dom_document_create_element(doc, tag_name, result);
}
#define dom_document_create_element(d, t, r) dom_document_create_element( \
		(dom_document *) (d), (struct dom_string *) (t), \
		(struct dom_element **) (r))

static inline dom_exception dom_document_create_document_fragment(
		struct dom_document *doc, 
		struct dom_document_fragment **result)
{
	return ((dom_document_vtable *) ((dom_node *) doc)->vtable)->
			dom_document_create_document_fragment(doc, result);
}
#define dom_document_create_document_fragment(d, r) \
		dom_document_create_document_fragment((dom_document *) (d), \
		(struct dom_document_fragment **) (r))

static inline dom_exception dom_document_create_text_node(
		struct dom_document *doc, struct dom_string *data, 
		struct dom_text **result)
{
	return ((dom_document_vtable *) ((dom_node *) doc)->vtable)->
			dom_document_create_text_node(doc, data, result);
}
#define dom_document_create_text_node(d, data, r) \
		dom_document_create_text_node((dom_document *) (d), \
		(struct dom_string *) (data), (struct dom_text **) (r))

static inline dom_exception dom_document_create_comment(
		struct dom_document *doc, struct dom_string *data, 
		struct dom_comment **result)
{
	return ((dom_document_vtable *) ((dom_node *) doc)->vtable)->
			dom_document_create_comment(doc, data, result);
}
#define dom_document_create_comment(d, data, r) dom_document_create_comment( \
		(dom_document *) (d), (struct dom_string *) (data), \
		(struct dom_comment **) (r))

static inline dom_exception dom_document_create_cdata_section(
		struct dom_document *doc, struct dom_string *data, 
		struct dom_cdata_section **result)
{
	return ((dom_document_vtable *) ((dom_node *) doc)->vtable)->
			dom_document_create_cdata_section(doc, data, result);
}
#define dom_document_create_cdata_section(d, data, r) \
		dom_document_create_cdata_section((dom_document *) (d), \
		(struct dom_string *) (data), \
		(struct dom_cdata_section **) (r))

static inline dom_exception dom_document_create_processing_instruction(
		struct dom_document *doc, struct dom_string *target,
		struct dom_string *data,
		struct dom_processing_instruction **result)
{
	return ((dom_document_vtable *) ((dom_node *) doc)->vtable)->
			dom_document_create_processing_instruction(doc, target,
			data, result);
}
#define dom_document_create_processing_instruction(d, t, data, r) \
		dom_document_create_processing_instruction( \
		(dom_document *) (d), (struct dom_string *) (t), \
		(struct dom_string *) (data), \
		(struct dom_processing_instruction **) (r))

static inline dom_exception dom_document_create_attribute(
		struct dom_document *doc, struct dom_string *name, 
		struct dom_attr **result)
{
	return ((dom_document_vtable *) ((dom_node *) doc)->vtable)->
			dom_document_create_attribute(doc, name, result);
}
#define dom_document_create_attribute(d, n, r) dom_document_create_attribute( \
		(dom_document *) (d), (struct dom_string *) (n), \
		(struct dom_attr **) (r))

static inline dom_exception dom_document_create_entity_reference(
		struct dom_document *doc, struct dom_string *name,
		struct dom_entity_reference **result)
{
	return ((dom_document_vtable *) ((dom_node *) doc)->vtable)->
			dom_document_create_entity_reference(doc, name, 
			result);
}
#define dom_document_create_entity_reference(d, n, r) \
		dom_document_create_entity_reference((dom_document *) (d), \
		(struct dom_string *) (n), (struct dom_entity_reference **) (r))

static inline dom_exception dom_document_get_elements_by_tag_name(
		struct dom_document *doc, struct dom_string *tagname, 
		struct dom_nodelist **result)
{
	return ((dom_document_vtable *) ((dom_node *) doc)->vtable)->
			dom_document_get_elements_by_tag_name(doc, tagname,
			result);
}
#define dom_document_get_elements_by_tag_name(d, t, r) \
		dom_document_get_elements_by_tag_name((dom_document *) (d), \
		(struct dom_string *) (t), (struct dom_nodelist **) (r))

static inline dom_exception dom_document_import_node(struct dom_document *doc,
		struct dom_node *node, bool deep, struct dom_node **result)
{
	return ((dom_document_vtable *) ((dom_node *) doc)->vtable)->
			dom_document_import_node(doc, node, deep, result);
}
#define dom_document_import_node(d, n, deep, r) dom_document_import_node( \
		(dom_document *) (d), (dom_node *) (n), (bool) deep, \
		(dom_node **) (r))

static inline dom_exception dom_document_create_element_ns(
		struct dom_document *doc, struct dom_string *namespace, 
		struct dom_string *qname, struct dom_element **result)
{
	return ((dom_document_vtable *) ((dom_node *) doc)->vtable)->
			dom_document_create_element_ns(doc, namespace,
			qname, result);
}
#define dom_document_create_element_ns(d, n, q, r) \
		dom_document_create_element_ns((dom_document *) (d), \
		(struct dom_string *) (n), (struct dom_string *) (q), \
		(struct dom_element **) (r))

static inline dom_exception dom_document_create_attribute_ns
		(struct dom_document *doc, struct dom_string *namespace, 
		struct dom_string *qname, struct dom_attr **result)
{
	return ((dom_document_vtable *) ((dom_node *) doc)->vtable)->
			dom_document_create_attribute_ns(doc, namespace,
			qname, result);
}
#define dom_document_create_attribute_ns(d, n, q, r) \
		dom_document_create_attribute_ns((dom_document *) (d), \
		(struct dom_string *) (n), (struct dom_string *) (q), \
		(struct dom_attr **) (r))

static inline dom_exception dom_document_get_elements_by_tag_name_ns(
		struct dom_document *doc, struct dom_string *namespace,
		struct dom_string *localname, struct dom_nodelist **result)
{
	return ((dom_document_vtable *) ((dom_node *) doc)->vtable)->
			dom_document_get_elements_by_tag_name_ns(doc,
			namespace, localname, result);
}
#define dom_document_get_elements_by_tag_name_ns(d, n, l, r) \
		dom_document_get_elements_by_tag_name_ns((dom_document *) (d),\
		(struct dom_string *) (n), (struct dom_string *) (l), \
		(struct dom_nodelist **) (r))

static inline dom_exception dom_document_get_element_by_id(
		struct dom_document *doc, struct dom_string *id, 
		struct dom_element **result)
{
	return ((dom_document_vtable *) ((dom_node *) doc)->vtable)->
			dom_document_get_element_by_id(doc, id, result);
}
#define dom_document_get_element_by_id(d, i, r) \
		dom_document_get_element_by_id((dom_document *) (d), \
		(struct dom_string *) (i), (struct dom_element **) (r))

static inline dom_exception dom_document_get_input_encoding(
		struct dom_document *doc, struct dom_string **result)
{
	return ((dom_document_vtable *) ((dom_node *) doc)->vtable)->
			dom_document_get_input_encoding(doc, result);
}
#define dom_document_get_input_encoding(d, r) dom_document_get_input_encoding(\
		(dom_document *) (d), (struct dom_string **) (r))

static inline dom_exception dom_document_get_xml_encoding(
		struct dom_document *doc, struct dom_string **result)
{
	return ((dom_document_vtable *) ((dom_node *) doc)->vtable)->
			dom_document_get_xml_encoding(doc, result);
}
#define dom_document_get_xml_encoding(d, r) dom_document_get_xml_encoding( \
		(dom_document *) (d), (struct dom_string **) (r))

static inline dom_exception dom_document_get_xml_standalone(
		struct dom_document *doc, bool *result)
{
	return ((dom_document_vtable *) ((dom_node *) doc)->vtable)->
			dom_document_get_xml_standalone(doc, result);
}
#define dom_document_get_xml_standalone(d, r) dom_document_get_xml_standalone(\
		(dom_document *) (d), (bool *) (r))

static inline dom_exception dom_document_set_xml_standalone(
		struct dom_document *doc, bool standalone)
{
	return ((dom_document_vtable *) ((dom_node *) doc)->vtable)->
			dom_document_set_xml_standalone(doc, standalone);
}
#define dom_document_set_xml_standalone(d, s) dom_document_set_xml_standalone(\
		(dom_document *) (d), (bool) (s))

static inline dom_exception dom_document_get_xml_version(
		struct dom_document *doc, struct dom_string **result)
{
	return ((dom_document_vtable *) ((dom_node *) doc)->vtable)->
			dom_document_get_xml_version(doc, result);
}
#define dom_document_get_xml_version(d, r) dom_document_get_xml_version( \
		(dom_document *) (d), (struct dom_string **) (r))

static inline dom_exception dom_document_set_xml_version(
		struct dom_document *doc, struct dom_string *version)
{
	return ((dom_document_vtable *) ((dom_node *) doc)->vtable)->
			dom_document_set_xml_version(doc, version);
}
#define dom_document_set_xml_version(d, v) dom_document_set_xml_version( \
		(dom_document *) (d), (struct dom_string *) (v))

static inline dom_exception dom_document_get_strict_error_checking(
		struct dom_document *doc, bool *result)
{
	return ((dom_document_vtable *) ((dom_node *) doc)->vtable)->
			dom_document_get_strict_error_checking(doc, result);
}
#define dom_document_get_strict_error_checking(d, r) \
		dom_document_get_strict_error_checking((dom_document *) (d), \
		(bool *) (r))

static inline dom_exception dom_document_set_strict_error_checking(
		struct dom_document *doc, bool strict)
{
	return ((dom_document_vtable *) ((dom_node *) doc)->vtable)->
			dom_document_set_strict_error_checking(doc, strict);
}
#define dom_document_set_strict_error_checking(d, s) \
		dom_document_set_strict_error_checking((dom_document *) (d), \
		(bool) (s))

static inline dom_exception dom_document_get_uri(struct dom_document *doc,
		struct dom_string **result)
{
	return ((dom_document_vtable *) ((dom_node *) doc)->vtable)->
			dom_document_get_uri(doc, result);
}
#define dom_document_get_uri(d, r) dom_document_get_uri((dom_document *) (d), \
		(struct dom_string **) (r))

static inline dom_exception dom_document_set_uri(struct dom_document *doc,
		struct dom_string *uri)
{
	return ((dom_document_vtable *) ((dom_node *) doc)->vtable)->
			dom_document_set_uri(doc, uri);
}
#define dom_document_set_uri(d, u) dom_document_set_uri((dom_document *) (d), \
		(struct dom_string *) (u))

static inline dom_exception dom_document_adopt_node(struct dom_document *doc,
		struct dom_node *node, struct dom_node **result)
{
	return ((dom_document_vtable *) ((dom_node *) doc)->vtable)->
			dom_document_adopt_node(doc, node, result);
}
#define dom_document_adopt_node(d, n, r) dom_document_adopt_node( \
		(dom_document *) (d), (dom_node *) (n), (dom_node **) (r))

static inline dom_exception dom_document_get_dom_config(
		struct dom_document *doc, struct dom_configuration **result)
{
	return ((dom_document_vtable *) ((dom_node *) doc)->vtable)->
			dom_document_get_dom_config(doc, result);
}
#define dom_document_get_dom_config(d, r) dom_document_get_dom_config( \
		(dom_document *) (d), (struct dom_configuration **) (r))

static inline dom_exception dom_document_normalize(struct dom_document *doc)
{
	return ((dom_document_vtable *) ((dom_node *) doc)->vtable)->
			dom_document_normalize(doc);
}
#define dom_document_normalize(d) dom_document_normalize((dom_document *) (d))

static inline dom_exception dom_document_rename_node(struct dom_document *doc,
		struct dom_node *node,
		struct dom_string *namespace, struct dom_string *qname,
		struct dom_node **result)
{
	return ((dom_document_vtable *) ((dom_node *) doc)->vtable)->
			dom_document_rename_node(doc, node, namespace, qname,
			result);
}
#define dom_document_rename_node(d, n, ns, q, r) dom_document_rename_node( \
		(dom_document *) (d), (struct dom_string *) (ns), \
		(struct dom_string *) (q), (dom_node **) (r))

#endif