Changeset 26485 in vbox for trunk/src/VBox/Runtime/common/misc

Timestamp:

Feb 14, 2010 6:59:06 AM (15 years ago)

Author:

vboxsync

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

57654

Message:

iprt/getopt: Added two standard options: h: --help/-help/-h/-?, V: --version,-version,-V. These can be disabled by giving using RTGETOPTINIT_FLAGS_NO_STD_OPTS. Added another init flag, RTGETOPTINIT_FLAGS_OPTS_FIRST, for making RTGetOpt return options first and then non-options. Converted tstGetOpt to RTTest.

File:

• trunk/src/VBox/Runtime/common/misc/getopt.cpp (modified) (18 diffs)

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

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2007 Sun Microsystems, Inc.
+ * Copyright (C) 2007-2010 Sun Microsystems, Inc.
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -44 +44 @@
 
 
+/*******************************************************************************
+*   Global Variables                                                           *
+*******************************************************************************/
+/**
+ * Standard options that gets included unless RTGETOPTINIT_FLAGS_NO_STD_OPTS is
+ * set.
+ */
+static RTGETOPTDEF const g_aStdOptions[] =
+{
+    {  "--help",        'h',    RTGETOPT_REQ_NOTHING },
+    {  "-help",         'h',    RTGETOPT_REQ_NOTHING },
+    {  "--version",     'V',    RTGETOPT_REQ_NOTHING },
+    {  "-version",      'V',    RTGETOPT_REQ_NOTHING },
+};
+/** The index of --help in g_aStdOptions.  Used for some trickery.  */
+#define RTGETOPT_STD_OPTIONS_HELP_IDX   0
+
+
 
 RTDECL(int) RTGetOptInit(PRTGETOPTSTATE pState, int argc, char **argv,
@@ -49 +67 @@
                          int iFirst, uint32_t fFlags)
 {
-    AssertReturn(!fFlags, VERR_INVALID_PARAMETER);
+    AssertReturn(!(fFlags & ~(RTGETOPTINIT_FLAGS_OPTS_FIRST | RTGETOPTINIT_FLAGS_NO_STD_OPTS)), VERR_INVALID_PARAMETER);
 
     pState->argv         = argv;
@@ -58 +76 @@
     pState->pszNextShort = NULL;
     pState->pDef         = NULL;
+    pState->uIndex       = UINT32_MAX;
+    pState->fFlags       = fFlags;
+    pState->cNonOptions  = 0;
 
     /* validate the options. */
@@ -68 +89 @@
     }
 
-    /** @todo Add an flag for sorting the arguments so that all the options comes
-     *        first. */
     return VINF_SUCCESS;
 }
@@ -180 +199 @@
  * @param   paOptions       Option array.
  * @param   cOptions        Number of items in the array.
- */
-static PCRTGETOPTDEF rtGetOptSearchLong(const char *pszOption, PCRTGETOPTDEF paOptions, size_t cOptions)
+ * @param   fFlags          Init flags.
+ */
+static PCRTGETOPTDEF rtGetOptSearchLong(const char *pszOption, PCRTGETOPTDEF paOptions, size_t cOptions, uint32_t fFlags)
 {
     PCRTGETOPTDEF pOpt = paOptions;
@@ -233 +253 @@
         pOpt++;
     }
+
+    if (!(fFlags & RTGETOPTINIT_FLAGS_NO_STD_OPTS))
+        for (uint32_t i = 0; i < RT_ELEMENTS(g_aStdOptions); i++)
+            if (!strcmp(pszOption, g_aStdOptions[i].pszLong))
+                return &g_aStdOptions[i];
+
     return NULL;
 }
@@ -244 +270 @@
  * @param   paOptions       Option array.
  * @param   cOptions        Number of items in the array.
