/* $Id: string.cpp 67646 2017-06-27 16:37:41Z vboxsync $ */ /** @file * MS COM / XPCOM Abstraction Layer - UTF-8 and UTF-16 string classes. */ /* * Copyright (C) 2006-2016 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. */ #include "VBox/com/string.h" #include #include #include #include #include namespace com { // BSTR representing a null wide char with 32 bits of length prefix (0); // this will work on Windows as well as other platforms where BSTR does // not use length prefixes const OLECHAR g_achEmptyBstr[3] = { 0, 0, 0 }; const BSTR g_bstrEmpty = (BSTR)&g_achEmptyBstr[2]; /* static */ const Bstr Bstr::Empty; /* default ctor is OK */ void Bstr::copyFromN(const char *a_pszSrc, size_t a_cchMax) { /* * Initialize m_bstr first in case of throws further down in the code, then * check for empty input (m_bstr == NULL means empty, there are no NULL * strings). */ m_bstr = NULL; if (!a_cchMax || !a_pszSrc || !*a_pszSrc) return; /* * Calculate the length and allocate a BSTR string buffer of the right * size, i.e. optimize heap usage. */ size_t cwc; int vrc = ::RTStrCalcUtf16LenEx(a_pszSrc, a_cchMax, &cwc); if (RT_SUCCESS(vrc)) { m_bstr = ::SysAllocStringByteLen(NULL, (unsigned)(cwc * sizeof(OLECHAR))); if (RT_LIKELY(m_bstr)) { PRTUTF16 pwsz = (PRTUTF16)m_bstr; vrc = ::RTStrToUtf16Ex(a_pszSrc, a_cchMax, &pwsz, cwc + 1, NULL); if (RT_SUCCESS(vrc)) return; /* This should not happen! */ AssertRC(vrc); cleanup(); } } else /* ASSUME: input is valid Utf-8. Fake out of memory error. */ AssertLogRelMsgFailed(("%Rrc %.*Rhxs\n", vrc, RTStrNLen(a_pszSrc, a_cchMax), a_pszSrc)); throw std::bad_alloc(); } int Bstr::compareUtf8(const char *a_pszRight, CaseSensitivity a_enmCase /*= CaseSensitive*/) const { PCRTUTF16 pwszLeft = m_bstr; /* * Special case for null/empty strings. Unlike RTUtf16Cmp we * treat null and empty equally. */ if (!pwszLeft) return !a_pszRight || *a_pszRight == '\0' ? 0 : -1; if (!a_pszRight) return *pwszLeft == '\0' ? 0 : 1; /* * Compare with a UTF-8 string by enumerating them char by char. */ for (;;) { RTUNICP ucLeft; int rc = RTUtf16GetCpEx(&pwszLeft, &ucLeft); AssertRCReturn(rc, 1); RTUNICP ucRight; rc = RTStrGetCpEx(&a_pszRight, &ucRight); AssertRCReturn(rc, -1); if (ucLeft == ucRight) { if (ucLeft) continue; return 0; } if (a_enmCase == CaseInsensitive) { if (RTUniCpToUpper(ucLeft) == RTUniCpToUpper(ucRight)) continue; if (RTUniCpToLower(ucLeft) == RTUniCpToLower(ucRight)) continue; } return ucLeft < ucRight ? -1 : 1; } } /* static */ const Utf8Str Utf8Str::Empty; /* default ctor is OK */ #if defined(VBOX_WITH_XPCOM) void Utf8Str::cloneTo(char **pstr) const { size_t cb = length() + 1; *pstr = (char *)nsMemory::Alloc(cb); if (RT_LIKELY(*pstr)) memcpy(*pstr, c_str(), cb); else throw std::bad_alloc(); } HRESULT Utf8Str::cloneToEx(char **pstr) const { size_t cb = length() + 1; *pstr = (char *)nsMemory::Alloc(cb); if (RT_LIKELY(*pstr)) { memcpy(*pstr, c_str(), cb); return S_OK; } return E_OUTOFMEMORY; } #endif Utf8Str& Utf8Str::stripTrailingSlash() { if (length()) { ::RTPathStripTrailingSlash(m_psz); jolt(); } return *this; } Utf8Str& Utf8Str::stripFilename() { if (length()) { RTPathStripFilename(m_psz); jolt(); } return *this; } Utf8Str& Utf8Str::stripPath() { if (length()) { char *pszName = ::RTPathFilename(m_psz); if (pszName) { size_t cchName = length() - (pszName - m_psz); memmove(m_psz, pszName, cchName + 1); jolt(); } else cleanup(); } return *this; } Utf8Str& Utf8Str::stripSuffix() { if (length()) { RTPathStripSuffix(m_psz); jolt(); } return *this; } size_t Utf8Str::parseKeyValue(Utf8Str &a_rKey, Utf8Str &a_rValue, size_t a_offStart /* = 0*/, const Utf8Str &a_rPairSeparator /*= ","*/, const Utf8Str &a_rKeyValueSeparator /*= "="*/) const { /* Find the end of the next pair, skipping empty pairs. Note! The skipping allows us to pass the return value of a parseKeyValue() call as offStart to the next call. */ size_t offEnd; while ( a_offStart == (offEnd = find(&a_rPairSeparator, a_offStart)) && offEnd != npos) a_offStart++; /* Look for a key/value separator before the end of the pair. ASSUMES npos value returned by find when the substring is not found is really high. */ size_t offKeyValueSep = find(&a_rKeyValueSeparator, a_offStart); if (offKeyValueSep < offEnd) { a_rKey = substr(a_offStart, offKeyValueSep - a_offStart); if (offEnd == npos) offEnd = m_cch; /* No confusing npos when returning strings. */ a_rValue = substr(offKeyValueSep + 1, offEnd - offKeyValueSep - 1); } else { a_rKey.setNull(); a_rValue.setNull(); } return offEnd; } /** * Internal function used in Utf8Str copy constructors and assignment when * copying from a UTF-16 string. * * As with the RTCString::copyFrom() variants, this unconditionally sets the * members to a copy of the given other strings and makes no assumptions about * previous contents. This can therefore be used both in copy constructors, * when member variables have no defined value, and in assignments after having * called cleanup(). * * This variant converts from a UTF-16 string, most probably from * a Bstr assignment. * * @param a_pbstr The source string. The caller guarantees that this * is valid UTF-16. * @param a_cwcMax The number of characters to be copied. If set to RTSTR_MAX, * the entire string will be copied. * * @sa RTCString::copyFromN */ void Utf8Str::copyFrom(CBSTR a_pbstr, size_t a_cwcMax) { if (a_pbstr && *a_pbstr) { int vrc = RTUtf16ToUtf8Ex((PCRTUTF16)a_pbstr, a_cwcMax, // size_t cwcString: translate entire string &m_psz, // char **ppsz: output buffer 0, // size_t cch: if 0, func allocates buffer in *ppsz &m_cch); // size_t *pcch: receives the size of the output string, excluding the terminator. if (RT_SUCCESS(vrc)) m_cbAllocated = m_cch + 1; else { if ( vrc != VERR_NO_STR_MEMORY && vrc != VERR_NO_MEMORY) { /* ASSUME: input is valid Utf-16. Fake out of memory error. */ AssertLogRelMsgFailed(("%Rrc %.*Rhxs\n", vrc, RTUtf16Len(a_pbstr) * sizeof(RTUTF16), a_pbstr)); } m_cch = 0; m_cbAllocated = 0; m_psz = NULL; throw std::bad_alloc(); } } else { m_cch = 0; m_cbAllocated = 0; m_psz = NULL; } } /** * A variant of Utf8Str::copyFrom that does not throw any exceptions but returns * E_OUTOFMEMORY instead. * * @param a_pbstr The source string. * @returns S_OK or E_OUTOFMEMORY. */ HRESULT Utf8Str::copyFromEx(CBSTR a_pbstr) { if (a_pbstr && *a_pbstr) { int vrc = RTUtf16ToUtf8Ex((PCRTUTF16)a_pbstr, RTSTR_MAX, // size_t cwcString: translate entire string &m_psz, // char **ppsz: output buffer 0, // size_t cch: if 0, func allocates buffer in *ppsz &m_cch); // size_t *pcch: receives the size of the output string, excluding the terminator. if (RT_SUCCESS(vrc)) m_cbAllocated = m_cch + 1; else { if ( vrc != VERR_NO_STR_MEMORY && vrc != VERR_NO_MEMORY) { /* ASSUME: input is valid Utf-16. Fake out of memory error. */ AssertLogRelMsgFailed(("%Rrc %.*Rhxs\n", vrc, RTUtf16Len(a_pbstr) * sizeof(RTUTF16), a_pbstr)); } m_cch = 0; m_cbAllocated = 0; m_psz = NULL; return E_OUTOFMEMORY; } } else { m_cch = 0; m_cbAllocated = 0; m_psz = NULL; } return S_OK; } /** * A variant of Utf8Str::copyFromN that does not throw any exceptions but * returns E_OUTOFMEMORY instead. * * @param a_pcszSrc The source string. * @param a_offSrc Start offset to copy from. * @param a_cchSrc The source string. * @returns S_OK or E_OUTOFMEMORY. * * @remarks This calls cleanup() first, so the caller doesn't have to. (Saves * code space.) */ HRESULT Utf8Str::copyFromExNComRC(const char *a_pcszSrc, size_t a_offSrc, size_t a_cchSrc) { cleanup(); if (a_cchSrc) { m_psz = RTStrAlloc(a_cchSrc + 1); if (RT_LIKELY(m_psz)) { m_cch = a_cchSrc; m_cbAllocated = a_cchSrc + 1; memcpy(m_psz, a_pcszSrc + a_offSrc, a_cchSrc); m_psz[a_cchSrc] = '\0'; } else { m_cch = 0; m_cbAllocated = 0; return E_OUTOFMEMORY; } } else { m_cch = 0; m_cbAllocated = 0; m_psz = NULL; } return S_OK; } } /* namespace com */