Changeset 9738 in vbox for trunk/src/VBox/Runtime/r3/win

Timestamp:

Jun 16, 2008 10:38:49 PM (17 years ago)

Author:

vboxsync

Message:

Some UUID cleanup; added RTUuidCompareStr(PCRTUUID, const char *).

File:

• trunk/src/VBox/Runtime/r3/win/uuid-win.cpp (modified) (4 diffs)

trunk/src/VBox/Runtime/r3/win/uuid-win.cpp

@@ -42 +42 @@
 
 
-/**
- * Generates a new UUID value.
- *
- * @returns iprt status code.
- * @param   pUuid           Where to store generated uuid.
- */
+/** @todo split out this guy */
 RTDECL(int)  RTUuidCreate(PRTUUID pUuid)
 {
     /* check params */
-    if (pUuid == NULL)
-    {
-        AssertMsgFailed(("pUuid=NULL\n"));
-        return VERR_INVALID_PARAMETER;
-    }
+    AssertPtrReturn(pUuid, VERR_INVALID_POINTER);
 
     RPC_STATUS rc = UuidCreate((UUID *)pUuid);
-    if ((rc == RPC_S_OK) || (rc == RPC_S_UUID_LOCAL_ONLY))
+    if (    rc == RPC_S_OK
+        || rc == RPC_S_UUID_LOCAL_ONLY)
         return VINF_SUCCESS;
 
@@ -65 +57 @@
 }
 
-/**
- * Makes null UUID value.
- *
- * @returns iprt status code.
- * @param   pUuid           Where to store generated null uuid.
- */
+
 RTDECL(int)  RTUuidClear(PRTUUID pUuid)
 {
     /* check params */
-    if (pUuid == NULL)
-    {
-        AssertMsgFailed(("pUuid=NULL\n"));
-        return VERR_INVALID_PARAMETER;
-    }
+    AssertPtrReturn(pUuid, VERR_INVALID_POINTER);
 
     return RTErrConvertFromWin32(UuidCreateNil((UUID *)pUuid));
 }
 
-/**
- * Checks if UUID is null.
- *
- * @returns true if UUID is null.
- * @param   pUuid           uuid to check.
- */
-RTDECL(int)  RTUuidIsNull(PCRTUUID pUuid)
+
+RTDECL(bool)  RTUuidIsNull(PCRTUUID pUuid)
 {
     /* check params */
-    if (pUuid == NULL)
-    {
-        AssertMsgFailed(("pUuid=NULL\n"));
-        return TRUE;
-    }
+    AssertPtrReturn(pUuid, true);
 
     RPC_STATUS status;
-    return UuidIsNil((UUID *)pUuid, &status);
+    return !!UuidIsNil((UUID *)pUuid, &status);
 }
 
-/**
- * Compares two UUID values.
- *
- * @returns 0 if eq, < 0 or > 0.
- * @param   pUuid1          First value to compare.
- * @param   pUuid2          Second value to compare.
- */
+
 RTDECL(int)  RTUuidCompare(PCRTUUID pUuid1, PCRTUUID pUuid2)
 {
     /* check params */
-    if ((pUuid1 == NULL) || (pUuid2 == NULL))
-    {
-        AssertMsgFailed(("Invalid parameters\n"));
-        return 1;
-    }
+    AssertPtrReturn(pUuid1, -1);
+    AssertPtrReturn(pUuid1, 1);
 
     RPC_STATUS status;
@@ -122 +87 @@
 }
 
