Changeset 30380 in vbox for trunk/src/VBox

Timestamp:

Jun 22, 2010 4:28:14 PM (15 years ago)

Author:

vboxsync

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

62987

Message:

Main: make calculateRelativePath methods a bit smarter and rename them to VirtualBox::copyPathRelativeToConfig() and Machine::copyPathRelativeToMachine()

Location:

trunk/src/VBox/Main

Files:

• MachineImpl.cpp (modified) (7 diffs)
• MediumImpl.cpp (modified) (1 diff)
• SnapshotImpl.cpp (modified) (1 diff)
• VirtualBoxImpl.cpp (modified) (1 diff)
• include/MachineImpl.h (modified) (1 diff)
• include/VirtualBoxImpl.h (modified) (1 diff)

trunk/src/VBox/Main/MachineImpl.cpp

@@ -5095 +5095 @@
 
 /**
- * Tries to calculate the relative path of the given absolute path using the
- * directory of the machine settings file as the base directory.
- *
- * @param  aPath    Absolute path to calculate the relative path for.
- * @param  aResult  Where to put the result (used only when it's possible to
- *                  make a relative path from the given absolute path; otherwise
- *                  left untouched).
+ * Copies strSource to strTarget, making it relative to the machine folder
+ * if it is a subdirectory thereof, or simply copying it otherwise.
+ *
+ * @param strSource Path to evalue and copy.
+ * @param strTarget Buffer to receive target path.
  *
  * @note Locks this object for reading.
  */
-void Machine::calculateRelativePath(const Utf8Str &strPath, Utf8Str &aResult)
+void Machine::copyPathRelativeToMachine(const Utf8Str &strSource,
+                                        Utf8Str &strTarget)
 {
     AutoCaller autoCaller(this);
@@ -5113 +5112 @@
 
     AssertReturnVoid(!mData->m_strConfigFileFull.isEmpty());
-
-    Utf8Str settingsDir = mData->m_strConfigFileFull;
-
-    settingsDir.stripFilename();
-    if (RTPathStartsWith(strPath.c_str(), settingsDir.c_str()))
-    {
-        /* when assigning, we create a separate Utf8Str instance because both
-         * aPath and aResult can point to the same memory location when this
-         * func is called (if we just do aResult = aPath, aResult will be freed
-         * first, and since its the same as aPath, an attempt to copy garbage
-         * will be made. */
-        aResult = Utf8Str(strPath.c_str() + settingsDir.length() + 1);
-    }
+    // use strTarget as a temporary buffer to hold the machine settings dir
+    strTarget = mData->m_strConfigFileFull;
+    strTarget.stripFilename();
+    if (RTPathStartsWith(strSource.c_str(), strTarget.c_str()))
+        // is relative: then append what's left
+        strTarget.append(strSource.c_str() + strTarget.length());     // include '/'
+    else
+        // is not relative: then overwrite
+        strTarget = strSource;
 }
 
@@ -7440 +7435 @@
             /* update m_strConfigFileFull amd mConfigFile */
             mData->m_strConfigFileFull = newConfigFile;
-
             // compute the relative path too
-            Utf8Str path = newConfigFile;
-            mParent->calculateRelativePath(path, path);
-            mData->m_strConfigFile = path;
+            mParent->copyPathRelativeToConfig(newConfigFile, mData->m_strConfigFile);
 
             // store the old and new so that VirtualBox::saveSettings() can update
@@ -7458 +7450 @@
 
             /* update the snapshot folder */
-            path = mUserData->mSnapshotFolderFull;
+            Utf8Str path = mUserData->mSnapshotFolderFull;
             if (RTPathStartsWith(path.c_str(), configDir.c_str()))
             {
@@ -7464 +7456 @@
                                   path.raw() + configDir.length());
                 mUserData->mSnapshotFolderFull = path;
-                calculateRelativePath(path, path);
-                mUserData->mSnapshotFolder = path;
+                Utf8Str strTemp;
+                copyPathRelativeToMachine(path, strTemp);
+                mUserData->mSnapshotFolder = strTemp;
             }
 
@@ -7720 +7713 @@
         Assert(!mSSData->mStateFilePath.isEmpty());
         /* try to make the file name relative to the settings file dir */
-        calculateRelativePath(mSSData->mStateFilePath, config.strStateFile);
-        if (!config.strStateFile.length())
-            // path is not relative (e.g. because snapshot folder was changed to a non-default location):
-            config.strStateFile = mSSData->mStateFilePath;
+        copyPathRelativeToMachine(mSSData->mStateFilePath, config.strStateFile);
     }
     else