- */
-static PCRTGETOPTDEF rtGetOptSearchShort(int chOption, PCRTGETOPTDEF paOptions, size_t cOptions)
+ * @param   fFlags          Init flags.
+ */
+static PCRTGETOPTDEF rtGetOptSearchShort(int chOption, PCRTGETOPTDEF paOptions, size_t cOptions, uint32_t fFlags)
 {
     PCRTGETOPTDEF pOpt = paOptions;
@@ -253 +280 @@
             return pOpt;
         pOpt++;
+    }
+
+    if (!(fFlags & RTGETOPTINIT_FLAGS_NO_STD_OPTS))
+    {
+        for (uint32_t i = 0; i < RT_ELEMENTS(g_aStdOptions); i++)
+            if (g_aStdOptions[i].iShort == chOption)
+                return &g_aStdOptions[i];
+        if (chOption == '?')
+            return &g_aStdOptions[RTGETOPT_STD_OPTIONS_HELP_IDX];
     }
     return NULL;
@@ -395 +431 @@
 
 
+/**
+ * Moves one argv option entries.
+ *
+ * @param   papszTo             Destination.
+ * @param   papszFrom           Source.
+ */
+static void rtGetOptMoveArgvEntries(char **papszTo, char **papszFrom)
+{
+    if (papszTo != papszFrom)
+    {
+        Assert((uintptr_t)papszTo < (uintptr_t)papszFrom);
+        char * const pszMoved = papszFrom[0];
+        memmove(&papszTo[1], &papszTo[0], (uintptr_t)papszFrom - (uintptr_t)papszTo);
+        papszTo[0] = pszMoved;
+    }
+}
+
+
 RTDECL(int) RTGetOpt(PRTGETOPTSTATE pState, PRTGETOPTUNION pValueUnion)
 {
@@ -408 +462 @@
     pValueUnion->u64 = 0;
     pValueUnion->pDef = NULL;
-
-    /** @todo Handle '--' (end of options).*/
-    /** @todo Add a flag to RTGetOptInit for handling the various help options in
-     *        a common way. (-?,-h,-help,--help,++) */
-    /** @todo Add a flag to RTGetOptInit for handling the standard version options
-     *        in a common way. (-V,--version) */
 
     /*
@@ -428 +476 @@
          * We've got short options left over from the previous call.
          */
-        pOpt = rtGetOptSearchShort(*pState->pszNextShort, pState->paOptions, pState->cOptions);
+        pOpt = rtGetOptSearchShort(*pState->pszNextShort, pState->paOptions, pState->cOptions, pState->fFlags);
         if (!pOpt)
         {
@@ -442 +490 @@
     {
         /*
-         * Pop off the next argument.
+         * Pop off the next argument.  Sorting options and dealing with the
+         * dash-dash makes this a little extra complicated.
          */
-        if (pState->iNext >= pState->argc)
-            return 0;
-        iThis = pState->iNext++;
-        pszArgThis = pState->argv[iThis];
-
-        /*
-         * Do a long option search first and then a short option one.
-         * This way we can make sure single dash long options doesn't
-         * get mixed up with short ones.
-         */
-        pOpt = rtGetOptSearchLong(pszArgThis, pState->paOptions, pState->cOptions);
-        if (    !pOpt
-            &&  pszArgThis[0] == '-'
-            &&  pszArgThis[1] != '-'
-            &&  pszArgThis[1] != '\0')
-        {
-            pOpt = rtGetOptSearchShort(pszArgThis[1], pState->paOptions, pState->cOptions);
-            fShort = pOpt != NULL;
-        }
-        else
-            fShort = false;
+        for (;;)
+        {
+            if (pState->iNext >= pState->argc)
+                return 0;
+
+            if (pState->cNonOptions)
+            {
+                if (pState->cNonOptions == INT32_MAX)
+                {
+                    pValueUnion->psz = pState->argv[pState->iNext++];
+                    return VINF_GETOPT_NOT_OPTION;
+                }
+
+                if (pState->iNext + pState->cNonOptions >= pState->argc)
+                {
+                    pState->cNonOptions = INT32_MAX;
+                    continue;
+                }
+            }
+
+            iThis = pState->iNext++;
+            pszArgThis = pState->argv[iThis + pState->cNonOptions];
+
+            /*
+             * Do a long option search first and then a short option one.
+             * This way we can make sure single dash long options doesn't
+             * get mixed up with short ones.
+             */
+            pOpt = rtGetOptSearchLong(pszArgThis, pState->paOptions, pState->cOptions, pState->fFlags);
+            if (    !pOpt
+                &&  pszArgThis[0] == '-'
+                &&  pszArgThis[1] != '-'
+                &&  pszArgThis[1] != '\0')
+            {
+                pOpt = rtGetOptSearchShort(pszArgThis[1], pState->paOptions, pState->cOptions, pState->fFlags);
+                fShort = pOpt != NULL;
+            }
+            else
+                fShort = false;
+
+            /* Look for dash-dash. */
+            if (!pOpt && !strcmp(pszArgThis, "--"))
+            {
+                rtGetOptMoveArgvEntries(&pState->argv[iThis], &pState->argv[iThis + pState->cNonOptions]);
+                pState->cNonOptions = INT32_MAX;
+                continue;
+            }
+
+            /* Options first hacks. */
+            if (pState->fFlags & RTGETOPTINIT_FLAGS_OPTS_FIRST)
+            {
+                if (pOpt)
+                    rtGetOptMoveArgvEntries(&pState->argv[iThis], &pState->argv[iThis + pState->cNonOptions]);
+                else if (*pszArgThis == '-')
+                {
+                    pValueUnion->psz = pszArgThis;
+                    return VERR_GETOPT_UNKNOWN_OPTION;
+                }
+                else
+                {
+                    /* not an option, add it to the non-options and try again. */
+                    pState->iNext--;
+                    pState->cNonOptions++;
+
+                    /* Switch to returning non-options if we've reached the end. */
+                    if (pState->iNext + pState->cNonOptions >= pState->argc)
+                        pState->cNonOptions = INT32_MAX;
+                    continue;
+                }
+            }
+
+            /* done */
+            break;
+        }
     }
 
@@ -492 +594 @@
                     if (iThis + 1 >= pState->argc)
                         return VERR_GETOPT_REQUIRED_ARGUMENT_MISSING;
-                    pszValue = pState->argv[iThis + 1];
+                    pszValue = pState->argv[iThis + pState->cNonOptions + 1];
+                    rtGetOptMoveArgvEntries(&pState->argv[iThis + 1], &pState->argv[iThis + pState->cNonOptions + 1]);
                     pState->iNext++;
                 }
@@ -528 +631 @@
                             return VERR_GETOPT_REQUIRED_ARGUMENT_MISSING;
                         pState->uIndex = uIndex;
-                        pszValue = pState->argv[iThis + 1];
+                        pszValue = pState->argv[iThis + pState->cNonOptions + 1];
+                        rtGetOptMoveArgvEntries(&pState->argv[iThis + 1], &pState->argv[iThis + pState->cNonOptions + 1]);
                         pState->iNext++;
                     }
