Changeset 26476 in vbox

Timestamp:

Feb 13, 2010 2:06:41 AM (15 years ago)

Author:

vboxsync

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

57643

Message:

iprt: Added RTPathCountComponents, RTPathCopyComponents, RTGetOptArgvFromString and RTGetOptArgvFree.

Location:

trunk

Files:

• include/iprt/getopt.h (modified) (1 diff)
• include/iprt/path.h (modified) (1 diff)
• src/VBox/Runtime/Makefile.kmk (modified) (3 diffs)
• src/VBox/Runtime/common/misc/getoptargv.cpp (added)
• src/VBox/Runtime/common/path/RTPathAppend.cpp (modified) (3 diffs)
• src/VBox/Runtime/common/path/RTPathCopyComponents.cpp (added)
• src/VBox/Runtime/common/path/RTPathCountComponents.cpp (added)
• src/VBox/Runtime/common/path/rtPathRootSpecLen.cpp (added)
• src/VBox/Runtime/common/path/rtPathVolumeSpecLen.cpp (modified) (1 diff)
• src/VBox/Runtime/include/internal/path.h (modified) (1 diff)
• src/VBox/Runtime/r3/posix/path-posix.cpp (modified) (1 diff)
• src/VBox/Runtime/r3/win/path-win.cpp (modified) (1 diff)
• src/VBox/Runtime/testcase/Makefile.kmk (modified) (2 diffs)
• src/VBox/Runtime/testcase/tstRTGetOptArgv.cpp (added)
• src/VBox/Runtime/testcase/tstRTPath.cpp (modified) (1 diff)

trunk/include/iprt/getopt.h

@@ -358 +358 @@
 RTDECL(int) RTGetOptPrintError(int ch, PCRTGETOPTUNION pValueUnion);
 
+/**
+ * Parses the @a pszCmdLine string into an argv array.
+ *
+ * This is useful for converting a response file or similar to an argument
+ * vector that can be used with RTGetOptInit().
+ *
+ * This function aims at following the bourn shell string quoting rules.
+ *
+ * @returns IPRT status code.
+ *
+ * @param   ppapszArgv      Where to return the argument vector.  This must be
+ *                          freed by calling RTGetOptArgvFree.
+ * @param   pcArgs          Where to return the argument count.
+ * @param   pszCmdLine      The string to parse.
+ * @param   pszSeparators   String containing the argument separators. If NULL,
+ *                          then space, tab, line feed (\\n) and return (\\r)
+ *                          are used.
+ */
+RTDECL(int) RTGetOptArgvFromString(char ***ppapszArgv, int *pcArgs, const char *pszCmdLine, const char *pszSeparators);
+
+/**
+ * Frees and argument vector returned by RTGetOptStringToArgv.
+ *
+ * @param   papszArgv       Argument vector.  NULL is fine.
+ */
+RTDECL(void) RTGetOptArgvFree(char **paArgv);
+
 /** @} */
 

trunk/include/iprt/path.h

@@ -320 +320 @@
 
 /**
+ * Counts the components in the specified path.
+ *
+ * An empty string has zero components.  A lone root slash is considered have
+ * one.  The paths "/init" and "/bin/" are considered having two components.  An
+ * UNC share specifier like "\\myserver\share" will be considered as one single
+ * component.
+ *
+ * @returns The number of path components.
+ * @param   pszPath     The path to parse.
+ */
+RTDECL(size_t) RTPathCountComponents(const char *pszPath);
+
+/**
+ * Copies the specified number of path components from @a pszSrc and into @a
+ * pszDst.
+ *
+ * @returns VINF_SUCCESS or VERR_BUFFER_OVERFLOW.  In the latter case the buffer
+ *          is not touched.
+ *
+ * @param   pszDst      The destination buffer.
+ * @param   cbDst       The size of the destination buffer.
+ * @param   pszSrc      The source path.
+ * @param   cComponents The number of components to copy from @a pszSrc.
+ */
+RTDECL(int) RTPathCopyComponents(char *pszDst, size_t cbDst, const char *pszSrc, size_t cComponents);
+
+/**
  * Compares two paths.
  *

trunk/src/VBox/Runtime/Makefile.kmk

@@ -252 +252 @@
         common/misc/cidr.cpp \
         common/misc/getopt.cpp \
+        common/misc/getoptargv.cpp \
         common/misc/handletable.cpp \
         common/misc/handletablectx.cpp \
@@ -266 +267 @@
         common/misc/term.cpp \
         common/misc/tar.cpp \
+        common/path/rtPathRootSpecLen.cpp \
         common/path/rtPathVolumeSpecLen.cpp \
         common/path/RTPathAbsDup.cpp \
@@ -271 +273 @@
         common/path/RTPathAbsExDup.cpp \
         common/path/RTPathAppend.cpp \
+        common/path/RTPathCopyComponents.cpp \
+        common/path/RTPathCountComponents.cpp \
         common/path/RTPathExt.cpp \
         common/path/RTPathFilename.cpp \

trunk/src/VBox/Runtime/common/path/RTPathAppend.cpp

@@ -35 +35 @@
 #include "internal/iprt.h"
 #include <iprt/path.h>
+
 #include <iprt/assert.h>
 #include <iprt/ctype.h>
@@ -50 +51 @@
  *
  * @remarks Unnecessary root slashes will not be counted. The caller will have
- *          to deal with it where it matters.
+ *          to deal with it where it matters.  (Unlike rtPathRootSpecLen which
+ *          counts them.)
  */
