Changeset 45394 in vbox

Timestamp:

Apr 7, 2013 7:03:00 PM (12 years ago)

Author:

vboxsync

Message:

IPRT: A Study in Paths - Chapter 2: The splitting of a path into component strings.

Location:

trunk

Files:

• include/iprt/mangling.h (modified) (1 diff)
• include/iprt/path.h (modified) (6 diffs)
• src/VBox/Runtime/Makefile.kmk (modified) (2 diffs)
• src/VBox/Runtime/common/path/RTPathParse.cpp.h (modified) (1 diff)
• src/VBox/Runtime/common/path/RTPathSplit.cpp (added)
• src/VBox/Runtime/common/path/RTPathSplitA.cpp (added)
• src/VBox/Runtime/testcase/tstRTPath.cpp (modified) (7 diffs)

trunk/include/iprt/mangling.h

@@ -953 +953 @@
 # define RTPathSetTimesEx                               RT_MANGLER(RTPathSetTimesEx)
 # define RTPathSharedLibs                               RT_MANGLER(RTPathSharedLibs)
+# define RTPathSplit                                    RT_MANGLER(RTPathSplit)
+# define RTPathSplitATag                                RT_MANGLER(RTPathSplitATag)
+# define RTPathSplitFree                                RT_MANGLER(RTPathSplitFree)
 # define RTPathStartsWith                               RT_MANGLER(RTPathStartsWith)
 # define RTPathStartsWithRoot                           RT_MANGLER(RTPathStartsWithRoot)

trunk/include/iprt/path.h

@@ -48 +48 @@
 #if !defined(___iprt_param_h) || defined(DOXYGEN_RUNNING)
 # define RTPATH_MAX         (4096 + 4)    /* (PATH_MAX + 1) on linux w/ some alignment */
+#endif
+
+/** @def RTPATH_TAG
+ * The default allocation tag used by the RTPath allocation APIs.
+ *
+ * When not defined before the inclusion of iprt/string.h, this will default to
+ * the pointer to the current file name.  The string API will make of use of
+ * this as pointer to a volatile but read-only string.
+ */
+#ifndef RTPATH_TAG
+# define RTPATH_TAG     (__FILE__)
 #endif
 
@@ -452 +463 @@
  * @note This is not set for lone root specifications (RTPATH_PROP_UNC,
  *       RTPATH_PROP_ROOT_SLASH, or RTPATH_PROP_VOLUME).
- * @note The slash is not counted into the last component.  */
+ * @note The slash is not counted into the last component. However, it is
+ *       counted into cchPath. */
 #define RTPATH_PROP_DIR_SLASH       UINT16_C(0x0002)
 
@@ -519 +531 @@
  * (All other components in a split or parsed path requies slashes added.) */
 #define RTPATH_PROP_FIRST_NEEDS_NO_SLASH(a_fProps) \
-    ( (a_fProps) & (RTPATH_PROP_ROOT_SLASH | RTPATH_PROP_VOLUME | RTPATH_PROP_UNC) )
+    RT_BOOL( (a_fProps) & (RTPATH_PROP_ROOT_SLASH | RTPATH_PROP_VOLUME | RTPATH_PROP_UNC) )
 
 /** Macro to determin whether there is a root specification of any kind
  * (unix, volumes, unc). */
 #define RTPATH_PROP_HAS_ROOT_SPEC(a_fProps) \
-    ( (a_fProps) & (RTPATH_PROP_ROOT_SLASH | RTPATH_PROP_VOLUME | RTPATH_PROP_UNC) )
+    RT_BOOL( (a_fProps) & (RTPATH_PROP_ROOT_SLASH | RTPATH_PROP_VOLUME | RTPATH_PROP_UNC) )
 
 /** @} */
@@ -615 +627 @@
      * component lengths and necessary separators.
      * Do NOT use this to index in the source path in case it contains
-     * unnecessary slashes that RTPathParsed has ignored here. */
+     * unnecessary slashes that RTPathSplit has ignored here. */
     uint16_t    cchPath;
     /** Reserved (internal use).  */
@@ -656 +668 @@
  *                              (variable sized array at the end).  Must be at
  *                              least the size of RTPATHSPLIT.