@@ -8152 +8142 @@
             if (!mSSData->mStateFilePath.isEmpty())
                 /* try to make the file name relative to the settings file dir */
-                calculateRelativePath(mSSData->mStateFilePath, mData->pMachineConfigFile->strStateFile);
+                copyPathRelativeToMachine(mSSData->mStateFilePath, mData->pMachineConfigFile->strStateFile);
             else
                 mData->pMachineConfigFile->strStateFile.setNull();

trunk/src/VBox/Main/MediumImpl.cpp

@@ -2866 +2866 @@
                                      aNewPath,
                                      pcszMediumPath + strlen(aOldPath));
-        Utf8Str path = newPath;
-        m->pVirtualBox->calculateRelativePath(path, path);
         unconst(m->strLocationFull) = newPath;
+
+        Utf8Str path;
+        m->pVirtualBox->copyPathRelativeToConfig(newPath, path);
         unconst(m->strLocation) = path;
 

trunk/src/VBox/Main/SnapshotImpl.cpp

@@ -762 +762 @@
     /* stateFile (optional) */
     if (!stateFilePath().isEmpty())
-        /* try to make the file name relative to the settings file dir */
-        m->pMachine->calculateRelativePath(stateFilePath(), data.strStateFile);
+        m->pMachine->copyPathRelativeToMachine(stateFilePath(), data.strStateFile);
     else
         data.strStateFile.setNull();

trunk/src/VBox/Main/VirtualBoxImpl.cpp

@@ -3395 +3395 @@
 
 /**
- * Tries to calculate the relative path of the given absolute path using the
- * directory of the VirtualBox settings file as the base directory.
- *
- * @param  aPath    Absolute path to calculate the relative path for.
- * @param  aResult  Where to put the result (used only when it's possible to
- *                  make a relative path from the given absolute path; otherwise
- *                  left untouched).
- *
- * @note Doesn't lock any object.
- */
-void VirtualBox::calculateRelativePath(const Utf8Str &strPath, Utf8Str &aResult)
+ * Copies strSource to strTarget, making it relative to the VirtualBox config folder
+ * if it is a subdirectory thereof, or simply copying it otherwise.
+ *
+ * @param strSource Path to evalue and copy.
+ * @param strTarget Buffer to receive target path.
+ */
+void VirtualBox::copyPathRelativeToConfig(const Utf8Str &strSource,
+                                          Utf8Str &strTarget)
 {
     AutoCaller autoCaller(this);
     AssertComRCReturnVoid(autoCaller.rc());
 
-    /* no need to lock since mHomeDir is const */
-
-    Utf8Str settingsDir = m->strHomeDir;
-
-    if (RTPathStartsWith(strPath.c_str(), settingsDir.c_str()))
-    {
-        /* when assigning, we create a separate Utf8Str instance because both
-         * aPath and aResult can point to the same memory location when this
-         * func is called (if we just do aResult = aPath, aResult will be freed
-         * first, and since its the same as aPath, an attempt to copy garbage
-         * will be made. */
-        aResult = Utf8Str(strPath.c_str() + settingsDir.length() + 1);
-    }
+    // no need to lock since mHomeDir is const
+
+    // use strTarget as a temporary buffer to hold the machine settings dir
+    strTarget = m->strHomeDir;
+    if (RTPathStartsWith(strSource.c_str(), strTarget.c_str()))
+        // is relative: then append what's left
+        strTarget.append(strSource.c_str() + strTarget.length());     // include '/'
+    else
+        // is not relative: then overwrite
+        strTarget = strSource;
 }
 

trunk/src/VBox/Main/include/MachineImpl.h

@@ -615 +615 @@
 
     int calculateFullPath(const Utf8Str &strPath, Utf8Str &aResult);
-    void calculateRelativePath(const Utf8Str &strPath, Utf8Str &aResult);
+    void copyPathRelativeToMachine(const Utf8Str &strSource, Utf8Str &strTarget);
 
     void getLogFolder(Utf8Str &aLogFolder);

trunk/src/VBox/Main/include/VirtualBoxImpl.h

@@ -282 +282 @@
 
     int calculateFullPath(const Utf8Str &strPath, Utf8Str &aResult);
-    void calculateRelativePath(const Utf8Str &strPath, Utf8Str &aResult);
+    void copyPathRelativeToConfig(const Utf8Str &strSource, Utf8Str &strTarget);
 
     HRESULT registerHardDisk(Medium *aHardDisk, bool *pfNeedsSaveSettings);