Changeset 77595 in vbox for trunk/src/VBox/Frontends/VBoxManage/VBoxInternalManage.cpp

Timestamp:

Mar 7, 2019 12:42:31 PM (6 years ago)

Author:

vboxsync

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

129222

Message:

VBoxManage: Re-do help category handling (command/sub-command specific help) for old-style commands to lift the low limit of the bit field approach for everything. This is now much closer to the handling of new-style commands, but far from converting anything old. While at it I eliminated the need to define an entry in the (old-style) USAGECATEGORY enum for new-style commands.

File:

• trunk/src/VBox/Frontends/VBoxManage/VBoxInternalManage.cpp (modified) (27 diffs)

trunk/src/VBox/Frontends/VBoxManage/VBoxInternalManage.cpp

@@ -135 +135 @@
  * Print the usage info.
  */
-void printUsageInternal(USAGECATEGORY u64Cmd, PRTSTREAM pStrm)
-{
+void printUsageInternal(USAGECATEGORY enmCommand, PRTSTREAM pStrm)
+{
+    Assert(enmCommand != USAGE_INVALID);
+    Assert(enmCommand != USAGE_S_NEWCMD);
+    Assert(enmCommand != USAGE_S_DUMPOPTS);
     RTStrmPrintf(pStrm,
         "Usage: VBoxManage internalcommands <command> [command arguments]\n"
@@ -147 +150 @@
         "         incompatible ways without warning.\n",
 
-        (u64Cmd & USAGE_LOADMAP)
+        (enmCommand == USAGE_I_LOADMAP || enmCommand == USAGE_S_ALL)
         ? "  loadmap <vmname|uuid> <symfile> <address> [module] [subtrahend] [segment]\n"
           "      This will instruct DBGF to load the given map file\n"
@@ -153 +156 @@
           "\n"
         : "",
-        (u64Cmd & USAGE_LOADSYMS)
+        (enmCommand == USAGE_I_LOADSYMS || enmCommand == USAGE_S_ALL)
         ? "  loadsyms <vmname|uuid> <symfile> [delta] [module] [module address]\n"
           "      This will instruct DBGF to load the given symbol file\n"
@@ -159 +162 @@
           "\n"
         : "",
-        (u64Cmd & USAGE_SETHDUUID)
+        (enmCommand == USAGE_I_SETHDUUID || enmCommand == USAGE_S_ALL)
         ? "  sethduuid <filepath> [<uuid>]\n"
           "       Assigns a new UUID to the given image file. This way, multiple copies\n"
@@ -165 +168 @@
           "\n"
         : "",
-        (u64Cmd & USAGE_SETHDPARENTUUID)
+        (enmCommand == USAGE_I_SETHDPARENTUUID || enmCommand == USAGE_S_ALL)
         ? "  sethdparentuuid <filepath> <uuid>\n"
           "       Assigns a new parent UUID to the given image file.\n"
           "\n"
         : "",
-        (u64Cmd & USAGE_DUMPHDINFO)
+        (enmCommand == USAGE_I_DUMPHDINFO || enmCommand == USAGE_S_ALL)
         ?  "  dumphdinfo <filepath>\n"
            "       Prints information about the image at the given location.\n"
            "\n"
         : "",
-        (u64Cmd & USAGE_LISTPARTITIONS)
+        (enmCommand == USAGE_I_LISTPARTITIONS || enmCommand == USAGE_S_ALL)
         ? "  listpartitions -rawdisk <diskname>\n"
           "       Lists all partitions on <diskname>.\n"
           "\n"
         : "",
-        (u64Cmd & USAGE_CREATERAWVMDK)
+        (enmCommand == USAGE_I_CREATERAWVMDK || enmCommand == USAGE_S_ALL)
         ? "  createrawvmdk -filename <filename> -rawdisk <diskname>\n"
           "                [-partitions <list of partition numbers> [-mbr <filename>] ]\n"
@@ -198 +201 @@
           "\n"
         : "",
-        (u64Cmd & USAGE_RENAMEVMDK)
+        (enmCommand == USAGE_I_RENAMEVMDK || enmCommand == USAGE_S_ALL)
         ? "  renamevmdk -from <filename> -to <filename>\n"
           "       Renames an existing VMDK image, including the base file and all its extents.\n"
           "\n"
         : "",
-        (u64Cmd & USAGE_CONVERTTORAW)
+        (enmCommand == USAGE_I_CONVERTTORAW || enmCommand == USAGE_S_ALL)
         ? "  converttoraw [-format <fileformat>] <filename> <outputfile>"
 #ifdef ENABLE_CONVERT_RAW_TO_STDOUT
@@ -216 +219 @@
           "\n"
         : "",
-        (u64Cmd & USAGE_CONVERTHD)
+        (enmCommand == USAGE_I_CONVERTHD || enmCommand == USAGE_S_ALL)
         ? "  converthd [-srcformat VDI|VMDK|VHD|RAW]\n"
           "            [-dstformat VDI|VMDK|VHD|RAW]\n"
@@ -223 +226 @@
           "\n"
         : "",
-        (u64Cmd & USAGE_REPAIRHD)
+        (enmCommand == USAGE_I_REPAIRHD || enmCommand == USAGE_S_ALL)
         ? "  repairhd [-dry-run]\n"
           "           [-format VDI|VMDK|VHD|...]\n"
@@ -231 +234 @@
         : "",
 #ifdef RT_OS_WINDOWS
-        (u64Cmd & USAGE_MODINSTALL)
+        (enmCommand == USAGE_I_MODINSTALL || enmCommand == USAGE_S_ALL)
         ? "  modinstall\n"
           "       Installs the necessary driver for the host OS\n"
           "\n"
         : "",
-        (u64Cmd & USAGE_MODUNINSTALL)
+        (enmCommand == USAGE_I_MODUNINSTALL || enmCommand == USAGE_S_ALL)
         ? "  moduninstall\n"
           "       Deinstalls the driver\n"
@@ -245 +248 @@
         "",
 #endif
-        (u64Cmd & USAGE_DEBUGLOG)
+        (enmCommand == USAGE_I_DEBUGLOG || enmCommand == USAGE_S_ALL)
         ? "  debuglog <vmname|uuid> [--enable|--disable] [--flags todo]\n"
           "           [--groups todo] [--destinations todo]\n"
@@ -251 +254 @@
           "\n"
         : "",
-        (u64Cmd & USAGE_PASSWORDHASH)
-        ? "  passwordhash <passsword>\n"
+        (enmCommand == USAGE_I_PASSWORDHASH || enmCommand == USAGE_S_ALL)
+        ? "  passwordhash <password>\n"
           "       Generates a password hash.\n"
           "\n"
         : "",
-        (u64Cmd & USAGE_GUESTSTATS)
+        (enmCommand == USAGE_I_GUESTSTATS || enmCommand == USAGE_S_ALL)
         ? "  gueststats <vmname|uuid> [--interval <seconds>]\n"
           "       Obtains and prints internal guest statistics.\n"
@@ -627 +630 @@
         uuidType = HDUUID;
         if (argc != 3 && argc != 2)
-            return errorSyntax(USAGE_SETHDUUID, "Not enough parameters");
+            return errorSyntax(USAGE_I_SETHDUUID, "Not enough parameters");
         /* if specified, take UUID, otherwise generate a new one */
         if (argc == 3)
         {
             if (RT_FAILURE(RTUuidFromStr(&rtuuid, argv[2])))
-                return errorSyntax(USAGE_SETHDUUID, "Invalid UUID parameter");
+                return errorSyntax(USAGE_I_SETHDUUID, "Invalid UUID parameter");
             uuid = argv[2];
         } else
@@ -641 +644 @@
         uuidType = HDPARENTUUID;
         if (argc != 3)
-            return errorSyntax(USAGE_SETHDPARENTUUID, "Not enough parameters");
+            return errorSyntax(USAGE_I_SETHDPARENTUUID, "Not enough parameters");
         if (RT_FAILURE(RTUuidFromStr(&rtuuid, argv[2])))
-            return errorSyntax(USAGE_SETHDPARENTUUID, "Invalid UUID parameter");
+            return errorSyntax(USAGE_I_SETHDPARENTUUID, "Invalid UUID parameter");
         uuid = argv[2];
     }
     else
-        return errorSyntax(USAGE_SETHDUUID, "Invalid invocation");
+        return errorSyntax(USAGE_I_SETHDUUID, "Invalid invocation");
 
     /* just try it */
@@ -699 +702 @@
     if (argc != 1)
     {
-        return errorSyntax(USAGE_DUMPHDINFO, "Not enough parameters");
+        return errorSyntax(USAGE_I_DUMPHDINFO, "Not enough parameters");
     }
 
@@ -1093 +1096 @@
         else
         {
-            return errorSyntax(USAGE_LISTPARTITIONS, "Invalid parameter '%s'", argv[i]);
+            return errorSyntax(USAGE_I_LISTPARTITIONS, "Invalid parameter '%s'", argv[i]);
         }
     }
 
     if (rawdisk.isEmpty())
-        return errorSyntax(USAGE_LISTPARTITIONS, "Mandatory parameter -rawdisk missing");
+        return errorSyntax(USAGE_I_LISTPARTITIONS, "Mandatory parameter -rawdisk missing");
 
     RTFILE hRawFile;
@@ -1210 +1213 @@
 #endif /* RT_OS_LINUX || RT_OS_FREEBSD */
         else
-            return errorSyntax(USAGE_CREATERAWVMDK, "Invalid parameter '%s'", argv[i]);
+            return errorSyntax(USAGE_I_CREATERAWVMDK, "Invalid parameter '%s'", argv[i]);
     }
 
     if (filename.isEmpty())
