Changeset 23644 in vbox for trunk/src/VBox

Timestamp:

Oct 9, 2009 12:28:56 PM (15 years ago)

Author:

vboxsync

Message:

Runtime: Added indexed options to RTGetOpt (eg: "--strwithindex14 value")

Location:

trunk/src/VBox/Runtime

Files:

• common/misc/getopt.cpp (modified) (5 diffs)
• testcase/tstGetOpt.cpp (modified) (4 diffs)

trunk/src/VBox/Runtime/common/misc/getopt.cpp

@@ -192 +192 @@
                  * A value is required with the argument. We're trying to be very
                  * understanding here and will permit any of the following:
-                 *      --long:value,  --long=value, --long value,
-                 *      --long: value, --long= value
+                 *      --long12:value,  --long12=value, --long12 value,
+                 *      --long:value,    --long=value,   --long value,
+                 *      --long: value,   --long= value
+                 *
+                 * If the option is index, then all trailing chars must be
+                 * digits.  For error reporting reasons we also match where
+                 * there is no index.
                  */
                 size_t cchLong = strlen(pOpt->pszLong);
-                if (    !strncmp(pszOption, pOpt->pszLong, cchLong)
-                    && (   pszOption[cchLong] == '\0'
+                if (!strncmp(pszOption, pOpt->pszLong, cchLong))
+                {
+                    if (pOpt->fFlags & RTGETOPT_FLAG_INDEX)
+                        while (RT_C_IS_DIGIT(pszOption[cchLong]))
+                            cchLong++;
+                    if (   pszOption[cchLong] == '\0'
                         || pszOption[cchLong] == ':'
-                        || pszOption[cchLong] == '='))
-                    return pOpt;
+                        || pszOption[cchLong] == '=')
+                        return pOpt;
+                }
+            }
+            else if (pOpt->fFlags & RTGETOPT_FLAG_INDEX)
+            {
+                /*
+                 * The option takes an index but no value.
+                 * As above, we also match where there is no index.
+                 */
+                size_t cchLong = strlen(pOpt->pszLong);
+                if (!strncmp(pszOption, pOpt->pszLong, cchLong))
+                {
+                    while (RT_C_IS_DIGIT(pszOption[cchLong]))
+                        cchLong++;
+                    if (pszOption[cchLong] == '\0')
+                        return pOpt;
+                }
             }
             else if (!strcmp(pszOption, pOpt->pszLong))
@@ -234 +259 @@
 RTDECL(int) RTGetOpt(PRTGETOPTSTATE pState, PRTGETOPTUNION pValueUnion)
 {
+    /*
+     * Reset the variables kept in state.
+     */
     pState->pDef = NULL;
+    pState->uIndex = UINT64_MAX;
+
     /*
      * Make sure the union is completely cleared out, whatever happens below.
@@ -338 +368 @@
             {
                 size_t cchLong = strlen(pOpt->pszLong);
-                if (    pszArgThis[cchLong]     == '\0'
-                    ||  pszArgThis[cchLong + 1] == '\0')
-                {
-                    if (iThis + 1 >= pState->argc)
-                        return VERR_GETOPT_REQUIRED_ARGUMENT_MISSING;
-                    pszValue = pState->argv[iThis + 1];
-                    pState->iNext++;
-                }
-                else /* same argument. */
-                    pszValue = &pszArgThis[cchLong + 1];
+                if (pOpt->fFlags & RTGETOPT_FLAG_INDEX)
+                {
+
+                    if (pszArgThis[cchLong] == '\0')
+                        return VERR_GETOPT_INDEX_MISSING;
+
+                    uint64_t uIndex;
+                    char *pszRet = NULL;
+                    int rc = RTStrToUInt64Ex(&pszArgThis[cchLong], &pszRet, 10, &uIndex);
+                    if (rc == VWRN_TRAILING_CHARS)
+                    {
+                        if (   pszRet[0] != ':'
+                            && pszRet[0] != '=')
+                            return VERR_GETOPT_INVALID_ARGUMENT_FORMAT;
+                        pState->uIndex = uIndex;
+                        pszValue = pszRet + 1;
+                    }
+                    else if (rc == VINF_SUCCESS)
+                    {
+                        if (iThis + 1 >= pState->argc)
+                            return VERR_GETOPT_REQUIRED_ARGUMENT_MISSING;
+                        pState->uIndex = uIndex;
+                        pszValue = pState->argv[iThis + 1];
+                        pState->iNext++;
+                    }
+                    else
+                        AssertMsgFailedReturn(("%s\n", pszArgThis), VERR_GETOPT_INVALID_ARGUMENT_FORMAT); /* search bug */
+                }
+                else
+                {
+                    if (    pszArgThis[cchLong]     == '\0'
+                        ||  pszArgThis[cchLong + 1] == '\0')
+                    {
+                        if (iThis + 1 >= pState->argc)
+                            return VERR_GETOPT_REQUIRED_ARGUMENT_MISSING;
+                        pszValue = pState->argv[iThis + 1];
+                        pState->iNext++;
+                    }
+                    else /* same argument. */
+                        pszValue = &pszArgThis[cchLong + 1];
+                }
             }
 
@@ -356 +417 @@
              * generic ints as octals.
              */
-            switch (pOpt->fFlags & (RTGETOPT_REQ_MASK | RTGETOPT_FLAG_HEX | RTGETOPT_FLAG_OCT | RTGETOPT_FLAG_DEC))
+            switch (pOpt->fFlags & (  RTGETOPT_REQ_MASK
+                                    | RTGETOPT_FLAG_HEX
+                                    | RTGETOPT_FLAG_DEC
+                                    | RTGETOPT_FLAG_OCT))
             {
                 case RTGETOPT_REQ_STRING:
@@ -480 +544 @@
             }
         }