+ * @param   fFlags              Combination of RTPATH_STR_F_XXX flags.
+ *                              Most users will pass 0.
  *
  * @sa      RTPathSplitA, RTPathParse.
  */
-RTDECL(int) RTPathSplit(const char *pszPath, PRTPATHSPLIT pSplit, size_t cbSplit);
+RTDECL(int) RTPathSplit(const char *pszPath, PRTPATHSPLIT pSplit, size_t cbSplit, uint32_t fFlags);
 
 /**
@@ -673 +687 @@
  *                              success.  This must be freed by calling
  *                              RTPathSplitFree().
+ * @param   fFlags              Combination of RTPATH_STR_F_XXX flags.
+ *                              Most users will pass 0.
  * @sa      RTPathSplitFree, RTPathSplit, RTPathParse.
  */
-RTDECL(int) RTPathSplitA(const char *pszPath, PRTPATHSPLIT *ppSplit);
+#define  RTPathSplitA(pszPath, ppSplit, fFlags)     RTPathSplitATag(pszPath, ppSplit, fFlags, RTPATH_TAG)
+
+/**
+ * Splits the path into individual component strings, allocating the buffer on
+ * the default thread heap.
+ *
+ * @returns IPRT status code.
+ * @retval  VERR_INVALID_POINTER if pParsed or pszPath is an invalid pointer.
+ * @retval  VERR_PATH_ZERO_LENGTH if the path is empty.
+ *
+ * @param   pszPath             The path to parse.
+ * @param   ppSplit             Where to return the pointer to the output on
+ *                              success.  This must be freed by calling
+ *                              RTPathSplitFree().
+ * @param   fFlags              Combination of RTPATH_STR_F_XXX flags.
+ *                              Most users will pass 0.
+ * @param   pszTag              Allocation tag used for statistics and such.
+ * @sa      RTPathSplitFree, RTPathSplit, RTPathParse.
+ */
+RTDECL(int) RTPathSplitATag(const char *pszPath, PRTPATHSPLIT *ppSplit, uint32_t fFlags, const char *pszTag);
 
 /**

trunk/src/VBox/Runtime/Makefile.kmk

@@ -366 +366 @@
         common/path/RTPathRealDup.cpp \
         common/path/RTPathRmCmd.cpp \
+        common/path/RTPathSplit.cpp \
+        common/path/RTPathSplitA.cpp \
         common/path/RTPathStartsWithRoot.cpp \
         common/path/RTPathStripExt.cpp \
@@ -1710 +1712 @@
         common/path/RTPathHasExt.cpp \
         common/path/RTPathHasPath.cpp \
-        common/path/RTPathParse.cpp \
         common/path/RTPathParseSimple.cpp \
         common/path/RTPathRealDup.cpp \

trunk/src/VBox/Runtime/common/path/RTPathParse.cpp.h

@@ -193 +193 @@
                 {
                     if (!(fFlags & RTPATH_STR_F_NO_END))
-                        fProps |= RTPATH_PROP_DIR_SLASH; /* (not counted) */
+                    {
+                        fProps |= RTPATH_PROP_DIR_SLASH; /* (not counted in component, but in cchPath) */
+                        cchPath++;
+                    }
                     else
                         fProps |= RTPATH_PROP_EXTRA_SLASHES;

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