-/**
- * Converts binary UUID to its string representation.
- *
- * @returns iprt status code.
- * @param   pUuid           Uuid to convert.
- * @param   pszString       Where to store result string.
- * @param   cchString       pszString buffer length, must be >= RTUUID_STR_LENGTH.
- */
-RTDECL(int)  RTUuidToStr(PCRTUUID pUuid, char *pszString, unsigned cchString)
+
+RTDECL(int)  RTUuidCompareStr(PCRTUUID pUuid1, const char *pszString)
 {
     /* check params */
-    if ((pUuid == NULL) || (pszString == NULL) || (cchString < RTUUID_STR_LENGTH))
-    {
-        AssertMsgFailed(("Invalid parameters\n"));
-        return VERR_INVALID_PARAMETER;
-    }
+    AssertPtrReturn(pUuid1, -1);
+    AssertPtrReturn(pszString, 1);
 
-    RPC_STATUS rc;
-    char *pStr = NULL;
+    /*
+     * Try convert the string to a UUID and then compare the two.
+     */
+    RTUUID Uuid2;
+    int rc = RTUuidFromStr(&Uuid2, pszString);
+    AssertRCReturn(rc, 1);
+
+    return RTUuidCompare(pUuid1, &Uuid2);
+}
+
+
+RTDECL(int)  RTUuidToStr(PCRTUUID pUuid, char *pszString, size_t cchString)
+{
+    /* check params */
+    AssertPtrReturn(pUuid, VERR_INVALID_POINTER);
+    AssertPtrReturn(pszString, VERR_INVALID_POINTER);
+    AssertReturn(cchString >= RTUUID_STR_LENGTH, VERR_INVALID_PARAMETER);
+
+    /*
+     * Try convert it.
+     *
+     * The API allocates a new string buffer for us, so we can do our own
+     * buffer overflow handling.
+     */
+    RPC_STATUS Status;
+    unsigned char *pszTmpStr = NULL;
 #ifdef RPC_UNICODE_SUPPORTED
     /* always use ASCII version! */
-    rc = UuidToStringA((UUID *)pUuid, (unsigned char **)&pStr);
+    Status = UuidToStringA((UUID *)pUuid, &pszTmpStr);
 #else
-    rc = UuidToString((UUID *)pUuid, (unsigned char **)&pStr);
+    Status = UuidToString((UUID *)pUuid, &pszTmpStr);
 #endif
-    if (rc != RPC_S_OK)
-        return RTErrConvertFromWin32(rc);
+    if (Status != RPC_S_OK)
+        return RTErrConvertFromWin32(Status);
 
-    if (strlen(pStr) >= cchString)
-    {
-        /* out of buffer space */
-#ifdef RPC_UNICODE_SUPPORTED
-        /* always use ASCII version! */
-        RpcStringFreeA((unsigned char **)&pStr);
-#else
-        RpcStringFree((unsigned char **)&pStr);
-#endif
-        AssertMsgFailed(("Buffer overflow\n"));
-        return ERROR_BUFFER_OVERFLOW;
-    }
-
-    /* copy str to user buffer */
-    pszString[0] = '\0';
-    strncat(pszString, pStr, cchString);
+    /* copy it. */
+    int rc = VINF_SUCCESS;
+    size_t cch = strlen((char *)pszTmpStr);
+    if (cch < cchString)
+        memcpy(pszString, pszTmpStr, cchTmpStr + 1);
+    else
+        rc = ERROR_BUFFER_OVERFLOW;
 
     /* free buffer */
 #ifdef RPC_UNICODE_SUPPORTED
     /* always use ASCII version! */
-    RpcStringFreeA((unsigned char **)&pStr);
+    RpcStringFreeA(&pszTmpStr);
 #else
-    RpcStringFree((unsigned char **)&pStr);
+    RpcStringFree(&pszTmpStr);
 #endif
 
     /* all done */
-    return VINF_SUCCESS;
+    return rc;
 }
 
-/**
- * Converts UUID from its string representation to binary format.
- *
- * @returns iprt status code.
- * @param   pUuid           Where to store result Uuid.
- * @param   pszString       String with UUID text data.
- */
+
 RTDECL(int)  RTUuidFromStr(PRTUUID pUuid, const char *pszString)
 {
     /* check params */
-    if ((pUuid == NULL) || (pszString == NULL))
-    {
-        AssertMsgFailed(("Invalid parameters\n"));
-        return VERR_INVALID_PARAMETER;
-    }
+    AssertPtrReturn(pUuid, VERR_INVALID_POINTER);
+    AssertPtrReturn(pszString, VERR_INVALID_POINTER);
 
     RPC_STATUS rc;
@@ -206 +167 @@
 }
 
+