XML.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232
  1. #pragma once
  2. #include <functional>
  3. #include "Array.h"
  4. #include "Maybe.h"
  5. #include "RCPointer.h"
  6. #include "ReferenceCounter.h"
  7. namespace Framework
  8. {
  9. class Text;
  10. namespace XML
  11. {
  12. class Editor;
  13. //! Ein XML element der Form \code <name attribut1
  14. //! attribut2="value">text oder childs</name> \endcode
  15. class Element : public virtual ReferenceCounter
  16. {
  17. private:
  18. RCArray<Element>* children;
  19. RCArray<Text>* attributes;
  20. RCArray<Text>* attributeValues;
  21. Text* name;
  22. Text* text;
  23. Element* parent;
  24. public:
  25. //! Erstellt ein XML Element
  26. //! \param string entweder der name des Elements oder ein XML Text
  27. //! der geparsed werden soll
  28. DLLEXPORT Element(Text string);
  29. //! Erstellt ein XML Element
  30. //! \param string entweder der name des Elements oder ein XML Text
  31. //! der geparsed werden soll \param zParent Ein Zeiger auf das
  32. //! eltern element (ohne erhöhten reference Counter)
  33. DLLEXPORT Element(Text string, Element* zParent);
  34. DLLEXPORT ~Element();
  35. //! ändert ein attribut oder fügt eines hinzu
  36. //! \param attribut Der Name des Attributes
  37. //! \param value Der Wert des Attributes
  38. DLLEXPORT void setAttribute(Text attribut, Text value);
  39. //! entfernt ein attribut
  40. //! \param attribut Der Name des Attributes
  41. DLLEXPORT void removeAttribute(Text attribut);
  42. //! fügt ein child hinzu
  43. //! \param child Das neue Child Element
  44. DLLEXPORT void addChild(Element* child);
  45. //! fügt ein child hinzu
  46. //! \param child Das neue Child Element
  47. DLLEXPORT void addChildAtFront(Element* child);
  48. //! entfernt ein child
  49. //! \param zChild das zu entfernende Child
  50. DLLEXPORT void removeChild(Element* child);
  51. //! entfernt das i-te child
  52. //! \param i der Index des childs (bei 0 beginnend)
  53. DLLEXPORT void removeChild(int i);
  54. //! entfernt alle childs
  55. DLLEXPORT void removeAllChilds();
  56. //! entfernt eine Liste mit childs
  57. //! \param childs alle Childs die entfernt werden sollen
  58. DLLEXPORT void removeChilds(RCArray<Element>* childs);
  59. //! entfernt dieses Element vom Eltern element
  60. DLLEXPORT void remove();
  61. //! setzt den Text in dem Element falls es keine childs gibt
  62. //! \param text dert Text
  63. DLLEXPORT void setText(Text text);
  64. //! gibt den Text im Element zurück
  65. DLLEXPORT Text getText() const;
  66. //! gibt die Anzahl der Childs zurück
  67. DLLEXPORT int getChildCount() const;
  68. /// <summary>
  69. /// returns the index of the zChild in the list of children or -1 if
  70. /// zChild is not a child of this element
  71. /// </summary>
  72. /// <param name="zChild">the child element to search for</param>
  73. /// <returns>the index of zChild in the list of children or -1 if
  74. /// zChild is not a child of this element</returns>
  75. DLLEXPORT int getChildIndex(Element* zChild) const;
  76. //! gibt das i-te child zurück
  77. DLLEXPORT Element* getChild(int i) const;
  78. //! gibt das i-te child zurück (ohne erhöhten reference Counter)
  79. DLLEXPORT Element* zChild(int i) const;
  80. //! gibt das parent element zurück
  81. DLLEXPORT Element* getParent() const;
  82. //! gibt das parent element zurück (ohne erhöhten reference Counter)
  83. DLLEXPORT Element* zParent() const;
  84. //! gibt einen iterator zurück mit dem durch alle childs iteriert
  85. //! werden kann
  86. DLLEXPORT ArrayIterator<Element*> getChilds() const;
  87. //! gibt einen Editor für dieses Element zurück
  88. DLLEXPORT Editor select();
  89. //! gibt einen selector zurück der alle childs beinhaltet
  90. DLLEXPORT Editor selectChildren() const;
  91. //! gibt eine Liste mit childs zurück, die einen bestimmten Namen
  92. //! haben \param name der name der Childs
  93. DLLEXPORT Editor selectChildsByName(Text name) const;
  94. //! gibt eine Liste mit childs zurück, die ein bestimmtes Attribut
  95. //! haben \param attribute der name des Attributes
  96. DLLEXPORT Editor selectChildsByAttribute(Text attribute) const;
  97. //! gibt eine Liste mit childs zurück, die ein bestimmtes Attribut
  98. //! mit einem bestimmten wert haben \param attribute der name des
  99. //! Attributes \param value der Wert des Attributes
  100. DLLEXPORT Editor selectChildsByAttribute(
  101. Text attribute, Text value) const;
  102. //! gibt 1 zurück, falls ein Attribut Name existiert, 0 sonnst
  103. DLLEXPORT bool hasAttribute(Text name) const;
  104. //! gibt die Anzahl der Attribute zurück
  105. DLLEXPORT int getAttributeCount() const;
  106. //! gibt den Namen des i-ten Attributes zurück
  107. DLLEXPORT Text getAttributeName(int i) const;
  108. //! gibt den Wert des i-ten Attributes zurück
  109. DLLEXPORT Text getAttributeValue(int i) const;
  110. //! gibt den Wert eines Attributes zurück
  111. //! \param attribut Der Name des Attributes
  112. DLLEXPORT Text getAttributeValue(Text attribut) const;
  113. //! gibt einen iterator zurück mit dem durch alle Attribut Namen
  114. //! iteriert werden kann
  115. DLLEXPORT ArrayIterator<Text*> getAttributeNames() const;
  116. //! gibt einen iterator zurück mit dem durch alle Attribut Werte
  117. //! iteriert werden kann
  118. DLLEXPORT ArrayIterator<Text*> getAttributeValues() const;
  119. //! gibt den Namen des Elementes zurück zurück
  120. DLLEXPORT Text getName() const;
  121. //! erzeugt einen XML Text der dieses Element und alle childs
  122. //! beinhaltet
  123. DLLEXPORT Text toString() const;
  124. //! Erzeugt eine Kopie ohne referenzen auf dieses objekt
  125. DLLEXPORT Element* dublicate() const;
  126. friend Editor;
  127. };
  128. //! Ein XML Editor der immer gleich mehrere Elemente editieren kann
  129. class Editor : public virtual ReferenceCounter
  130. {
  131. private:
  132. RCArray<Element>* elements;
  133. public:
  134. //! Erzeugt einen neuen XML Editor mit einer Liste von Objekten die
  135. //! editiert werden sollen
  136. DLLEXPORT Editor(RCArray<Element>* elements);
  137. DLLEXPORT Editor(const Editor& e);
  138. DLLEXPORT ~Editor();
  139. /// <summary>
  140. /// returns the first element in the list
  141. /// </summary>
  142. /// <returns> the first element of a list or an empty object if no
  143. /// elements are present</returns>
  144. DLLEXPORT Maybe<RCPointer<Element>> getFirstElement() const;
  145. //! ändert ein attribut oder fügt eines hinzu (auf allen elementen
  146. //! in der Liste) \param attribut Der Name des Attributes \param
  147. //! value Der Wert des Attributes
  148. DLLEXPORT void setAttribute(Text attribut, Text value);
  149. //! entfernt ein attribut (auf allen elementen in der Liste)
  150. //! \param attribut Der Name des Attributes
  151. DLLEXPORT void removeAttribute(Text attribut);
  152. //! fügt ein child hinzu (auf allen elementen in der Liste)
  153. //! \param child Das neue Child Element
  154. DLLEXPORT void addChild(Element* child);
  155. //! entfernt ein child (auf allen elementen in der Liste)
  156. //! \param zChild das zu entfernende Child
  157. DLLEXPORT void removeChild(Element* child);
  158. //! entfernt das i-te child (auf allen elementen in der Liste)
  159. //! \param i der Index des childs (bei 0 beginnend)
  160. DLLEXPORT void removeChild(int i);
  161. //! entfernt alle childs (auf allen elementen in der Liste)
  162. DLLEXPORT void removeAllChilds();
  163. //! entfernt eine Liste mit childs (auf allen elementen in der
  164. //! Liste) \param childs alle Childs die entfernt werden sollen
  165. DLLEXPORT void removeChilds(RCArray<Element>* childs);
  166. //! entfernt dieses Element vom Eltern element (auf allen elementen
  167. //! in der Liste)
  168. DLLEXPORT void remove();
  169. //! setzt den Text in dem Element falls es keine childs gibt (auf
  170. //! allen elementen in der Liste) \param text dert Text
  171. DLLEXPORT void setText(Text text);
  172. //! Gibt ein Iterator durch alle Elemente zurück
  173. DLLEXPORT ArrayIterator<Element*> begin();
  174. //! Gibt das ende des iterators zurück
  175. DLLEXPORT ArrayIterator<Element*> end();
  176. //! Gibt einen selector zurück der alle elemente beinhaltet die in
  177. //! diesem selector vorkommen und rekursiv alle Kinder der elemente
  178. //! Enthält
  179. DLLEXPORT Editor selectAllElements();
  180. //! gibt einen selector zurück der alle childs beinhaltet
  181. DLLEXPORT Editor selectChildren() const;
  182. //! gibt einen selector zurück der alle parents beinhaltet
  183. DLLEXPORT Editor selectParents() const;
  184. //! gibt eine Liste mit elementen zurück, die einen bestimmten Namen
  185. //! haben \param name der name der Childs
  186. DLLEXPORT Editor whereNameEquals(Text name) const;
  187. //! gibt eine Liste mit elementen zurück, die ein bestimmtes child
  188. //! haben \param name der name des childs
  189. DLLEXPORT Editor whereChildWithNameExists(Text name) const;
  190. //! gibt eine Liste mit elementen zurück, die ein bestimmtes child
  191. //! haben \param attribute der name des attributes
  192. DLLEXPORT Editor whereChildWithAttributeExists(
  193. Text attribute) const;
  194. //! gibt eine Liste mit elementen zurück, die ein bestimmtes child
  195. //! haben \param attribute der name des attributes \param value der
  196. //! Wert des Attributes
  197. DLLEXPORT Editor whereChildWithAttributeExists(
  198. Text attribute, Text value) const;
  199. //! gibt eine Liste mit elementen zurück, die ein bestimmtes
  200. //! Attribut haben \param attribute der name des Attributes
  201. DLLEXPORT Editor whereAttributeExists(Text attribute) const;
  202. //! gibt eine Liste mit elementen zurück, die ein bestimmtes
  203. //! Attribut mit einem bestimmten wert haben \param attribute der
  204. //! name des Attributes \param value der Wert des Attributes
  205. DLLEXPORT Editor whereAttributeEquals(
  206. Text attribute, Text value) const;
  207. //! Gibt einen Editor zurück welcher nurnoch die Elemente enthält
  208. //! die nicht in e sind \param e Ein Editor mit elementen die nicht
  209. //! enthalten sein sollen
  210. DLLEXPORT Editor without(Editor e) const;
  211. //! Ruft eine funktion für jedes Element auf (nimmt als argument ein
  212. //! Element objekt ohne erhöhten reference Counter) \param f die
  213. //! funktion
  214. DLLEXPORT void forEach(std::function<void(Element*)> f) const;
  215. //! gibt 1 zurück, wenn mindestens ein Element gefunden wurde
  216. DLLEXPORT bool exists() const;
  217. //! gibt die anzahl der ausgewählten elemente zurück
  218. DLLEXPORT int getSize() const;
  219. //! assignment operator
  220. DLLEXPORT Editor& operator=(const Editor& e);
  221. };
  222. } // namespace XML
  223. } // namespace Framework