libcore/asobj/XML_as.h

   1 // XML_as.h:  ActionScript 3 "XMLDocument" class, for Gnash.
   2 //
   3 //   Copyright (C) 2009, 2010 Free Software Foundation, Inc.
   4 //
   5 // This program is free software; you can redistribute it and/or modify
   6 // it under the terms of the GNU General Public License as published by
   7 // the Free Software Foundation; either version 3 of the License, or
   8 // (at your option) any later version.
   9 //
  10 // This program is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with this program; if not, write to the Free Software
  17 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  18 //
  19
  20 #ifndef GNASH_ASOBJ3_XMLDOCUMENT_H
  21 #define GNASH_ASOBJ3_XMLDOCUMENT_H
  22
  23 #include "XMLNode_as.h"
  24 #include "dsodefs.h"
  25 #include "StringPredicates.h"
  26
  27 #include <map>
  28 #include <string>
  29
  30
  31 namespace gnash {
  32
  33 // Forward declarations
  34 class fn_call;
  35 class URL;
  36
  37 /// Implements XML (AS2) and flash.xml.XMLDocument (AS3) class.
  38 //
  39 /// This class interface is identical in AS3 and AS2; it is probably
  40 /// included in AS3 for backward compatibility.
  41 //
  42 /// The class definition is necessary because XML is encoded differently
  43 /// in AMF.
  44 class XML_as : public XMLNode_as
  45 {
  46 public:
  47
  48     typedef std::string::const_iterator xml_iterator;
  49
  50     enum ParseStatus {
  51             XML_OK = 0,
  52             XML_UNTERMINATED_CDATA = -2,
  53             XML_UNTERMINATED_XML_DECL = -3,
  54             XML_UNTERMINATED_DOCTYPE_DECL = -4,
  55             XML_UNTERMINATED_COMMENT = -5,
  56             XML_UNTERMINATED_ELEMENT = -6,
  57             XML_OUT_OF_MEMORY = -7,
  58             XML_UNTERMINATED_ATTRIBUTE = -8,
  59             XML_MISSING_CLOSE_TAG = -9,
  60             XML_MISSING_OPEN_TAG = -10
  61     };
  62
  63     enum LoadStatus {
  64         XML_LOADED_UNDEFINED = -1,
  65         XML_LOADED_FALSE = false,
  66         XML_LOADED_TRUE = true
  67     };
  68
  69     /// Create an XML object.
  70     //
  71     /// An XMLDocument is always user-created, so always starts with an
  72     /// associated object.
  73     XML_as(as_object& object);
  74
  75     XML_as(as_object& object, const std::string& xml);
  76
  77     ~XML_as() {};
  78
  79     /// Convert the XML object to a string
  80     //
  81     /// This calls XMLNode::toString after adding an xmlDecl and
  82     /// docTypeDecl
  83     //
  84     /// @param o        The ostream to write the string to.
  85     /// @param encode   Whether to URL encode the node values.
  86     void toString(std::ostream& o, bool encode) const;
  87
  88     const std::string& getXMLDecl() const {
  89         return _xmlDecl;
  90     }
  91
  92     void setXMLDecl(const std::string& xml) {
  93         _xmlDecl = xml;
  94     }
  95
  96     const std::string& getDocTypeDecl() const {
  97         return _docTypeDecl;
  98     }
  99
 100     void setDocTypeDecl(const std::string& docType) {
 101         _docTypeDecl = docType;
 102     }
 103
 104     // Methods
 105
 106     /// Parses an XML document into the specified XML object tree.
 107     //
 108     /// This reads in an XML file from disk and parses into into a memory
 109     /// resident tree which can be walked through later.
 110     ///
 111     /// Calls to this function clear any precedently parsed data.
 112     ///
 113     void parseXML(const std::string& xml);
 114
 115     XMLNode_as* createElement(const std::string& name);
 116
 117     XMLNode_as* createTextNode(const std::string& name);
 118
 119     ParseStatus status() const {
 120         return _status;
 121     }
 122
 123     void setStatus(ParseStatus st) {
 124         _status = st;
 125     }
 126
 127     LoadStatus loaded() const {
 128         return _loaded;
 129     }
 130
 131     void setLoaded(LoadStatus st) {
 132         _loaded = st;
 133     }
 134
 135 private:
 136
 137     typedef std::map<std::string, std::string, StringNoCaseLessThan> Attributes;
 138
 139     void parseTag(XMLNode_as*& node, xml_iterator& it, xml_iterator end);
 140
 141     void parseAttribute(XMLNode_as* node, xml_iterator& it,
 142             xml_iterator end, Attributes& attributes);
 143
 144     void parseDocTypeDecl( xml_iterator& it, xml_iterator end);
 145
 146     void parseText(XMLNode_as* node, xml_iterator& it, xml_iterator end);
 147
 148     void parseXMLDecl(xml_iterator& it, xml_iterator end);
 149
 150     void parseComment(XMLNode_as* node, xml_iterator& it, xml_iterator end);
 151
 152     void parseCData(XMLNode_as* node, xml_iterator& it, xml_iterator end);
 153
 154     /// Clear all properties.
 155     //
 156     /// This removes all children, resets doctype and xml decls, and
 157     /// sets status to XML.
 158     void clear();
 159
 160     /// \brief
 161     /// Return true if ignoreWhite property was set to anything evaluating
 162     /// to true.
 163     bool ignoreWhite();
 164
 165     // -1 if never asked to load anything
 166     //  0 if asked to load but not yet loaded (or failure)
 167     //  1 if successfully loaded
 168     LoadStatus _loaded;
 169
 170     ParseStatus _status;
 171
 172     std::string _docTypeDecl;
 173
 174     std::string _xmlDecl;
 175
 176 };
 177
 178
 179 /// Escape using XML entities.
 180 //
 181 /// Note this is not the same as a URL escape.
 182 void escapeXML(std::string& text);
 183 void unescapeXML(std::string& text);
 184
 185 /// Register the XML class.
 186 void xml_class_init(as_object& where, const ObjectURI& uri);
 187
 188 /// Register XML native functions.
 189 void registerXMLNative(as_object& where);
 190
 191 }       // namespace gnash
 192 #endif
 193
 194 // local Variables:
 195 // mode: C++
 196 // indent-tabs-mode: t
 197 // End:
 198