XML.h 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190
  1. #pragma once
  2. #include "Array.h"
  3. #include <functional>
  4. namespace Framework
  5. {
  6. class Text;
  7. namespace XML
  8. {
  9. class Editor;
  10. //! Ein XML element der Form \code <name attribut1 attribut2="value">text oder childs</name> \endcode
  11. class Element
  12. {
  13. private:
  14. int ref;
  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. //! erhöht den reference Counter um 1 und gibt this zurück
  107. DLLEXPORT Element *getThis();
  108. //! verringert den reference Counter um 1 und gibt 0 zurück
  109. DLLEXPORT Element *release();
  110. friend Editor;
  111. };
  112. //! Ein XML Editor der immer gleich mehrere Elemente editieren kann
  113. class Editor
  114. {
  115. private:
  116. RCArray< Element > *elements;
  117. public:
  118. //! Erzeugt einen neuen XML Editor mit einer Liste von Objekten die editiert werden sollen
  119. DLLEXPORT Editor( RCArray< Element > *elements );
  120. DLLEXPORT Editor( const Editor &e );
  121. DLLEXPORT ~Editor();
  122. //! ändert ein attribut oder fügt eines hinzu (auf allen elementen in der Liste)
  123. //! \param attribut Der Name des Attributes
  124. //! \param value Der Wert des Attributes
  125. DLLEXPORT void setAttribute( Text attribut, Text value );
  126. //! entfernt ein attribut (auf allen elementen in der Liste)
  127. //! \param attribut Der Name des Attributes
  128. DLLEXPORT void removeAttribute( Text attribut );
  129. //! fügt ein child hinzu (auf allen elementen in der Liste)
  130. //! \param child Das neue Child Element
  131. DLLEXPORT void addChild( Element *child );
  132. //! entfernt ein child (auf allen elementen in der Liste)
  133. //! \param zChild das zu entfernende Child
  134. DLLEXPORT void removeChild( Element *child );
  135. //! entfernt das i-te child (auf allen elementen in der Liste)
  136. //! \param i der Index des childs (bei 0 beginnend)
  137. DLLEXPORT void removeChild( int i );
  138. //! entfernt alle childs (auf allen elementen in der Liste)
  139. DLLEXPORT void removeAllChilds();
  140. //! entfernt eine Liste mit childs (auf allen elementen in der Liste)
  141. //! \param childs alle Childs die entfernt werden sollen
  142. DLLEXPORT void removeChilds( RCArray<Element> *childs );
  143. //! entfernt dieses Element vom Eltern element (auf allen elementen in der Liste)
  144. DLLEXPORT void remove();
  145. //! setzt den Text in dem Element falls es keine childs gibt (auf allen elementen in der Liste)
  146. //! \param text dert Text
  147. DLLEXPORT void setText( Text text );
  148. //! Gibt ein Iterator durch alle Elemente zurück
  149. DLLEXPORT Iterator<Element *> getIterator();
  150. //! gibt einen selector zurück der alle childs beinhaltet
  151. DLLEXPORT Editor selectChildren() const;
  152. //! gibt einen selector zurück der alle parents beinhaltet
  153. DLLEXPORT Editor selectParents() const;
  154. //! gibt eine Liste mit elementen zurück, die einen bestimmten Namen haben
  155. //! \param name der name der Childs
  156. DLLEXPORT Editor whereNameEquals( Text name ) const;
  157. //! gibt eine Liste mit elementen zurück, die ein bestimmtes child haben
  158. //! \param name der name des childs
  159. DLLEXPORT Editor whereChildWithNameExists( Text name ) const;
  160. //! gibt eine Liste mit elementen zurück, die ein bestimmtes child haben
  161. //! \param attribute der name des attributes
  162. DLLEXPORT Editor whereChildWithAttributeExists( Text attribute ) const;
  163. //! gibt eine Liste mit elementen zurück, die ein bestimmtes child haben
  164. //! \param attribute der name des attributes
  165. //! \param value der Wert des Attributes
  166. DLLEXPORT Editor whereChildWithAttributeExists( Text attribute, Text value ) const;
  167. //! gibt eine Liste mit elementen zurück, die ein bestimmtes Attribut haben
  168. //! \param attribute der name des Attributes
  169. DLLEXPORT Editor whereAttributeExists( Text attribute ) const;
  170. //! gibt eine Liste mit elementen zurück, die ein bestimmtes Attribut mit einem bestimmten wert haben
  171. //! \param attribute der name des Attributes
  172. //! \param value der Wert des Attributes
  173. DLLEXPORT Editor whereAttributeEquals( Text attribute, Text value ) const;
  174. //! Gibt einen Editor zurück welcher nurnoch die Elemente enthält die nicht in e sind
  175. //! \param e Ein Editor mit elementen die nicht enthalten sein sollen
  176. DLLEXPORT Editor without( Editor e ) const;
  177. //! Ruft eine funktion für jedes Element auf (nimmt als argument ein Element objekt ohne erhöhten reference Counter)
  178. //! \param f die funktion
  179. DLLEXPORT void forEach( std::function< void( Element * ) > f ) const;
  180. };
  181. }
  182. }