1 // ANNA - Anna is Not Nothingness Anymore //
3 // (c) Copyright 2005-2015 Eduardo Ramos Testillano & Francisco Ruiz Rayo //
5 // See project site at http://redmine.teslayout.com/projects/anna-suite //
6 // See accompanying file LICENSE or copy at http://www.teslayout.com/projects/public/anna.LICENSE //
9 #ifndef anna_xml_Document_hpp
10 #define anna_xml_Document_hpp
16 #include <anna/core/DataBlock.hpp>
17 #include <anna/core/RuntimeException.hpp>
29 Clase base para manejar los documentos XML.
31 Ejemplo de documento XML:
35 <xvc HeartBeat="20000">
37 <INetAddress Address="204.152.65.15" Port="2000"/>
38 <INetAddress Address="204.152.65.47" Port="2002"/>
41 <ethernet Mode="raw" VirtualAddress="1.1.1.100">
42 <Input Device="/dev/qfe" PhysicalAccessPoint="2" MAC="8:0:20:9e:ee:21"/>
43 <Output Device="/dev/qfe" PhysicalAccessPoint="2" MAC="8:0:20:9e:ee:c9"/>
49 class Document : anna::DataBlock {
57 Inicializa el contenido del documento XML.
58 \param content Contenido de la Documento, depedendiendo del tipo de Documento hara referencia
59 a un nombre de archivo, una URI o a una cadena.
61 void initialize(const char* content) throw(RuntimeException);
64 Inicializa el contenido del documento XML.
65 \param content Contenido del Documento XML.
67 void initialize(const DataBlock& content) throw(RuntimeException);
70 * Obtiene el conjunto de caracteres usado en el documento XML. Puede ser NULL.
71 * \return El conjunto de caracteres usado en el documento XML.
73 const char* getEncoding() const throw();
76 * Obtiene la versión indicada en el documento XML.Puede ser NULL.
77 * \return La versión indicada en el documento XML.
79 const char* getVersion() const throw();
82 Devuelve el contenido asociado al documento XML.
83 \return El contenido asociado al documento XML.
85 virtual const DataBlock& getContent() const throw(RuntimeException) { return *this; }
88 Devuelve el contenido asociado al documento XML expresado como una cadena C.
89 \return El contenido asociado al documento XML expresado como una cadena C.
91 const char* getContentAsCString() const throw(RuntimeException);
94 * Establece el conjunto de caracteres usado en el documento XML.
95 * \param encoding Literal que indica el conjunto de caracteres. Puede ser NULL.
97 void setEncoding(const char* encoding) throw();
100 * Establece la versión usada en el documento XML.
101 * \param encoding Literal que indica la versión. Puede ser NULL.
103 void setVersion(const char* version) throw();
106 * Analiza el contenido del documento XML y devuelve el nodo raíz.
107 * \return El nodo raiz del arbol XML correspondiente al resultado del analisis.
108 * \warning Este documento debe estar correctamente inicializado.
110 const xml::Node* parse() throw(RuntimeException);
113 * Analiza el documento XML recibido como parametro, y verifica que cumpla las reglas
114 * establecidas por la DTD.
115 * \param dtd DTD que debe cumplir el documento XML.
116 * \return El nodo raiz del arbol XML correspondiente al resultado del analisis.
117 * \warning Este documento debe estar correctamente inicializado.
119 const xml::Node* parse(const DTD& dtd) throw(RuntimeException);
128 * Libera la memoria asociada a los componentes de este documento.
130 void clear() throw();
133 * Establece el contenido de este documento XML.
134 * \param content Buffer que contiene una C-String con la que inciar este documento XML.
136 void setContent(const char* content) throw() {
138 DataBlock::append(content, anna_strlen(content) + 1);
139 a_contentIsCString = true;
143 * Establece el contenido de este documento XML.
144 * \param content Buffer que apunta al contenido con la que inciar este documento XML.
145 * \param size Longitud del buffer.
146 * \warning Sólo uso interno
148 void setContent(const char* content, const int size) throw() {
150 DataBlock::append(content, size);
151 a_contentIsCString = false;
155 * Establece el contenido de este documento XML.
156 * \param content Bloque de datos del que copiar el valor para iniciar este documento XML.
158 void setContent(const DataBlock& content) throw() {
159 DataBlock::operator= (content);
160 a_contentIsCString = false;
165 std::string* a_encoding;
166 std::string* a_version;
167 bool a_contentIsCString;
168 DataBlock* a_asCString;
171 Document(const Document&);
173 virtual _xmlDoc* do_initialize(const char* content) throw(RuntimeException) = 0;
174 virtual _xmlDoc* do_initialize(const DataBlock& content) throw(RuntimeException) = 0;