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

Timestamp:

Sep 29, 2008 4:27:32 PM (17 years ago)

Author:

vboxsync

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

37166

Message:

VbglR3GuestPropDelTree -> VbglR3GuestPropDelSet, added missing docs and make some adjustments. Fixed the missing 'const'-ness of the enumeration API.

Location:

trunk/src/VBox/Additions/common

Files:

• VBoxControl/VBoxControl.cpp (modified) (3 diffs)
• VBoxGuestLib/VBoxGuestR3LibGuestProp.cpp (modified) (4 diffs)

trunk/src/VBox/Additions/common/VBoxControl/VBoxControl.cpp

@@ -1044 +1044 @@
 static int enumGuestProperty(int argc, char *argv[])
 {
-/*
- * Check the syntax.  We can deduce the correct syntax from the number of
- * arguments.
- */
-    const char *paszPatterns = NULL;
-    if ((argc > 1) && (0 == strcmp(argv[0], "-patterns")))
-        paszPatterns = argv[1];
+    /*
+     * Check the syntax.  We can deduce the correct syntax from the number of
+     * arguments.
+     */
+    char const * const *papszPatterns = NULL;
+    size_t cPatterns = 0;
+    if (    argc > 1
+        && !strcmp(argv[0], "-patterns"))
+    {
+        papszPatterns = (char const * const *)&argv[1];
+        cPatterns = argc - 1;
+    }
     else if (argc != 0)
     {
@@ -1057 +1062 @@
     }
 
-/*
- * Do the actual enumeration.
- */
+    /*
+     * Do the actual enumeration.
+     */
     uint32_t u32ClientId = 0;
-    PVBGLR3GUESTPROPENUM pHandle = NULL;
-    RTMemAutoPtr<VBGLR3GUESTPROPENUM, VbglR3GuestPropEnumFree> Handle;
-    char *pszName = NULL, *pszValue = NULL, *pszFlags = NULL;
-    uint64_t u64Timestamp = 0;
-    int rc = VINF_SUCCESS;
-    rc = VbglR3GuestPropConnect(&u32ClientId);
-    if (!RT_SUCCESS(rc))
-        VBoxControlError("Failed to connect to the guest property service! Error: %Rrc\n", rc);
+    int rc = VbglR3GuestPropConnect(&u32ClientId);
     if (RT_SUCCESS(rc))
     {
-        char **ppaszPatterns = argc > 1 ? argv + 1 : NULL;
-        int cPatterns = argc > 1 ? argc - 1 : 0;
-        rc = VbglR3GuestPropEnum(u32ClientId, ppaszPatterns, cPatterns, &pHandle,
+        PVBGLR3GUESTPROPENUM pHandle;
+        const char *pszName, *pszValue, *pszFlags;
+        uint64_t u64Timestamp;
+
+        rc = VbglR3GuestPropEnum(u32ClientId, papszPatterns, cPatterns, &pHandle,
                                  &pszName, &pszValue, &u64Timestamp, &pszFlags);
         if (RT_SUCCESS(rc))
         {
-            Handle = pHandle;
+            while (RT_SUCCESS(rc) && !pszName)
+            {
+                RTPrintf("Name: %s, value: %s, timestamp: %lld, flags: %s\n",
+                         pszName, pszValue, u64Timestamp, pszFlags);
+
+                rc = VbglR3GuestPropEnumNext(pHandle, &pszName, &pszValue, &u64Timestamp, &pszFlags);
+                if (RT_FAILURE(rc))
+                    VBoxControlError("Error while enumerating guest properties: %Rrc\n", rc);
+            }
+
+            VbglR3GuestPropEnumFree(pHandle);
         }
         else if (VERR_NOT_FOUND == rc)
@@ -1083 +1093 @@
         else
             VBoxControlError("Failed to enumerate the guest properties! Error: %Rrc\n", rc);
-    }
-    while (RT_SUCCESS(rc) && (pszName != NULL))
-    {
-        RTPrintf("Name: %s, value: %s, timestamp: %lld, flags: %s\n",
-                 pszName, pszValue, u64Timestamp, pszFlags);
-        rc = VbglR3GuestPropEnumNext(Handle.get(), &pszName, &pszValue, &u64Timestamp, &pszFlags);
-        if (!RT_SUCCESS(rc))
-            VBoxControlError("Error while enumerating guest properties: %Rrc\n", rc);
-    }
-
-    if (u32ClientId != 0)
         VbglR3GuestPropDisconnect(u32ClientId);
+    }
+    else
+        VBoxControlError("Failed to connect to the guest property service! Error: %Rrc\n", rc);
     return RT_SUCCESS(rc) ? 0 : 1;
 }

