Changeset 46980 in vbox for trunk/include/iprt/manifest.h

Timestamp:

Jul 4, 2013 11:38:28 AM (11 years ago)

Author:

vboxsync

Message:

Deprecated the old manifest API. r=bird: IPRT does NOT use ugly C++ references, it pointers directly - no cloak and dagger pointers thank you. Please don't reformat if expressions into unreadability. RTDIGESTTYPE_UNKNOWN should be RTDIGESTTYPE_INVALID and there is actually no need to set output variables on failure, just check the status code.

File:

• trunk/include/iprt/manifest.h (modified) (8 diffs)

trunk/include/iprt/manifest.h

@@ -61 +61 @@
 typedef enum RTDIGESTTYPE
 {
-    /** unknown digest */
-    RTDIGESTTYPE_UNKNOWN,
-    /** CRC32 checksum */
-    RTDIGESTTYPE_CRC32 = 1,
-    /** CRC64 checksum */
+    /** Invalid digest value.  */
+    RTDIGESTTYPE_INVALID = 0,
+    /** CRC32 checksum. */
+    RTDIGESTTYPE_CRC32,
+    /** CRC64 checksum. */
     RTDIGESTTYPE_CRC64,
-    /** MD5 checksum (unsafe!) */
+    /** MD5 checksum (unsafe!). */
     RTDIGESTTYPE_MD5,
-    /** SHA1 checksum (unsafe!) */
+    /** SHA1 checksum (unsafe!). */
     RTDIGESTTYPE_SHA1,
-    /** SHA256 checksum */
+    /** SHA256 checksum. */
     RTDIGESTTYPE_SHA256,
-    /** SHA512 checksum */
-    RTDIGESTTYPE_SHA512
+    /** SHA512 checksum. */
+    RTDIGESTTYPE_SHA512,
+    /** Usual 32-bit type blowup. */
+    RTDIGESTTYPE_32BIT_HACK = 0x7fffffff
 } RTDIGESTTYPE;
 /** @} */
@@ -448 +450 @@
  *                               VERR_MANIFEST_DIGEST_MISMATCH error case
  *                               (optional).
+ * @deprecated Use the RTMANIFEST based API instead.
  */
 RTR3DECL(int) RTManifestVerify(const char *pszManifestFile, PRTMANIFESTTEST paTests, size_t cTests, size_t *piFailed);
@@ -465 +468 @@
  * @param   pfnProgressCallback  optional callback for the progress indication
  * @param   pvUser               user defined pointer for the callback
+ * @deprecated Use the RTMANIFEST based API instead.
  */
 RTR3DECL(int) RTManifestVerifyFiles(const char *pszManifestFile, const char * const *papszFiles, size_t cFiles, size_t *piFailed,
@@ -482 +486 @@
  * @param   pfnProgressCallback  optional callback for the progress indication
  * @param   pvUser               user defined pointer for the callback
+ * @deprecated Use the RTMANIFEST based API instead.
  */
 RTR3DECL(int) RTManifestWriteFiles(const char *pszManifestFile, RTDIGESTTYPE enmDigestType,
@@ -488 +493 @@
 
 /**
- * Verify the type of digest in the manifest file in memory. 
+ * Queries the first digest type found in the given manifest.
  *
  * @returns iprt status code.
@@ -494 +499 @@
  * @param   pvBuf                Pointer to memory buffer of the manifest file.
  * @param   cbSize               Size of the memory buffer.
- *                               VERR_MANIFEST_DIGEST_MISMATCH error case
- *                               (optional).
- * @param   digestType           digest type
- */
-RTR3DECL(int) RTManifestVerifyDigestType(void *pvBuf, size_t cbSize, RTDIGESTTYPE &digestType);
+ * @param   penmDigestType       Where to return the first digest type found in 
+ *                               the manifest.
+ * @deprecated Use the RTMANIFEST based API instead.
+ */
+RTR3DECL(int) RTManifestVerifyDigestType(void const *pvBuf, size_t cbSize, RTDIGESTTYPE *penmDigestType);
 
 /**
@@ -513 +518 @@
  *                               VERR_MANIFEST_DIGEST_MISMATCH error case
  *                               (optional).
+ * @deprecated Use the RTMANIFEST based API instead.
  */
 RTR3DECL(int) RTManifestVerifyFilesBuf(void *pvBuf, size_t cbSize, PRTMANIFESTTEST paTests, size_t cTests, size_t *piFailed);
@@ -528 +534 @@
  * @param   paFiles              Array of file names and digests.
  * @param   cFiles               Number of entries in paFiles.
+ * @deprecated Use the RTMANIFEST based API instead.
  */
 RTR3DECL(int) RTManifestWriteFilesBuf(void **ppvBuf, size_t *pcbSize, RTDIGESTTYPE enmDigestType, PRTMANIFESTTEST paFiles, size_t cFiles);