Changeset 94290 in vbox for trunk/src/VBox/Frontends/VBoxManage/VBoxManageHelp.cpp

Timestamp:

Mar 17, 2022 12:47:49 PM (3 years ago)

Author:

vboxsync

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

150557

Message:

doc/manual,FE/VBoxManage: Make use of the general options from the refentry XML files when printing the help text and some more cleanups getting rid of all the legacy help code, bugref:9186

File:

• trunk/src/VBox/Frontends/VBoxManage/VBoxManageHelp.cpp (modified) (5 diffs)

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

@@ -49 +49 @@
 DECLARE_TRANSLATION_CONTEXT(Help);
 
-static enum HELP_CMD_VBOXMANAGE    g_enmCurCommand = HELP_CMD_VBOXMANAGE_INVALID;
+static enum HELP_CMD_VBOXMANAGE    g_enmCurCommand = HELP_CMD_COMMON;
 /** The scope mask for the current subcommand. */
 static uint64_t                    g_fCurSubcommandScope = RTMSGREFENTRYSTR_SCOPE_GLOBAL;
@@ -62 +62 @@
 void setCurrentCommand(enum HELP_CMD_VBOXMANAGE enmCommand)
 {
-    Assert(g_enmCurCommand == HELP_CMD_VBOXMANAGE_INVALID);
+    Assert(g_enmCurCommand == HELP_CMD_COMMON);
     g_enmCurCommand       = enmCommand;
     g_fCurSubcommandScope = RTMSGREFENTRYSTR_SCOPE_GLOBAL;
@@ -128 +128 @@
         {
             PCRTMSGREFENTRY pHelp = apHelpLangEntries[k]->papHelpEntries[i];
-            if (pHelp->idInternal == (int64_t)enmCommand)
+            if (   pHelp->idInternal == (int64_t)enmCommand
+                || enmCommand == HELP_CMD_COMMON)
             {
                 cFound++;
@@ -194 +195 @@
 
             if (   pHelp->idInternal == (int64_t)enmCommand
-                || enmCommand == HELP_CMD_VBOXMANAGE_INVALID)
+                || enmCommand == HELP_CMD_COMMON)
             {
                 cFound++;
@@ -503 +504 @@
     }
 }
-
-
-
-
-void printUsage(USAGECATEGORY enmCommand, uint64_t fSubcommandScope, PRTSTREAM pStrm)
-{
-    RT_NOREF(fSubcommandScope);
-
-    Assert(enmCommand != USAGE_INVALID);
-    Assert(enmCommand != USAGE_S_NEWCMD);
-
-    if (enmCommand == USAGE_S_DUMPOPTS)
-        enmCommand = USAGE_S_ALL;
-
-    RTStrmPrintf(pStrm,
-                 Help::tr("Usage:\n"
-                          "\n"));
-
-    if (enmCommand == USAGE_S_ALL)
-        RTStrmPrintf(pStrm,
-                     "  VBoxManage [<general option>] <command>\n"
-                     "\n"
-                     "\n"
-                     "General Options:\n"
-                     "\n"
-                     "  [-V|--version]            print version number and exit\n"
-                     "  [--dump-build-type]       print build type and exit\n"
-                     "  [-q|--nologo]             suppress the logo\n"
-                     "  [--settingspw <pw>]       provide the settings password\n"
-                     "  [--settingspwfile <file>] provide a file containing the settings password\n"
-                     "  [@<response-file>]        load arguments from the given response file (bourne style)\n"
-                     "\n"
-                     "\n"
-                     "Commands:\n"
-                     "\n");
-
-    if (enmCommand == USAGE_S_ALL)
-    {
-        uint32_t            cPendingBlankLines = 0;
-        PCHELP_LANG_ENTRY_T pHelpLangEntry     = ASMAtomicUoReadPtrT(&g_pHelpLangEntry, PCHELP_LANG_ENTRY_T);
-        uint32_t const      cHelpEntries       = *pHelpLangEntry->pcHelpEntries;
-        for (uint32_t i = 0; i < cHelpEntries; i++)
-        {
-            PCRTMSGREFENTRY pHelp = pHelpLangEntry->papHelpEntries[i];
-
-            while (cPendingBlankLines-- > 0)
-                RTStrmPutCh(pStrm, '\n');
-
-            char szFirstChar[8];
-            RTStrmPrintf(pStrm, " %s%s:\n", szFirstChar, captialize(pHelp->pszBrief, szFirstChar));
-
-            cPendingBlankLines = 0;
-            RTMsgRefEntryPrintStringTable(pStrm, &pHelp->Synopsis, RTMSGREFENTRYSTR_SCOPE_GLOBAL,
-                                          &cPendingBlankLines, NULL /*pcLinesWritten*/);
-            cPendingBlankLines = RT_MAX(cPendingBlankLines, 1);
-        }
-    }
-}