Changeset 61065 in vbox for trunk/src/VBox/Additions/common

Timestamp:

May 19, 2016 11:15:31 PM (9 years ago)

Author:

vboxsync

Message:

VBoxServiceToolBox.cpp: Corrected warning fix, the intention was to return a const pointer. Added a todo/r=bird. ((Removed) some (unnecessary) parentheses.)

File:

• trunk/src/VBox/Additions/common/VBoxService/VBoxServiceToolBox.cpp (modified) (8 diffs)

trunk/src/VBox/Additions/common/VBoxService/VBoxServiceToolBox.cpp

@@ -83 +83 @@
 } VBOXSERVICETOOLBOXOUTPUTFLAG;
 
+
 /*********************************************************************************************************************************
 *   Prototypes                                                                                                                   *
@@ -93 +94 @@
 static RTEXITCODE vgsvcToolboxStat(int argc, char **argv);
 
+
 /*********************************************************************************************************************************
 *   Structures and Typedefs                                                                                                      *
@@ -106 +108 @@
     /** Main handler to be invoked to use the tool. */
     RTEXITCODE (*pfnHandler)(int argc, char **argv);
-    /** Conversion routine to convert the tool's exit code back to an IPRT rc. Optional. */
+    /** Conversion routine to convert the tool's exit code back to an IPRT rc. Optional.
+     *
+     * @todo r=bird: You better revert this, i.e. having pfnHandler return a VBox
+     *       status code and have a routine for converting it to RTEXITCODE.
+     *       Unless, what you really want to do here is to get a cached status, in
+     *       which case you better call it what it is.
+     */
     int        (*pfnExitCodeConvertToRc)(RTEXITCODE rcExit);
-} VBOXSERVICETOOLBOXTOOL, *PVBOXSERVICETOOLBOXTOOL;
-
-static VBOXSERVICETOOLBOXTOOL s_aTools[] =
+} VBOXSERVICETOOLBOXTOOL;
+/** Pointer to a const tool definition. */
+typedef VBOXSERVICETOOLBOXTOOL const *PCVBOXSERVICETOOLBOXTOOL;
+
+/**
+ * An file/directory entry. Used to cache
+ * file names/paths for later processing.
+ */
+typedef struct VBOXSERVICETOOLBOXPATHENTRY
+{
+    /** Our node. */
+    RTLISTNODE  Node;
+    /** Name of the entry. */
+    char       *pszName;
+} VBOXSERVICETOOLBOXPATHENTRY, *PVBOXSERVICETOOLBOXPATHENTRY;
+
+typedef struct VBOXSERVICETOOLBOXDIRENTRY
+{
+    /** Our node. */
+    RTLISTNODE   Node;
+    /** The actual entry. */
+    RTDIRENTRYEX dirEntry;
+} VBOXSERVICETOOLBOXDIRENTRY, *PVBOXSERVICETOOLBOXDIRENTRY;
+
+
+/*********************************************************************************************************************************
+*   Global Variables                                                                                                             *
+*********************************************************************************************************************************/
+/** Tool definitions. */
+static VBOXSERVICETOOLBOXTOOL const g_aTools[] =
 {
     { VBOXSERVICE_TOOL_CAT,    vgsvcToolboxCat   , NULL },
@@ -119 +154 @@
     { VBOXSERVICE_TOOL_STAT,   vgsvcToolboxStat  , NULL }
 };
-
-/**
- * An file/directory entry. Used to cache
- * file names/paths for later processing.
- */
-typedef struct VBOXSERVICETOOLBOXPATHENTRY
-{
-    /** Our node. */
-    RTLISTNODE  Node;
-    /** Name of the entry. */
-    char       *pszName;
-} VBOXSERVICETOOLBOXPATHENTRY, *PVBOXSERVICETOOLBOXPATHENTRY;
-
-typedef struct VBOXSERVICETOOLBOXDIRENTRY
-{
-    /** Our node. */
-    RTLISTNODE   Node;
-    /** The actual entry. */
-    RTDIRENTRYEX dirEntry;
-} VBOXSERVICETOOLBOXDIRENTRY, *PVBOXSERVICETOOLBOXDIRENTRY;
-
-
 
 
@@ -1527 +1540 @@
  * @param   pszTool     The name of the tool.
  */
-static PVBOXSERVICETOOLBOXTOOL vgsvcToolboxLookUp(const char *pszTool)
+static PCVBOXSERVICETOOLBOXTOOL const vgsvcToolboxLookUp(const char *pszTool)
 {
     AssertPtrReturn(pszTool, NULL);
 
     /* Do a linear search, since we don't have that much stuff in the table. */
-    for (unsigned i = 0; i < RT_ELEMENTS(s_aTools); i++)
-        if (!strcmp(s_aTools[i].pszName, pszTool))
-            return &s_aTools[i];
+    for (unsigned i = 0; i < RT_ELEMENTS(g_aTools); i++)
+        if (!strcmp(g_aTools[i].pszName, pszTool))
+            return &g_aTools[i];
 
     return NULL;
@@ -1551 +1564 @@
     AssertPtrReturn(pszTool, VERR_INVALID_POINTER);
 
-    PVBOXSERVICETOOLBOXTOOL pTool = vgsvcToolboxLookUp(pszTool);
+    PCVBOXSERVICETOOLBOXTOOL pTool = vgsvcToolboxLookUp(pszTool);
     if (pTool)
         return pTool->pfnExitCodeConvertToRc(rcExit);
@@ -1577 +1590 @@
     AssertReturn(argc > 0, false);
     const char              *pszTool = RTPathFilename(argv[0]);
-    PVBOXSERVICETOOLBOXTOOL  pTool   = vgsvcToolboxLookUp(pszTool);
+    PCVBOXSERVICETOOLBOXTOOL pTool   = vgsvcToolboxLookUp(pszTool);
     if (!pTool)
     {
@@ -1598 +1611 @@
                return true;
            }
-           if (   (strcmp(pszTool, "help")) && (strcmp(pszTool, "--help"))
-               && (strcmp(pszTool, "-h")))
+           if (   strcmp(pszTool, "help")
+               && strcmp(pszTool, "--help")
+               && strcmp(pszTool, "-h"))
                *prcExit = RTEXITCODE_SYNTAX;
            vgsvcToolboxShowUsage();