include/anna/xml/DTD.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_DTD_hpp
  38 #define anna_xml_DTD_hpp
  39
  40 struct _xmlDtd;
  41 struct _xmlValidCtxt;
  42 struct _xmlDoc;
  43
  44 #include <anna/core/mt/Mutex.hpp>
  45 #include <anna/core/RuntimeException.hpp>
  46
  47 namespace anna {
  48
  49 namespace xml {
  50
  51 class Parser;
  52
  53 /**
  54    Clase base para manejar la DTD.
  55
  56    A continuacion podemos ver un estracto de la DTD que definirias las reglas
  57    de formacion del documento XML mostrado como ejemplo en Parser.
  58
  59    \code
  60    <?xml version="1.0" encoding="UTF-8"?>
  61    <!ELEMENT xvc (broadcast, ethernet, real, unreal)>
  62    <!ATTLIST xvc HeartBeat CDATA "2000">
  63
  64    <!-- broadcast -->
  65    <!ELEMENT broadcast (INetAddress+)>
  66    <!ELEMENT INetAddress EMPTY>
  67    <!ATTLIST INetAddress Address CDATA #REQUIRED>
  68    <!ATTLIST INetAddress Port CDATA #REQUIRED>
  69
  70    <!-- ethernet -->
  71    <!ELEMENT ethernet (Input, Output)>
  72    <!ATTLIST ethernet Mode (raw|ethernet) #REQUIRED>
  73    <!ATTLIST ethernet VirtualAddress CDATA #REQUIRED>
  74    <!ELEMENT Input EMPTY>
  75    <!ATTLIST Input Device CDATA #REQUIRED>
  76    <!ATTLIST Input PhysicalAccessPoint CDATA #REQUIRED>
  77    <!ATTLIST Input MAC CDATA #REQUIRED>
  78    <!ELEMENT Output EMPTY>
  79    <!ATTLIST Output Device CDATA #REQUIRED>
  80    <!ATTLIST Output PhysicalAccessPoint CDATA #REQUIRED>
  81    <!ATTLIST Output MAC CDATA #REQUIRED>
  82    \endcode
  83 */
  84 class DTD {
  85 public:
  86   /**
  87      Destructor.
  88   */
  89   virtual ~DTD();
  90
  91   /**
  92      Inicializa la DTD con un nuevo contenido.
  93      \param content Contenido de la DTD, depedendiendo del tipo de DTD hara referencia
  94      a un nombre de archivo, una URI o a una cadena.
  95   */
  96   void initialize(const char* content) throw(RuntimeException);
  97
  98 protected:
  99   /**
 100      Constructor.
 101   */
 102   DTD() : a_handle(NULL) {;}
 103
 104 private:
 105   Mutex a_mutex;
 106   _xmlDtd* a_handle;
 107
 108   void validate(_xmlValidCtxt* context, _xmlDoc* document) const throw(RuntimeException);
 109   virtual _xmlDtd* parse(const char* content) const throw(RuntimeException) = 0;
 110
 111   friend class Parser;
 112 };
 113
 114 }
 115 }
 116
 117 #endif