Index: /trunk/include/iprt/string.h =================================================================== --- /trunk/include/iprt/string.h (revision 33677) +++ /trunk/include/iprt/string.h (revision 33678) @@ -2041,4 +2041,35 @@ /** + * 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 pszDst The destination buffer. + * @param cbDst The size of the destination buffer (in bytes). + * @param pszSrc The source string. NULL is not OK. + */ +RTDECL(int) RTStrCat(char *pszDst, size_t cbDst, const char *pszSrc); + +/** + * 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 pszDst The destination buffer. + * @param cbDst The size of the destination buffer (in bytes). + * @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) RTStrCatEx(char *pszDst, size_t cbDst, const char *pszSrc, size_t cchSrcMax); + +/** * Performs a case sensitive string compare between two UTF-8 strings. * Index: /trunk/src/VBox/Runtime/Makefile.kmk =================================================================== --- /trunk/src/VBox/Runtime/Makefile.kmk (revision 33677) +++ /trunk/src/VBox/Runtime/Makefile.kmk (revision 33678) @@ -312,4 +312,6 @@ common/sort/RTSortApvIsSorted.cpp \ common/sort/shellsort.cpp \ + common/string/RTStrCat.cpp \ + common/string/RTStrCatEx.cpp \ common/string/RTStrCmp.cpp \ common/string/RTStrConvertHexBytes.cpp \ @@ -962,4 +964,6 @@ common/path/RTPathStripFilename.cpp \ common/path/RTPathStripTrailingSlash.cpp \ + common/string/RTStrCat.cpp \ + common/string/RTStrCatEx.cpp \ common/string/RTStrCmp.cpp \ common/string/RTStrCopy.cpp \ @@ -1291,4 +1295,6 @@ common/string/strncmp.cpp \ common/string/strpbrk.cpp \ + common/string/RTStrCat.cpp \ + common/string/RTStrCatEx.cpp \ common/string/RTStrCopy.cpp \ common/string/RTStrCopyEx.cpp \ @@ -1426,4 +1432,6 @@ common/rand/randadv.cpp \ common/rand/randparkmiller.cpp \ + common/string/RTStrCat.cpp \ + common/string/RTStrCatEx.cpp \ common/string/RTStrCmp.cpp \ common/string/RTStrCopy.cpp \ Index: /trunk/src/VBox/Runtime/common/string/RTStrCat.cpp =================================================================== --- /trunk/src/VBox/Runtime/common/string/RTStrCat.cpp (revision 33678) +++ /trunk/src/VBox/Runtime/common/string/RTStrCat.cpp (revision 33678) @@ -0,0 +1,56 @@ +/* $Id$ */ +/** @file + * IPRT - RTStrCat. + */ + +/* + * Copyright (C) 2010 Oracle Corporation + * + * This file is part of VirtualBox Open Source Edition (OSE), as + * available from http://www.virtualbox.org. This file is free software; + * you can redistribute it and/or modify it under the terms of the GNU + * General Public License (GPL) as published by the Free Software + * Foundation, in version 2 as it comes in the "COPYING" file of the + * VirtualBox OSE distribution. VirtualBox OSE is distributed in the + * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind. + * + * The contents of this file may alternatively be used under the terms + * of the Common Development and Distribution License Version 1.0 + * (CDDL) only, as it comes in the "COPYING.CDDL" file of the + * VirtualBox OSE distribution, in which case the provisions of the + * CDDL are applicable instead of those of the GPL. + * + * You may elect to license modified versions of this file under the + * terms and conditions of either the GPL or the CDDL or both. + */ + + +/******************************************************************************* +* Header Files * +*******************************************************************************/ +#include +#include "internal/iprt.h" + + +RTDECL(int) RTStrCat(char *pszDst, size_t cbDst, const char *pszSrc) +{ + char *pszDst2 = RTStrEnd(pszDst, cbDst); + AssertReturn(pszDst2, VERR_INVALID_PARAMETER); + cbDst -= pszDst2 - pszDst; + + size_t cchSrc = strlen(pszSrc); + if (RT_LIKELY(cchSrc < cbDst)) + { + memcpy(pszDst2, pszSrc, cchSrc + 1); + return VINF_SUCCESS; + } + + if (cbDst != 0) + { + memcpy(pszDst2, pszSrc, cbDst - 1); + pszDst2[cbDst - 1] = '\0'; + } + return VERR_BUFFER_OVERFLOW; +} +RT_EXPORT_SYMBOL(RTStrCat); + Index: /trunk/src/VBox/Runtime/common/string/RTStrCatEx.cpp =================================================================== --- /trunk/src/VBox/Runtime/common/string/RTStrCatEx.cpp (revision 33678) +++ /trunk/src/VBox/Runtime/common/string/RTStrCatEx.cpp (revision 33678) @@ -0,0 +1,58 @@ +/* $Id$ */ +/** @file + * IPRT - RTStrCatEx + */ + +/* + * Copyright (C) 2010 Oracle Corporation + * + * This file is part of VirtualBox Open Source Edition (OSE), as + * available from http://www.virtualbox.org. This file is free software; + * you can redistribute it and/or modify it under the terms of the GNU + * General Public License (GPL) as published by the Free Software + * Foundation, in version 2 as it comes in the "COPYING" file of the + * VirtualBox OSE distribution. VirtualBox OSE is distributed in the + * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind. + * + * The contents of this file may alternatively be used under the terms + * of the Common Development and Distribution License Version 1.0 + * (CDDL) only, as it comes in the "COPYING.CDDL" file of the + * VirtualBox OSE distribution, in which case the provisions of the + * CDDL are applicable instead of those of the GPL. + * + * You may elect to license modified versions of this file under the + * terms and conditions of either the GPL or the CDDL or both. + */ + + +/******************************************************************************* +* Header Files * +*******************************************************************************/ +#include +#include "internal/iprt.h" + + +RTDECL(int) RTStrCatEx(char *pszDst, size_t cbDst, const char *pszSrc, size_t cchMaxSrc) +{ + char *pszDst2 = RTStrEnd(pszDst, cbDst); + AssertReturn(pszDst2, VERR_INVALID_PARAMETER); + cbDst -= pszDst2 - pszDst; + + const char *pszSrcEol = RTStrEnd(pszSrc, cchMaxSrc); + size_t cchSrc = pszSrcEol ? (size_t)(pszSrcEol - pszSrc) : cchMaxSrc; + if (RT_LIKELY(cchSrc < cbDst)) + { + memcpy(pszDst2, pszSrc, cchSrc); + pszDst2[cchSrc] = '\0'; + return VINF_SUCCESS; + } + + if (cbDst != 0) + { + memcpy(pszDst2, pszSrc, cbDst - 1); + pszDst2[cbDst - 1] = '\0'; + } + return VERR_BUFFER_OVERFLOW; +} +RT_EXPORT_SYMBOL(RTStrCatEx); + Index: /trunk/src/VBox/Runtime/common/string/RTStrCopyEx.cpp =================================================================== --- /trunk/src/VBox/Runtime/common/string/RTStrCopyEx.cpp (revision 33677) +++ /trunk/src/VBox/Runtime/common/string/RTStrCopyEx.cpp (revision 33678) @@ -1,5 +1,5 @@ /* $Id$ */ /** @file - * IPRT - RTStrCopy. + * IPRT - RTStrCopyEx. */ Index: /trunk/src/VBox/Runtime/testcase/Makefile.kmk =================================================================== --- /trunk/src/VBox/Runtime/testcase/Makefile.kmk (revision 33677) +++ /trunk/src/VBox/Runtime/testcase/Makefile.kmk (revision 33678) @@ -97,4 +97,5 @@ tstRTStrAlloc \ tstRTStrCache \ + tstRTStrCatCopy \ tstRTStrFormat \ tstStrSimplePattern \ @@ -428,4 +429,8 @@ tstRTStrCache_SOURCES = tstRTStrCache.cpp +tstRTStrCatCopy_TEMPLATE = VBOXR3TSTEXE +tstRTStrCatCopy_SOURCES = tstRTStrCatCopy.cpp + +tstRTStrFormat_TEMPLATE = VBOXR3TSTEXE tstRTStrFormat_SOURCES = tstRTStrFormat.cpp Index: /trunk/src/VBox/Runtime/testcase/tstRTStrCatCopy.cpp =================================================================== --- /trunk/src/VBox/Runtime/testcase/tstRTStrCatCopy.cpp (revision 33678) +++ /trunk/src/VBox/Runtime/testcase/tstRTStrCatCopy.cpp (revision 33678) @@ -0,0 +1,213 @@ +/* $Id$ */ +/** @file + * IPRT Testcase - String Concatenation and Copy. + */ + +/* + * Copyright (C) 2010 Oracle Corporation + * + * This file is part of VirtualBox Open Source Edition (OSE), as + * available from http://www.virtualbox.org. This file is free software; + * you can redistribute it and/or modify it under the terms of the GNU + * General Public License (GPL) as published by the Free Software + * Foundation, in version 2 as it comes in the "COPYING" file of the + * VirtualBox OSE distribution. VirtualBox OSE is distributed in the + * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind. + * + * The contents of this file may alternatively be used under the terms + * of the Common Development and Distribution License Version 1.0 + * (CDDL) only, as it comes in the "COPYING.CDDL" file of the + * VirtualBox OSE distribution, in which case the provisions of the + * CDDL are applicable instead of those of the GPL. + * + * You may elect to license modified versions of this file under the + * terms and conditions of either the GPL or the CDDL or both. + */ + +/******************************************************************************* +* Header Files * +*******************************************************************************/ +#include + +#include + + +static void testCopy1(RTTEST hTest) +{ + RTTestISub("RTStrCopy"); + + char *pszBuf4H = (char *)RTTestGuardedAllocHead(hTest, 4); + char *pszBuf4T = (char *)RTTestGuardedAllocTail(hTest, 4); + RTTESTI_CHECK_RC(RTStrCopy(pszBuf4H, 4, "abc"), VINF_SUCCESS); + RTTESTI_CHECK(strcmp(pszBuf4H, "abc") == 0); + RTTESTI_CHECK_RC(RTStrCopy(pszBuf4T, 4, "abc"), VINF_SUCCESS); + RTTESTI_CHECK(strcmp(pszBuf4T, "abc") == 0); + + RT_BZERO(pszBuf4H, 4); RT_BZERO(pszBuf4T, 4); + RTTESTI_CHECK_RC(RTStrCopy(pszBuf4H, 4, "abcd"), VERR_BUFFER_OVERFLOW); + RTTESTI_CHECK(strcmp(pszBuf4H, "abc") == 0); + RTTESTI_CHECK_RC(RTStrCopy(pszBuf4T, 4, "abcd"), VERR_BUFFER_OVERFLOW); + RTTESTI_CHECK(strcmp(pszBuf4T, "abc") == 0); +} + + +static void testCopyEx1(RTTEST hTest) +{ + RTTestISub("RTStrCopyEx"); + + char *pszBuf4H = (char *)RTTestGuardedAllocHead(hTest, 4); + char *pszBuf4T = (char *)RTTestGuardedAllocTail(hTest, 4); + RTTESTI_CHECK_RC(RTStrCopyEx(pszBuf4H, 4, "abc", RTSTR_MAX), VINF_SUCCESS); + RTTESTI_CHECK(strcmp(pszBuf4H, "abc") == 0); + RTTESTI_CHECK_RC(RTStrCopyEx(pszBuf4T, 4, "abc", RTSTR_MAX), VINF_SUCCESS); + RTTESTI_CHECK(strcmp(pszBuf4T, "abc") == 0); + + RT_BZERO(pszBuf4H, 4); RT_BZERO(pszBuf4T, 4); + RTTESTI_CHECK_RC(RTStrCopyEx(pszBuf4H, 4, "abcd", RTSTR_MAX), VERR_BUFFER_OVERFLOW); + RTTESTI_CHECK(strcmp(pszBuf4H, "abc") == 0); + RTTESTI_CHECK_RC(RTStrCopyEx(pszBuf4T, 4, "abcd", RTSTR_MAX), VERR_BUFFER_OVERFLOW); + RTTESTI_CHECK(strcmp(pszBuf4T, "abc") == 0); + + RT_BZERO(pszBuf4H, 4); RT_BZERO(pszBuf4T, 4); + RTTESTI_CHECK_RC(RTStrCopyEx(pszBuf4H, 4, "abcd", 3), VINF_SUCCESS); + RTTESTI_CHECK(strcmp(pszBuf4H, "abc") == 0); + RTTESTI_CHECK_RC(RTStrCopyEx(pszBuf4T, 4, "abcd", 3), VINF_SUCCESS); + RTTESTI_CHECK(strcmp(pszBuf4T, "abc") == 0); + + RT_BZERO(pszBuf4H, 4); RT_BZERO(pszBuf4T, 4); + RTTESTI_CHECK_RC(RTStrCopyEx(pszBuf4H, 4, "abcd", 2), VINF_SUCCESS); + RTTESTI_CHECK(strcmp(pszBuf4H, "ab") == 0); + RTTESTI_CHECK_RC(RTStrCopyEx(pszBuf4T, 4, "abcd", 2), VINF_SUCCESS); + RTTESTI_CHECK(strcmp(pszBuf4T, "ab") == 0); +} + + +static void testCat1(RTTEST hTest) +{ + RTTestISub("RTStrCat"); + + char *pszBuf4H = (char *)RTTestGuardedAllocHead(hTest, 4); + char *pszBuf4T = (char *)RTTestGuardedAllocTail(hTest, 4); + memset(pszBuf4T, 0xff, 4); *pszBuf4T = '\0'; + RTTESTI_CHECK_RC(RTStrCat(pszBuf4H, 4, "abc"), VINF_SUCCESS); + RTTESTI_CHECK(strcmp(pszBuf4H, "abc") == 0); + memset(pszBuf4H, 0xff, 4); *pszBuf4H = '\0'; + RTTESTI_CHECK_RC(RTStrCat(pszBuf4T, 4, "abc"), VINF_SUCCESS); + RTTESTI_CHECK(strcmp(pszBuf4T, "abc") == 0); + + memset(pszBuf4T, 0xff, 4); strcpy(pszBuf4T, "a"); + memset(pszBuf4H, 0xff, 4); strcpy(pszBuf4H, "a"); + RTTESTI_CHECK_RC(RTStrCat(pszBuf4H, 4, "bc"), VINF_SUCCESS); + RTTESTI_CHECK(strcmp(pszBuf4H, "abc") == 0); + RTTESTI_CHECK_RC(RTStrCat(pszBuf4T, 4, "bc"), VINF_SUCCESS); + RTTESTI_CHECK(strcmp(pszBuf4T, "abc") == 0); + + memset(pszBuf4T, 0xff, 4); strcpy(pszBuf4T, "ab"); + memset(pszBuf4H, 0xff, 4); strcpy(pszBuf4H, "ab"); + RTTESTI_CHECK_RC(RTStrCat(pszBuf4H, 4, "c"), VINF_SUCCESS); + RTTESTI_CHECK(strcmp(pszBuf4H, "abc") == 0); + RTTESTI_CHECK_RC(RTStrCat(pszBuf4T, 4, "c"), VINF_SUCCESS); + RTTESTI_CHECK(strcmp(pszBuf4T, "abc") == 0); + + memset(pszBuf4T, 0xff, 4); strcpy(pszBuf4T, "abc"); + memset(pszBuf4H, 0xff, 4); strcpy(pszBuf4H, "abc"); + RTTESTI_CHECK_RC(RTStrCat(pszBuf4H, 4, ""), VINF_SUCCESS); + RTTESTI_CHECK(strcmp(pszBuf4H, "abc") == 0); + RTTESTI_CHECK_RC(RTStrCat(pszBuf4T, 4, ""), VINF_SUCCESS); + RTTESTI_CHECK(strcmp(pszBuf4T, "abc") == 0); + + memset(pszBuf4T, 0xff, 4); strcpy(pszBuf4T, ""); + memset(pszBuf4H, 0xff, 4); strcpy(pszBuf4H, ""); + RTTESTI_CHECK_RC(RTStrCat(pszBuf4H, 4, "abcd"), VERR_BUFFER_OVERFLOW); + RTTESTI_CHECK(strcmp(pszBuf4H, "abc") == 0); + RTTESTI_CHECK_RC(RTStrCat(pszBuf4T, 4, "abcd"), VERR_BUFFER_OVERFLOW); + RTTESTI_CHECK(strcmp(pszBuf4T, "abc") == 0); + + memset(pszBuf4T, 0xff, 4); strcpy(pszBuf4T, "ab"); + memset(pszBuf4H, 0xff, 4); strcpy(pszBuf4H, "ab"); + RTTESTI_CHECK_RC(RTStrCat(pszBuf4H, 4, "cd"), VERR_BUFFER_OVERFLOW); + RTTESTI_CHECK(strcmp(pszBuf4H, "abc") == 0); + RTTESTI_CHECK_RC(RTStrCat(pszBuf4T, 4, "cd"), VERR_BUFFER_OVERFLOW); + RTTESTI_CHECK(strcmp(pszBuf4T, "abc") == 0); + + memset(pszBuf4T, 0xff, 4); strcpy(pszBuf4T, "abc"); + memset(pszBuf4H, 0xff, 4); strcpy(pszBuf4H, "abc"); + RTTESTI_CHECK_RC(RTStrCat(pszBuf4H, 4, "d"), VERR_BUFFER_OVERFLOW); + RTTESTI_CHECK(strcmp(pszBuf4H, "abc") == 0); + RTTESTI_CHECK_RC(RTStrCat(pszBuf4T, 4, "d"), VERR_BUFFER_OVERFLOW); + RTTESTI_CHECK(strcmp(pszBuf4T, "abc") == 0); +} + + +static void testCatEx1(RTTEST hTest) +{ + RTTestISub("RTStrCatEx"); + + char *pszBuf4H = (char *)RTTestGuardedAllocHead(hTest, 4); + char *pszBuf4T = (char *)RTTestGuardedAllocTail(hTest, 4); + memset(pszBuf4T, 0xff, 4); *pszBuf4T = '\0'; + RTTESTI_CHECK_RC(RTStrCatEx(pszBuf4H, 4, "abc", RTSTR_MAX), VINF_SUCCESS); + RTTESTI_CHECK(strcmp(pszBuf4H, "abc") == 0); + memset(pszBuf4H, 0xff, 4); *pszBuf4H = '\0'; + RTTESTI_CHECK_RC(RTStrCatEx(pszBuf4T, 4, "abc", RTSTR_MAX), VINF_SUCCESS); + RTTESTI_CHECK(strcmp(pszBuf4T, "abc") == 0); + + memset(pszBuf4T, 0xff, 4); strcpy(pszBuf4T, "a"); + memset(pszBuf4H, 0xff, 4); strcpy(pszBuf4H, "a"); + RTTESTI_CHECK_RC(RTStrCatEx(pszBuf4H, 4, "bc", 2), VINF_SUCCESS); + RTTESTI_CHECK(strcmp(pszBuf4H, "abc") == 0); + RTTESTI_CHECK_RC(RTStrCatEx(pszBuf4T, 4, "bc", 2), VINF_SUCCESS); + RTTESTI_CHECK(strcmp(pszBuf4T, "abc") == 0); + + memset(pszBuf4T, 0xff, 4); strcpy(pszBuf4T, "ab"); + memset(pszBuf4H, 0xff, 4); strcpy(pszBuf4H, "ab"); + RTTESTI_CHECK_RC(RTStrCatEx(pszBuf4H, 4, "c", 1), VINF_SUCCESS); + RTTESTI_CHECK(strcmp(pszBuf4H, "abc") == 0); + RTTESTI_CHECK_RC(RTStrCatEx(pszBuf4T, 4, "c", 1), VINF_SUCCESS); + RTTESTI_CHECK(strcmp(pszBuf4T, "abc") == 0); + + memset(pszBuf4T, 0xff, 4); strcpy(pszBuf4T, "abc"); + memset(pszBuf4H, 0xff, 4); strcpy(pszBuf4H, "abc"); + RTTESTI_CHECK_RC(RTStrCatEx(pszBuf4H, 4, "defg", 0), VINF_SUCCESS); + RTTESTI_CHECK(strcmp(pszBuf4H, "abc") == 0); + RTTESTI_CHECK_RC(RTStrCatEx(pszBuf4T, 4, "defg", 0), VINF_SUCCESS); + RTTESTI_CHECK(strcmp(pszBuf4T, "abc") == 0); + + memset(pszBuf4T, 0xff, 4); strcpy(pszBuf4T, ""); + memset(pszBuf4H, 0xff, 4); strcpy(pszBuf4H, ""); + RTTESTI_CHECK_RC(RTStrCatEx(pszBuf4H, 4, "abcd", 4), VERR_BUFFER_OVERFLOW); + RTTESTI_CHECK(strcmp(pszBuf4H, "abc") == 0); + RTTESTI_CHECK_RC(RTStrCatEx(pszBuf4T, 4, "abcd", 4), VERR_BUFFER_OVERFLOW); + RTTESTI_CHECK(strcmp(pszBuf4T, "abc") == 0); + + memset(pszBuf4T, 0xff, 4); strcpy(pszBuf4T, "ab"); + memset(pszBuf4H, 0xff, 4); strcpy(pszBuf4H, "ab"); + RTTESTI_CHECK_RC(RTStrCatEx(pszBuf4H, 4, "cdefg", 2), VERR_BUFFER_OVERFLOW); + RTTESTI_CHECK(strcmp(pszBuf4H, "abc") == 0); + RTTESTI_CHECK_RC(RTStrCatEx(pszBuf4T, 4, "cdefg", 2), VERR_BUFFER_OVERFLOW); + RTTESTI_CHECK(strcmp(pszBuf4T, "abc") == 0); + + memset(pszBuf4T, 0xff, 4); strcpy(pszBuf4T, "abc"); + memset(pszBuf4H, 0xff, 4); strcpy(pszBuf4H, "abc"); + RTTESTI_CHECK_RC(RTStrCatEx(pszBuf4H, 4, "de", 1), VERR_BUFFER_OVERFLOW); + RTTESTI_CHECK(strcmp(pszBuf4H, "abc") == 0); + RTTESTI_CHECK_RC(RTStrCatEx(pszBuf4T, 4, "de", 1), VERR_BUFFER_OVERFLOW); + RTTESTI_CHECK(strcmp(pszBuf4T, "abc") == 0); +} + + + +int main() +{ + RTTEST hTest; + RTEXITCODE rcExit = RTTestInitAndCreate("tstRTStrCatCopy", &hTest); + if (rcExit != RTEXITCODE_SUCCESS) + return rcExit; + + testCopy1(hTest); + testCopyEx1(hTest); + testCat1(hTest); + testCatEx1(hTest); + + return RTTestSummaryAndDestroy(hTest); +}