trunk/src/VBox/Additions/common/VBoxGuestLib/VBoxGuestR3LibGuestProp.cpp

@@ -523 +523 @@
  * @param   ppszFlags       Where to store the first flags value on success.
  *                          Should not be freed.
- *
- * @todo    Make papszPatterns char const * const *, and cPatterns size_t (so we
- *          can use RT_ELEMENTS without getting warnings on Windows).
- *          Most of the returns should also be made char const * to discourage
- *          changes and encourage compiler optimizations.
  */
 VBGLR3DECL(int) VbglR3GuestPropEnum(uint32_t u32ClientId,
-                                    char **papszPatterns,
-                                    int cPatterns,
+                                    char const * const *papszPatterns,
+                                    size_t cPatterns,
                                     PVBGLR3GUESTPROPENUM *ppHandle,
-                                    char **ppszName,
-                                    char **ppszValue,
+                                    char const **ppszName,
+                                    char const **ppszValue,
                                     uint64_t *pu64Timestamp,
-                                    char **ppszFlags)
+                                    char const **ppszFlags)
 {
     int rc = VINF_SUCCESS;
     RTMemAutoPtr<VBGLR3GUESTPROPENUM, VbglR3GuestPropEnumFree> Handle;
-    Handle = (PVBGLR3GUESTPROPENUM) RTMemAllocZ(sizeof(VBGLR3GUESTPROPENUM));
+    Handle = (PVBGLR3GUESTPROPENUM)RTMemAllocZ(sizeof(VBGLR3GUESTPROPENUM));
     if (!Handle)
         rc = VERR_NO_MEMORY;
@@ -546 +541 @@
     /* Get the length of the pattern string, including the final terminator. */
     uint32_t cchPatterns = 1;
-    for (int i = 0; i < cPatterns; ++i)
+    for (unsigned i = 0; i < cPatterns; ++i)
         cchPatterns += strlen(papszPatterns[i]) + 1;
+
     /* Pack the pattern array */
     RTMemAutoPtr<char> Patterns;
-    Patterns = (char *) RTMemAlloc(cchPatterns);
+    Patterns = (char *)RTMemAlloc(cchPatterns);
     size_t iOffs = 0;
-    for (int i = 0; i < cPatterns; ++i)
+    for (size_t i = 0; i < cPatterns; ++i)
     {
         size_t cb = strlen(papszPatterns[i]) + 1;
@@ -619 +615 @@
  *                       set to NULL if there are no more properties to
  *                       enumerate.  This pointer should not be freed.
- *
- * @todo return char const *.
  */
 VBGLR3DECL(int) VbglR3GuestPropEnumNext(PVBGLR3GUESTPROPENUM pHandle,
-                                        char **ppszName,
-                                        char **ppszValue,
+                                        char const **ppszName,
+                                        char const **ppszValue,
                                         uint64_t *pu64Timestamp,
-                                        char **ppszFlags)
+                                        char const **ppszFlags)
 {
     uint32_t iBuf = pHandle->iBuf;
     char *pszName = pHandle->pchBuf + iBuf;
-    /** @todo replace these with safe memchr's and return an error if needed. */
+    /** @todo replace these with safe memchr's and return an error if needed. A
+     *        PLEASE add a comment about the layout because this is rather
+     *        unreadable. */
     iBuf += strlen(pszName) + 1;
     char *pszValue = pHandle->pchBuf + iBuf;
@@ -680 +676 @@
 {
     PVBGLR3GUESTPROPENUM pHandle;
-    char *pszName;
-    char *pszValue;
+    char const *pszName, *pszValue, *pszFlags;
     uint64_t pu64Timestamp;
-    char *pszFlags;
     int rc = VbglR3GuestPropEnum(u32ClientId,
                                  (char **)papszPatterns, /** @todo fix this cast. */