Changeset 35128 in vbox

Timestamp:

Dec 15, 2010 12:38:41 PM (14 years ago)

Author:

vboxsync

Message:

Main: more backslash conversion in settings read/write, so add generic methods to XML classes

Location:

trunk

Files:

• include/VBox/com/string.h (modified) (1 diff)
• include/iprt/cpp/ministring.h (modified) (1 diff)
• include/iprt/cpp/xml.h (modified) (2 diffs)
• src/VBox/Main/glue/string.cpp (modified) (1 diff)
• src/VBox/Main/xml/Settings.cpp (modified) (7 diffs)
• src/VBox/Runtime/common/string/ministring.cpp (modified) (1 diff)
• src/VBox/Runtime/r3/xml.cpp (modified) (2 diffs)

trunk/include/VBox/com/string.h

@@ -552 +552 @@
 
     /**
-     * Converts all '\' characters into '/'.
-     */
-    Utf8Str& useForwardSlashes();
-
-    /**
      *  Static immutable empty-string object. May be used for comparison purposes.
      */

trunk/include/iprt/cpp/ministring.h

@@ -664 +664 @@
 
     /**
+     * Replaces all occurences of cFind with cReplace in the member string.
+     * In order not to produce invalid UTF-8, the characters must be ASCII
+     * values less than 128; this is not verified.
+     *
+     * @param cFind Character to replace. Must be ASCII < 128.
+     * @param cReplace Character to replace cFind with. Must be ASCII < 128.
+     */
+    void findReplace(char cFind, char cReplace);
+
+    /**
      * Returns a substring of "this" as a new Utf8Str.
      *

trunk/include/iprt/cpp/xml.h

@@ -454 +454 @@
     bool getAttributeValue(const char *pcszMatch, const char *&ppcsz) const;
     bool getAttributeValue(const char *pcszMatch, iprt::MiniString &str) const;
+    bool getAttributeValuePath(const char *pcszMatch, iprt::MiniString &str) const;
     bool getAttributeValue(const char *pcszMatch, int32_t &i) const;
     bool getAttributeValue(const char *pcszMatch, uint32_t &i) const;
@@ -473 +474 @@
         return setAttribute(pcszName, strValue.c_str());
     }
+    AttributeNode* setAttributePath(const char *pcszName, const iprt::MiniString &strValue);
     AttributeNode* setAttribute(const char *pcszName, int32_t i);
     AttributeNode* setAttribute(const char *pcszName, uint32_t i);

trunk/src/VBox/Main/glue/string.cpp

@@ -133 +133 @@
 }
 
-Utf8Str& Utf8Str::useForwardSlashes()
-{
-    for (size_t i = 0; i < length(); ++i)
-    {
-        char *p = &m_psz[i];
-        if (*p == '\\')
-            *p = '/';
-    }
-
-    return *this;
-}
-
 /**
  * Internal function used in Utf8Str copy constructors and assignment when

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

@@ -647 +647 @@
             if (fNeedsFilePath)
             {
-                if (!(pelmImage->getAttributeValue("filePath", med.strLocation)))
+                if (!(pelmImage->getAttributeValuePath("filePath", med.strLocation)))
                     throw ConfigFileError(this, &elmMedium, N_("Required %s/@filePath attribute is missing"), elmMedium.getName());
-                else
-                    // IPRT can handle forward slashes in file paths everywhere, but there might be
-                    // backslashes in the settings file, so convert them into forward slashes.
-                    med.strLocation.useForwardSlashes();
             }
         }
@@ -1011 +1007 @@
     pelmMedium->setAttribute("uuid", mdm.uuid.toStringCurly());
 
-    // always use forward slashes when writing out settings, never '\'
-    Utf8Str strLocation(mdm.strLocation);
-    strLocation.useForwardSlashes();
-    pelmMedium->setAttribute("location", strLocation);
+    pelmMedium->setAttributePath("location", mdm.strLocation);
 
     pelmMedium->setAttribute("format", mdm.strFormat);
@@ -3061 +3054 @@
     parseTimestamp(snap.timestamp, strTemp);
 
-    elmSnapshot.getAttributeValue("stateFile", snap.strStateFile);      // online snapshots only
+    elmSnapshot.getAttributeValuePath("stateFile", snap.strStateFile);      // online snapshots only
 
     // parse Hardware before the other elements because other things depend on it
@@ -3184 +3177 @@
             convertOldOSType_pre1_5(machineUserData.strOsType);
 
-        elmMachine.getAttributeValue("stateFile", strStateFile);
+        elmMachine.getAttributeValuePath("stateFile", strStateFile);
+
         if (elmMachine.getAttributeValue("currentSnapshot", str))
             parseUUID(uuidCurrentSnapshot, str);
 
-        elmMachine.getAttributeValue("snapshotFolder", machineUserData.strSnapshotFolder);
-        // IPRT can handle forward slashes in file paths everywhere, but there might be
-        // backslashes in the settings file, so convert them into forward slashes.
-        machineUserData.strSnapshotFolder.useForwardSlashes();
+        elmMachine.getAttributeValuePath("snapshotFolder", machineUserData.strSnapshotFolder);
 
         if (!elmMachine.getAttributeValue("currentStateModified", fCurrentStateModified))
@@ -4122 +4113 @@
 
     if (snap.strStateFile.length())
-        pelmSnapshot->setAttribute("stateFile", snap.strStateFile);
+        pelmSnapshot->setAttributePath("stateFile", snap.strStateFile);
 
     if (snap.strDescription.length())
@@ -4210 +4201 @@
          && !(fl & BuildMachineXML_SuppressSavedState)
        )
-        elmMachine.setAttribute("stateFile", strStateFile);
+        elmMachine.setAttributePath("stateFile", strStateFile);
     if (    (fl & BuildMachineXML_IncludeSnapshots)
          && !uuidCurrentSnapshot.isEmpty())
@@ -4216 +4207 @@
 
     if (machineUserData.strSnapshotFolder.length())
-    {
-        // always use forward slashes when writing out settings, never '\'
-        Utf8Str strSnapshotFolder(machineUserData.strSnapshotFolder);
-        strSnapshotFolder.useForwardSlashes();
-        elmMachine.setAttribute("snapshotFolder", strSnapshotFolder);
-    }
+        elmMachine.setAttributePath("snapshotFolder", machineUserData.strSnapshotFolder);
     if (!fCurrentStateModified)
         elmMachine.setAttribute("currentStateModified", fCurrentStateModified);

trunk/src/VBox/Runtime/common/string/ministring.cpp

@@ -212 +212 @@
 
     return npos;
+}
+
+void MiniString::findReplace(char cFind, char cReplace)
+{
+    for (size_t i = 0; i < length(); ++i)
+    {
+        char *p = &m_psz[i];
+        if (*p == cFind)
+            *p = cReplace;
+    }
 }
 

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

@@ -831 +831 @@
     {
         str = pAttr->getValue();
+        return true;
+    }
+
+    return false;
+}
+
+/**
+ * Like getAttributeValue (ministring variant), but makes sure that all backslashes
+ * are converted to forward slashes.
+ * @param pcszMatch
+ * @param str
+ * @return
+ */
+bool ElementNode::getAttributeValuePath(const char *pcszMatch, iprt::MiniString &str) const
+{
+    if (getAttributeValue(pcszMatch, str))
+    {
+        str.findReplace('\\', '/');
         return true;
     }
@@ -1054 +1072 @@
 
 /**
+ * Like setAttribute (ministring variant), but replaces all backslashes with forward slashes
+ * before calling that one.
+ * @param pcszName
+ * @param strValue
+ * @return
+ */
+AttributeNode* ElementNode::setAttributePath(const char *pcszName, const iprt::MiniString &strValue)
+{
+    iprt::MiniString strTemp(strValue);
+    strTemp.findReplace('\\', '/');
+    return setAttribute(pcszName, strTemp.c_str());
+}
+
+/**
  * Sets the given attribute; overloaded version for int32_t.
  *