XML.h 8.6 KB

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