-        return errorSyntax(USAGE_CREATERAWVMDK, "Mandatory parameter -filename missing");
+        return errorSyntax(USAGE_I_CREATERAWVMDK, "Mandatory parameter -filename missing");
     if (rawdisk.isEmpty())
-        return errorSyntax(USAGE_CREATERAWVMDK, "Mandatory parameter -rawdisk missing");
+        return errorSyntax(USAGE_I_CREATERAWVMDK, "Mandatory parameter -rawdisk missing");
     if (!pszPartitions && pszMBRFilename)
-        return errorSyntax(USAGE_CREATERAWVMDK, "The parameter -mbr is only valid when the parameter -partitions is also present");
+        return errorSyntax(USAGE_I_CREATERAWVMDK, "The parameter -mbr is only valid when the parameter -partitions is also present");
 
 #ifdef RT_OS_DARWIN
@@ -1897 +1900 @@
         else
         {
-            return errorSyntax(USAGE_RENAMEVMDK, "Invalid parameter '%s'", argv[i]);
+            return errorSyntax(USAGE_I_RENAMEVMDK, "Invalid parameter '%s'", argv[i]);
         }
     }
 
     if (src.isEmpty())
-        return errorSyntax(USAGE_RENAMEVMDK, "Mandatory parameter -from missing");
+        return errorSyntax(USAGE_I_RENAMEVMDK, "Mandatory parameter -from missing");
     if (dst.isEmpty())
