XML.h 11 KB

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