+        else if (pOpt->fFlags & RTGETOPT_FLAG_INDEX)
+        {
+            size_t cchLong = strlen(pOpt->pszLong);
+            if (pszArgThis[cchLong] == '\0')
+                return VERR_GETOPT_INDEX_MISSING;
+
+            uint64_t uIndex;
+            char *pszRet = NULL;
+            if (RTStrToUInt64Full(&pszArgThis[cchLong], 10, &uIndex) == VINF_SUCCESS)
+                pState->uIndex = uIndex;
+            else
+                AssertMsgFailedReturn(("%s\n", pszArgThis), VERR_GETOPT_INVALID_ARGUMENT_FORMAT); /* search bug */
+        }
 
         pState->pDef = pOpt;

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

@@ -88 +88 @@
         { "--gateway",          'g', RTGETOPT_REQ_IPV4ADDR },
         { "--mac",              'm', RTGETOPT_REQ_MACADDR },
+        { "--strindex",         400, RTGETOPT_REQ_STRING  | RTGETOPT_FLAG_INDEX },
+        { "strindex",           400, RTGETOPT_REQ_STRING  | RTGETOPT_FLAG_INDEX },
+        { "--intindex",         401, RTGETOPT_REQ_INT32   | RTGETOPT_FLAG_INDEX },
+        { "--macindex",         402, RTGETOPT_REQ_MACADDR | RTGETOPT_FLAG_INDEX },
+        { "--indexnovalue",     403, RTGETOPT_REQ_NOTHING | RTGETOPT_FLAG_INDEX },
+        { "--macindexnegative", 404, RTGETOPT_REQ_NOTHING },
     };
 
@@ -129 +135 @@
         "--mac:1:::::c",
 
+        "--strindex786",    "string4",
+        "--strindex786:string5",
+        "--strindex786=string6",
+        "strindex687",      "string7",
+        "strindex687:string8",
+        "strindex687=string9",
+        "--intindex137",    "1000",
+        "--macindex138",    "08:0:27:00:ab:f3",
+        "--indexnovalue1",
+        "--macindexnegative",
+
         NULL
     };
@@ -137 +154 @@
     CHECK_GETOPT(RTGetOpt(&GetState, &Val), 's', 2);
     CHECK(VALID_PTR(Val.psz) && !strcmp(Val.psz, "string1"));
+    CHECK(GetState.uIndex == UINT64_MAX);
     CHECK_GETOPT(RTGetOpt(&GetState, &Val), 's', 2);
     CHECK(VALID_PTR(Val.psz) && !strcmp(Val.psz, "string2"));
+    CHECK(GetState.uIndex == UINT64_MAX);
 
     /* -i */
@@ -222 +241 @@
           && Val.MacAddr.au8[5] == 0x0c);
 
+    /* string with indexed argument */
+    CHECK_GETOPT(RTGetOpt(&GetState, &Val), 400, 2);
+    CHECK(VALID_PTR(Val.psz) && !strcmp(Val.psz, "string4"));
+    CHECK(GetState.uIndex == 786);
+
+    CHECK_GETOPT(RTGetOpt(&GetState, &Val), 400, 1);
+    CHECK(VALID_PTR(Val.psz) && !strcmp(Val.psz, "string5"));
+    CHECK(GetState.uIndex == 786);
+
+    CHECK_GETOPT(RTGetOpt(&GetState, &Val), 400, 1);
+    CHECK(VALID_PTR(Val.psz) && !strcmp(Val.psz, "string6"));
+    CHECK(GetState.uIndex == 786);
+
+    CHECK_GETOPT(RTGetOpt(&GetState, &Val), 400, 2);
+    CHECK(VALID_PTR(Val.psz) && !strcmp(Val.psz, "string7"));
+    CHECK(GetState.uIndex == 687);
+
+    CHECK_GETOPT(RTGetOpt(&GetState, &Val), 400, 1);
+    CHECK(VALID_PTR(Val.psz) && !strcmp(Val.psz, "string8"));
+    CHECK(GetState.uIndex == 687);
+
+    CHECK_GETOPT(RTGetOpt(&GetState, &Val), 400, 1);
+    CHECK(VALID_PTR(Val.psz) && !strcmp(Val.psz, "string9"));
+    CHECK(GetState.uIndex == 687);
+
+    CHECK_GETOPT(RTGetOpt(&GetState, &Val), 401, 2);
+    CHECK(Val.i32 == 1000);
+    CHECK(GetState.uIndex == 137);
+
+    CHECK_GETOPT(RTGetOpt(&GetState, &Val), 402, 2);
+    CHECK(   Val.MacAddr.au8[0] == 0x08
+          && Val.MacAddr.au8[1] == 0x00
+          && Val.MacAddr.au8[2] == 0x27
+          && Val.MacAddr.au8[3] == 0x00
+          && Val.MacAddr.au8[4] == 0xab
+          && Val.MacAddr.au8[5] == 0xf3);
+    CHECK(GetState.uIndex == 138);
+
+    CHECK_GETOPT(RTGetOpt(&GetState, &Val), 403, 1);
+    CHECK(GetState.uIndex == 1);
+
+    CHECK_GETOPT(RTGetOpt(&GetState, &Val), 404, 1);
+    CHECK(GetState.uIndex == UINT64_MAX);
+
     /* the end */
     CHECK_GETOPT(RTGetOpt(&GetState, &Val), 0, 0);