@@ -39 +39 @@
 
 
-static void testParser(RTTEST hTest)
+static void testParserAndSplitter(RTTEST hTest)
 {
-    RTTestSub(hTest, "RTPathParse");
-
     static struct
     {
@@ -53 +51 @@
     } const s_aTests[] =
     {
+        { 2,  5,  5,  "/bin/",            RTPATH_PROP_ROOT_SLASH | RTPATH_PROP_ABSOLUTE | RTPATH_PROP_DIR_SLASH,                                                RTPATH_STR_F_STYLE_UNIX },
         { 2, 13,  9,  "C:/Config.sys",    RTPATH_PROP_VOLUME | RTPATH_PROP_ROOT_SLASH | RTPATH_PROP_ABSOLUTE | RTPATH_PROP_FILENAME | RTPATH_PROP_SUFFIX,       RTPATH_STR_F_STYLE_DOS },
         { 2, 13, 10,  "C://Config.sys",   RTPATH_PROP_VOLUME | RTPATH_PROP_ROOT_SLASH | RTPATH_PROP_ABSOLUTE | RTPATH_PROP_FILENAME | RTPATH_PROP_SUFFIX | RTPATH_PROP_EXTRA_SLASHES, RTPATH_STR_F_STYLE_DOS },
@@ -65 +64 @@
         { 1,  1,  1,  "/",                RTPATH_PROP_ROOT_SLASH | RTPATH_PROP_ABSOLUTE,                                                                        RTPATH_STR_F_STYLE_UNIX },
         { 2,  4,  4,  "/bin",             RTPATH_PROP_ROOT_SLASH | RTPATH_PROP_ABSOLUTE | RTPATH_PROP_FILENAME,                                                 RTPATH_STR_F_STYLE_UNIX },
-        { 2,  4,  5,  "/bin/",            RTPATH_PROP_ROOT_SLASH | RTPATH_PROP_ABSOLUTE | RTPATH_PROP_DIR_SLASH,                                                RTPATH_STR_F_STYLE_UNIX },
+        { 2,  5,  5,  "/bin/",            RTPATH_PROP_ROOT_SLASH | RTPATH_PROP_ABSOLUTE | RTPATH_PROP_DIR_SLASH,                                                RTPATH_STR_F_STYLE_UNIX },
         { 3,  7,  7,  "/bin/ls",          RTPATH_PROP_ROOT_SLASH | RTPATH_PROP_ABSOLUTE | RTPATH_PROP_FILENAME,                                                 RTPATH_STR_F_STYLE_UNIX },
         { 3,  12, 7,  "/etc/rc.conf",     RTPATH_PROP_ROOT_SLASH | RTPATH_PROP_ABSOLUTE | RTPATH_PROP_FILENAME | RTPATH_PROP_SUFFIX,                            RTPATH_STR_F_STYLE_UNIX },
@@ -72 +71 @@
         { 3,  6,  7,  "/.//bin",          RTPATH_PROP_ROOT_SLASH | RTPATH_PROP_ABSOLUTE | RTPATH_PROP_EXTRA_SLASHES | RTPATH_PROP_DOT_REFS | RTPATH_PROP_FILENAME, RTPATH_STR_F_STYLE_UNIX },
         { 1,  3,  3,  "bin",              RTPATH_PROP_RELATIVE | RTPATH_PROP_FILENAME,                                                                          RTPATH_STR_F_STYLE_UNIX },
-        { 1,  3,  4,  "bin/",             RTPATH_PROP_RELATIVE | RTPATH_PROP_DIR_SLASH,                                                                         RTPATH_STR_F_STYLE_UNIX },
-        { 1,  3,  7,  "bin////",          RTPATH_PROP_RELATIVE | RTPATH_PROP_DIR_SLASH | RTPATH_PROP_EXTRA_SLASHES,                                             RTPATH_STR_F_STYLE_UNIX },
+        { 1,  4,  4,  "bin/",             RTPATH_PROP_RELATIVE | RTPATH_PROP_DIR_SLASH,                                                                         RTPATH_STR_F_STYLE_UNIX },
+        { 1,  4,  7,  "bin////",          RTPATH_PROP_RELATIVE | RTPATH_PROP_DIR_SLASH | RTPATH_PROP_EXTRA_SLASHES,                                             RTPATH_STR_F_STYLE_UNIX },
         { 3, 10, 10,  "bin/../usr",       RTPATH_PROP_RELATIVE | RTPATH_PROP_DOTDOT_REFS | RTPATH_PROP_FILENAME,                                                RTPATH_STR_F_STYLE_UNIX },
         { 4, 11, 11,  "/bin/../usr",      RTPATH_PROP_ROOT_SLASH | RTPATH_PROP_RELATIVE | RTPATH_PROP_DOTDOT_REFS | RTPATH_PROP_FILENAME,                       RTPATH_STR_F_STYLE_UNIX },
@@ -91 +90 @@
     {
         RTPATHPARSED    Parsed;
+        RTPATHSPLIT     Split;
         uint8_t         ab[4096];
     } u;
 
+    RTTestSub(hTest, "RTPathParse");
     for (uint32_t i = 0; i < RT_ELEMENTS(s_aTests); i++)
     {
+        memset(&u, i & 1 ? 0xff : 0, sizeof(u));
         int rc = RTPathParse(s_aTests[i].pszPath, &u.Parsed, sizeof(u), s_aTests[i].fFlags);
         if (   rc != VINF_SUCCESS
@@ -114 +116 @@
                                  s_aTests[i].offSuffix, u.Parsed.offSuffix,
                                  s_aTests[i].cchPath,   u.Parsed.cchPath);
+        }
+    }
+
+    RTTestSub(hTest, "RTPathSplit");
+    for (uint32_t i = 0; i < RT_ELEMENTS(s_aTests); i++)
+    {
+        memset(&u, i & 1 ? 0xff : 0, sizeof(u));
+        int rc = RTPathSplit(s_aTests[i].pszPath, &u.Split, sizeof(u), s_aTests[i].fFlags);
+        if (   rc != VINF_SUCCESS
+            || s_aTests[i].cComps    != u.Split.cComps
+            || s_aTests[i].fProps    != u.Split.fProps
+            || s_aTests[i].cchPath   != u.Split.cchPath)
+        {
+            RTTestFailed(hTest, "i=%d rc=%Rrc %s", i, rc, s_aTests[i].pszPath);
+            RTTestFailureDetails(hTest,
+                                 "  cComps    %u, got %u\n"
+                                 "  fProps    %#x, got %#x, xor=>%#x\n"
+                                 "  cchPath   %u, got %u\n"
+                                 ,
+                                 s_aTests[i].cComps,    u.Split.cComps,
+                                 s_aTests[i].fProps,    u.Split.fProps, s_aTests[i].fProps ^ u.Split.fProps,
+                                 s_aTests[i].cchPath,   u.Split.cchPath);
+        }
+        else
+        {
+            RTTESTI_CHECK_MSG(*u.Split.pszSuffix == '\0' || *u.Split.pszSuffix == '.', ("%s", u.Split.pszSuffix));
+            for (uint32_t idxComp = RTPATH_PROP_HAS_ROOT_SPEC(u.Split.fProps); idxComp < u.Split.cComps; idxComp++)
+                if ( (s_aTests[i].fFlags & RTPATH_STR_F_STYLE_MASK) == RTPATH_STR_F_STYLE_DOS
+                    ? strpbrk(u.Split.apszComps[idxComp], "/\\")
+                    : strchr(u.Split.apszComps[idxComp], RTPATH_SLASH) )
+                    RTTestFailed(hTest, "i=%d idxComp=%d '%s'", i, idxComp, u.Split.apszComps[idxComp]);
+
+            PRTPATHSPLIT pSplit = NULL;
+            RTTESTI_CHECK_RC(rc = RTPathSplitA(s_aTests[i].pszPath, &pSplit, s_aTests[i].fFlags), VINF_SUCCESS);
+            if (RT_SUCCESS(rc))
+            {
+                RTTESTI_CHECK(pSplit);
+                RTTESTI_CHECK(pSplit->cComps   == u.Split.cComps);
+                RTTESTI_CHECK(pSplit->fProps   == u.Split.fProps);
+                RTTESTI_CHECK(pSplit->cchPath  == u.Split.cchPath);
+                RTTESTI_CHECK(pSplit->cbNeeded == u.Split.cbNeeded);
+                RTTESTI_CHECK(!strcmp(pSplit->pszSuffix, u.Split.pszSuffix));
+                for (uint32_t idxComp = 0; idxComp < u.Split.cComps; idxComp++)
+                    RTTESTI_CHECK(!strcmp(pSplit->apszComps[idxComp], pSplit->apszComps[idxComp]));
+                RTPathSplitFree(pSplit);
+            }
         }
     }
@@ -702 +750 @@
     }
 
-    testParser(hTest);
+    testParserAndSplitter(hTest);
 
     /*