Changeset 17362 in vbox for trunk/include/VBox

Timestamp:

Mar 4, 2009 6:10:58 PM (16 years ago)

Author:

vboxsync

Message:

OVF: partial implementation of write support in XML classes.

File:

• trunk/include/VBox/xml.h (modified) (12 diffs)

trunk/include/VBox/xml.h

@@ -139 +139 @@
 {
 public:
-
     XmlError(xmlErrorPtr aErr);
 
@@ -151 +150 @@
 {
 public:
-
-    ENotImplemented (const char *aMsg = NULL) : LogicError (aMsg) {}
-    ENotImplemented (RT_SRC_POS_DECL) : LogicError (RT_SRC_POS_ARGS) {}
+    ENotImplemented(const char *aMsg = NULL) : LogicError(aMsg) {}
+    ENotImplemented(RT_SRC_POS_DECL) : LogicError(RT_SRC_POS_ARGS) {}
 };
 
@@ -159 +157 @@
 {
 public:
-
-    EInvalidArg (const char *aMsg = NULL) : LogicError (aMsg) {}
-    EInvalidArg (RT_SRC_POS_DECL) : LogicError (RT_SRC_POS_ARGS) {}
+    EInvalidArg(const char *aMsg = NULL) : LogicError(aMsg) {}
+    EInvalidArg(RT_SRC_POS_DECL) : LogicError(RT_SRC_POS_ARGS) {}
+};
+
+class VBOXXML_CLASS EDocumentNotEmpty : public LogicError
+{
+public:
+    EDocumentNotEmpty(const char *aMsg = NULL) : LogicError(aMsg) {}
+    EDocumentNotEmpty(RT_SRC_POS_DECL) : LogicError(RT_SRC_POS_ARGS) {}
 };
 
@@ -170 +174 @@
 {
 public:
-
-    ENoMemory (const char *aMsg = NULL) : RuntimeError (aMsg) {}
+    ENoMemory(const char *aMsg = NULL) : RuntimeError (aMsg) {}
     virtual ~ENoMemory() throw() {}
 };
@@ -321 +324 @@
 
     /**
-     * Destrroys the File object. If the object was created from a file name
+     * Destroys the File object. If the object was created from a file name
      * the corresponding file will be automatically closed. If the object was
      * created from a file handle, it will remain open.
@@ -418 +421 @@
 
 /*
- * Node
- *
+ * Node:
+ *  an XML node, which represents either an element or an attribute.
+ *
+ *  For elements, getName() returns the element name, and getValue()
+ *  returns the text contents, if any.
+ *
+ *  For attributes, getName() returns the attribute name, and getValue()
+ *  returns the attribute value, if any.
+ *
+ *  Since the default constructor is private, one can create new nodes
+ *  only through factory methods provided by the XML classes. These are:
+ *
+ *  --  xml::Document::createRootElement()
+ *  --  xml::Node::createChild()
+ *  --  xml::Node::setAttribute()
  */
 
@@ -428 +444 @@
 {
 public:
-    Node();
     ~Node();
 
@@ -451 +466 @@
     bool getAttributeValue(const char *pcszMatch, uint64_t &i) const;
 
-private:
+    Node* createChild(const char *pcszElementName);
+    Node* setAttribute(const char *pcszName, const char *pcszValue);
+
+private:
+    // hide the default constructor so people use only our factory methods
+    Node();
+
     friend class Document;
     friend class XmlFileParser;
@@ -477 +498 @@
 
 private:
+    /* Obscure class data */
     struct Data;
     Data *m;
@@ -491 +513 @@
     Document();
     ~Document();
+
     Document(const Document &x);
     Document& operator=(const Document &x);
@@ -496 +519 @@
     const Node* getRootElement() const;
 
+    Node* createRootElement(const char *pcszRootElementName);
+
 private:
     friend class XmlFileParser;
+    friend class XmlFileWriter;
 
     void refreshInternals();
@@ -539 +565 @@
 
     static int ReadCallback(void *aCtxt, char *aBuf, int aLen);
-
     static int CloseCallback (void *aCtxt);
 };
 
-
+/*
+ * XmlFileWriter
+ *
+ */
+
+class VBOXXML_CLASS XmlFileWriter
+{
+public:
+    XmlFileWriter(Document &doc);
+    ~XmlFileWriter();
+
+    void write(const char *pcszFilename);
+
+    static int WriteCallback(void *aCtxt, const char *aBuf, int aLen);
+    static int CloseCallback (void *aCtxt);
+
+private:
+    /* Obscure class data */
+    struct Data;
+    Data *m;
+};
 
 #if defined(_MSC_VER)