Changeset 56533 in vbox for trunk/src

Timestamp:

Jun 18, 2015 6:15:51 PM (10 years ago)

Author:

vboxsync

Message:

VBoxManage generated help updates, manual/Makefile.kmk hacking, related stuff.

File:

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

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

@@ -44 +44 @@
 enum HELP_CMD_VBOXMANAGE    g_enmCurCommand = HELP_CMD_VBOXMANAGE_INVALID;
 /** The scope maskt for the current subcommand. */
-uint64_t                    g_fCurSubcommandScope = UINT64_MAX;
-
+uint64_t                    g_fCurSubcommandScope = REFENTRYSTR_SCOPE_GLOBAL;
+/** String of spaces that can be used for indentation.   */
+static const char           g_szSpaces[] = "                                                ";
 
 /**
@@ -58 +59 @@
     Assert(g_enmCurCommand == HELP_CMD_VBOXMANAGE_INVALID);
     g_enmCurCommand       = enmCommand;
-    g_fCurSubcommandScope = UINT64_MAX;
+    g_fCurSubcommandScope = REFENTRYSTR_SCOPE_GLOBAL;
 }
 
@@ -104 +105 @@
  * @param   psz             The string table string to print.
  * @param   cchMaxWidth     The maximum output width.
- */
-static uint32_t printString(PRTSTREAM pStrm, const char *psz, uint32_t cchMaxWidth)
+ * @param   fFlags          String flags that may affect formatting.
+ */
+static uint32_t printString(PRTSTREAM pStrm, const char *psz, uint32_t cchMaxWidth, uint64_t fFlags)
 {
     uint32_t    cLinesWritten;
@@ -142 +144 @@
         while (*psz == ' ')
             cchIndent++, psz++;
+        Assert(cchIndent + 4 + 1 <= RT_ELEMENTS(g_szSpaces));
+
         if (cchIndent + 8 >= cchMaxWidth)
             cchMaxWidth += cchIndent + 8;
 
         /* Work our way thru the string, line by line. */
+        uint32_t cchHangingIndent = 0;
         cLinesWritten = 0;
         do
         {
-            RTStrmWrite(pStrm, pszIndent, cchIndent);
-            size_t offLine       = cchIndent;
-            bool   fPendingSpace = false;
+            RTStrmWrite(pStrm, g_szSpaces, cchIndent + cchHangingIndent);
+            size_t   offLine       = cchIndent + cchHangingIndent;
+            bool     fPendingSpace = false;
             do
             {
@@ -183 +188 @@
             RTStrmPutCh(pStrm, '\n');
             cLinesWritten++;
+
+            /* Set up hanging indent if relevant. */
+            if (fFlags & REFENTRYSTR_FLAGS_SYNOPSIS)
+                cchHangingIndent = 4;
         } while (*psz != '\0');
     }
@@ -223 +232 @@
     {
         uint64_t fCurScope = pStrTab->paStrings[i].fScope;
-        if (fCurScope == REFENTRYSTR_SCOPE_SAME)
-            fCurScope = fPrevScope;
-        if (fCurScope & fScope)
+        if ((fCurScope & REFENTRYSTR_SCOPE_MASK) == REFENTRYSTR_SCOPE_SAME)
+        {
+            fCurScope &= ~REFENTRYSTR_SCOPE_MASK;
+            fCurScope |= (fPrevScope & REFENTRYSTR_SCOPE_MASK);
+        }
+        if (fCurScope & REFENTRYSTR_SCOPE_MASK & fScope)
         {
             const char *psz = pStrTab->paStrings[i].psz;
@@ -236 +248 @@
                     cLinesWritten++;
                 }
-                cLinesWritten += printString(pStrm, psz, cchWidth);
+                cLinesWritten += printString(pStrm, psz, cchWidth, fCurScope & REFENTRYSTR_FLAGS_MASK);
             }
             else
@@ -255 +267 @@
  * @returns Number of lines written.
  * @param   enmCommand          The command.
- * @param   fSubcommandScope    The subcommand scope, UINT64_MAX for all.
+ * @param   fSubcommandScope    The subcommand scope, REFENTRYSTR_SCOPE_GLOBAL
+ *                              for all.
  * @param   pStrm               The output stream.
  */
@@ -301 +314 @@
  *
  * @param   enmCommand          The command.
- * @param   fSubcommandScope    The subcommand scope, UINT64_MAX for all.
+ * @param   fSubcommandScope    The subcommand scope, REFENTRYSTR_SCOPE_GLOBAL
+ *                              for all.
  * @param   pStrm               The output stream.
  */
@@ -343 +357 @@
 {
     Assert(g_enmCurCommand != HELP_CMD_VBOXMANAGE_INVALID);
-    Assert(g_fCurSubcommandScope == UINT64_MAX);
+    Assert(g_fCurSubcommandScope == REFENTRYSTR_SCOPE_GLOBAL);
 
     return errorSyntax("No subcommand specified");
@@ -360 +374 @@
 {
     Assert(g_enmCurCommand != HELP_CMD_VBOXMANAGE_INVALID);
-    Assert(g_fCurSubcommandScope == UINT64_MAX);
+    Assert(g_fCurSubcommandScope == REFENTRYSTR_SCOPE_GLOBAL);
 
     /* check if help was requested. */
@@ -387 +401 @@
 {
     Assert(g_enmCurCommand != HELP_CMD_VBOXMANAGE_INVALID);
-    Assert(g_fCurSubcommandScope != UINT64_MAX);
+    Assert(g_fCurSubcommandScope != REFENTRYSTR_SCOPE_GLOBAL);
 
     /* check if help was requested. */