Changeset 36405 in vbox for trunk/src/VBox

Timestamp:

Mar 24, 2011 3:57:03 PM (14 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

70760

Message:

IPRT/xml: add optional parameter for adding a comment to the created xml file. Used by VirtualBox.xml and the VM config files to include a "do not edit" notice.

Location:

trunk/src/VBox

Files:

• Main/xml/Settings.cpp (modified) (2 diffs)
• Runtime/r3/xml.cpp (modified) (5 diffs)

trunk/src/VBox/Main/xml/Settings.cpp

@@ -52 +52 @@
 
 /*
- * Copyright (C) 2007-2010 Oracle Corporation
+ * Copyright (C) 2007-2011 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -864 +864 @@
     m->pDoc = new xml::Document;
 
-    m->pelmRoot = m->pDoc->createRootElement("VirtualBox");
+    m->pelmRoot = m->pDoc->createRootElement("VirtualBox",
+                                             "\n"
+                                             "** DO NOT EDIT THIS FILE.\n"
+                                             "** If you make changes to this file while any VirtualBox related application\n"
+                                             "** is running, your changes will be overwritten later, without taking effect.\n"
+                                             "** Use VBoxManage or the VirtualBox Manager GUI to make changes.\n"
+);
     m->pelmRoot->setAttribute("xmlns", VBOX_XML_NAMESPACE);
 

trunk/src/VBox/Runtime/r3/xml.cpp

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2007-2010 Oracle Corporation
+ * Copyright (C) 2007-2011 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -1308 +1308 @@
     xmlDocPtr   plibDocument;
     ElementNode *pRootElement;
+    ElementNode *pComment;
 
     Data()
@@ -1313 +1314 @@
         plibDocument = NULL;
         pRootElement = NULL;
+        pComment = NULL;
     }
 
@@ -1403 +1405 @@
  * only work if the document is empty; otherwise EDocumentNotEmpty is thrown.
  */
-ElementNode* Document::createRootElement(const char *pcszRootElementName)
+ElementNode* Document::createRootElement(const char *pcszRootElementName,
+                                         const char *pcszComment /* = NULL */)
 {
     if (m->pRootElement || m->plibDocument)
@@ -1415 +1418 @@
         throw std::bad_alloc();
     xmlDocSetRootElement(m->plibDocument, plibRootNode);
-
     // now wrap this in C++
     m->pRootElement = new ElementNode(NULL, NULL, plibRootNode);
+
+    // add document global comment if specified
+    if (pcszComment != NULL)
+    {
+        xmlNode *pComment;
+        if (!(pComment = xmlNewDocComment(m->plibDocument,
+                                          (const xmlChar *)pcszComment)))
+            throw std::bad_alloc();
+        xmlAddPrevSibling(plibRootNode, pComment);
+        // now wrap this in C++
+        m->pComment = new ElementNode(NULL, NULL, pComment);
+    }
 
     return m->pRootElement;