Changeset 36407 in vbox for trunk/include/iprt

Timestamp:

Mar 24, 2011 4:14:57 PM (14 years ago)

Author:

vboxsync

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

70762

Message:

IPRT: Added RTStrCopyP, RTStrCopyPEx, RTStrCatP and RTStrCatPEx. These functions will advance the destination buffer pointer and size parameters.

Location:

trunk/include/iprt

Files:

• mangling.h (modified) (1 diff)
• string.h (modified) (2 diffs)

trunk/include/iprt/mangling.h

@@ -1123 +1123 @@
 #define RTStrCat                                RT_MANGLER(RTStrCat)
 #define RTStrCatEx                              RT_MANGLER(RTStrCatEx)
+#define RTStrCatP                               RT_MANGLER(RTStrCatP)
+#define RTStrCatPEx                             RT_MANGLER(RTStrCatPEx)
 #define RTStrCmp                                RT_MANGLER(RTStrCmp)
 #define RTStrConvertHexBytes                    RT_MANGLER(RTStrConvertHexBytes)
 #define RTStrCopy                               RT_MANGLER(RTStrCopy)
 #define RTStrCopyEx                             RT_MANGLER(RTStrCopyEx)
+#define RTStrCopyP                              RT_MANGLER(RTStrCopyP)
+#define RTStrCopyPEx                            RT_MANGLER(RTStrCopyPEx)
 #define RTStrCurrentCPToUtf8Tag                 RT_MANGLER(RTStrCurrentCPToUtf8Tag)
 #define RTStrDupExTag                           RT_MANGLER(RTStrDupExTag)

trunk/include/iprt/string.h

@@ -2151 +2151 @@
 
 /**
+ * String copy with overflow handling and buffer advancing.
+ *
+ * @retval  VINF_SUCCESS on success.
+ * @retval  VERR_BUFFER_OVERFLOW if the destination buffer is too small.  The
+ *          buffer will contain as much of the string as it can hold, fully
+ *          terminated.
+ *
+ * @param   ppszDst             Pointer to the destination buffer pointer.
+ *                              This will be advanced to the end of the copied
+ *                              bytes (points at the terminator).  This is also
+ *                              updated on overflow.
+ * @param   pcbDst              Pointer to the destination buffer size
+ *                              variable.  This will be updated in accord with
+ *                              the buffer pointer.
+ * @param   pszSrc              The source string.  NULL is not OK.
+ */
+RTDECL(int) RTStrCopyP(char **ppszDst, size_t *pcbDst, const char *pszSrc);
+
+/**
+ * String copy with overflow handling.
+ *
+ * @retval  VINF_SUCCESS on success.
+ * @retval  VERR_BUFFER_OVERFLOW if the destination buffer is too small.  The
+ *          buffer will contain as much of the string as it can hold, fully
+ *          terminated.
+ *
+ * @param   ppszDst             Pointer to the destination buffer pointer.
+ *                              This will be advanced to the end of the copied
+ *                              bytes (points at the terminator).  This is also
+ *                              updated on overflow.
+ * @param   pcbDst              Pointer to the destination buffer size
+ *                              variable.  This will be updated in accord with
+ *                              the buffer pointer.
+ * @param   pszSrc              The source string.  NULL is not OK.
+ * @param   cchSrcMax           The maximum number of chars (not code points) to
+ *                              copy from the source string, not counting the
+ *                              terminator as usual.
+ */
+RTDECL(int) RTStrCopyPEx(char **ppszDst, size_t *pcbDst, const char *pszSrc, size_t cchSrcMax);
+
+/**
  * String concatenation with overflow handling.
  *
@@ -2180 +2221 @@
  */
 RTDECL(int) RTStrCatEx(char *pszDst, size_t cbDst, const char *pszSrc, size_t cchSrcMax);
+
+/**
+ * String concatenation with overflow handling.
+ *
+ * @retval  VINF_SUCCESS on success.
+ * @retval  VERR_BUFFER_OVERFLOW if the destination buffer is too small.  The
+ *          buffer will contain as much of the string as it can hold, fully
+ *          terminated.
+ *
+ * @param   ppszDst             Pointer to the destination buffer pointer.
+ *                              This will be advanced to the end of the copied
+ *                              bytes (points at the terminator).  This is also
+ *                              updated on overflow.
+ * @param   pcbDst              Pointer to the destination buffer size
+ *                              variable.  This will be updated in accord with
+ *                              the buffer pointer.
+ * @param   pszSrc              The source string.  NULL is not OK.
+ */
+RTDECL(int) RTStrCatP(char **ppszDst, size_t *pcbDst, const char *pszSrc);
+
+/**
+ * String concatenation with overflow handling and buffer advancing.
+ *
+ * @retval  VINF_SUCCESS on success.
+ * @retval  VERR_BUFFER_OVERFLOW if the destination buffer is too small.  The
+ *          buffer will contain as much of the string as it can hold, fully
+ *          terminated.
+ *
+ * @param   ppszDst             Pointer to the destination buffer pointer.
+ *                              This will be advanced to the end of the copied
+ *                              bytes (points at the terminator).  This is also
+ *                              updated on overflow.
+ * @param   pcbDst              Pointer to the destination buffer size
+ *                              variable.  This will be updated in accord with
+ *                              the buffer pointer.
+ * @param   pszSrc              The source string.  NULL is not OK.
+ * @param   cchSrcMax           The maximum number of chars (not code points) to
+ *                              copy from the source string, not counting the
+ *                              terminator as usual.
+ */
+RTDECL(int) RTStrCatPEx(char **ppszDst, size_t *pcbDst, const char *pszSrc, size_t cchSrcMax);
 
 /**