-
Notifications
You must be signed in to change notification settings - Fork 5
/
mxml.xml
1627 lines (1523 loc) · 57.1 KB
/
mxml.xml
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
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="utf-8"?>
<mxmldoc xmlns="http://www.easysw.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.minixml.org/mxmldoc.xsd">
<function name="mxmlAdd">
<description>Add a node to a tree.
Adds the specified node to the parent. If the child argument is not
NULL, puts the new node before or after the specified child depending
on the value of the where argument. If the child argument is NULL,
puts the new node at the beginning of the child list (MXML_ADD_BEFORE)
or at the end of the child list (MXML_ADD_AFTER). The constant
MXML_ADD_TO_PARENT can be used to specify a NULL child pointer.</description>
<argument name="parent" direction="I">
<type>mxml_node_t *</type>
<description>Parent node</description>
</argument>
<argument name="where" direction="I">
<type>int</type>
<description>Where to add, MXML_ADD_BEFORE or MXML_ADD_AFTER</description>
</argument>
<argument name="child" direction="I">
<type>mxml_node_t *</type>
<description>Child node for where or MXML_ADD_TO_PARENT</description>
</argument>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to add</description>
</argument>
</function>
<function name="mxmlDelete">
<description>Delete a node and all of its children.
If the specified node has a parent, this function first removes the
node from its parent using the mxmlRemove() function.</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to delete</description>
</argument>
</function>
<function name="mxmlElementDeleteAttr">
<description>Delete an attribute.
@since Mini-XML 2.4@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Element</description>
</argument>
<argument name="name" direction="I">
<type>const char *</type>
<description>Attribute name</description>
</argument>
</function>
<function name="mxmlElementGetAttr">
<returnvalue>
<type>const char *</type>
<description>Attribute value or NULL</description>
</returnvalue>
<description>Get an attribute.
This function returns NULL if the node is not an element or the
named attribute does not exist.</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Element node</description>
</argument>
<argument name="name" direction="I">
<type>const char *</type>
<description>Name of attribute</description>
</argument>
</function>
<function name="mxmlElementSetAttr">
<description>Set an attribute.
If the named attribute already exists, the value of the attribute
is replaced by the new string value. The string value is copied
into the element node. This function does nothing if the node is
not an element.</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Element node</description>
</argument>
<argument name="name" direction="I">
<type>const char *</type>
<description>Name of attribute</description>
</argument>
<argument name="value" direction="I">
<type>const char *</type>
<description>Attribute value</description>
</argument>
</function>
<function name="mxmlElementSetAttrf">
<description>Set an attribute with a formatted value.
If the named attribute already exists, the value of the attribute
is replaced by the new formatted string. The formatted string value is
copied into the element node. This function does nothing if the node
is not an element.
@since Mini-XML 2.3@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Element node</description>
</argument>
<argument name="name" direction="I">
<type>const char *</type>
<description>Name of attribute</description>
</argument>
<argument name="format" direction="I">
<type>const char *</type>
<description>Printf-style attribute value</description>
</argument>
<argument name="..." direction="I">
<type /> <description>Additional arguments as needed</description>
</argument>
</function>
<function name="mxmlEntityAddCallback">
<returnvalue>
<type>int</type>
<description>0 on success, -1 on failure</description>
</returnvalue>
<description>Add a callback to convert entities to Unicode.</description>
<argument name="cb" direction="I">
<type>mxml_entity_cb_t</type>
<description>Callback function to add</description>
</argument>
</function>
<function name="mxmlEntityGetName">
<returnvalue>
<type>const char *</type>
<description>Entity name or NULL</description>
</returnvalue>
<description>Get the name that corresponds to the character value.
If val does not need to be represented by a named entity, NULL is returned.</description>
<argument name="val" direction="I">
<type>int</type>
<description>Character value</description>
</argument>
</function>
<function name="mxmlEntityGetValue">
<returnvalue>
<type>int</type>
<description>Character value or -1 on error</description>
</returnvalue>
<description>Get the character corresponding to a named entity.
The entity name can also be a numeric constant. -1 is returned if the
name is not known.</description>
<argument name="name" direction="I">
<type>const char *</type>
<description>Entity name</description>
</argument>
</function>
<function name="mxmlEntityRemoveCallback">
<description>Remove a callback.</description>
<argument name="cb" direction="I">
<type>mxml_entity_cb_t</type>
<description>Callback function to remove</description>
</argument>
</function>
<function name="mxmlFindElement">
<returnvalue>
<type>mxml_node_t *</type>
<description>Element node or NULL</description>
</returnvalue>
<description>Find the named element.
The search is constrained by the name, attribute name, and value; any
NULL names or values are treated as wildcards, so different kinds of
searches can be implemented by looking for all elements of a given name
or all elements with a specific attribute. The descend argument determines
whether the search descends into child nodes; normally you will use
MXML_DESCEND_FIRST for the initial search and MXML_NO_DESCEND to find
additional direct descendents of the node. The top node argument
constrains the search to a particular node's children.</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Current node</description>
</argument>
<argument name="top" direction="I">
<type>mxml_node_t *</type>
<description>Top node</description>
</argument>
<argument name="name" direction="I">
<type>const char *</type>
<description>Element name or NULL for any</description>
</argument>
<argument name="attr" direction="I">
<type>const char *</type>
<description>Attribute name, or NULL for none</description>
</argument>
<argument name="value" direction="I">
<type>const char *</type>
<description>Attribute value, or NULL for any</description>
</argument>
<argument name="descend" direction="I">
<type>int</type>
<description>Descend into tree - MXML_DESCEND, MXML_NO_DESCEND, or MXML_DESCEND_FIRST</description>
</argument>
</function>
<function name="mxmlFindPath">
<returnvalue>
<type>mxml_node_t *</type>
<description>Found node or NULL</description>
</returnvalue>
<description>Find a node with the given path.
The "path" is a slash-separated list of element names. The name "*" is
considered a wildcard for one or more levels of elements. For example,
"foo/one/two", "bar/two/one", "*/one", and so forth.
The first child node of the found node is returned if the given node has
children and the first child is a value node.
@since Mini-XML 2.7@</description>
<argument name="top" direction="I">
<type>mxml_node_t *</type>
<description>Top node</description>
</argument>
<argument name="path" direction="I">
<type>const char *</type>
<description>Path to element</description>
</argument>
</function>
<function name="mxmlGetCDATA">
<returnvalue>
<type>const char *</type>
<description>CDATA value or NULL</description>
</returnvalue>
<description>Get the value for a CDATA node.
@code NULL@ is returned if the node is not a CDATA element.
@since Mini-XML 2.7@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to get</description>
</argument>
</function>
<function name="mxmlGetCustom">
<returnvalue>
<type>const void *</type>
<description>Custom value or NULL</description>
</returnvalue>
<description>Get the value for a custom node.
@code NULL@ is returned if the node (or its first child) is not a custom
value node.
@since Mini-XML 2.7@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to get</description>
</argument>
</function>
<function name="mxmlGetElement">
<returnvalue>
<type>const char *</type>
<description>Element name or NULL</description>
</returnvalue>
<description>Get the name for an element node.
@code NULL@ is returned if the node is not an element node.
@since Mini-XML 2.7@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to get</description>
</argument>
</function>
<function name="mxmlGetFirstChild">
<returnvalue>
<type>mxml_node_t *</type>
<description>First child or NULL</description>
</returnvalue>
<description>Get the first child of an element node.
@code NULL@ is returned if the node is not an element node or if the node
has no children.
@since Mini-XML 2.7@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to get</description>
</argument>
</function>
<function name="mxmlGetInteger">
<returnvalue>
<type>int</type>
<description>Integer value or 0</description>
</returnvalue>
<description>Get the integer value from the specified node or its
first child.
0 is returned if the node (or its first child) is not an integer value node.
@since Mini-XML 2.7@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to get</description>
</argument>
</function>
<function name="mxmlGetLastChild">
<returnvalue>
<type>mxml_node_t *</type>
<description>Last child or NULL</description>
</returnvalue>
<description>Get the last child of an element node.
@code NULL@ is returned if the node is not an element node or if the node
has no children.
@since Mini-XML 2.7@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to get</description>
</argument>
</function>
<function name="mxmlGetNextSibling">
<returnvalue>
<type>mxml_node_t *</type>
<description>Get the next node for the current parent.
@code NULL@ is returned if this is the last child for the current parent.
@since Mini-XML 2.7@</description>
</returnvalue>
<description>Return the node type...</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to get</description>
</argument>
</function>
<function name="mxmlGetOpaque">
<returnvalue>
<type>const char *</type>
<description>Opaque string or NULL</description>
</returnvalue>
<description>Get an opaque string value for a node or its first child.
@code NULL@ is returned if the node (or its first child) is not an opaque
value node.
@since Mini-XML 2.7@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to get</description>
</argument>
</function>
<function name="mxmlGetParent">
<returnvalue>
<type>mxml_node_t *</type>
<description>Parent node or NULL</description>
</returnvalue>
<description>Get the parent node.
@code NULL@ is returned for a root node.
@since Mini-XML 2.7@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to get</description>
</argument>
</function>
<function name="mxmlGetPrevSibling">
<returnvalue>
<type>mxml_node_t *</type>
<description>Previous node or NULL</description>
</returnvalue>
<description>Get the previous node for the current parent.
@code NULL@ is returned if this is the first child for the current parent.
@since Mini-XML 2.7@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to get</description>
</argument>
</function>
<function name="mxmlGetReal">
<returnvalue>
<type>double</type>
<description>Real value or 0.0</description>
</returnvalue>
<description>Get the real value for a node or its first child.
0.0 is returned if the node (or its first child) is not a real value node.
@since Mini-XML 2.7@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to get</description>
</argument>
</function>
<function name="mxmlGetRefCount">
<returnvalue>
<type>int</type>
<description>Reference count</description>
</returnvalue>
<description>Get the current reference (use) count for a node.
The initial reference count of new nodes is 1. Use the @link mxmlRetain@
and @link mxmlRelease@ functions to increment and decrement a node's
reference count.
@since Mini-XML 2.7@.</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node</description>
</argument>
</function>
<function name="mxmlGetText">
<returnvalue>
<type>const char *</type>
<description>Text string or NULL</description>
</returnvalue>
<description>Get the text value for a node or its first child.
@code NULL@ is returned if the node (or its first child) is not a text node.
The "whitespace" argument can be NULL.
@since Mini-XML 2.7@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to get</description>
</argument>
<argument name="whitespace" direction="O">
<type>int *</type>
<description>1 if string is preceded by whitespace, 0 otherwise</description>
</argument>
</function>
<function name="mxmlGetType">
<returnvalue>
<type>mxml_type_t</type>
<description>Type of node</description>
</returnvalue>
<description>Get the node type.
@code MXML_IGNORE@ is returned if "node" is @code NULL@.
@since Mini-XML 2.7@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to get</description>
</argument>
</function>
<function name="mxmlGetUserData">
<returnvalue>
<type>void *</type>
<description>User data pointer</description>
</returnvalue>
<description>Get the user data pointer for a node.
@since Mini-XML 2.7@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to get</description>
</argument>
</function>
<function name="mxmlIndexDelete">
<description>Delete an index.</description>
<argument name="ind" direction="I">
<type>mxml_index_t *</type>
<description>Index to delete</description>
</argument>
</function>
<function name="mxmlIndexEnum">
<returnvalue>
<type>mxml_node_t *</type>
<description>Next node or NULL if there is none</description>
</returnvalue>
<description>Return the next node in the index.
Nodes are returned in the sorted order of the index.</description>
<argument name="ind" direction="I">
<type>mxml_index_t *</type>
<description>Index to enumerate</description>
</argument>
</function>
<function name="mxmlIndexFind">
<returnvalue>
<type>mxml_node_t *</type>
<description>Node or NULL if none found</description>
</returnvalue>
<description>Find the next matching node.
You should call mxmlIndexReset() prior to using this function for
the first time with a particular set of "element" and "value"
strings. Passing NULL for both "element" and "value" is equivalent
to calling mxmlIndexEnum().</description>
<argument name="ind" direction="I">
<type>mxml_index_t *</type>
<description>Index to search</description>
</argument>
<argument name="element" direction="I">
<type>const char *</type>
<description>Element name to find, if any</description>
</argument>
<argument name="value" direction="I">
<type>const char *</type>
<description>Attribute value, if any</description>
</argument>
</function>
<function name="mxmlIndexGetCount">
<returnvalue>
<type>int</type>
<description>Number of nodes in index</description>
</returnvalue>
<description>Get the number of nodes in an index.
@since Mini-XML 2.7@</description>
<argument name="ind" direction="I">
<type>mxml_index_t *</type>
<description>Index of nodes</description>
</argument>
</function>
<function name="mxmlIndexNew">
<returnvalue>
<type>mxml_index_t *</type>
<description>New index</description>
</returnvalue>
<description>Create a new index.
The index will contain all nodes that contain the named element and/or
attribute. If both "element" and "attr" are NULL, then the index will
contain a sorted list of the elements in the node tree. Nodes are
sorted by element name and optionally by attribute value if the "attr"
argument is not NULL.</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>XML node tree</description>
</argument>
<argument name="element" direction="I">
<type>const char *</type>
<description>Element to index or NULL for all</description>
</argument>
<argument name="attr" direction="I">
<type>const char *</type>
<description>Attribute to index or NULL for none</description>
</argument>
</function>
<function name="mxmlIndexReset">
<returnvalue>
<type>mxml_node_t *</type>
<description>First node or NULL if there is none</description>
</returnvalue>
<description>Reset the enumeration/find pointer in the index and
return the first node in the index.
This function should be called prior to using mxmlIndexEnum() or
mxmlIndexFind() for the first time.</description>
<argument name="ind" direction="I">
<type>mxml_index_t *</type>
<description>Index to reset</description>
</argument>
</function>
<function name="mxmlLoadFd">
<returnvalue>
<type>mxml_node_t *</type>
<description>First node or NULL if the file could not be read.</description>
</returnvalue>
<description>Load a file descriptor into an XML node tree.
The nodes in the specified file are added to the specified top node.
If no top node is provided, the XML file MUST be well-formed with a
single parent node like <?xml> for the entire file. The callback
function returns the value type that should be used for child nodes.
If MXML_NO_CALLBACK is specified then all child nodes will be either
MXML_ELEMENT or MXML_TEXT nodes.
The constants MXML_INTEGER_CALLBACK, MXML_OPAQUE_CALLBACK,
MXML_REAL_CALLBACK, and MXML_TEXT_CALLBACK are defined for loading
child nodes of the specified type.</description>
<argument name="top" direction="I">
<type>mxml_node_t *</type>
<description>Top node</description>
</argument>
<argument name="fd" direction="I">
<type>int</type>
<description>File descriptor to read from</description>
</argument>
<argument name="cb" direction="I">
<type>mxml_load_cb_t</type>
<description>Callback function or MXML_NO_CALLBACK</description>
</argument>
</function>
<function name="mxmlLoadFile">
<returnvalue>
<type>mxml_node_t *</type>
<description>First node or NULL if the file could not be read.</description>
</returnvalue>
<description>Load a file into an XML node tree.
The nodes in the specified file are added to the specified top node.
If no top node is provided, the XML file MUST be well-formed with a
single parent node like <?xml> for the entire file. The callback
function returns the value type that should be used for child nodes.
If MXML_NO_CALLBACK is specified then all child nodes will be either
MXML_ELEMENT or MXML_TEXT nodes.
The constants MXML_INTEGER_CALLBACK, MXML_OPAQUE_CALLBACK,
MXML_REAL_CALLBACK, and MXML_TEXT_CALLBACK are defined for loading
child nodes of the specified type.</description>
<argument name="top" direction="I">
<type>mxml_node_t *</type>
<description>Top node</description>
</argument>
<argument name="fp" direction="I">
<type>FILE *</type>
<description>File to read from</description>
</argument>
<argument name="cb" direction="I">
<type>mxml_load_cb_t</type>
<description>Callback function or MXML_NO_CALLBACK</description>
</argument>
</function>
<function name="mxmlLoadString">
<returnvalue>
<type>mxml_node_t *</type>
<description>First node or NULL if the string has errors.</description>
</returnvalue>
<description>Load a string into an XML node tree.
The nodes in the specified string are added to the specified top node.
If no top node is provided, the XML string MUST be well-formed with a
single parent node like <?xml> for the entire string. The callback
function returns the value type that should be used for child nodes.
If MXML_NO_CALLBACK is specified then all child nodes will be either
MXML_ELEMENT or MXML_TEXT nodes.
The constants MXML_INTEGER_CALLBACK, MXML_OPAQUE_CALLBACK,
MXML_REAL_CALLBACK, and MXML_TEXT_CALLBACK are defined for loading
child nodes of the specified type.</description>
<argument name="top" direction="I">
<type>mxml_node_t *</type>
<description>Top node</description>
</argument>
<argument name="s" direction="I">
<type>const char *</type>
<description>String to load</description>
</argument>
<argument name="cb" direction="I">
<type>mxml_load_cb_t</type>
<description>Callback function or MXML_NO_CALLBACK</description>
</argument>
</function>
<function name="mxmlNewCDATA">
<returnvalue>
<type>mxml_node_t *</type>
<description>New node</description>
</returnvalue>
<description>Create a new CDATA node.
The new CDATA node is added to the end of the specified parent's child
list. The constant MXML_NO_PARENT can be used to specify that the new
CDATA node has no parent. The data string must be nul-terminated and
is copied into the new node. CDATA nodes use the MXML_ELEMENT type.
@since Mini-XML 2.3@</description>
<argument name="parent" direction="I">
<type>mxml_node_t *</type>
<description>Parent node or MXML_NO_PARENT</description>
</argument>
<argument name="data" direction="I">
<type>const char *</type>
<description>Data string</description>
</argument>
</function>
<function name="mxmlNewCustom">
<returnvalue>
<type>mxml_node_t *</type>
<description>New node</description>
</returnvalue>
<description>Create a new custom data node.
The new custom node is added to the end of the specified parent's child
list. The constant MXML_NO_PARENT can be used to specify that the new
element node has no parent. NULL can be passed when the data in the
node is not dynamically allocated or is separately managed.
@since Mini-XML 2.1@</description>
<argument name="parent" direction="I">
<type>mxml_node_t *</type>
<description>Parent node or MXML_NO_PARENT</description>
</argument>
<argument name="data" direction="I">
<type>void *</type>
<description>Pointer to data</description>
</argument>
<argument name="destroy" direction="I">
<type>mxml_custom_destroy_cb_t</type>
<description>Function to destroy data</description>
</argument>
</function>
<function name="mxmlNewElement">
<returnvalue>
<type>mxml_node_t *</type>
<description>New node</description>
</returnvalue>
<description>Create a new element node.
The new element node is added to the end of the specified parent's child
list. The constant MXML_NO_PARENT can be used to specify that the new
element node has no parent.</description>
<argument name="parent" direction="I">
<type>mxml_node_t *</type>
<description>Parent node or MXML_NO_PARENT</description>
</argument>
<argument name="name" direction="I">
<type>const char *</type>
<description>Name of element</description>
</argument>
</function>
<function name="mxmlNewInteger">
<returnvalue>
<type>mxml_node_t *</type>
<description>New node</description>
</returnvalue>
<description>Create a new integer node.
The new integer node is added to the end of the specified parent's child
list. The constant MXML_NO_PARENT can be used to specify that the new
integer node has no parent.</description>
<argument name="parent" direction="I">
<type>mxml_node_t *</type>
<description>Parent node or MXML_NO_PARENT</description>
</argument>
<argument name="integer" direction="I">
<type>int</type>
<description>Integer value</description>
</argument>
</function>
<function name="mxmlNewOpaque">
<returnvalue>
<type>mxml_node_t *</type>
<description>New node</description>
</returnvalue>
<description>Create a new opaque string.
The new opaque node is added to the end of the specified parent's child
list. The constant MXML_NO_PARENT can be used to specify that the new
opaque node has no parent. The opaque string must be nul-terminated and
is copied into the new node.</description>
<argument name="parent" direction="I">
<type>mxml_node_t *</type>
<description>Parent node or MXML_NO_PARENT</description>
</argument>
<argument name="opaque" direction="I">
<type>const char *</type>
<description>Opaque string</description>
</argument>
</function>
<function name="mxmlNewReal">
<returnvalue>
<type>mxml_node_t *</type>
<description>New node</description>
</returnvalue>
<description>Create a new real number node.
The new real number node is added to the end of the specified parent's
child list. The constant MXML_NO_PARENT can be used to specify that
the new real number node has no parent.</description>
<argument name="parent" direction="I">
<type>mxml_node_t *</type>
<description>Parent node or MXML_NO_PARENT</description>
</argument>
<argument name="real" direction="I">
<type>double</type>
<description>Real number value</description>
</argument>
</function>
<function name="mxmlNewText">
<returnvalue>
<type>mxml_node_t *</type>
<description>New node</description>
</returnvalue>
<description>Create a new text fragment node.
The new text node is added to the end of the specified parent's child
list. The constant MXML_NO_PARENT can be used to specify that the new
text node has no parent. The whitespace parameter is used to specify
whether leading whitespace is present before the node. The text
string must be nul-terminated and is copied into the new node.</description>
<argument name="parent" direction="I">
<type>mxml_node_t *</type>
<description>Parent node or MXML_NO_PARENT</description>
</argument>
<argument name="whitespace" direction="I">
<type>int</type>
<description>1 = leading whitespace, 0 = no whitespace</description>
</argument>
<argument name="string" direction="I">
<type>const char *</type>
<description>String</description>
</argument>
</function>
<function name="mxmlNewTextf">
<returnvalue>
<type>mxml_node_t *</type>
<description>New node</description>
</returnvalue>
<description>Create a new formatted text fragment node.
The new text node is added to the end of the specified parent's child
list. The constant MXML_NO_PARENT can be used to specify that the new
text node has no parent. The whitespace parameter is used to specify
whether leading whitespace is present before the node. The format
string must be nul-terminated and is formatted into the new node.</description>
<argument name="parent" direction="I">
<type>mxml_node_t *</type>
<description>Parent node or MXML_NO_PARENT</description>
</argument>
<argument name="whitespace" direction="I">
<type>int</type>
<description>1 = leading whitespace, 0 = no whitespace</description>
</argument>
<argument name="format" direction="I">
<type>const char *</type>
<description>Printf-style frmat string</description>
</argument>
<argument name="..." direction="I">
<type /> <description>Additional args as needed</description>
</argument>
</function>
<function name="mxmlNewXML">
<returnvalue>
<type>mxml_node_t *</type>
<description>New ?xml node</description>
</returnvalue>
<description>Create a new XML document tree.
The "version" argument specifies the version number to put in the
?xml element node. If NULL, version 1.0 is assumed.
@since Mini-XML 2.3@</description>
<argument name="version" direction="I">
<type>const char *</type>
<description>Version number to use</description>
</argument>
</function>
<function name="mxmlRelease">
<returnvalue>
<type>int</type>
<description>New reference count</description>
</returnvalue>
<description>Release a node.
When the reference count reaches zero, the node (and any children)
is deleted via mxmlDelete().
@since Mini-XML 2.3@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node</description>
</argument>
</function>
<function name="mxmlRemove">
<description>Remove a node from its parent.
Does not free memory used by the node - use mxmlDelete() for that.
This function does nothing if the node has no parent.</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node to remove</description>
</argument>
</function>
<function name="mxmlRetain">
<returnvalue>
<type>int</type>
<description>New reference count</description>
</returnvalue>
<description>Retain a node.
@since Mini-XML 2.3@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node</description>
</argument>
</function>
<function name="mxmlSAXLoadFd">
<returnvalue>
<type>mxml_node_t *</type>
<description>First node or NULL if the file could not be read.</description>
</returnvalue>
<description>Load a file descriptor into an XML node tree
using a SAX callback.
The nodes in the specified file are added to the specified top node.
If no top node is provided, the XML file MUST be well-formed with a
single parent node like <?xml> for the entire file. The callback
function returns the value type that should be used for child nodes.
If MXML_NO_CALLBACK is specified then all child nodes will be either
MXML_ELEMENT or MXML_TEXT nodes.
The constants MXML_INTEGER_CALLBACK, MXML_OPAQUE_CALLBACK,
MXML_REAL_CALLBACK, and MXML_TEXT_CALLBACK are defined for loading
child nodes of the specified type.
The SAX callback must call mxmlRetain() for any nodes that need to
be kept for later use. Otherwise, nodes are deleted when the parent
node is closed or after each data, comment, CDATA, or directive node.
@since Mini-XML 2.3@</description>
<argument name="top" direction="I">
<type>mxml_node_t *</type>
<description>Top node</description>
</argument>
<argument name="fd" direction="I">
<type>int</type>
<description>File descriptor to read from</description>
</argument>
<argument name="cb" direction="I">
<type>mxml_load_cb_t</type>
<description>Callback function or MXML_NO_CALLBACK</description>
</argument>
<argument name="sax_cb" direction="I">
<type>mxml_sax_cb_t</type>
<description>SAX callback or MXML_NO_CALLBACK</description>
</argument>
<argument name="sax_data" direction="I">
<type>void *</type>
<description>SAX user data</description>
</argument>
</function>
<function name="mxmlSAXLoadFile">
<returnvalue>
<type>mxml_node_t *</type>
<description>First node or NULL if the file could not be read.</description>
</returnvalue>
<description>Load a file into an XML node tree
using a SAX callback.
The nodes in the specified file are added to the specified top node.
If no top node is provided, the XML file MUST be well-formed with a
single parent node like <?xml> for the entire file. The callback
function returns the value type that should be used for child nodes.
If MXML_NO_CALLBACK is specified then all child nodes will be either
MXML_ELEMENT or MXML_TEXT nodes.
The constants MXML_INTEGER_CALLBACK, MXML_OPAQUE_CALLBACK,
MXML_REAL_CALLBACK, and MXML_TEXT_CALLBACK are defined for loading
child nodes of the specified type.
The SAX callback must call mxmlRetain() for any nodes that need to
be kept for later use. Otherwise, nodes are deleted when the parent
node is closed or after each data, comment, CDATA, or directive node.
@since Mini-XML 2.3@</description>
<argument name="top" direction="I">
<type>mxml_node_t *</type>
<description>Top node</description>
</argument>
<argument name="fp" direction="I">
<type>FILE *</type>
<description>File to read from</description>
</argument>
<argument name="cb" direction="I">
<type>mxml_load_cb_t</type>
<description>Callback function or MXML_NO_CALLBACK</description>
</argument>
<argument name="sax_cb" direction="I">
<type>mxml_sax_cb_t</type>
<description>SAX callback or MXML_NO_CALLBACK</description>
</argument>
<argument name="sax_data" direction="I">
<type>void *</type>
<description>SAX user data</description>
</argument>
</function>
<function name="mxmlSAXLoadString">
<returnvalue>
<type>mxml_node_t *</type>
<description>First node or NULL if the string has errors.</description>
</returnvalue>
<description>Load a string into an XML node tree
using a SAX callback.
The nodes in the specified string are added to the specified top node.
If no top node is provided, the XML string MUST be well-formed with a
single parent node like <?xml> for the entire string. The callback
function returns the value type that should be used for child nodes.
If MXML_NO_CALLBACK is specified then all child nodes will be either
MXML_ELEMENT or MXML_TEXT nodes.
The constants MXML_INTEGER_CALLBACK, MXML_OPAQUE_CALLBACK,
MXML_REAL_CALLBACK, and MXML_TEXT_CALLBACK are defined for loading
child nodes of the specified type.
The SAX callback must call mxmlRetain() for any nodes that need to
be kept for later use. Otherwise, nodes are deleted when the parent
node is closed or after each data, comment, CDATA, or directive node.
@since Mini-XML 2.3@</description>
<argument name="top" direction="I">
<type>mxml_node_t *</type>
<description>Top node</description>
</argument>
<argument name="s" direction="I">
<type>const char *</type>
<description>String to load</description>
</argument>