-        return errorSyntax(USAGE_RENAMEVMDK, "Mandatory parameter -to missing");
+        return errorSyntax(USAGE_I_RENAMEVMDK, "Mandatory parameter -to missing");
 
     PVDISK pDisk = NULL;
@@ -1970 +1973 @@
         else
         {
-            return errorSyntax(USAGE_CONVERTTORAW, "Invalid parameter '%s'", argv[i]);
+            return errorSyntax(USAGE_I_CONVERTTORAW, "Invalid parameter '%s'", argv[i]);
         }
     }
 
     if (src.isEmpty())
-        return errorSyntax(USAGE_CONVERTTORAW, "Mandatory filename parameter missing");
+        return errorSyntax(USAGE_I_CONVERTTORAW, "Mandatory filename parameter missing");
     if (dst.isEmpty())
-        return errorSyntax(USAGE_CONVERTTORAW, "Mandatory outputfile parameter missing");
+        return errorSyntax(USAGE_I_CONVERTTORAW, "Mandatory outputfile parameter missing");
 
     PVDISK pDisk = NULL;
@@ -2135 +2138 @@
         else
         {
-            return errorSyntax(USAGE_CONVERTHD, "Invalid parameter '%s'", argv[i]);
+            return errorSyntax(USAGE_I_CONVERTHD, "Invalid parameter '%s'", argv[i]);
         }
     }
 
     if (src.isEmpty())