-static size_t rtPathRootSpecLen(const char *pszPath)
+static size_t rtPathRootSpecLen2(const char *pszPath)
 {
     /* fend of wildlife. */
@@ -170 +172 @@
         /* In the leading path we can skip unnecessary trailing slashes, but
            be sure to leave one. */
-        size_t const cchRoot = rtPathRootSpecLen(pszPath);
+        size_t const cchRoot = rtPathRootSpecLen2(pszPath);
         while (     (size_t)(pszPathEnd - pszPath) > RT_MAX(1, cchRoot)
                &&   RTPATH_IS_SLASH(pszPathEnd[-2]))

trunk/src/VBox/Runtime/common/path/rtPathVolumeSpecLen.cpp

@@ -44 +44 @@
  * If no such specifier zero is returned.
  */
-size_t rtPathVolumeSpecLen(const char *pszPath)
+DECLHIDDEN(size_t) rtPathVolumeSpecLen(const char *pszPath)
 {
 #if defined (RT_OS_OS2) || defined (RT_OS_WINDOWS)

trunk/src/VBox/Runtime/include/internal/path.h

@@ -43 +43 @@
 
 
-size_t  rtPathVolumeSpecLen(const char *pszPath);
-int     rtPathPosixRename(const char *pszSrc, const char *pszDst, unsigned fRename, RTFMODE fFileType);
-int     rtPathWin32MoveRename(const char *pszSrc, const char *pszDst, uint32_t fFlags, RTFMODE fFileType);
+DECLHIDDEN(size_t)  rtPathRootSpecLen(const char *pszPath);
+DECLHIDDEN(size_t)  rtPathVolumeSpecLen(const char *pszPath);
+DECLHIDDEN(int)     rtPathPosixRename(const char *pszSrc, const char *pszDst, unsigned fRename, RTFMODE fFileType);
+DECLHIDDEN(int)     rtPathWin32MoveRename(const char *pszSrc, const char *pszDst, uint32_t fFlags, RTFMODE fFileType);
 
 

trunk/src/VBox/Runtime/r3/posix/path-posix.cpp

@@ -662 +662 @@
  *                      not a directory (we are NOT checking whether it's a file).
  */
-int rtPathPosixRename(const char *pszSrc, const char *pszDst, unsigned fRename, RTFMODE fFileType)
+DECLHIDDEN(int) rtPathPosixRename(const char *pszSrc, const char *pszDst, unsigned fRename, RTFMODE fFileType)
 {
     /*

trunk/src/VBox/Runtime/r3/win/path-win.cpp

@@ -455 +455 @@
  *                      not a directory (we are NOT checking whether it's a file).
  */
-int rtPathWin32MoveRename(const char *pszSrc, const char *pszDst, uint32_t fFlags, RTFMODE fFileType)
+DECLHIDDEN(int) rtPathWin32MoveRename(const char *pszSrc, const char *pszDst, uint32_t fFlags, RTFMODE fFileType)
 {
     /*

trunk/src/VBox/Runtime/testcase/Makefile.kmk

@@ -66 +66 @@
         tstFork \
         tstGetOpt \
+        tstRTGetOptArgv \
         tstHandleTable \
         tstRTHeapOffset \
@@ -202 +203 @@
 tstGetOpt_SOURCES = tstGetOpt.cpp
 
+tstRTGetOptArgv_TEMPLATE = VBOXR3TSTEXE
+tstRTGetOptArgv_SOURCES = tstRTGetOptArgv.cpp
+
 tstHandleTable_SOURCES = tstHandleTable.cpp
 

trunk/src/VBox/Runtime/testcase/tstRTPath.cpp

@@ -414 +414 @@
 
     /*
+     * RTPathCountComponents
+     */
+    RTTestSub(hTest, "RTPathCountComponents");
+    RTTESTI_CHECK(RTPathCountComponents("") == 0);
+    RTTESTI_CHECK(RTPathCountComponents("/") == 1);
+    RTTESTI_CHECK(RTPathCountComponents("//") == 1);
+    RTTESTI_CHECK(RTPathCountComponents("//////////////") == 1);
+    RTTESTI_CHECK(RTPathCountComponents("//////////////bin") == 2);
+    RTTESTI_CHECK(RTPathCountComponents("//////////////bin/") == 2);
+    RTTESTI_CHECK(RTPathCountComponents("//////////////bin/////") == 2);
+    RTTESTI_CHECK(RTPathCountComponents("..") == 1);
+    RTTESTI_CHECK(RTPathCountComponents("../") == 1);
+    RTTESTI_CHECK(RTPathCountComponents("../..") == 2);
+    RTTESTI_CHECK(RTPathCountComponents("../../") == 2);
+#if defined (RT_OS_OS2) || defined (RT_OS_WINDOWS)
+    RTTESTI_CHECK(RTPathCountComponents("d:") == 1);
+    RTTESTI_CHECK(RTPathCountComponents("d:/") == 1);
+    RTTESTI_CHECK(RTPathCountComponents("d:/\\") == 1);
+    RTTESTI_CHECK(RTPathCountComponents("d:\\") == 1);
+    RTTESTI_CHECK(RTPathCountComponents("c:\\config.sys") == 2);
+    RTTESTI_CHECK(RTPathCountComponents("c:\\windows") == 2);
+    RTTESTI_CHECK(RTPathCountComponents("c:\\windows\\") == 2);
+    RTTESTI_CHECK(RTPathCountComponents("c:\\windows\\system32") == 3);
+    RTTESTI_CHECK(RTPathCountComponents("//./C$") == 1);
+    RTTESTI_CHECK(RTPathCountComponents("\\\\.\\C$") == 1);
+    RTTESTI_CHECK(RTPathCountComponents("/\\.\\C$") == 1);
+    RTTESTI_CHECK(RTPathCountComponents("//myserver") == 1);
+    RTTESTI_CHECK(RTPathCountComponents("//myserver/") == 1);
+    RTTESTI_CHECK(RTPathCountComponents("//myserver/share") == 1);
+    RTTESTI_CHECK(RTPathCountComponents("//myserver/share/") == 1);
+    RTTESTI_CHECK(RTPathCountComponents("//myserver/share\\") == 1);
+    RTTESTI_CHECK(RTPathCountComponents("//myserver/share\\x") == 2);
+    RTTESTI_CHECK(RTPathCountComponents("//myserver/share\\x\\y") == 3);
+    RTTESTI_CHECK(RTPathCountComponents("//myserver/share\\x\\y\\") == 3);
+#endif
+
+    /*
+     * RTPathCopyComponents
+     */
+    struct
+    {
+        const char *pszSrc;
+        size_t      cComponents;
+        const char *pszResult;
+    } s_aCopyComponents[] =
+    {
+        { "",                           0, "" },
+        { "",                           5, "" },
+        { "/",                          0, "" },
+        { "/",                          1, "/" },
+        { "/",                          2, "/" },
+        { "/usr/bin/sed",               0, "" },
+        { "/usr/bin/sed",               1, "/" },
+        { "/usr/bin/sed",               2, "/usr/" },
+        { "/usr/bin/sed",               3, "/usr/bin/" },
+        { "/usr/bin/sed",               4, "/usr/bin/sed" },
+        { "/usr/bin/sed",               5, "/usr/bin/sed" },
+        { "/usr/bin/sed",               6, "/usr/bin/sed" },
+        { "/usr///bin/sed",             2, "/usr///" },
+    };
+    for (unsigned i = 0; i < RT_ELEMENTS(s_aCopyComponents); i++)
+    {
+        const char *pszInput    = s_aCopyComponents[i].pszSrc;
+        size_t      cComponents = s_aCopyComponents[i].cComponents;
+        const char *pszResult   = s_aCopyComponents[i].pszResult;
+
+        memset(szPath, 'a', sizeof(szPath));
+        rc = RTPathCopyComponents(szPath, sizeof(szPath), pszInput, cComponents);
+        RTTESTI_CHECK_RC(rc, VINF_SUCCESS);
+        if (RT_SUCCESS(rc) && strcmp(szPath, pszResult))
+            RTTestIFailed("Unexpected result\n"
+                          "   input: '%s' cComponents=%u\n"
+                          "  output: '%s'\n"
+                          "expected: '%s'",
+                          pszInput, cComponents, szPath, pszResult);
+        else if (RT_SUCCESS(rc))
+        {
+            RTTESTI_CHECK_RC(RTPathCopyComponents(szPath, strlen(pszResult) + 1, pszInput, cComponents), VINF_SUCCESS);
+            RTTESTI_CHECK_RC(RTPathCopyComponents(szPath, strlen(pszResult), pszInput, cComponents), VERR_BUFFER_OVERFLOW);
+        }
+    }
+
+    /*
      * Summary.
      */