include/anna/xml/DocumentFile.hpp

   1 // ANNA - Anna is Not Nothingness Anymore
   2 //
   3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
   4 //
   5 // https://bitbucket.org/testillano/anna
   6 //
   7 // Redistribution and use in source and binary forms, with or without
   8 // modification, are permitted provided that the following conditions
   9 // are met:
  10 //
  11 //     * Redistributions of source code must retain the above copyright
  12 // notice, this list of conditions and the following disclaimer.
  13 //     * Redistributions in binary form must reproduce the above
  14 // copyright notice, this list of conditions and the following disclaimer
  15 // in the documentation and/or other materials provided with the
  16 // distribution.
  17 //     * Neither the name of Google Inc. nor the names of its
  18 // contributors may be used to endorse or promote products derived from
  19 // this software without specific prior written permission.
  20 //
  21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 //
  33 // Authors: eduardo.ramos.testillano@gmail.com
  34 //          cisco.tierra@gmail.com
  35
  36
  37 #ifndef anna_xml_DocumentFile_hpp
  38 #define anna_xml_DocumentFile_hpp
  39
  40 #include <anna/config/defines.hpp>
  41 #include <anna/xml/Document.hpp>
  42 #include <anna/xml/Compiler.hpp>
  43
  44 namespace anna {
  45
  46 namespace xml {
  47
  48 /**
  49    Clase para gestionar un documento XML contenido en un archivo.
  50 */
  51 class DocumentFile : public Document {
  52 public:
  53   /**
  54      Constructor.
  55   */
  56   DocumentFile() : a_filename("<none>"), a_rootNode(NULL) {;}
  57
  58   /**
  59   * Root node after parsing, or NULL if not analyzed by mean parse()
  60   *
  61   * @return XML document root node
  62   */
  63   const Node * getRootNode() const throw() { return a_rootNode; }
  64
  65   /**
  66      Devuelve el contenido asociado al documento XML.
  67      \return El contenido asociado al documento XML.
  68   */
  69   const anna::DataBlock& getContent() const throw(RuntimeException);
  70
  71   /**
  72    * Parse xml document and return root node
  73    * \return Root node
  74    * \warning Need previous initialization
  75    */
  76   const Node* parse() throw(RuntimeException) { return (a_rootNode = Document::parse()); }
  77
  78   /**
  79    * Parse xml document with dtd and return root node
  80    * \param dtd Validation DTD for XML document
  81    * \return Root node
  82    * \warning Need previous initialization
  83    */
  84   const Node* parse(const DTD& dtd) throw(RuntimeException) { return (a_rootNode = Document::parse(dtd)); }
  85
  86   /**
  87    * XML representation from loaded document
  88    * \return XML string
  89    * \warning Need previous initialization and parsing
  90    */
  91   std::string asXmlString() const throw() { Compiler c; return (c.apply(a_rootNode)); }
  92
  93
  94 protected:
  95   /**
  96      Nombre del fichero indicado como parametro al invocar a Document::initialize
  97   */
  98   std::string a_filename;
  99
 100 private:
 101   const anna::xml::Node * a_rootNode;
 102   virtual _xmlDoc* do_initialize(const char* filename) throw(RuntimeException);
 103   virtual _xmlDoc* do_initialize(const anna::DataBlock&) throw(RuntimeException);
 104 };
 105
 106 }
 107 }
 108
 109 #endif