-        return errorSyntax(USAGE_CONVERTHD, "Mandatory input image parameter missing");
+        return errorSyntax(USAGE_I_CONVERTHD, "Mandatory input image parameter missing");
     if (dst.isEmpty())
-        return errorSyntax(USAGE_CONVERTHD, "Mandatory output image parameter missing");
+        return errorSyntax(USAGE_I_CONVERTHD, "Mandatory output image parameter missing");
 
 
@@ -2254 +2257 @@
         else
         {
-            return errorSyntax(USAGE_REPAIRHD, "Invalid parameter '%s'", argv[i]);
+            return errorSyntax(USAGE_I_REPAIRHD, "Invalid parameter '%s'", argv[i]);
         }
     }
 
     if (image.isEmpty())
-        return errorSyntax(USAGE_REPAIRHD, "Mandatory input image parameter missing");
+        return errorSyntax(USAGE_I_REPAIRHD, "Mandatory input image parameter missing");
 
     PVDINTERFACE     pVDIfs = NULL;
@@ -2333 +2336 @@
      */
     if (argc < 1)
-        return errorSyntax(USAGE_DEBUGLOG, "Missing VM name/UUID");
+        return errorSyntax(USAGE_I_DEBUGLOG, "Missing VM name/UUID");
 
     ComPtr<IMachine> ptrMachine;
@@ -2421 +2424 @@
 
             default:
-                return errorGetOpt(USAGE_DEBUGLOG, ch, &ValueUnion);
+                return errorGetOpt(USAGE_I_DEBUGLOG, ch, &ValueUnion);
         }
     }
@@ -2449 +2452 @@
     /* one parameter, the password to hash */
     if (argc != 1)
-        return errorSyntax(USAGE_PASSWORDHASH, "password to hash required");
+        return errorSyntax(USAGE_I_PASSWORDHASH, "password to hash required");
 
     uint8_t abDigest[RTSHA256_HASH_SIZE];
@@ -2468 +2471 @@
     /* one parameter, guest name */
     if (argc < 1)
-        return errorSyntax(USAGE_GUESTSTATS, "Missing VM name/UUID");
+        return errorSyntax(USAGE_I_GUESTSTATS, "Missing VM name/UUID");
 
     /*
@@ -2493 +2496 @@
 
             default:
-                return errorGetOpt(USAGE_GUESTSTATS, ch, &ValueUnion);
+                return errorGetOpt(USAGE_I_GUESTSTATS, ch, &ValueUnion);
         }
     }
 
     if (argc > 1 && aUpdateInterval == 0)
-        return errorSyntax(USAGE_GUESTSTATS, "Invalid update interval specified");
+        return errorSyntax(USAGE_I_GUESTSTATS, "Invalid update interval specified");
 
     RTPrintf("argc=%d interval=%u\n", argc, aUpdateInterval);
@@ -2553 +2556 @@
     /* at least a command is required */
     if (a->argc < 1)
-        return errorSyntax(USAGE_ALL, "Command missing");
+        return errorSyntax(USAGE_S_ALL, "Command missing");
 
     /*
@@ -2593 +2596 @@
 
     /* default: */
-    return errorSyntax(USAGE_ALL, "Invalid command '%s'", a->argv[0]);
+    return errorSyntax(USAGE_S_ALL, "Invalid command '%s'", a->argv[0]);
 }