Changeset 73587 in vbox for trunk/include

Timestamp:

Aug 9, 2018 1:37:52 PM (6 years ago)

Author:

vboxsync

Message:

iptr/base64: introduce RTBase64EncodedLengthEx() and RTBase64EncodeEx(),
and RTBASE64_FLAGS_NO_LINE_BREAKS flag for them.

Location:

trunk/include/iprt

Files:

• base64.h (modified) (4 diffs)
• mangling.h (modified) (1 diff)

trunk/include/iprt/base64.h

@@ -43 +43 @@
 # define RTBASE64_EOL_SIZE      (sizeof("\n")   - 1)
 #endif
+
+
+/** @name Flags for RTBase64EncodeEx() and RTBase64EncodedLengthEx().
+ * @{ */
+/** Insert line breaks into encoded string.
+ * The size of the end-of-line marker is that that of the host platform.
+ */
+#define RTBASE64_FLAGS_NO_LINE_BREAKS RT_BIT_32(0)
+/** @} */
+
 
 /**
@@ -121 +131 @@
                              size_t *pcbActual, char **ppszEnd);
 
+
 /**
  * Calculates the length of the Base64 encoding of a given number of bytes of
- * data.
- *
- * This will assume line breaks every 64 chars. A RTBase64EncodedLengthEx
- * function can be added if closer control over the output is found to be
- * required.
+ * data produced by RTBase64Encode().
  *
  * @returns The Base64 string length.
@@ -135 +142 @@
 
 /**
+ * Calculates the length of the Base64 encoding of a given number of bytes of
+ * data produced by RTBase64EncodeEx() with the same @a fFlags.
+ *
+ * @returns The Base64 string length.
+ * @param   cbData      The number of bytes to encode.
+ * @param   fFlags      Flags, any combination of the RTBASE64_FLAGS \#defines.
+ */
+RTDECL(size_t) RTBase64EncodedLengthEx(size_t cbData, uint32_t fFlags);
+
+/**
  * Encodes the specifed data into a Base64 string, the caller supplies the
  * output buffer.
  *
- * This will make the same assumptions about line breaks and EOL size as
- * RTBase64EncodedLength() does. A RTBase64EncodeEx function can be added if
- * more strict control over the output formatting is found necessary.
+ * This is equivalent to calling RTBase64EncodeEx() with no flags.
  *
  * @returns IRPT status code.
@@ -154 +169 @@
 RTDECL(int) RTBase64Encode(const void *pvData, size_t cbData, char *pszBuf, size_t cbBuf, size_t *pcchActual);
 
+/**
+ * Encodes the specifed data into a Base64 string, the caller supplies the
+ * output buffer.
+ *
+ * @returns IRPT status code.
+ * @retval  VERR_BUFFER_OVERFLOW if the output buffer is too small. The buffer
+ *          may contain an invalid Base64 string.
+ *
+ * @param   pvData      The data to encode.
+ * @param   cbData      The number of bytes to encode.
+ * @param   pszBuf      Where to put the Base64 string.
+ * @param   cbBuf       The size of the output buffer, including the terminator.
+ * @param   pcchActual  The actual number of characters returned.
+ */
+RTDECL(int) RTBase64EncodeEx(const void *pvData, size_t cbData, uint32_t fFlags,
+                             char *pszBuf, size_t cbBuf, size_t *pcchActual);
+
 /** @}  */
 

trunk/include/iprt/mangling.h

@@ -575 +575 @@
 # define RTBase64DecodedSizeEx                          RT_MANGLER(RTBase64DecodedSizeEx)
 # define RTBase64Encode                                 RT_MANGLER(RTBase64Encode)
+# define RTBase64EncodeEx                               RT_MANGLER(RTBase64EncodeEx)
 # define RTBase64EncodedLength                          RT_MANGLER(RTBase64EncodedLength)
+# define RTBase64EncodedLengthEx                        RT_MANGLER(RTBase64EncodedLengthEx)
 # define RTBldCfgCompiler                               RT_MANGLER(RTBldCfgCompiler)
 # define RTBldCfgRevision                               RT_MANGLER(RTBldCfgRevision)