Zen API

- Home
- Topics
- Types
- Files

All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kXml.h
Go to the documentation of this file.
1
10 #ifndef K_API_XML_H
11 #define K_API_XML_H
12
13 #include <kApi/kApiDef.h>
14
15 kBeginHeader()
16
17
27 //typedef kObject kXml; --forward-declared in kApiDef.x.h
28
29
35 //typedef kPointer kXmlItem; --forward-declared in kApiDef.x.h
36
37
47 kFx(kStatus) kXml_Construct(kXml* xml, kAlloc allocator);
48
57 kFx(kStatus) kXml_FromString(kXml xml, kString str);
58
67 kFx(kStatus) kXml_ToString(kXml xml, kString str);
68
79 kFx(kStatus) kXml_SaveBytes(kXml xml, kByte** data, kSize* size, kAlloc allocator);
80
91 kFx(kStatus) kXml_LoadBytes(kXml* xml, const kByte* data, kSize size, kAlloc allocator);
92
102 kFx(kStatus) kXml_Load(kXml* xml, const kChar* fileName, kAlloc allocator);
103
112 kFx(kStatus) kXml_Read(kXml xml, kStream stream);
113
122 kFx(kStatus) kXml_Write(kXml xml, kStream stream);
123
133 kFx(kStatus) kXml_FromText(kXml* xml, const kChar* str, kAlloc allocator);
134
144 kFx(kStatus) kXml_Compact(kXml xml);
145
154 kFx(kStatus) kXml_Save(kXml xml, const kChar* fileName);
155
163 kFx(kStatus) kXml_Clear(kXml xml);
164
173 kFx(kStatus) kXml_Assign(kXml xml, kXml source);
174
182 kFx(kXmlItem) kXml_Root(kXml xml);
183
193 kFx(kXmlItem) kXml_Child(kXml xml, kXmlItem parent, const kChar* path);
194
203 kFx(kXmlItem) kXml_Parent(kXml xml, kXmlItem item);
204
213 kFx(kXmlItem) kXml_FirstChild(kXml xml, kXmlItem parent);
214
223 kFx(kXmlItem) kXml_LastChild(kXml xml, kXmlItem parent);
224
233 kFx(kXmlItem) kXml_NextSibling(kXml xml, kXmlItem item);
234
243 kFx(kXmlItem) kXml_PreviousSibling(kXml xml, kXmlItem item);
244
253 kFx(kStatus) kXml_FindRoot(kXml xml, kXmlItem* root);
254
265 kFx(kStatus) kXml_FindChild(kXml xml, kXmlItem parent, const kChar* path, kXmlItem* child);
266
276 kFx(kBool) kXml_ChildExists(kXml xml, kXmlItem parent, const kChar* path);
277
286 kFx(kSize) kXml_ChildCount(kXml xml, kXmlItem parent);
287
298 kFx(kXmlItem) kXml_ChildAt(kXml xml, kXmlItem parent, kSize index);
299
313 kFx(kStatus) kXml_EnsureChildExists(kXml xml, kXmlItem parent, const kChar* path, kXmlItem* item);
314
323 kFx(kStatus) kXml_DeleteChildren(kXml xml, kXmlItem item);
324
335 kFx(kStatus) kXml_AddItem(kXml xml, kXmlItem parent, const kChar* name, kXmlItem* item);
336
347 kFx(kStatus) kXml_InsertItem(kXml xml, kXmlItem before, const kChar* name, kXmlItem* item);
348
361 kFx(kStatus) kXml_CopyItem(kXml xml, kXmlItem parent, kXmlItem before, kXml srcXml, kXmlItem srcItem, kXmlItem* item);
362
373 kFx(kStatus) kXml_OverwriteItem(kXml xml, kXmlItem destItem, kXml srcXml, kXmlItem srcItem);
374
383 kFx(kStatus) kXml_ClearItem(kXml xml, kXmlItem item);
384
393 kFx(const kChar*) kXml_ItemName(kXml xml, kXmlItem item);
394
404 kFx(kStatus) kXml_SetItemName(kXml xml, kXmlItem item, const kChar* name);
405
414 kFx(kStatus) kXml_DeleteItem(kXml xml, kXmlItem item);
415
427 kFx(kStatus) kXml_ItemStringZen(kXml xml, kXmlItem item, kChar** str);
428
438 kFx(kStatus) kXml_ItemString(kXml xml, kXmlItem item, kString str);
439
450 kFx(kStatus) kXml_ItemText(kXml xml, kXmlItem item, kChar* str, kSize capacity);
451
461 kFx(kStatus) kXml_Item16u(kXml xml, kXmlItem item, k16u* value);
462
472 kFx(kStatus) kXml_Item16s(kXml xml, kXmlItem item, k16s* value);
473
483 kFx(kStatus) kXml_Item32u(kXml xml, kXmlItem item, k32u* value);
484
494 kFx(kStatus) kXml_Item32s(kXml xml, kXmlItem item, k32s* value);
495
505 kFx(kStatus) kXml_ItemBool(kXml xml, kXmlItem item, kBool* value);
506
516 kFx(kStatus) kXml_Item64u(kXml xml, kXmlItem item, k64u* value);
517
527 kFx(kStatus) kXml_Item64s(kXml xml, kXmlItem item, k64s* value);
528
538 kFx(kStatus) kXml_ItemSize(kXml xml, kXmlItem item, kSize* value);
539
549 kFx(kStatus) kXml_Item32f(kXml xml, kXmlItem item, k32f* value);
550
560 kFx(kStatus) kXml_Item64f(kXml xml, kXmlItem item, k64f* value);
561
571 kFx(kStatus) kXml_SetItemText(kXml xml, kXmlItem item, const kChar* str);
572
582 kFx(kStatus) kXml_SetItem16u(kXml xml, kXmlItem item, k16u value);
583
593 kFx(kStatus) kXml_SetItem16s(kXml xml, kXmlItem item, k16s value);
594
604 kFx(kStatus) kXml_SetItem32u(kXml xml, kXmlItem item, k32u value);
605
615 kFx(kStatus) kXml_SetItem32s(kXml xml, kXmlItem item, k32s value);
616
626 kFx(kStatus) kXml_SetItemBool(kXml xml, kXmlItem item, kBool value);
627
637 kFx(kStatus) kXml_SetItem64u(kXml xml, kXmlItem item, k64u value);
638
648 kFx(kStatus) kXml_SetItem64s(kXml xml, kXmlItem item, k64s value);
649
659 kFx(kStatus) kXml_SetItemSize(kXml xml, kXmlItem item, kSize value);
660
670 kFx(kStatus) kXml_SetItem32f(kXml xml, kXmlItem item, k32f value);
671
681 kFx(kStatus) kXml_SetItem64f(kXml xml, kXmlItem item, k64f value);
682
693 kFx(kStatus) kXml_ChildStringZen(kXml xml, kXmlItem parent, const kChar* path, kChar** str);
694
705 kFx(kStatus) kXml_ChildString(kXml xml, kXmlItem parent, const kChar* path, kString str);
706
718 kFx(kStatus) kXml_ChildText(kXml xml, kXmlItem parent, const kChar* path, kChar* str, kSize capacity);
719
730 kFx(kStatus) kXml_Child16u(kXml xml, kXmlItem parent, const kChar* path, k16u* value);
731
742 kFx(kStatus) kXml_Child16s(kXml xml, kXmlItem parent, const kChar* path, k16s* value);
743
754 kFx(kStatus) kXml_Child32u(kXml xml, kXmlItem parent, const kChar* path, k32u* value);
755
766 kFx(kStatus) kXml_Child32s(kXml xml, kXmlItem parent, const kChar* path, k32s* value);
767
778 kFx(kStatus) kXml_ChildBool(kXml xml, kXmlItem parent, const kChar* path, kBool* value);
779
790 kFx(kStatus) kXml_Child64u(kXml xml, kXmlItem parent, const kChar* path, k64u* value);
791
802 kFx(kStatus) kXml_Child64s(kXml xml, kXmlItem parent, const kChar* path, k64s* value);
803
814 kFx(kStatus) kXml_ChildSize(kXml xml, kXmlItem parent, const kChar* path, kSize* value);
815
826 kFx(kStatus) kXml_Child32f(kXml xml, kXmlItem parent, const kChar* path, k32f* value);
827
838 kFx(kStatus) kXml_Child64f(kXml xml, kXmlItem parent, const kChar* path, k64f* value);
849 kFx(kStatus) kXml_SetChildText(kXml xml, kXmlItem parent, const kChar* path, const kChar* str);
850
861 kFx(kStatus) kXml_SetChild16u(kXml xml, kXmlItem parent, const kChar* path, k16u value);
862
873 kFx(kStatus) kXml_SetChild16s(kXml xml, kXmlItem parent, const kChar* path, k16s value);
874
885 kFx(kStatus) kXml_SetChild32u(kXml xml, kXmlItem parent, const kChar* path, k32u value);
886
897 kFx(kStatus) kXml_SetChild32s(kXml xml, kXmlItem parent, const kChar* path, k32s value);
898
909 kFx(kStatus) kXml_SetChildBool(kXml xml, kXmlItem parent, const kChar* path, kBool value);
910
921 kFx(kStatus) kXml_SetChild64u(kXml xml, kXmlItem parent, const kChar* path, k64u value);
922
933 kFx(kStatus) kXml_SetChild64s(kXml xml, kXmlItem parent, const kChar* path, k64s value);
934
945 kFx(kStatus) kXml_SetChildSize(kXml xml, kXmlItem parent, const kChar* path, kSize value);
946
957 kFx(kStatus) kXml_SetChild32f(kXml xml, kXmlItem parent, const kChar* path, k32f value);
958
969 kFx(kStatus) kXml_SetChild64f(kXml xml, kXmlItem parent, const kChar* path, k64f value);
970
980 kFx(kBool) kXml_AttrExists(kXml xml, kXmlItem item, const kChar* name);
981
990 kFx(kSize) kXml_AttrCount(kXml xml, kXmlItem item);
991
1001 kFx(const kChar*) kXml_AttrNameAt(kXml xml, kXmlItem item, kSize index);
1002
1012 kFx(kStatus) kXml_DeleteAttr(kXml xml, kXmlItem item, const kChar* name);
1013
1022 kFx(kStatus) kXml_DeleteAttrs(kXml xml, kXmlItem item);
1023
1034 kFx(kStatus) kXml_AttrStringZen(kXml xml, kXmlItem item, const kChar* name, kChar** str);
1035
1046 kFx(kStatus) kXml_AttrString(kXml xml, kXmlItem item, const kChar* name, kString string);
1047
1059 kFx(kStatus) kXml_AttrText(kXml xml, kXmlItem item, const kChar* name, kChar* str, kSize capacity);
1060
1071 kFx(kStatus) kXml_Attr16u(kXml xml, kXmlItem item, const kChar* name, k16u* value);
1072
1083 kFx(kStatus) kXml_Attr16s(kXml xml, kXmlItem item, const kChar* name, k16s* value);
1084
1095 kFx(kStatus) kXml_Attr32u(kXml xml, kXmlItem item, const kChar* name, k32u* value);
1096
1107 kFx(kStatus) kXml_Attr32s(kXml xml, kXmlItem item, const kChar* name, k32s* value);
1108
1119 kFx(kStatus) kXml_AttrBool(kXml xml, kXmlItem item, const kChar* name, kBool* value);
1120
1131 kFx(kStatus) kXml_Attr64u(kXml xml, kXmlItem item, const kChar* name, k64u* value);
1132
1143 kFx(kStatus) kXml_Attr64s(kXml xml, kXmlItem item, const kChar* name, k64s* value);
1144
1155 kFx(kStatus) kXml_AttrSize(kXml xml, kXmlItem item, const kChar* name, kSize* value);
1156
1167 kFx(kStatus) kXml_Attr32f(kXml xml, kXmlItem item, const kChar* name, k32f* value);
1168
1179 kFx(kStatus) kXml_Attr64f(kXml xml, kXmlItem item, const kChar* name, k64f* value);
1180
1191 kFx(kStatus) kXml_SetAttrText(kXml xml, kXmlItem item, const kChar* name, const kChar* str);
1192
1203 kFx(kStatus) kXml_SetAttr16u(kXml xml, kXmlItem item, const kChar* name, k16u value);
1204
1215 kFx(kStatus) kXml_SetAttr16s(kXml xml, kXmlItem item, const kChar* name, k16s value);
1216
1227 kFx(kStatus) kXml_SetAttr32u(kXml xml, kXmlItem item, const kChar* name, k32u value);
1228
1239 kFx(kStatus) kXml_SetAttr32s(kXml xml, kXmlItem item, const kChar* name, k32s value);
1240
1251 kFx(kStatus) kXml_SetAttrBool(kXml xml, kXmlItem item, const kChar* name, kBool value);
1252
1263 kFx(kStatus) kXml_SetAttr64u(kXml xml, kXmlItem item, const kChar* name, k64u value);
1264
1275 kFx(kStatus) kXml_SetAttr64s(kXml xml, kXmlItem item, const kChar* name, k64s value);
1276
1287 kFx(kStatus) kXml_SetAttrSize(kXml xml, kXmlItem item, const kChar* name, kSize value);
1288
1299 kFx(kStatus) kXml_SetAttr32f(kXml xml, kXmlItem item, const kChar* name, k32f value);
1300
1311 kFx(kStatus) kXml_SetAttr64f(kXml xml, kXmlItem item, const kChar* name, k64f value);
1312
1313 kEndHeader()
1314
1315 #include <kApi/Data/kXml.x.h>
1316
1317 #endif
1318
kXml::kXml_SetAttrText
kStatus kXml_SetAttrText(kXml xml, kXmlItem item, const kChar *name, const kChar *str)
Sets XML attribute content from a character array.
kXml::kXml_SetItem64u
kStatus kXml_SetItem64u(kXml xml, kXmlItem item, k64u value)
Sets XML element node content from a k64u value.
kXml::kXml_Parent
kXmlItem kXml_Parent(kXml xml, kXmlItem item)
Returns the parent node of the given element.
kXml::kXmlItem
kPointer kXmlItem
Represents an XML element within an XML document.
kXml::kXml_SetChild32u
kStatus kXml_SetChild32u(kXml xml, kXmlItem parent, const kChar *path, k32u value)
Sets XML child node content from a k32u value.
kXml::kXml_Attr32f
kStatus kXml_Attr32f(kXml xml, kXmlItem item, const kChar *name, k32f *value)
Gets XML attribute content as a k32f value.
kXml::kXml_CopyItem
kStatus kXml_CopyItem(kXml xml, kXmlItem parent, kXmlItem before, kXml srcXml, kXmlItem srcItem, kXmlItem *item)
Copies a node from another XML document to this document, inserting a new node at the specified locat...
kXml::kXml_ItemText
kStatus kXml_ItemText(kXml xml, kXmlItem item, kChar *str, kSize capacity)
Gets XML element content as a character array.
k32u
Represents a 32-bit unsigned integer.
kXml::kXml_SetChild64u
kStatus kXml_SetChild64u(kXml xml, kXmlItem parent, const kChar *path, k64u value)
Sets XML child node content from a k64u value.
kXml::kXml_ChildSize
kStatus kXml_ChildSize(kXml xml, kXmlItem parent, const kChar *path, kSize *value)
Gets XML child node content as a kSize value.
kXml::kXml_Child32u
kStatus kXml_Child32u(kXml xml, kXmlItem parent, const kChar *path, k32u *value)
Gets XML child node content as a k32u value.
kXml::kXml_SetItem32s
kStatus kXml_SetItem32s(kXml xml, kXmlItem item, k32s value)
Sets XML element node content from a k32s value.
kXml::kXml_Attr16s
kStatus kXml_Attr16s(kXml xml, kXmlItem item, const kChar *name, k16s *value)
Gets XML attribute content as a k16s value.
kXml::kXml_SetChild32f
kStatus kXml_SetChild32f(kXml xml, kXmlItem parent, const kChar *path, k32f value)
Sets XML child node content from a k32f value.
kXml::kXml_SetItem64s
kStatus kXml_SetItem64s(kXml xml, kXmlItem item, k64s value)
Sets XML element node content from a k64s value.
kXml::kXml_SetItemName
kStatus kXml_SetItemName(kXml xml, kXmlItem item, const kChar *name)
Sets the name of an XML element node.
kXml::kXml_Assign
kStatus kXml_Assign(kXml xml, kXml source)
Copies the source document.
k64u
Represents a 64-bit unsigned integer.
kXml::kXml_SetChild32s
kStatus kXml_SetChild32s(kXml xml, kXmlItem parent, const kChar *path, k32s value)
Sets XML child node content from a k32s value.
kXml::kXml_AttrString
kStatus kXml_AttrString(kXml xml, kXmlItem item, const kChar *name, kString string)
Gets XML attribute content as a string object.
kXml::kXml_Item32f
kStatus kXml_Item32f(kXml xml, kXmlItem item, k32f *value)
Gets XML element node content as a k32f value.
kXml::kXml_Child16s
kStatus kXml_Child16s(kXml xml, kXmlItem parent, const kChar *path, k16s *value)
Gets XML child node content as a k16s value.
kXml::kXml_Child32s
kStatus kXml_Child32s(kXml xml, kXmlItem parent, const kChar *path, k32s *value)
Gets XML child node content as a k32s value.
kXml::kXml_Load
kStatus kXml_Load(kXml *xml, const kChar *fileName, kAlloc allocator)
Loads an XML document from file.
kXml::kXml_SetItemBool
kStatus kXml_SetItemBool(kXml xml, kXmlItem item, kBool value)
Sets XML element node content from a kBool value.
kXml::kXml_FromText
kStatus kXml_FromText(kXml *xml, const kChar *str, kAlloc allocator)
Loads an XML document from a character array.
kXml::kXml_SetAttr64f
kStatus kXml_SetAttr64f(kXml xml, kXmlItem item, const kChar *name, k64f value)
Sets XML attribute content from a k64f value.
kXml::kXml_AttrNameAt
const kChar * kXml_AttrNameAt(kXml xml, kXmlItem item, kSize index)
Returns an attribute at a specific index within the list of attributes for the given element node...
kXml::kXml_Clear
kStatus kXml_Clear(kXml xml)
Removes all elements from the XML document.
kXml::kXml_AttrBool
kStatus kXml_AttrBool(kXml xml, kXmlItem item, const kChar *name, kBool *value)
Gets XML attribute content as a kBool value.
kXml::kXml_ChildExists
kBool kXml_ChildExists(kXml xml, kXmlItem parent, const kChar *path)
Reports whether a child node exists at the specified relative path.
kXml::kXml_DeleteItem
kStatus kXml_DeleteItem(kXml xml, kXmlItem item)
Deletes an XML element node.
kXml::kXml_SetItem32f
kStatus kXml_SetItem32f(kXml xml, kXmlItem item, k32f value)
Sets XML element node content from a k32f value.
kXml::kXml_SetChild16u
kStatus kXml_SetChild16u(kXml xml, kXmlItem parent, const kChar *path, k16u value)
Sets XML child node content from a k16u value.
kXml::kXml_SetItem16u
kStatus kXml_SetItem16u(kXml xml, kXmlItem item, k16u value)
Sets XML element node content from a k16u value.
kXml::kXml_SetChild64s
kStatus kXml_SetChild64s(kXml xml, kXmlItem parent, const kChar *path, k64s value)
Sets XML child node content from a k64s value.
kXml::kXml_FindRoot
kStatus kXml_FindRoot(kXml xml, kXmlItem *root)
Finds the root node, if it exists.
kXml::kXml_SetChildText
kStatus kXml_SetChildText(kXml xml, kXmlItem parent, const kChar *path, const kChar *str)
Sets XML child node content from a character array.
k16u
Represents a 16-bit unsigned integer.
kXml::kXml_DeleteChildren
kStatus kXml_DeleteChildren(kXml xml, kXmlItem item)
Deletes all children in the specified parent item.
kXml::kXml_ChildString
kStatus kXml_ChildString(kXml xml, kXmlItem parent, const kChar *path, kString str)
Gets XML child node content as a string object.
kSize
Represents an unsigned integer that can store a pointer address.
kAlloc
Abstract base class for memory allocator types.
kXml::kXml_SetAttr64s
kStatus kXml_SetAttr64s(kXml xml, kXmlItem item, const kChar *name, k64s value)
Sets XML attribute content from a k64s value.
kXml::kXml_ChildStringZen
kStatus kXml_ChildStringZen(kXml xml, kXmlItem parent, const kChar *path, kChar **str)
Gets XML element node content as a character array.
kXml::kXml_Save
kStatus kXml_Save(kXml xml, const kChar *fileName)
Saves the XML document object to file.
kXml::kXml_ChildText
kStatus kXml_ChildText(kXml xml, kXmlItem parent, const kChar *path, kChar *str, kSize capacity)
Gets XML child node content as a character array.
kXml::kXml_SetChild64f
kStatus kXml_SetChild64f(kXml xml, kXmlItem parent, const kChar *path, k64f value)
Sets XML child node content from a k64f value.
kXml::kXml_SetChildSize
kStatus kXml_SetChildSize(kXml xml, kXmlItem parent, const kChar *path, kSize value)
Sets XML child node content from a kSize value.
kXml::kXml_SaveBytes
kStatus kXml_SaveBytes(kXml xml, kByte **data, kSize *size, kAlloc allocator)
Saves an XML document to an in-memory file.
kXml::kXml_SetItem32u
kStatus kXml_SetItem32u(kXml xml, kXmlItem item, k32u value)
Sets XML element node content from a k32u value.
kXml::kXml_ToString
kStatus kXml_ToString(kXml xml, kString str)
Exports the XML document to a string object.
kXml::kXml_SetItem64f
kStatus kXml_SetItem64f(kXml xml, kXmlItem item, k64f value)
Sets XML element node content from a k64f value.
kXml::kXml_Item64s
kStatus kXml_Item64s(kXml xml, kXmlItem item, k64s *value)
Gets XML element node content as a k64s value.
kChar
Represents a single unit (byte) in a UTF-8 character.
kXml::kXml_SetChildBool
kStatus kXml_SetChildBool(kXml xml, kXmlItem parent, const kChar *path, kBool value)
Sets XML child node content from a kBool value.
kByte
Represents a byte on the current platform.
kXml::kXml_Child64u
kStatus kXml_Child64u(kXml xml, kXmlItem parent, const kChar *path, k64u *value)
Gets XML child node content as a k64u value.
kXml::kXml_Child64f
kStatus kXml_Child64f(kXml xml, kXmlItem parent, const kChar *path, k64f *value)
Gets XML child node content as a k64f value.
kXml::kXml_SetAttr32s
kStatus kXml_SetAttr32s(kXml xml, kXmlItem item, const kChar *name, k32s value)
Sets XML attribute content from a k32s value.
kXml::kXml_SetAttrBool
kStatus kXml_SetAttrBool(kXml xml, kXmlItem item, const kChar *name, kBool value)
Sets XML attribute content from a kBool value.
kXml::kXml_Item16s
kStatus kXml_Item16s(kXml xml, kXmlItem item, k16s *value)
Gets XML element node content as a k16s value.
kXml::kXml_ClearItem
kStatus kXml_ClearItem(kXml xml, kXmlItem item)
Removes all children, attributes, and value from the XML element node.
kXml::kXml_AddItem
kStatus kXml_AddItem(kXml xml, kXmlItem parent, const kChar *name, kXmlItem *item)
Inserts a new child node at the end of the specified parent node's child list.
kXml::kXml_AttrSize
kStatus kXml_AttrSize(kXml xml, kXmlItem item, const kChar *name, kSize *value)
Gets XML attribute content as a kSize value.
kXml::kXml_Child32f
kStatus kXml_Child32f(kXml xml, kXmlItem parent, const kChar *path, k32f *value)
Gets XML child node content as a k32f value.
kXml::kXml_PreviousSibling
kXmlItem kXml_PreviousSibling(kXml xml, kXmlItem item)
Returns the previous sibling element of the given element node.
kXml::kXml_SetItemText
kStatus kXml_SetItemText(kXml xml, kXmlItem item, const kChar *str)
Sets XML element node content from a character array.
kXml::kXml_Item64f
kStatus kXml_Item64f(kXml xml, kXmlItem item, k64f *value)
Gets XML element node content as a k64f value.
kXml::kXml_Attr16u
kStatus kXml_Attr16u(kXml xml, kXmlItem item, const kChar *name, k16u *value)
Gets XML attribute content as a k16u value.
kXml::kXml_DeleteAttr
kStatus kXml_DeleteAttr(kXml xml, kXmlItem item, const kChar *name)
Deletes an XML attribute.
kXml::kXml_ItemBool
kStatus kXml_ItemBool(kXml xml, kXmlItem item, kBool *value)
Gets XML element node content as a kBool value.
kXml::kXml_Child
kXmlItem kXml_Child(kXml xml, kXmlItem parent, const kChar *path)
Returns the child node at the given relative path.
kXml::kXml_Construct
kStatus kXml_Construct(kXml *xml, kAlloc allocator)
Constructs a kXml object.
kXml::kXml_SetAttr32f
kStatus kXml_SetAttr32f(kXml xml, kXmlItem item, const kChar *name, k32f value)
Sets XML attribute content from a k32f value.
kXml::kXml_FirstChild
kXmlItem kXml_FirstChild(kXml xml, kXmlItem parent)
Returns the first child element of the given parent node.
kXml::kXml_ItemStringZen
kStatus kXml_ItemStringZen(kXml xml, kXmlItem item, kChar **str)
Gets XML element content as a character array.
kXml::kXml_Root
kXmlItem kXml_Root(kXml xml)
Returns the root element of the XML document.
kXml::kXml_InsertItem
kStatus kXml_InsertItem(kXml xml, kXmlItem before, const kChar *name, kXmlItem *item)
Inserts a new node before the specified sibling node.
kApiDef.h
Core Zen type declarations.
kXml::kXml_Item16u
kStatus kXml_Item16u(kXml xml, kXmlItem item, k16u *value)
Gets XML element node content as a k16u value.
kStream
Represents an I/O stream.
kXml::kXml_ItemString
kStatus kXml_ItemString(kXml xml, kXmlItem item, kString str)
Gets XML element node content as a string object.
k32s
Represents a 32-bit signed integer.
kXml::kXml_SetItemSize
kStatus kXml_SetItemSize(kXml xml, kXmlItem item, kSize value)
Sets XML element node content from a kSize value.
kXml::kXml_Attr64f
kStatus kXml_Attr64f(kXml xml, kXmlItem item, const kChar *name, k64f *value)
Gets XML attribute content as a k64f value.
kXml::kXml_SetAttr16s
kStatus kXml_SetAttr16s(kXml xml, kXmlItem item, const kChar *name, k16s value)
Sets XML attribute content from a k16s value.
kXml::kXml_SetAttrSize
kStatus kXml_SetAttrSize(kXml xml, kXmlItem item, const kChar *name, kSize value)
Sets XML attribute content from a kSize value.
kXml::kXml_NextSibling
kXmlItem kXml_NextSibling(kXml xml, kXmlItem item)
Returns the next sibling element of the given element node.
kXml::kXml_ChildCount
kSize kXml_ChildCount(kXml xml, kXmlItem parent)
Returns the number of child nodes for the given parent node.
kXml::kXml_SetAttr16u
kStatus kXml_SetAttr16u(kXml xml, kXmlItem item, const kChar *name, k16u value)
Sets XML attribute content from a k16u value.
kXml::kXml_LastChild
kXmlItem kXml_LastChild(kXml xml, kXmlItem parent)
Returns the last child element of the given parent node.
k64s
Represents a 64-bit signed integer.
kXml
Represents an XML document.
kXml::kXml_ItemSize
kStatus kXml_ItemSize(kXml xml, kXmlItem item, kSize *value)
Gets XML element node content as a kSize value.
kString
Represents a character string.
kXml::kXml_ChildAt
kXmlItem kXml_ChildAt(kXml xml, kXmlItem parent, kSize index)
Returns a child node at a specific index within the list of child nodes for the given parent node...
kXml::kXml_AttrStringZen
kStatus kXml_AttrStringZen(kXml xml, kXmlItem item, const kChar *name, kChar **str)
Gets XML attribute content as a character array.
kXml::kXml_Attr64s
kStatus kXml_Attr64s(kXml xml, kXmlItem item, const kChar *name, k64s *value)
Gets XML attribute content as a k64s value.
kXml::kXml_SetAttr32u
kStatus kXml_SetAttr32u(kXml xml, kXmlItem item, const kChar *name, k32u value)
Sets XML attribute content from a k32u value.
kXml::kXml_LoadBytes
kStatus kXml_LoadBytes(kXml *xml, const kByte *data, kSize size, kAlloc allocator)
Loads an XML document from an in-memory file.
k16s
Represents a 16-bit signed integer.
kXml::kXml_OverwriteItem
kStatus kXml_OverwriteItem(kXml xml, kXmlItem destItem, kXml srcXml, kXmlItem srcItem)
Copies a node from another XML document to this document, overwriting an existing element...
k32f
Represents a 32-bit floating-point number.
kXml::kXml_Write
kStatus kXml_Write(kXml xml, kStream stream)
Writes an XML document to a stream.
kXml::kXml_SetItem16s
kStatus kXml_SetItem16s(kXml xml, kXmlItem item, k16s value)
Sets XML element node content from a k16s value.
kXml::kXml_FromString
kStatus kXml_FromString(kXml xml, kString str)
Loads an XML document from a string object.
kXml::kXml_Item32u
kStatus kXml_Item32u(kXml xml, kXmlItem item, k32u *value)
Gets XML element node content as a k32u value.
kStatus
Represents an error code.
kXml::kXml_Compact
kStatus kXml_Compact(kXml xml)
Compacts the XML object for minimum memory usage.
kXml::kXml_ItemName
const kChar * kXml_ItemName(kXml xml, kXmlItem item)
Returns the name of an XML element node.
kXml::kXml_AttrExists
kBool kXml_AttrExists(kXml xml, kXmlItem item, const kChar *name)
Reports whether a specific attribute exists for the given XML element.
kXml::kXml_ChildBool
kStatus kXml_ChildBool(kXml xml, kXmlItem parent, const kChar *path, kBool *value)
Gets XML child node content as a kBool value.
kXml::kXml_Item64u
kStatus kXml_Item64u(kXml xml, kXmlItem item, k64u *value)
Gets XML element node content as a k64u value.
kXml::kXml_Read
kStatus kXml_Read(kXml xml, kStream stream)
Loads an XML document from a stream.
kXml::kXml_Attr32u
kStatus kXml_Attr32u(kXml xml, kXmlItem item, const kChar *name, k32u *value)
Gets XML attribute content as a k32u value.
k64f
Represents a 64-bit floating-point number.
kXml::kXml_Attr64u
kStatus kXml_Attr64u(kXml xml, kXmlItem item, const kChar *name, k64u *value)
Gets XML attribute content as a k64u value.
kXml::kXml_Child16u
kStatus kXml_Child16u(kXml xml, kXmlItem parent, const kChar *path, k16u *value)
Gets XML child node content as a k16u value.
kBool
Represents a boolean value.
kXml::kXml_EnsureChildExists
kStatus kXml_EnsureChildExists(kXml xml, kXmlItem parent, const kChar *path, kXmlItem *item)
Ensures that a child node exists at the specified path.
kXml::kXml_AttrText
kStatus kXml_AttrText(kXml xml, kXmlItem item, const kChar *name, kChar *str, kSize capacity)
Gets XML attribute content as a character array.
kXml::kXml_FindChild
kStatus kXml_FindChild(kXml xml, kXmlItem parent, const kChar *path, kXmlItem *child)
Finds the child node at the given relative path, if it exists.
kXml::kXml_Attr32s
kStatus kXml_Attr32s(kXml xml, kXmlItem item, const kChar *name, k32s *value)
Gets XML attribute content as a k32s value.
kXml::kXml_Child64s
kStatus kXml_Child64s(kXml xml, kXmlItem parent, const kChar *path, k64s *value)
Gets XML child node content as a k64s value.
kXml::kXml_DeleteAttrs
kStatus kXml_DeleteAttrs(kXml xml, kXmlItem item)
Deletes all XML attributes.
kXml::kXml_SetAttr64u
kStatus kXml_SetAttr64u(kXml xml, kXmlItem item, const kChar *name, k64u value)
Sets XML attribute content from a k64u value.
kXml::kXml_AttrCount
kSize kXml_AttrCount(kXml xml, kXmlItem item)
Returns the number of attributes for the given XML element.
kXml::kXml_Item32s
kStatus kXml_Item32s(kXml xml, kXmlItem item, k32s *value)
Gets XML element node content as a k32s value.
kXml::kXml_SetChild16s
kStatus kXml_SetChild16s(kXml xml, kXmlItem parent, const kChar *path, k16s value)
Sets XML child node content from a k16s value.