@@ -541 +645 @@
                         if (iThis + 1 >= pState->argc)
                             return VERR_GETOPT_REQUIRED_ARGUMENT_MISSING;
-                        pszValue = pState->argv[iThis + 1];
+                        pszValue = pState->argv[iThis + pState->cNonOptions + 1];
+                        rtGetOptMoveArgvEntries(&pState->argv[iThis + 1], &pState->argv[iThis + pState->cNonOptions + 1]);
                         pState->iNext++;
                     }
@@ -600 +705 @@
      * fail with unkown option, and if it doesn't we'll return it as a non-option.
      */
-
     if (*pszArgThis == '-')
     {
@@ -635 +739 @@
         return VERR_GETOPT_REQUIRED_ARGUMENT_MISSING;
     int         iThis    = pState->iNext++;
-    const char *pszValue = pState->argv[iThis];
+    const char *pszValue = pState->argv[iThis + (pState->cNonOptions != INT32_MAX ? pState->cNonOptions : 0)];
     pValueUnion->pDef    = pOpt; /* in case of no value or error. */
+
+    if (pState->cNonOptions && pState->cNonOptions != INT32_MAX)
+        rtGetOptMoveArgvEntries(&pState->argv[iThis], &pState->argv[iThis + pState->cNonOptions]);
 
     return rtGetOptProcessValue(fFlags, pszValue, pValueUnion);