XML.h 11 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 <name attribut1 attribut2="value">text oder childs</name>
  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. // string: entweder der name des Elements oder ein XML Text der geparsed werden soll
  24. __declspec( dllexport ) Element( Text string );
  25. // Erstellt ein XML Element
  26. // string: entweder der name des Elements oder ein XML Text der geparsed werden soll
  27. // zParent: Ein Zeiger auf das eltern element (ohne erhöhten reference Counter)
  28. __declspec( dllexport ) Element( Text string, Element *zParent );
  29. __declspec( dllexport ) ~Element();
  30. // ändert ein attribut oder fügt eines hinzu
  31. // attribut: Der Name des Attributes
  32. // value: Der Wert des Attributes
  33. __declspec( dllexport ) void setAttribute( Text attribut, Text value );
  34. // entfernt ein attribut
  35. // attribut: Der Name des Attributes
  36. __declspec( dllexport ) void removeAttribute( Text attribut );
  37. // fügt ein child hinzu
  38. // child: Das neue Child Element
  39. __declspec( dllexport ) void addChild( Element *child );
  40. // fügt ein child hinzu
  41. // child: Das neue Child Element
  42. __declspec( dllexport ) void addChildAtFront( Element *child );
  43. // entfernt ein child
  44. // zChild: das zu entfernende Child
  45. __declspec( dllexport ) void removeChild( Element *child );
  46. // entfernt das i-te child
  47. // i: der Index des childs (bei 0 beginnend)
  48. __declspec( dllexport ) void removeChild( int i );
  49. // entfernt alle childs
  50. __declspec( dllexport ) void removeAllChilds();
  51. // entfernt eine Liste mit childs
  52. // childs: alle Childs die entfernt werden sollen
  53. __declspec( dllexport ) void removeChilds( RCArray<Element> *childs );
  54. // entfernt dieses Element vom Eltern element
  55. __declspec( dllexport ) void remove();
  56. // setzt den Text in dem Element falls es keine childs gibt
  57. // text: dert Text
  58. __declspec( dllexport ) void setText( Text text );
  59. // gibt den Text im Element zurück
  60. __declspec( dllexport ) Text getText() const;
  61. // gibt die Anzahl der Childs zurück
  62. __declspec( dllexport ) int getChildCount() const;
  63. // gibt das i-te child zurück
  64. __declspec( dllexport ) Element *getChild( int i ) const;
  65. // gibt das i-te child zurück (ohne erhöhten reference Counter)
  66. __declspec( dllexport ) Element *zChild( int i ) const;
  67. // gibt das parent element zurück
  68. __declspec( dllexport ) Element *getParent() const;
  69. // gibt das parent element zurück (ohne erhöhten reference Counter)
  70. __declspec( dllexport ) Element *zParent() const;
  71. // gibt einen iterator zurück mit dem durch alle childs iteriert werden kann
  72. __declspec( dllexport ) Iterator< Element* > getChilds() const;
  73. // gibt einen selector zurück der alle childs beinhaltet
  74. __declspec( dllexport ) Editor selectChildren() const;
  75. // gibt eine Liste mit childs zurück, die einen bestimmten Namen haben
  76. // name: der name der Childs
  77. __declspec( dllexport ) Editor selectChildsByName( Text name ) const;
  78. // gibt eine Liste mit childs zurück, die ein bestimmtes Attribut haben
  79. // attribute: der name des Attributes
  80. __declspec( dllexport ) Editor selectChildsByAttribute( Text attribute ) const;
  81. // gibt eine Liste mit childs zurück, die ein bestimmtes Attribut mit einem bestimmten wert haben
  82. // attribute: der name des Attributes
  83. // value: der Wert des Attributes
  84. __declspec( dllexport ) Editor selectChildsByAttribute( Text attribute, Text value ) const;
  85. // gibt 1 zurück, falls ein Attribut Name existiert, 0 sonnst
  86. __declspec( dllexport ) bool hasAttribute( Text name ) const;
  87. // gibt die Anzahl der Attribute zurück
  88. __declspec( dllexport ) int getAttributeCount() const;
  89. // gibt den Namen des i-ten Attributes zurück
  90. __declspec( dllexport ) Text getAttributeName( int i ) const;
  91. // gibt den Wert des i-ten Attributes zurück
  92. __declspec( dllexport ) Text getAttributeValue( int i ) const;
  93. // gibt den Wert eines Attributes zurück
  94. // attribut: Der Name des Attributes
  95. __declspec( dllexport ) Text getAttributeValue( Text attribut ) const;
  96. // gibt einen iterator zurück mit dem durch alle Attribut Namen iteriert werden kann
  97. __declspec( dllexport ) Iterator< Text* > getAttributeNames() const;
  98. // gibt einen iterator zurück mit dem durch alle Attribut Werte iteriert werden kann
  99. __declspec( dllexport ) Iterator< Text* > getAttributeValues() const;
  100. // gibt den Namen des Elementes zurück zurück
  101. __declspec( dllexport ) Text getName() const;
  102. // erzeugt einen XML Text der dieses Element und alle childs beinhaltet
  103. __declspec( dllexport ) Text toString() const;
  104. // Erzeugt eine Kopie ohne referenzen auf dieses objekt
  105. __declspec( dllexport ) Element *dublicate() const;
  106. // erhöht den reference Counter um 1 und gibt this zurück
  107. __declspec( dllexport ) Element *getThis();
  108. // verringert den reference Counter um 1 und gibt 0 zurück
  109. __declspec( 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. __declspec( dllexport ) Editor( RCArray< Element > *elements );
  120. __declspec( dllexport ) Editor( const Editor &e );
  121. __declspec( dllexport ) ~Editor();
  122. // ändert ein attribut oder fügt eines hinzu (auf allen elementen in der Liste)
  123. // attribut: Der Name des Attributes
  124. // value: Der Wert des Attributes
  125. __declspec( dllexport ) void setAttribute( Text attribut, Text value );
  126. // entfernt ein attribut (auf allen elementen in der Liste)
  127. // attribut: Der Name des Attributes
  128. __declspec( dllexport ) void removeAttribute( Text attribut );
  129. // fügt ein child hinzu (auf allen elementen in der Liste)
  130. // child: Das neue Child Element
  131. __declspec( dllexport ) void addChild( Element *child );
  132. // entfernt ein child (auf allen elementen in der Liste)
  133. // zChild: das zu entfernende Child
  134. __declspec( dllexport ) void removeChild( Element *child );
  135. // entfernt das i-te child (auf allen elementen in der Liste)
  136. // i: der Index des childs (bei 0 beginnend)
  137. __declspec( dllexport ) void removeChild( int i );
  138. // entfernt alle childs (auf allen elementen in der Liste)
  139. __declspec( dllexport ) void removeAllChilds();
  140. // entfernt eine Liste mit childs (auf allen elementen in der Liste)
  141. // childs: alle Childs die entfernt werden sollen
  142. __declspec( dllexport ) void removeChilds( RCArray<Element> *childs );
  143. // entfernt dieses Element vom Eltern element (auf allen elementen in der Liste)
  144. __declspec( dllexport ) void remove();
  145. // setzt den Text in dem Element falls es keine childs gibt (auf allen elementen in der Liste)
  146. // text: dert Text
  147. __declspec( dllexport ) void setText( Text text );
  148. // Gibt ein Iterator durch alle Elemente zurück
  149. __declspec( dllexport ) Iterator<Element *> getIterator();
  150. // gibt einen selector zurück der alle childs beinhaltet
  151. __declspec( dllexport ) Editor selectChildren() const;
  152. // gibt einen selector zurück der alle parents beinhaltet
  153. __declspec( dllexport ) Editor selectParents() const;
  154. // gibt eine Liste mit elementen zurück, die einen bestimmten Namen haben
  155. // name: der name der Childs
  156. __declspec( dllexport ) Editor whereNameEquals( Text name ) const;
  157. // gibt eine Liste mit elementen zurück, die ein bestimmtes child haben
  158. // name: der name des childs
  159. __declspec( dllexport ) Editor whereChildWithNameExists( Text name ) const;
  160. // gibt eine Liste mit elementen zurück, die ein bestimmtes child haben
  161. // attribute: der name des attributes
  162. __declspec( dllexport ) Editor whereChildWithAttributeExists( Text attribute ) const;
  163. // gibt eine Liste mit elementen zurück, die ein bestimmtes child haben
  164. // attribute: der name des attributes
  165. // value: der Wert des Attributes
  166. __declspec( dllexport ) Editor whereChildWithAttributeExists( Text attribute, Text value ) const;
  167. // gibt eine Liste mit elementen zurück, die ein bestimmtes Attribut haben
  168. // attribute: der name des Attributes
  169. __declspec( dllexport ) Editor whereAttributeExists( Text attribute ) const;
  170. // gibt eine Liste mit elementen zurück, die ein bestimmtes Attribut mit einem bestimmten wert haben
  171. // attribute: der name des Attributes
  172. // value: der Wert des Attributes
  173. __declspec( 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. // e: Ein Editor mit elementen die nicht enthalten sein sollen
  176. __declspec( 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. // f: die funktion
  179. __declspec( dllexport ) void forEach( std::function< void( Element * ) > f ) const;
  180. };
  181. }
  182. }