Changeset 104152 in vbox for trunk

Timestamp:

Apr 4, 2024 9:37:12 AM (10 months ago)

Author:

vboxsync

Message:

VBoxSDS: Added missing syntax help, documented and show more options which weren't before, added proper version string. Added a @todo.

File:

• trunk/src/VBox/Main/src-global/win/VBoxSDS.cpp (modified) (4 diffs)

trunk/src/VBox/Main/src-global/win/VBoxSDS.cpp

@@ -109 +109 @@
 #include <iprt/path.h>
 #include <iprt/message.h>
+#include <iprt/stream.h>
 #include <iprt/string.h>
 
 #include <VBox/com/microatl.h>
+
+#include <package-generated.h>
+#include "product-generated.h"
+
+#include <VBox/version.h>
 
 #define _ATL_FREE_THREADED /** @todo r=bird: WTF? */
@@ -763 +769 @@
 }
 #endif
+
+/**
+ * Shows an information message box.
+ *
+ * @param   pszFormat   The message text.
+ * @param   ...         Format string arguments.
+ */
+static void vboxSdsShowInfoMsgBox(const char *pszFormat, ...)
+{
+    va_list va;
+    va_start(va, pszFormat);
+
+    char *psz = NULL;
+    int vrc = RTStrAPrintfV(&psz, pszFormat, va);
+    AssertRCReturnVoid(vrc);
+
+    va_end(va);
+
+    PRTUTF16 pwsz = NULL;
+    vrc = RTStrToUtf16(psz, &pwsz);
+    AssertRCReturnVoid(vrc);
+
+    MessageBoxW(NULL, pwsz, L"VBoxSDS", MB_OK | MB_ICONINFORMATION);
+
+    RTUtf16Free(pwsz);
+    RTStrFree(psz);
+}
+
+/**
+ * Shows tool usage text.
+ *
+ * @returns RTEXITCODE_SYNTAX
+ */
+static RTEXITCODE vboxSdsShowUsage(void)
+{
+    vboxSdsShowInfoMsgBox(
+                 VBOX_PRODUCT " VBoxSDS (System Directory Service) Version " VBOX_VERSION_STRING " - r%s\n"
+                 "Copyright (C) " VBOX_C_YEAR " " VBOX_VENDOR "\n"
+                 "\n"
+                 " Service handling:\n"
+                 " --regservice, /RegService\n"
+                 "   Registers COM out-of-proc service\n"
+                 " --unregservice, /UnregService\n"
+                 "   Unregisters COM out-of-proc service\n"
+                 " --reregservice, /ReregService\n"
+                 "   Unregisters and registers COM service\n"
+                 "\n"
+                 " Common options:\n"
+                 "  -V, --version\n"
+                 "    Displays version\n"
+                 "  -h, -?, --help\n"
+                 "    Displays help\n"
+                 "\n"
+                 " Logging options:\n"
+                 "  --logfile, /logfile </path/to/log>\n"
+                 "    Specifies the log file destination\n"
+                 "  --logsize, /logsize <bytes>\n"
+                 "    Specifies the maximum log size (in bytes)\n"
+                  "  --loginterval, /loginterval <s>\n"
+                 "    Specifies the maximum log time (in seconds)\n",
+                 RTBldCfgRevisionStr());
+
+    return RTEXITCODE_SYNTAX;
+}
 
 
@@ -815 +885 @@
         { "/?",             'h',    RTGETOPT_REQ_NOTHING }, /* Most Windows programs use '/?', so have this as an alias. */
         { "/h",             'h',    RTGETOPT_REQ_NOTHING }, /* Ditto for '/h'. */
-        { "/help",          'h',    RTGETOPT_REQ_NOTHING }  /* Ditto for '/help'. */
+        { "/help",          'h',    RTGETOPT_REQ_NOTHING }, /* Ditto for '/help'. */
+        { "--version",      'V',    RTGETOPT_REQ_NOTHING },
+        { "/V",             'V',    RTGETOPT_REQ_NOTHING },
+        { "/version",       'V',    RTGETOPT_REQ_NOTHING }
     };
 
@@ -863 +936 @@
 
             case 'S':
-                uHistoryFileSize = ValueUnion.u64;
+                uHistoryFileSize = ValueUnion.u64; /** @todo r=andy Too fine grained (bytes), MB would be enough, I think. */
                 break;
 
             case 'I':
-                uHistoryFileTime = ValueUnion.u32;
+                uHistoryFileTime = ValueUnion.u32; /** @todo r=andy Too fine grained (seconds), minutes/hours would be enough, I think. */
                 break;
 
             case 'h':
             {
-                static WCHAR const s_wszHelpText[] =
-                    L"Options:\n"
-                    L"\n"
-                    L"/RegService\t"   L"register COM out-of-proc service\n"
-                    L"/UnregService\t" L"unregister COM out-of-proc service\n"
-                    L"/ReregService\t" L"unregister and register COM service\n"
-                    L"no options\t"    L"run the service";
-                MessageBoxW(NULL, s_wszHelpText, L"VBoxSDS - Usage", MB_OK);
-                return 0;
+                vboxSdsShowUsage();
+                return RTEXITCODE_SUCCESS;
             }
 
             case 'V':
             {
-                char *pszText = NULL;
-                RTStrAPrintf(&pszText, "%sr%s\n", RTBldCfgVersion(), RTBldCfgRevisionStr());
-
-                PRTUTF16 pwszText = NULL;
-                RTStrToUtf16(pszText, &pwszText);
-
-                MessageBoxW(NULL, pwszText, L"VBoxSDS - Version", MB_OK);
-
-                RTStrFree(pszText);
-                RTUtf16Free(pwszText);
-                return 0;
+                vboxSdsShowInfoMsgBox("%sr%s\n", RTBldCfgVersion(), RTBldCfgRevisionStr());
+                return RTEXITCODE_SUCCESS;
             }
 
             default:
-            {
-                char szTmp[256];
-                RTGetOptFormatError(szTmp, sizeof(szTmp), vrc, &ValueUnion);
-
-                PRTUTF16 pwszText = NULL;
-                RTStrToUtf16(szTmp, &pwszText);
-
-                MessageBoxW(NULL, pwszText, L"VBoxSDS - Syntax error", MB_OK | MB_ICONERROR);
-
-                RTUtf16Free(pwszText);
-                return RTEXITCODE_SYNTAX;
-            }
+                return vboxSdsShowUsage();
         }
     }