LibreOffice
LibreOffice 7.2 SDK C/C++ API Reference
string.hxx
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20/*
21 * This file is part of LibreOffice published API.
22 */
23
24#ifndef INCLUDED_RTL_STRING_HXX
25#define INCLUDED_RTL_STRING_HXX
26
27#include "sal/config.h"
28
29#include <cassert>
30#include <cstddef>
31#include <cstdlib>
32#include <limits>
33#include <new>
34#include <ostream>
35#include <utility>
36#include <string.h>
37
38#if defined LIBO_INTERNAL_ONLY
39#include <string_view>
40#include <type_traits>
41#endif
42
43#include "rtl/textenc.h"
44#include "rtl/string.h"
45#include "rtl/stringutils.hxx"
46
47#ifdef LIBO_INTERNAL_ONLY // "RTL_FAST_STRING"
48#include "config_global.h"
49#include "rtl/stringconcat.hxx"
50#endif
51
52#ifdef RTL_STRING_UNITTEST
53extern bool rtl_string_unittest_const_literal;
54extern bool rtl_string_unittest_const_literal_function;
55#endif
56
57// The unittest uses slightly different code to help check that the proper
58// calls are made. The class is put into a different namespace to make
59// sure the compiler generates a different (if generating also non-inline)
60// copy of the function and does not merge them together. The class
61// is "brought" into the proper rtl namespace by a typedef below.
62#ifdef RTL_STRING_UNITTEST
63#define rtl rtlunittest
64#endif
65
66namespace rtl
67{
68
70#ifdef RTL_STRING_UNITTEST
71#undef rtl
72// helper macro to make functions appear more readable
73#define RTL_STRING_CONST_FUNCTION rtl_string_unittest_const_literal_function = true;
74#else
75#define RTL_STRING_CONST_FUNCTION
76#endif
78
79#ifdef LIBO_INTERNAL_ONLY // "RTL_FAST_STRING"
86template<std::size_t N> class SAL_WARN_UNUSED OStringLiteral {
87 static_assert(N != 0);
88 static_assert(N - 1 <= std::numeric_limits<sal_Int32>::max(), "literal too long");
89 friend class OString;
90
91public:
92#if HAVE_CPP_CONSTEVAL
93 consteval
94#else
95 constexpr
96#endif
97 OStringLiteral(char const (&literal)[N]) {
98 assertLayout();
99 assert(literal[N - 1] == '\0');
100 //TODO: Use C++20 constexpr std::copy_n (P0202R3):
101 for (std::size_t i = 0; i != N; ++i) {
102 more.buffer[i] = literal[i];
103 }
104 }
105
106#if defined __cpp_char8_t
107#if HAVE_CPP_CONSTEVAL
108 consteval
109#else
110 constexpr
111#endif
112 explicit OStringLiteral(char8_t const (&literal)[N]) {
113 assertLayout();
114 assert(literal[N - 1] == '\0');
115 //TODO: Use C++20 constexpr std::copy_n (P0202R3):
116 for (std::size_t i = 0; i != N; ++i) {
117 more.buffer[i] = literal[i];
118 }
119 }
120#endif
121
122 constexpr sal_Int32 getLength() const { return more.length; }
123
124 constexpr char const * getStr() const SAL_RETURNS_NONNULL { return more.buffer; }
125
126 constexpr operator std::string_view() const { return {more.buffer, sal_uInt32(more.length)}; }
127
128private:
129 static constexpr void assertLayout() {
130 // These static_asserts verifying the layout compatibility with rtl_String cannot be class
131 // member declarations, as offsetof requires a complete type, so defer them to here:
132 static_assert(offsetof(OStringLiteral, str.refCount) == offsetof(OStringLiteral, more.refCount));
133 static_assert(offsetof(OStringLiteral, str.length) == offsetof(OStringLiteral, more.length));
134 static_assert(offsetof(OStringLiteral, str.buffer) == offsetof(OStringLiteral, more.buffer));
135 }
136
137 union {
138 rtl_String str;
139 struct {
140 oslInterlockedCount refCount;
141 sal_Int32 length;
142 char buffer[N];
143 } more =
144 {
145 0x40000000, // SAL_STRING_STATIC_FLAG (sal/rtl/strimp.hxx)
146 N - 1,
147 {} //TODO: drop initialization for C++20 (P1331R2)
148 };
149 };
150};
151#endif
152
153/* ======================================================================= */
154
179class SAL_WARN_UNUSED SAL_DLLPUBLIC_RTTI OString
180{
181public:
183 rtl_String * pData;
185
190 {
191 pData = NULL;
192 rtl_string_new( &pData );
193 }
194
200 OString( const OString & str )
201 {
202 pData = str.pData;
203 rtl_string_acquire( pData );
204 }
205
206#if defined LIBO_INTERNAL_ONLY
213 OString( OString && str ) noexcept
214 {
215 pData = str.pData;
216 str.pData = nullptr;
217 rtl_string_new( &str.pData );
218 }
219#endif
220
226 OString( rtl_String * str )
227 {
228 pData = str;
229 rtl_string_acquire( pData );
230 }
231
239 OString( rtl_String * str, __sal_NoAcquire )
240 {
241 pData = str;
242 }
243
249 explicit OString( char value )
250 : pData (NULL)
251 {
252 rtl_string_newFromStr_WithLength( &pData, &value, 1 );
253 }
254
255#if defined LIBO_INTERNAL_ONLY && !defined RTL_STRING_UNITTEST_CONCAT
256 // Catch inadvertent conversions to the above ctor (e.g., from sal_[u]Int8, aka [un]signed
257 // char):
258 OString(int) = delete;
259#endif
260
269 template< typename T >
271 {
272 pData = NULL;
273 rtl_string_newFromStr( &pData, value );
274 }
275
276 template< typename T >
278 {
279 pData = NULL;
280 rtl_string_newFromStr( &pData, value );
281 }
282
293 template< typename T >
295 {
296 assert(
298 pData = NULL;
300 rtl_string_new(&pData);
301 } else {
303 &pData,
305 literal),
307 }
308#ifdef RTL_STRING_UNITTEST
309 rtl_string_unittest_const_literal = true;
310#endif
311 }
312
321 OString( const char * value, sal_Int32 length )
322 {
323 pData = NULL;
324 rtl_string_newFromStr_WithLength( &pData, value, length );
325 }
326
327#ifdef LIBO_INTERNAL_ONLY // "RTL_FAST_STRING"
329
334 template<std::size_t N> constexpr OString(OStringLiteral<N> const & literal):
335 pData(const_cast<rtl_String *>(&literal.str)) {}
336 template<std::size_t N> OString(OStringLiteral<N> &&) = delete;
338#endif
339
340#if defined LIBO_INTERNAL_ONLY
341 explicit OString(std::string_view sv) {
342 if (sv.size() > sal_uInt32(std::numeric_limits<sal_Int32>::max())) {
343 throw std::bad_alloc();
344 }
345 pData = nullptr;
346 rtl_string_newFromStr_WithLength(&pData, sv.data(), sv.size());
347 }
348#endif
349
364 OString( const sal_Unicode * value, sal_Int32 length,
365 rtl_TextEncoding encoding,
366 sal_uInt32 convertFlags = OUSTRING_TO_OSTRING_CVTFLAGS )
367 {
368 pData = NULL;
369 rtl_uString2String( &pData, value, length, encoding, convertFlags );
370 if (pData == NULL) {
371 throw std::bad_alloc();
372 }
373 }
374
375#ifdef LIBO_INTERNAL_ONLY // "RTL_FAST_STRING"
380 template< typename T1, typename T2 >
381 OString( OStringConcat< T1, T2 >&& c )
382 {
383 const sal_Int32 l = c.length();
384 pData = rtl_string_alloc( l );
385 if (l != 0)
386 {
387 char* end = c.addData( pData->buffer );
388 pData->length = l;
389 *end = '\0';
390 }
391 }
392
397 template< typename T >
398 OString( OStringNumber< T >&& n )
399 : OString( n.buf, n.length )
400 {}
401#endif
402
403#ifdef LIBO_INTERNAL_ONLY
404 OString(std::nullptr_t) = delete;
405#endif
406
411 {
412 rtl_string_release( pData );
413 }
414
420 OString & operator=( const OString & str )
421 {
422 rtl_string_assign( &pData, str.pData );
423 return *this;
424 }
425
426#if defined LIBO_INTERNAL_ONLY
433 OString & operator=( OString && str ) noexcept
434 {
435 rtl_string_release( pData );
436 pData = str.pData;
437 str.pData = nullptr;
438 rtl_string_new( &str.pData );
439 return *this;
440 }
441#endif
442
448 template< typename T >
450 {
451 RTL_STRING_CONST_FUNCTION
452 assert(
455 rtl_string_new(&pData);
456 } else {
458 &pData,
460 literal),
462 }
463 return *this;
464 }
465
471 OString & operator+=( const OString & str )
472#if defined LIBO_INTERNAL_ONLY
473 &
474#endif
475 {
476 rtl_string_newConcat( &pData, pData, str.pData );
477 return *this;
478 }
479#if defined LIBO_INTERNAL_ONLY
480 void operator+=(OString const &) && = delete;
481#endif
482
483#if defined LIBO_INTERNAL_ONLY
485 operator +=(T const & value) & { return operator +=(std::string_view(value)); }
486 template<typename T> typename libreoffice_internal::CharPtrDetector<T, OString &>::Type
487 operator +=(T const &) && = delete;
488
489 template<typename T>
490 typename libreoffice_internal::NonConstCharArrayDetector<T, OString &>::Type
491 operator +=(T & value) & { return operator +=(std::string_view(value)); }
492 template<typename T>
493 typename libreoffice_internal::NonConstCharArrayDetector<T, OString &>::Type operator +=(T &) &&
494 = delete;
495
496 template<typename T> typename libreoffice_internal::ConstCharArrayDetector<T, OString &>::Type
497 operator +=(T & literal) & {
498 assert(libreoffice_internal::ConstCharArrayDetector<T>::isValid(literal));
499 return operator +=(
500 std::string_view(
501 libreoffice_internal::ConstCharArrayDetector<T>::toPointer(literal),
502 libreoffice_internal::ConstCharArrayDetector<T>::length));
503 }
504 template<typename T> typename libreoffice_internal::ConstCharArrayDetector<T, OString &>::Type
505 operator +=(T &) && = delete;
506
507 template<std::size_t N> OString & operator +=(OStringLiteral<N> const & literal) &
508 { return operator +=(std::string_view(literal.getStr(), literal.getLength())); }
509 template<std::size_t N> void operator +=(OStringLiteral<N> const &) && = delete;
510
511 OString & operator +=(std::string_view sv) & {
512 if (sv.empty()) {
513 return *this;
514 }
515 if (sv.size() > sal_uInt32(std::numeric_limits<sal_Int32>::max() - pData->length)) {
516 throw std::bad_alloc();
517 }
518 auto const l = pData->length + sv.size();
519 rtl_string_ensureCapacity(&pData, l);
520 *addDataHelper(pData->buffer + pData->length, sv.data(), sv.size()) = '\0';
521 pData->length = l;
522 return *this;
523 }
524 void operator +=(std::string_view) && = delete;
525#endif
526
527#ifdef LIBO_INTERNAL_ONLY // "RTL_FAST_STRING"
532 template< typename T1, typename T2 >
533 OString& operator+=( OStringConcat< T1, T2 >&& c ) & {
534 sal_Int32 l = c.length();
535 if( l == 0 )
536 return *this;
537 l += pData->length;
538 rtl_string_ensureCapacity( &pData, l );
539 char* end = c.addData( pData->buffer + pData->length );
540 *end = '\0';
541 pData->length = l;
542 return *this;
543 }
544 template<typename T1, typename T2> void operator +=(
545 OStringConcat<T1, T2> &&) && = delete;
546
551 template< typename T >
552 OString& operator+=( OStringNumber< T >&& n ) & {
553 return operator +=(std::string_view(n.buf, n.length));
554 }
555 template<typename T> void operator +=(
556 OStringNumber<T> &&) && = delete;
557#endif
558
563 void clear()
564 {
565 rtl_string_new( &pData );
566 }
567
576 sal_Int32 getLength() const { return pData->length; }
577
586 bool isEmpty() const
587 {
588 return pData->length == 0;
589 }
590
602 const char * getStr() const SAL_RETURNS_NONNULL { return pData->buffer; }
603
613 char operator [](sal_Int32 index) const {
614 // silence spurious -Werror=strict-overflow warnings from GCC 4.8.2
615 assert(index >= 0 && static_cast<sal_uInt32>(index) < static_cast<sal_uInt32>(getLength()));
616 return getStr()[index];
617 }
618
631 sal_Int32 compareTo( const OString & str ) const
632 {
633 return rtl_str_compare_WithLength( pData->buffer, pData->length,
634 str.pData->buffer, str.pData->length );
635 }
636
650 sal_Int32 compareTo( const OString & rObj, sal_Int32 maxLength ) const
651 {
652 return rtl_str_shortenedCompare_WithLength( pData->buffer, pData->length,
653 rObj.pData->buffer, rObj.pData->length, maxLength );
654 }
655
668 sal_Int32 reverseCompareTo( const OString & str ) const
669 {
670 return rtl_str_reverseCompare_WithLength( pData->buffer, pData->length,
671 str.pData->buffer, str.pData->length );
672 }
673
685 bool equals( const OString & str ) const
686 {
687 if ( pData->length != str.pData->length )
688 return false;
689 if ( pData == str.pData )
690 return true;
691 return rtl_str_reverseCompare_WithLength( pData->buffer, pData->length,
692 str.pData->buffer, str.pData->length ) == 0;
693 }
694
710 bool equalsL( const char* value, sal_Int32 length ) const
711 {
712 if ( pData->length != length )
713 return false;
714
715 return rtl_str_reverseCompare_WithLength( pData->buffer, pData->length,
716 value, length ) == 0;
717 }
718
733#if defined LIBO_INTERNAL_ONLY
734 bool equalsIgnoreAsciiCase( std::string_view str ) const
735 {
736 if ( sal_uInt32(pData->length) != str.size() )
737 return false;
738 if ( pData->buffer == str.data() )
739 return true;
740 return rtl_str_compareIgnoreAsciiCase_WithLength( pData->buffer, pData->length,
741 str.data(), str.size() ) == 0;
742 }
743#else
744 bool equalsIgnoreAsciiCase( const OString & str ) const
745 {
746 if ( pData->length != str.pData->length )
747 return false;
748 if ( pData == str.pData )
749 return true;
750 return rtl_str_compareIgnoreAsciiCase_WithLength( pData->buffer, pData->length,
751 str.pData->buffer, str.pData->length ) == 0;
752 }
753#endif
754
776 template< typename T >
778 {
779 return rtl_str_compareIgnoreAsciiCase( pData->buffer, asciiStr ) == 0;
780 }
781
782 template< typename T >
784 {
785 return rtl_str_compareIgnoreAsciiCase( pData->buffer, asciiStr ) == 0;
786 }
787
793 template< typename T >
795 {
796 RTL_STRING_CONST_FUNCTION
797 assert(
799 return
800 (pData->length
803 pData->buffer, pData->length,
805 literal),
807 == 0);
808 }
809
829 bool equalsIgnoreAsciiCaseL( const char * asciiStr, sal_Int32 asciiStrLength ) const
830 {
831 if ( pData->length != asciiStrLength )
832 return false;
833
834 return rtl_str_compareIgnoreAsciiCase_WithLength( pData->buffer, pData->length,
835 asciiStr, asciiStrLength ) == 0;
836 }
837
853#if defined LIBO_INTERNAL_ONLY
854 bool match( std::string_view str, sal_Int32 fromIndex = 0 ) const
855 {
856 return rtl_str_shortenedCompare_WithLength( pData->buffer+fromIndex, pData->length-fromIndex,
857 str.data(), str.size(), str.size() ) == 0;
858 }
859#else
860 bool match( const OString & str, sal_Int32 fromIndex = 0 ) const
861 {
862 return rtl_str_shortenedCompare_WithLength( pData->buffer+fromIndex, pData->length-fromIndex,
863 str.pData->buffer, str.pData->length, str.pData->length ) == 0;
864 }
865#endif
866
872 template< typename T >
873 typename libreoffice_internal::ConstCharArrayDetector< T, bool >::Type match( T& literal, sal_Int32 fromIndex = 0 ) const
874 {
875 RTL_STRING_CONST_FUNCTION
876 assert(
878 return
880 pData->buffer + fromIndex, pData->length - fromIndex,
882 literal),
885 == 0;
886 }
887
904 bool matchL(
905 char const * str, sal_Int32 strLength, sal_Int32 fromIndex = 0)
906 const
907 {
909 pData->buffer + fromIndex, pData->length - fromIndex,
910 str, strLength, strLength) == 0;
911 }
912
913 // This overload is left undefined, to detect calls of matchL that
914 // erroneously use RTL_CONSTASCII_USTRINGPARAM instead of
915 // RTL_CONSTASCII_STRINGPARAM (but would lead to ambiguities on 32 bit
916 // platforms):
917#if SAL_TYPES_SIZEOFLONG == 8
918 void matchL(char const *, sal_Int32, rtl_TextEncoding) const;
919#endif
920
939#if defined LIBO_INTERNAL_ONLY
940 bool matchIgnoreAsciiCase( std::string_view str, sal_Int32 fromIndex = 0 ) const
941 {
942 return rtl_str_shortenedCompareIgnoreAsciiCase_WithLength( pData->buffer+fromIndex, pData->length-fromIndex,
943 str.data(), str.size(),
944 str.size() ) == 0;
945 }
946#else
947 bool matchIgnoreAsciiCase( const OString & str, sal_Int32 fromIndex = 0 ) const
948 {
949 return rtl_str_shortenedCompareIgnoreAsciiCase_WithLength( pData->buffer+fromIndex, pData->length-fromIndex,
950 str.pData->buffer, str.pData->length,
951 str.pData->length ) == 0;
952 }
953#endif
959 template< typename T >
961 {
962 RTL_STRING_CONST_FUNCTION
963 assert(
965 return
967 pData->buffer+fromIndex, pData->length-fromIndex,
969 literal),
972 == 0;
973 }
974
989#if defined LIBO_INTERNAL_ONLY
990 bool startsWith(std::string_view str, OString * rest = NULL) const {
991 bool b = match(str);
992 if (b && rest != NULL) {
993 *rest = copy(str.size());
994 }
995 return b;
996 }
997#else
998 bool startsWith(OString const & str, OString * rest = NULL) const {
999 bool b = match(str);
1000 if (b && rest != NULL) {
1001 *rest = copy(str.getLength());
1002 }
1003 return b;
1004 }
1005#endif
1006
1012 template< typename T >
1014 T & literal, OString * rest = NULL) const
1015 {
1016 RTL_STRING_CONST_FUNCTION
1017 bool b = match(literal, 0);
1018 if (b && rest != NULL) {
1019 *rest = copy(
1021 }
1022 return b;
1023 }
1024
1044#if defined LIBO_INTERNAL_ONLY
1045 bool startsWithIgnoreAsciiCase(std::string_view str, OString * rest = NULL)
1046 const
1047 {
1048 bool b = matchIgnoreAsciiCase(str);
1049 if (b && rest != NULL) {
1050 *rest = copy(str.size());
1051 }
1052 return b;
1053 }
1054#else
1055 bool startsWithIgnoreAsciiCase(OString const & str, OString * rest = NULL)
1056 const
1057 {
1058 bool b = matchIgnoreAsciiCase(str);
1059 if (b && rest != NULL) {
1060 *rest = copy(str.getLength());
1061 }
1062 return b;
1063 }
1064#endif
1065
1071 template< typename T >
1073 startsWithIgnoreAsciiCase(T & literal, OString * rest = NULL) const
1074 {
1075 RTL_STRING_CONST_FUNCTION
1076 assert(
1078 bool b = matchIgnoreAsciiCase(literal);
1079 if (b && rest != NULL) {
1080 *rest = copy(
1082 }
1083 return b;
1084 }
1085
1100#if defined LIBO_INTERNAL_ONLY
1101 bool endsWith(std::string_view str, OString * rest = NULL) const {
1102 bool b = str.size() <= sal_uInt32(getLength())
1103 && match(str, getLength() - str.size());
1104 if (b && rest != NULL) {
1105 *rest = copy(0, getLength() - str.size());
1106 }
1107 return b;
1108 }
1109#else
1110 bool endsWith(OString const & str, OString * rest = NULL) const {
1111 bool b = str.getLength() <= getLength()
1112 && match(str, getLength() - str.getLength());
1113 if (b && rest != NULL) {
1114 *rest = copy(0, getLength() - str.getLength());
1115 }
1116 return b;
1117 }
1118#endif
1119
1125 template< typename T >
1127 T & literal, OString * rest = NULL) const
1128 {
1129 RTL_STRING_CONST_FUNCTION
1130 assert(
1132 bool b
1134 <= sal_uInt32(getLength()))
1135 && match(
1137 literal),
1138 (getLength()
1140 if (b && rest != NULL) {
1141 *rest = copy(
1142 0,
1143 (getLength()
1145 }
1146 return b;
1147 }
1148
1162 bool endsWithL(char const * str, sal_Int32 strLength) const {
1163 return strLength <= getLength()
1164 && matchL(str, strLength, getLength() - strLength);
1165 }
1166
1167 friend bool operator == ( const OString& rStr1, const OString& rStr2 )
1168 { return rStr1.equals(rStr2); }
1169 friend bool operator != ( const OString& rStr1, const OString& rStr2 )
1170 { return !(operator == ( rStr1, rStr2 )); }
1171 friend bool operator < ( const OString& rStr1, const OString& rStr2 )
1172 { return rStr1.compareTo( rStr2 ) < 0; }
1173 friend bool operator > ( const OString& rStr1, const OString& rStr2 )
1174 { return rStr1.compareTo( rStr2 ) > 0; }
1175 friend bool operator <= ( const OString& rStr1, const OString& rStr2 )
1176 { return rStr1.compareTo( rStr2 ) <= 0; }
1177 friend bool operator >= ( const OString& rStr1, const OString& rStr2 )
1178 { return rStr1.compareTo( rStr2 ) >= 0; }
1179
1180 template< typename T >
1181 friend typename libreoffice_internal::CharPtrDetector< T, bool >::Type operator==( const OString& rStr1, const T& value )
1182 {
1183 return rStr1.compareTo( value ) == 0;
1184 }
1185
1186 template< typename T >
1188 {
1189 return rStr1.compareTo( value ) == 0;
1190 }
1191
1192 template< typename T >
1193 friend typename libreoffice_internal::CharPtrDetector< T, bool >::Type operator==( const T& value, const OString& rStr2 )
1194 {
1195 return rStr2.compareTo( value ) == 0;
1196 }
1197
1198 template< typename T >
1200 {
1201 return rStr2.compareTo( value ) == 0;
1202 }
1203
1209 template< typename T >
1211 {
1212 RTL_STRING_CONST_FUNCTION
1213 assert(
1215 return
1216 (rStr.getLength()
1219 rStr.pData->buffer, rStr.pData->length,
1221 literal),
1223 == 0);
1224 }
1225
1231 template< typename T >
1233 {
1234 RTL_STRING_CONST_FUNCTION
1235 assert(
1237 return
1238 (rStr.getLength()
1241 rStr.pData->buffer, rStr.pData->length,
1243 literal),
1245 == 0);
1246 }
1247
1248 template< typename T >
1249 friend typename libreoffice_internal::CharPtrDetector< T, bool >::Type operator!=( const OString& rStr1, const T& value )
1250 {
1251 return !(operator == ( rStr1, value ));
1252 }
1253
1254 template< typename T >
1256 {
1257 return !(operator == ( rStr1, value ));
1258 }
1259
1260 template< typename T >
1261 friend typename libreoffice_internal::CharPtrDetector< T, bool >::Type operator!=( const T& value, const OString& rStr2 )
1262 {
1263 return !(operator == ( value, rStr2 ));
1264 }
1265
1266 template< typename T >
1268 {
1269 return !(operator == ( value, rStr2 ));
1270 }
1271
1277 template< typename T >
1279 {
1280 return !( rStr == literal );
1281 }
1282
1288 template< typename T >
1290 {
1291 return !( literal == rStr );
1292 }
1293
1301 sal_Int32 hashCode() const
1302 {
1303 return rtl_str_hashCode_WithLength( pData->buffer, pData->length );
1304 }
1305
1319 sal_Int32 indexOf( char ch, sal_Int32 fromIndex = 0 ) const
1320 {
1321 sal_Int32 ret = rtl_str_indexOfChar_WithLength( pData->buffer+fromIndex, pData->length-fromIndex, ch );
1322 return (ret < 0 ? ret : ret+fromIndex);
1323 }
1324
1334 sal_Int32 lastIndexOf( char ch ) const
1335 {
1336 return rtl_str_lastIndexOfChar_WithLength( pData->buffer, pData->length, ch );
1337 }
1338
1351 sal_Int32 lastIndexOf( char ch, sal_Int32 fromIndex ) const
1352 {
1353 return rtl_str_lastIndexOfChar_WithLength( pData->buffer, fromIndex, ch );
1354 }
1355
1371#if defined LIBO_INTERNAL_ONLY
1372 sal_Int32 indexOf( std::string_view str, sal_Int32 fromIndex = 0 ) const
1373 {
1374 sal_Int32 ret = rtl_str_indexOfStr_WithLength( pData->buffer+fromIndex, pData->length-fromIndex,
1375 str.data(), str.size() );
1376 return (ret < 0 ? ret : ret+fromIndex);
1377 }
1378#else
1379 sal_Int32 indexOf( const OString & str, sal_Int32 fromIndex = 0 ) const
1380 {
1381 sal_Int32 ret = rtl_str_indexOfStr_WithLength( pData->buffer+fromIndex, pData->length-fromIndex,
1382 str.pData->buffer, str.pData->length );
1383 return (ret < 0 ? ret : ret+fromIndex);
1384 }
1385#endif
1391 template< typename T >
1392 typename libreoffice_internal::ConstCharArrayDetector< T, sal_Int32 >::Type indexOf( T& literal, sal_Int32 fromIndex = 0 ) const
1393 {
1394 RTL_STRING_CONST_FUNCTION
1395 assert(
1397 sal_Int32 n = rtl_str_indexOfStr_WithLength(
1398 pData->buffer + fromIndex, pData->length - fromIndex,
1401 return n < 0 ? n : n + fromIndex;
1402 }
1403
1422 sal_Int32 indexOfL(char const * str, sal_Int32 len, sal_Int32 fromIndex = 0)
1423 const
1424 {
1425 sal_Int32 n = rtl_str_indexOfStr_WithLength(
1426 pData->buffer + fromIndex, pData->length - fromIndex, str, len);
1427 return n < 0 ? n : n + fromIndex;
1428 }
1429
1430 // This overload is left undefined, to detect calls of indexOfL that
1431 // erroneously use RTL_CONSTASCII_USTRINGPARAM instead of
1432 // RTL_CONSTASCII_STRINGPARAM (but would lead to ambiguities on 32 bit
1433 // platforms):
1434#if SAL_TYPES_SIZEOFLONG == 8
1435 void indexOfL(char const *, sal_Int32, rtl_TextEncoding) const;
1436#endif
1437
1453#if defined LIBO_INTERNAL_ONLY
1454 sal_Int32 lastIndexOf( std::string_view str ) const
1455 {
1456 return rtl_str_lastIndexOfStr_WithLength( pData->buffer, pData->length,
1457 str.data(), str.size() );
1458 }
1459#else
1460 sal_Int32 lastIndexOf( const OString & str ) const
1461 {
1462 return rtl_str_lastIndexOfStr_WithLength( pData->buffer, pData->length,
1463 str.pData->buffer, str.pData->length );
1464 }
1465#endif
1466
1484#if defined LIBO_INTERNAL_ONLY
1485 sal_Int32 lastIndexOf( std::string_view str, sal_Int32 fromIndex ) const
1486 {
1487 return rtl_str_lastIndexOfStr_WithLength( pData->buffer, fromIndex,
1488 str.data(), str.size() );
1489 }
1490#else
1491 sal_Int32 lastIndexOf( const OString & str, sal_Int32 fromIndex ) const
1492 {
1493 return rtl_str_lastIndexOfStr_WithLength( pData->buffer, fromIndex,
1494 str.pData->buffer, str.pData->length );
1495 }
1496#endif
1497
1508 SAL_WARN_UNUSED_RESULT OString copy( sal_Int32 beginIndex ) const
1509 {
1510 return copy(beginIndex, getLength() - beginIndex);
1511 }
1512
1525 SAL_WARN_UNUSED_RESULT OString copy( sal_Int32 beginIndex, sal_Int32 count ) const
1526 {
1527 rtl_String *pNew = NULL;
1528 rtl_string_newFromSubString( &pNew, pData, beginIndex, count );
1529 return OString( pNew, SAL_NO_ACQUIRE );
1530 }
1531
1532#if defined LIBO_INTERNAL_ONLY
1543 SAL_WARN_UNUSED_RESULT std::string_view subView( sal_Int32 beginIndex ) const
1544 {
1545 assert(beginIndex >= 0);
1546 assert(beginIndex <= getLength());
1547 return subView(beginIndex, getLength() - beginIndex);
1548 }
1549
1562 SAL_WARN_UNUSED_RESULT std::string_view subView( sal_Int32 beginIndex, sal_Int32 count ) const
1563 {
1564 assert(beginIndex >= 0);
1565 assert(count >= 0);
1566 assert(beginIndex <= getLength());
1567 assert(count <= getLength() - beginIndex);
1568 return std::string_view(*this).substr(beginIndex, count);
1569 }
1570#endif
1571
1572#ifndef LIBO_INTERNAL_ONLY // "RTL_FAST_STRING"
1581 SAL_WARN_UNUSED_RESULT OString concat( const OString & str ) const
1582 {
1583 rtl_String* pNew = NULL;
1584 rtl_string_newConcat( &pNew, pData, str.pData );
1585 return OString( pNew, SAL_NO_ACQUIRE );
1586 }
1587#endif
1588
1589#ifndef LIBO_INTERNAL_ONLY // "RTL_FAST_STRING"
1590 friend OString operator+( const OString & str1, const OString & str2 )
1591 {
1592 return str1.concat( str2 );
1593 }
1594#endif
1595
1609 SAL_WARN_UNUSED_RESULT OString replaceAt( sal_Int32 index, sal_Int32 count, const OString& newStr ) const
1610 {
1611 rtl_String* pNew = NULL;
1612 rtl_string_newReplaceStrAt( &pNew, pData, index, count, newStr.pData );
1613 return OString( pNew, SAL_NO_ACQUIRE );
1614 }
1615
1629 SAL_WARN_UNUSED_RESULT OString replace( char oldChar, char newChar ) const
1630 {
1631 rtl_String* pNew = NULL;
1632 rtl_string_newReplace( &pNew, pData, oldChar, newChar );
1633 return OString( pNew, SAL_NO_ACQUIRE );
1634 }
1635
1655 OString const & from, OString const & to, sal_Int32 * index = NULL) const
1656 {
1657 rtl_String * s = NULL;
1658 sal_Int32 i = 0;
1660 &s, pData, from.pData->buffer, from.pData->length,
1661 to.pData->buffer, to.pData->length, index == NULL ? &i : index);
1662 return OString(s, SAL_NO_ACQUIRE);
1663 }
1664
1678 SAL_WARN_UNUSED_RESULT OString replaceAll(OString const & from, OString const & to) const {
1679 rtl_String * s = NULL;
1681 &s, pData, from.pData->buffer, from.pData->length,
1682 to.pData->buffer, to.pData->length);
1683 return OString(s, SAL_NO_ACQUIRE);
1684 }
1685
1697 {
1698 rtl_String* pNew = NULL;
1699 rtl_string_newToAsciiLowerCase( &pNew, pData );
1700 return OString( pNew, SAL_NO_ACQUIRE );
1701 }
1702
1714 {
1715 rtl_String* pNew = NULL;
1716 rtl_string_newToAsciiUpperCase( &pNew, pData );
1717 return OString( pNew, SAL_NO_ACQUIRE );
1718 }
1719
1732 {
1733 rtl_String* pNew = NULL;
1734 rtl_string_newTrim( &pNew, pData );
1735 return OString( pNew, SAL_NO_ACQUIRE );
1736 }
1737
1762 OString getToken( sal_Int32 token, char cTok, sal_Int32& index ) const
1763 {
1764 rtl_String * pNew = NULL;
1765 index = rtl_string_getToken( &pNew, pData, token, cTok, index );
1766 return OString( pNew, SAL_NO_ACQUIRE );
1767 }
1768
1782 OString getToken(sal_Int32 count, char separator) const {
1783 sal_Int32 n = 0;
1784 return getToken(count, separator, n);
1785 }
1786
1795 bool toBoolean() const
1796 {
1797 return rtl_str_toBoolean( pData->buffer );
1798 }
1799
1806 char toChar() const
1807 {
1808 return pData->buffer[0];
1809 }
1810
1821 sal_Int32 toInt32( sal_Int16 radix = 10 ) const
1822 {
1823 return rtl_str_toInt32( pData->buffer, radix );
1824 }
1825
1838 sal_uInt32 toUInt32( sal_Int16 radix = 10 ) const
1839 {
1840 return rtl_str_toUInt32( pData->buffer, radix );
1841 }
1842
1853 sal_Int64 toInt64( sal_Int16 radix = 10 ) const
1854 {
1855 return rtl_str_toInt64( pData->buffer, radix );
1856 }
1857
1870 sal_uInt64 toUInt64( sal_Int16 radix = 10 ) const
1871 {
1872 return rtl_str_toUInt64( pData->buffer, radix );
1873 }
1874
1883 float toFloat() const
1884 {
1885 return rtl_str_toFloat( pData->buffer );
1886 }
1887
1896 double toDouble() const
1897 {
1898 return rtl_str_toDouble( pData->buffer );
1899 }
1900
1901#ifdef LIBO_INTERNAL_ONLY // "RTL_FAST_STRING"
1902
1903 static OStringNumber< int > number( int i, sal_Int16 radix = 10 )
1904 {
1905 return OStringNumber< int >( i, radix );
1906 }
1907 static OStringNumber< long long > number( long long ll, sal_Int16 radix = 10 )
1908 {
1909 return OStringNumber< long long >( ll, radix );
1910 }
1911 static OStringNumber< unsigned long long > number( unsigned long long ll, sal_Int16 radix = 10 )
1912 {
1913 return OStringNumber< unsigned long long >( ll, radix );
1914 }
1915 static OStringNumber< unsigned long long > number( unsigned int i, sal_Int16 radix = 10 )
1916 {
1917 return number( static_cast< unsigned long long >( i ), radix );
1918 }
1919 static OStringNumber< long long > number( long i, sal_Int16 radix = 10)
1920 {
1921 return number( static_cast< long long >( i ), radix );
1922 }
1923 static OStringNumber< unsigned long long > number( unsigned long i, sal_Int16 radix = 10 )
1924 {
1925 return number( static_cast< unsigned long long >( i ), radix );
1926 }
1927 static OStringNumber< float > number( float f )
1928 {
1929 return OStringNumber< float >( f );
1930 }
1931 static OStringNumber< double > number( double d )
1932 {
1933 return OStringNumber< double >( d );
1934 }
1935#else
1946 static OString number( int i, sal_Int16 radix = 10 )
1947 {
1948 char aBuf[RTL_STR_MAX_VALUEOFINT32];
1949 return OString(aBuf, rtl_str_valueOfInt32(aBuf, i, radix));
1950 }
1953 static OString number( unsigned int i, sal_Int16 radix = 10 )
1954 {
1955 return number( static_cast< unsigned long long >( i ), radix );
1956 }
1959 static OString number( long i, sal_Int16 radix = 10 )
1960 {
1961 return number( static_cast< long long >( i ), radix );
1962 }
1965 static OString number( unsigned long i, sal_Int16 radix = 10 )
1966 {
1967 return number( static_cast< unsigned long long >( i ), radix );
1968 }
1971 static OString number( long long ll, sal_Int16 radix = 10 )
1972 {
1973 char aBuf[RTL_STR_MAX_VALUEOFINT64];
1974 return OString(aBuf, rtl_str_valueOfInt64(aBuf, ll, radix));
1975 }
1978 static OString number( unsigned long long ll, sal_Int16 radix = 10 )
1979 {
1980 char aBuf[RTL_STR_MAX_VALUEOFUINT64];
1981 return OString(aBuf, rtl_str_valueOfUInt64(aBuf, ll, radix));
1982 }
1983
1993 static OString number( float f )
1994 {
1995 char aBuf[RTL_STR_MAX_VALUEOFFLOAT];
1996 return OString(aBuf, rtl_str_valueOfFloat(aBuf, f));
1997 }
1998
2008 static OString number( double d )
2009 {
2010 char aBuf[RTL_STR_MAX_VALUEOFDOUBLE];
2011 return OString(aBuf, rtl_str_valueOfDouble(aBuf, d));
2012 }
2013#endif
2014
2026 SAL_DEPRECATED("use boolean()") static OString valueOf( sal_Bool b )
2027 {
2028 return boolean(b);
2029 }
2030
2042 static OString boolean( bool b )
2043 {
2044 char aBuf[RTL_STR_MAX_VALUEOFBOOLEAN];
2045 return OString(aBuf, rtl_str_valueOfBoolean(aBuf, b));
2046 }
2047
2055 SAL_DEPRECATED("convert to OString or use directly") static OString valueOf( char c )
2056 {
2057 return OString( &c, 1 );
2058 }
2059
2070 SAL_DEPRECATED("use number()") static OString valueOf( sal_Int32 i, sal_Int16 radix = 10 )
2071 {
2072 return number( i, radix );
2073 }
2074
2085 SAL_DEPRECATED("use number()") static OString valueOf( sal_Int64 ll, sal_Int16 radix = 10 )
2086 {
2087 return number( ll, radix );
2088 }
2089
2099 SAL_DEPRECATED("use number()") static OString valueOf( float f )
2100 {
2101 return number(f);
2102 }
2103
2113 SAL_DEPRECATED("use number()") static OString valueOf( double d )
2114 {
2115 return number(d);
2116 }
2117
2118#if defined LIBO_INTERNAL_ONLY
2119 operator std::string_view() const { return {getStr(), sal_uInt32(getLength())}; }
2120#endif
2121
2122#if defined LIBO_INTERNAL_ONLY
2123 // A wrapper for the first expression in an
2124 //
2125 // OString::Concat(e1) + e2 + ...
2126 //
2127 // concatenation chain, when neither of the first two e1, e2 is one of our rtl string-related
2128 // classes (so something like
2129 //
2130 // OString s = "a" + (b ? std::string_view("c") : std::string_view("dd"));
2131 //
2132 // would not compile):
2133 template<typename T> [[nodiscard]] static
2134 typename std::enable_if_t<
2135 ToStringHelper<T>::allowOStringConcat, OStringConcat<OStringConcatMarker, T>>
2136 Concat(T const & value) { return OStringConcat<OStringConcatMarker, T>({}, value); }
2137
2138 // This overload is needed so that an argument of type 'char const[N]' ends up as
2139 // 'OStringConcat<rtl::OStringConcatMarker, char const[N]>' rather than as
2140 // 'OStringConcat<rtl::OStringConcatMarker, char[N]>':
2141 template<typename T, std::size_t N> [[nodiscard]] static
2142 typename std::enable_if_t<
2143 ToStringHelper<T[N]>::allowOStringConcat, OStringConcat<OStringConcatMarker, T[N]>>
2144 Concat(T (& value)[N]) { return OStringConcat<OStringConcatMarker, T[N]>({}, value); }
2145#endif
2146};
2147
2148/* ======================================================================= */
2149
2150#ifdef LIBO_INTERNAL_ONLY // "RTL_FAST_STRING"
2151
2155template<>
2156struct ToStringHelper< OString >
2157 {
2158 static std::size_t length( const OString& s ) { return s.getLength(); }
2159 static char* addData( char* buffer, const OString& s ) { return addDataHelper( buffer, s.getStr(), s.getLength()); }
2160 static const bool allowOStringConcat = true;
2161 static const bool allowOUStringConcat = false;
2162 };
2163
2167template<std::size_t N>
2168struct ToStringHelper< OStringLiteral<N> >
2169 {
2170 static constexpr std::size_t length( const OStringLiteral<N>& str ) { return str.getLength(); }
2171 static char* addData( char* buffer, const OStringLiteral<N>& str ) { return addDataHelper( buffer, str.getStr(), str.getLength() ); }
2172 static const bool allowOStringConcat = true;
2173 static const bool allowOUStringConcat = false;
2174 };
2175
2179template< typename charT, typename traits, typename T1, typename T2 >
2180inline std::basic_ostream<charT, traits> & operator <<(
2181 std::basic_ostream<charT, traits> & stream, OStringConcat< T1, T2 >&& concat)
2182{
2183 return stream << OString( std::move(concat) );
2184}
2185#endif
2186
2187
2194{
2204 size_t operator()( const OString& rString ) const
2205 { return static_cast<size_t>(rString.hashCode()); }
2206};
2207
2210{
2211 bool operator()( const char* p1, const char* p2) const
2212 { return rtl_str_compare(p1, p2) == 0; }
2213};
2214
2217{
2218 size_t operator()(const char* p) const
2219 { return rtl_str_hashCode(p); }
2220};
2221
2222/* ======================================================================= */
2223
2230template< typename charT, typename traits > std::basic_ostream<charT, traits> &
2232 std::basic_ostream<charT, traits> & stream, OString const & rString)
2233{
2234 return stream << rString.getStr();
2235 // best effort; potentially loses data due to embedded null characters
2236}
2237
2238} /* Namespace */
2239
2240#ifdef RTL_STRING_UNITTEST
2241namespace rtl
2242{
2243typedef rtlunittest::OString OString;
2244}
2245#undef RTL_STRING_CONST_FUNCTION
2246#endif
2247
2248#if defined LIBO_INTERNAL_ONLY && !defined RTL_STRING_UNITTEST
2249using ::rtl::OString;
2250using ::rtl::OStringChar;
2251using ::rtl::OStringHash;
2252using ::rtl::OStringLiteral;
2253#endif
2254
2256
2261#if defined LIBO_INTERNAL_ONLY
2262namespace std {
2263
2264template<>
2265struct hash<::rtl::OString>
2266{
2267 std::size_t operator()(::rtl::OString const & s) const
2268 { return std::size_t(s.hashCode()); }
2269};
2270
2271}
2272
2273#endif
2275
2276#endif // INCLUDED_RTL_STRING_HXX
2277
2278/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
#define SAL_DEPRECATED(message)
Use as follows: SAL_DEPRECATED("Don't use, it's evil.") void doit(int nPara);.
Definition: types.h:474
__sal_NoAcquire
Definition: types.h:353
@ SAL_NO_ACQUIRE
definition of a no acquire enum for ctors
Definition: types.h:356
unsigned char sal_Bool
Definition: types.h:38
sal_uInt16 sal_Unicode
Definition: types.h:123
#define SAL_WARN_UNUSED_RESULT
Use this as markup for functions and methods whose return value must be checked.
Definition: types.h:284
#define SAL_WARN_UNUSED
Annotate classes where a compiler should warn if an instance is unused.
Definition: types.h:587
SAL_DLLPUBLIC double rtl_str_toDouble(const char *str) SAL_THROW_EXTERN_C()
Interpret a string as a double.
SAL_DLLPUBLIC sal_Int32 rtl_str_compare(const char *first, const char *second) SAL_THROW_EXTERN_C()
Compare two strings.
SAL_DLLPUBLIC sal_Int32 rtl_str_hashCode_WithLength(const char *str, sal_Int32 len) SAL_THROW_EXTERN_C()
Return a hash code for a string.
SAL_DLLPUBLIC void rtl_string_newReplaceStrAt(rtl_String **newStr, rtl_String *str, sal_Int32 idx, sal_Int32 count, rtl_String *subStr) SAL_THROW_EXTERN_C()
Create a new string by replacing a substring of another string.
SAL_DLLPUBLIC sal_Bool rtl_str_toBoolean(const char *str) SAL_THROW_EXTERN_C()
Interpret a string as a boolean.
#define RTL_STR_MAX_VALUEOFDOUBLE
Definition: string.h:715
#define RTL_STR_MAX_VALUEOFINT32
Definition: string.h:631
SAL_DLLPUBLIC void rtl_string_acquire(rtl_String *str) SAL_THROW_EXTERN_C()
Increment the reference count of a string.
SAL_DLLPUBLIC sal_Int32 rtl_str_valueOfFloat(char *str, float f) SAL_THROW_EXTERN_C()
Create the string representation of a float.
SAL_DLLPUBLIC rtl_String * rtl_string_alloc(sal_Int32 nLen) SAL_THROW_EXTERN_C()
Allocate a new string containing space for a given number of characters.
SAL_DLLPUBLIC void rtl_string_newConcat(rtl_String **newStr, rtl_String *left, rtl_String *right) SAL_THROW_EXTERN_C()
Create a new string that is the concatenation of two other strings.
SAL_DLLPUBLIC sal_uInt32 rtl_str_toUInt32(const char *str, sal_Int16 radix) SAL_THROW_EXTERN_C()
Interpret a string as an unsigned integer.
SAL_DLLPUBLIC sal_Int32 rtl_str_compareIgnoreAsciiCase(const char *first, const char *second) SAL_THROW_EXTERN_C()
Compare two strings, ignoring the case of ASCII characters.
SAL_DLLPUBLIC void rtl_string_assign(rtl_String **str, rtl_String *rightValue) SAL_THROW_EXTERN_C()
Assign a new value to a string.
SAL_DLLPUBLIC sal_Int32 rtl_str_lastIndexOfStr_WithLength(const char *str, sal_Int32 len, const char *subStr, sal_Int32 subLen) SAL_THROW_EXTERN_C()
Search for the last occurrence of a substring within a string.
SAL_DLLPUBLIC void rtl_string_newReplaceAll(rtl_String **newStr, rtl_String *str, char const *from, sal_Int32 fromLength, char const *to, sal_Int32 toLength) SAL_THROW_EXTERN_C()
Create a new string by replacing all occurrences of a given substring with another substring.
SAL_DLLPUBLIC sal_Int32 rtl_str_reverseCompare_WithLength(const char *first, sal_Int32 firstLen, const char *second, sal_Int32 secondLen) SAL_THROW_EXTERN_C()
Compare two strings from back to front.
SAL_DLLPUBLIC sal_uInt64 rtl_str_toUInt64(const char *str, sal_Int16 radix) SAL_THROW_EXTERN_C()
Interpret a string as an unsigned long integer.
SAL_DLLPUBLIC sal_Int32 rtl_string_getToken(rtl_String **newStr, rtl_String *str, sal_Int32 token, char cTok, sal_Int32 idx) SAL_THROW_EXTERN_C()
Create a new string by extracting a single token from another string.
SAL_DLLPUBLIC sal_Int32 rtl_str_valueOfInt64(char *str, sal_Int64 l, sal_Int16 radix) SAL_THROW_EXTERN_C()
Create the string representation of a long integer.
SAL_DLLPUBLIC void rtl_string_newReplaceFirst(rtl_String **newStr, rtl_String *str, char const *from, sal_Int32 fromLength, char const *to, sal_Int32 toLength, sal_Int32 *index) SAL_THROW_EXTERN_C()
Create a new string by replacing the first occurrence of a given substring with another substring.
SAL_DLLPUBLIC void rtl_string_newFromStr(rtl_String **newStr, const char *value) SAL_THROW_EXTERN_C()
Allocate a new string that contains a copy of a character array.
SAL_DLLPUBLIC sal_Int32 rtl_str_valueOfDouble(char *str, double d) SAL_THROW_EXTERN_C()
Create the string representation of a double.
SAL_DLLPUBLIC sal_Int32 rtl_str_shortenedCompare_WithLength(const char *first, sal_Int32 firstLen, const char *second, sal_Int32 secondLen, sal_Int32 shortenedLen) SAL_THROW_EXTERN_C()
Compare two strings with a maximum count of characters.
SAL_DLLPUBLIC void rtl_string_new(rtl_String **newStr) SAL_THROW_EXTERN_C()
Allocate a new string containing no characters.
SAL_DLLPUBLIC sal_Int32 rtl_str_shortenedCompareIgnoreAsciiCase_WithLength(const char *first, sal_Int32 firstLen, const char *second, sal_Int32 secondLen, sal_Int32 shortenedLen) SAL_THROW_EXTERN_C()
Compare two strings with a maximum count of characters, ignoring the case of ASCII characters.
SAL_DLLPUBLIC sal_Int32 rtl_str_indexOfChar_WithLength(const char *str, sal_Int32 len, char ch) SAL_THROW_EXTERN_C()
Search for the first occurrence of a character within a string.
SAL_DLLPUBLIC void rtl_uString2String(rtl_String **newStr, const sal_Unicode *str, sal_Int32 len, rtl_TextEncoding encoding, sal_uInt32 convertFlags) SAL_THROW_EXTERN_C()
Create a new byte string by converting a Unicode string, using a specific text encoding.
SAL_DLLPUBLIC sal_Int32 rtl_str_valueOfBoolean(char *str, sal_Bool b) SAL_THROW_EXTERN_C()
Create the string representation of a boolean.
#define OUSTRING_TO_OSTRING_CVTFLAGS
Definition: string.h:1354
SAL_DLLPUBLIC void rtl_string_newFromLiteral(rtl_String **newStr, const char *value, sal_Int32 len, sal_Int32 allocExtra) SAL_THROW_EXTERN_C()
#define RTL_STR_MAX_VALUEOFBOOLEAN
Definition: string.h:589
#define RTL_STR_MAX_VALUEOFFLOAT
Definition: string.h:696
SAL_DLLPUBLIC sal_Int32 rtl_str_hashCode(const char *str) SAL_THROW_EXTERN_C()
Return a hash code for a string.
SAL_DLLPUBLIC sal_Int32 rtl_str_valueOfInt32(char *str, sal_Int32 i, sal_Int16 radix) SAL_THROW_EXTERN_C()
Create the string representation of an integer.
#define RTL_STR_MAX_VALUEOFUINT64
Definition: string.h:677
SAL_DLLPUBLIC void rtl_string_newToAsciiLowerCase(rtl_String **newStr, rtl_String *str) SAL_THROW_EXTERN_C()
Create a new string by converting all ASCII uppercase letters to lowercase within another string.
SAL_DLLPUBLIC void rtl_string_newFromStr_WithLength(rtl_String **newStr, const char *value, sal_Int32 len) SAL_THROW_EXTERN_C()
Allocate a new string that contains a copy of a character array.
SAL_DLLPUBLIC void rtl_string_newTrim(rtl_String **newStr, rtl_String *str) SAL_THROW_EXTERN_C()
Create a new string by removing white space from both ends of another string.
SAL_DLLPUBLIC sal_Int32 rtl_str_toInt32(const char *str, sal_Int16 radix) SAL_THROW_EXTERN_C()
Interpret a string as an integer.
#define RTL_STR_MAX_VALUEOFINT64
Definition: string.h:654
SAL_DLLPUBLIC void rtl_string_ensureCapacity(rtl_String **str, sal_Int32 size) SAL_THROW_EXTERN_C()
Ensure a string has enough space for a given number of characters.
SAL_DLLPUBLIC void rtl_string_release(rtl_String *str) SAL_THROW_EXTERN_C()
Decrement the reference count of a string.
SAL_DLLPUBLIC void rtl_string_newFromSubString(rtl_String **newStr, const rtl_String *from, sal_Int32 beginIndex, sal_Int32 count) SAL_THROW_EXTERN_C()
Allocate a new string that is a substring of this string.
SAL_DLLPUBLIC sal_Int32 rtl_str_indexOfStr_WithLength(const char *str, sal_Int32 len, const char *subStr, sal_Int32 subLen) SAL_THROW_EXTERN_C()
Search for the first occurrence of a substring within a string.
SAL_DLLPUBLIC sal_Int32 rtl_str_valueOfUInt64(char *str, sal_uInt64 l, sal_Int16 radix) SAL_THROW_EXTERN_C()
Create the string representation of an unsigned long integer.
SAL_DLLPUBLIC void rtl_string_newToAsciiUpperCase(rtl_String **newStr, rtl_String *str) SAL_THROW_EXTERN_C()
Create a new string by converting all ASCII lowercase letters to uppercase within another string.
SAL_DLLPUBLIC float rtl_str_toFloat(const char *str) SAL_THROW_EXTERN_C()
Interpret a string as a float.
SAL_DLLPUBLIC void rtl_string_newReplace(rtl_String **newStr, rtl_String *str, char oldChar, char newChar) SAL_THROW_EXTERN_C()
Create a new string by replacing all occurrences of a single character within another string.
SAL_DLLPUBLIC sal_Int64 rtl_str_toInt64(const char *str, sal_Int16 radix) SAL_THROW_EXTERN_C()
Interpret a string as a long integer.
SAL_DLLPUBLIC sal_Int32 rtl_str_compareIgnoreAsciiCase_WithLength(const char *first, sal_Int32 firstLen, const char *second, sal_Int32 secondLen) SAL_THROW_EXTERN_C()
Compare two strings, ignoring the case of ASCII characters.
SAL_DLLPUBLIC sal_Int32 rtl_str_compare_WithLength(const char *first, sal_Int32 firstLen, const char *second, sal_Int32 secondLen) SAL_THROW_EXTERN_C()
Compare two strings.
SAL_DLLPUBLIC sal_Int32 rtl_str_lastIndexOfChar_WithLength(const char *str, sal_Int32 len, char ch) SAL_THROW_EXTERN_C()
Search for the last occurrence of a character within a string.
sal_uInt16 rtl_TextEncoding
The various supported text encodings.
Definition: textenc.h:37
sal_Int32 oslInterlockedCount
Definition: interlck.h:44
bool operator<(const TTimeValue &rTimeA, const TTimeValue &rTimeB)
Definition: timer.hxx:93
bool operator>(const TTimeValue &rTimeA, const TTimeValue &rTimeB)
Definition: timer.hxx:103
bool operator==(const TTimeValue &rTimeA, const TTimeValue &rTimeB)
Definition: timer.hxx:113
Definition: bootstrap.hxx:34
std::basic_ostream< charT, traits > & operator<<(std::basic_ostream< charT, traits > &stream, OString const &rString)
Support for rtl::OString in std::ostream (and thus in CPPUNIT_ASSERT or SAL_INFO macros,...
Definition: string.hxx:2231
bool operator!=(const Any &rAny, const C &value)
Template inequality operator: compares set value of left side any to right side value.
Definition: Any.hxx:668
This String class provide base functionality for C++ like 8-Bit character array handling.
Definition: string.hxx:180
SAL_WARN_UNUSED_RESULT OString concat(const OString &str) const
Concatenates the specified string to the end of this string.
Definition: string.hxx:1581
OString(T &literal, typename libreoffice_internal::ConstCharArrayDetector< T, libreoffice_internal::Dummy >::Type=libreoffice_internal::Dummy())
New string from a string literal.
Definition: string.hxx:294
OString(const sal_Unicode *value, sal_Int32 length, rtl_TextEncoding encoding, sal_uInt32 convertFlags=OUSTRING_TO_OSTRING_CVTFLAGS)
New string from a Unicode character buffer array.
Definition: string.hxx:364
libreoffice_internal::ConstCharArrayDetector< T, bool >::Type endsWith(T &literal, OString *rest=NULL) const
This is an overloaded member function, provided for convenience. It differs from the above function o...
Definition: string.hxx:1126
static OString number(unsigned long i, sal_Int16 radix=10)
This is an overloaded member function, provided for convenience. It differs from the above function o...
Definition: string.hxx:1965
bool startsWith(OString const &str, OString *rest=NULL) const
Check whether this string starts with a given substring.
Definition: string.hxx:998
friend libreoffice_internal::ConstCharArrayDetector< T, bool >::Type operator==(const OString &rStr, T &literal)
This is an overloaded member function, provided for convenience. It differs from the above function o...
Definition: string.hxx:1210
libreoffice_internal::ConstCharArrayDetector< T, bool >::Type startsWith(T &literal, OString *rest=NULL) const
This is an overloaded member function, provided for convenience. It differs from the above function o...
Definition: string.hxx:1013
friend libreoffice_internal::ConstCharArrayDetector< T, bool >::Type operator==(T &literal, const OString &rStr)
This is an overloaded member function, provided for convenience. It differs from the above function o...
Definition: string.hxx:1232
libreoffice_internal::ConstCharArrayDetector< T, sal_Int32 >::Type indexOf(T &literal, sal_Int32 fromIndex=0) const
This is an overloaded member function, provided for convenience. It differs from the above function o...
Definition: string.hxx:1392
OString(const char *value, sal_Int32 length)
New string from a character buffer array.
Definition: string.hxx:321
static OString number(unsigned long long ll, sal_Int16 radix=10)
This is an overloaded member function, provided for convenience. It differs from the above function o...
Definition: string.hxx:1978
static OString number(int i, sal_Int16 radix=10)
Returns the string representation of the integer argument.
Definition: string.hxx:1946
sal_uInt64 toUInt64(sal_Int16 radix=10) const
Returns the uint64 value from this string.
Definition: string.hxx:1870
sal_Int32 indexOfL(char const *str, sal_Int32 len, sal_Int32 fromIndex=0) const
Returns the index within this string of the first occurrence of the specified substring,...
Definition: string.hxx:1422
libreoffice_internal::ConstCharArrayDetector< T, OString & >::Type operator=(T &literal)
This is an overloaded member function, provided for convenience. It differs from the above function o...
Definition: string.hxx:449
sal_Int32 compareTo(const OString &str) const
Compares two strings.
Definition: string.hxx:631
OString & operator+=(const OString &str)
Append a string to this string.
Definition: string.hxx:471
libreoffice_internal::ConstCharArrayDetector< T, bool >::Type equalsIgnoreAsciiCase(T &literal) const
This is an overloaded member function, provided for convenience. It differs from the above function o...
Definition: string.hxx:794
SAL_WARN_UNUSED_RESULT OString toAsciiUpperCase() const
Converts from this string all ASCII lowercase characters (97-122) to ASCII uppercase characters (65-9...
Definition: string.hxx:1713
libreoffice_internal::ConstCharArrayDetector< T, bool >::Type startsWithIgnoreAsciiCase(T &literal, OString *rest=NULL) const
This is an overloaded member function, provided for convenience. It differs from the above function o...
Definition: string.hxx:1073
friend libreoffice_internal::ConstCharArrayDetector< T, bool >::Type operator!=(T &literal, const OString &rStr)
This is an overloaded member function, provided for convenience. It differs from the above function o...
Definition: string.hxx:1289
char toChar() const
Returns the first character from this string.
Definition: string.hxx:1806
bool toBoolean() const
Returns the Boolean value from this string.
Definition: string.hxx:1795
friend OString operator+(const OString &str1, const OString &str2)
Definition: string.hxx:1590
SAL_WARN_UNUSED_RESULT OString copy(sal_Int32 beginIndex) const
Returns a new string that is a substring of this string.
Definition: string.hxx:1508
friend libreoffice_internal::NonConstCharArrayDetector< T, bool >::Type operator!=(const OString &rStr1, T &value)
Definition: string.hxx:1255
OString(rtl_String *str)
New string from OString data.
Definition: string.hxx:226
bool startsWithIgnoreAsciiCase(OString const &str, OString *rest=NULL) const
Check whether this string starts with a given string, ignoring the case of ASCII letters.
Definition: string.hxx:1055
static OString number(long long ll, sal_Int16 radix=10)
This is an overloaded member function, provided for convenience. It differs from the above function o...
Definition: string.hxx:1971
sal_Int32 lastIndexOf(const OString &str) const
Returns the index within this string of the last occurrence of the specified substring,...
Definition: string.hxx:1460
void clear()
Clears the string, i.e, makes a zero-character string.
Definition: string.hxx:563
SAL_WARN_UNUSED_RESULT OString replaceFirst(OString const &from, OString const &to, sal_Int32 *index=NULL) const
Returns a new string resulting from replacing the first occurrence of a given substring with another ...
Definition: string.hxx:1654
OString getToken(sal_Int32 count, char separator) const
Returns a token from the string.
Definition: string.hxx:1782
static OString number(unsigned int i, sal_Int16 radix=10)
This is an overloaded member function, provided for convenience. It differs from the above function o...
Definition: string.hxx:1953
const char * getStr() const SAL_RETURNS_NONNULL
Returns a pointer to the characters of this string.
Definition: string.hxx:602
OString & operator=(const OString &str)
Assign a new string.
Definition: string.hxx:420
libreoffice_internal::ConstCharArrayDetector< T, bool >::Type matchIgnoreAsciiCase(T &literal, sal_Int32 fromIndex=0) const
This is an overloaded member function, provided for convenience. It differs from the above function o...
Definition: string.hxx:960
sal_Int32 compareTo(const OString &rObj, sal_Int32 maxLength) const
Compares two strings with an maximum count of characters.
Definition: string.hxx:650
bool isEmpty() const
Checks if a string is empty.
Definition: string.hxx:586
friend libreoffice_internal::NonConstCharArrayDetector< T, bool >::Type operator==(T &value, const OString &rStr2)
Definition: string.hxx:1199
OString(const T &value, typename libreoffice_internal::CharPtrDetector< T, libreoffice_internal::Dummy >::Type=libreoffice_internal::Dummy())
New string from a character buffer array.
Definition: string.hxx:270
OString getToken(sal_Int32 token, char cTok, sal_Int32 &index) const
Returns a token in the string.
Definition: string.hxx:1762
sal_Int32 reverseCompareTo(const OString &str) const
Compares two strings in reverse order.
Definition: string.hxx:668
sal_Int32 lastIndexOf(const OString &str, sal_Int32 fromIndex) const
Returns the index within this string of the last occurrence of the specified substring,...
Definition: string.hxx:1491
sal_Int32 lastIndexOf(char ch) const
Returns the index within this string of the last occurrence of the specified character,...
Definition: string.hxx:1334
SAL_WARN_UNUSED_RESULT OString copy(sal_Int32 beginIndex, sal_Int32 count) const
Returns a new string that is a substring of this string.
Definition: string.hxx:1525
friend libreoffice_internal::CharPtrDetector< T, bool >::Type operator!=(const OString &rStr1, const T &value)
Definition: string.hxx:1249
SAL_WARN_UNUSED_RESULT OString replace(char oldChar, char newChar) const
Returns a new string resulting from replacing all occurrences of oldChar in this string with newChar.
Definition: string.hxx:1629
sal_Int32 hashCode() const
Returns a hashcode for this string.
Definition: string.hxx:1301
static OString boolean(bool b)
Returns the string representation of the boolean argument.
Definition: string.hxx:2042
bool matchL(char const *str, sal_Int32 strLength, sal_Int32 fromIndex=0) const
Match against a substring appearing in this string.
Definition: string.hxx:904
bool equalsL(const char *value, sal_Int32 length) const
Perform a comparison of two strings.
Definition: string.hxx:710
SAL_WARN_UNUSED_RESULT OString trim() const
Returns a new string resulting from removing white space from both ends of the string.
Definition: string.hxx:1731
OString(const OString &str)
New string from OString.
Definition: string.hxx:200
SAL_WARN_UNUSED_RESULT OString replaceAll(OString const &from, OString const &to) const
Returns a new string resulting from replacing all occurrences of a given substring with another subst...
Definition: string.hxx:1678
bool endsWithL(char const *str, sal_Int32 strLength) const
Check whether this string ends with a given substring.
Definition: string.hxx:1162
SAL_WARN_UNUSED_RESULT OString toAsciiLowerCase() const
Converts from this string all ASCII uppercase characters (65-90) to ASCII lowercase characters (97-12...
Definition: string.hxx:1696
bool match(const OString &str, sal_Int32 fromIndex=0) const
Match against a substring appearing in this string.
Definition: string.hxx:860
float toFloat() const
Returns the float value from this string.
Definition: string.hxx:1883
OString()
New string containing no characters.
Definition: string.hxx:189
libreoffice_internal::ConstCharArrayDetector< T, bool >::Type match(T &literal, sal_Int32 fromIndex=0) const
This is an overloaded member function, provided for convenience. It differs from the above function o...
Definition: string.hxx:873
friend libreoffice_internal::CharPtrDetector< T, bool >::Type operator==(const T &value, const OString &rStr2)
Definition: string.hxx:1193
OString(char value)
New string from a single character.
Definition: string.hxx:249
static OString number(long i, sal_Int16 radix=10)
This is an overloaded member function, provided for convenience. It differs from the above function o...
Definition: string.hxx:1959
bool equalsIgnoreAsciiCase(const OString &str) const
Perform an ASCII lowercase comparison of two strings.
Definition: string.hxx:744
sal_Int64 toInt64(sal_Int16 radix=10) const
Returns the int64 value from this string.
Definition: string.hxx:1853
sal_Int32 indexOf(const OString &str, sal_Int32 fromIndex=0) const
Returns the index within this string of the first occurrence of the specified substring,...
Definition: string.hxx:1379
sal_Int32 toInt32(sal_Int16 radix=10) const
Returns the int32 value from this string.
Definition: string.hxx:1821
~OString()
Release the string data.
Definition: string.hxx:410
libreoffice_internal::NonConstCharArrayDetector< T, bool >::Type equalsIgnoreAsciiCase(T &asciiStr) const
Definition: string.hxx:783
friend libreoffice_internal::ConstCharArrayDetector< T, bool >::Type operator!=(const OString &rStr, T &literal)
This is an overloaded member function, provided for convenience. It differs from the above function o...
Definition: string.hxx:1278
libreoffice_internal::CharPtrDetector< T, bool >::Type equalsIgnoreAsciiCase(const T &asciiStr) const
Perform an ASCII lowercase comparison of two strings.
Definition: string.hxx:777
sal_Int32 indexOf(char ch, sal_Int32 fromIndex=0) const
Returns the index within this string of the first occurrence of the specified character,...
Definition: string.hxx:1319
SAL_WARN_UNUSED_RESULT OString replaceAt(sal_Int32 index, sal_Int32 count, const OString &newStr) const
Returns a new string resulting from replacing n = count characters from position index in this string...
Definition: string.hxx:1609
sal_Int32 getLength() const
Returns the length of this string.
Definition: string.hxx:576
double toDouble() const
Returns the double value from this string.
Definition: string.hxx:1896
static OString number(double d)
Returns the string representation of the double argument.
Definition: string.hxx:2008
bool endsWith(OString const &str, OString *rest=NULL) const
Check whether this string ends with a given substring.
Definition: string.hxx:1110
bool equals(const OString &str) const
Perform a comparison of two strings.
Definition: string.hxx:685
friend libreoffice_internal::NonConstCharArrayDetector< T, bool >::Type operator==(const OString &rStr1, T &value)
Definition: string.hxx:1187
OString(rtl_String *str, __sal_NoAcquire)
New string from OString data without acquiring it.
Definition: string.hxx:239
sal_Int32 lastIndexOf(char ch, sal_Int32 fromIndex) const
Returns the index within this string of the last occurrence of the specified character,...
Definition: string.hxx:1351
OString(T &value, typename libreoffice_internal::NonConstCharArrayDetector< T, libreoffice_internal::Dummy >::Type=libreoffice_internal::Dummy())
Definition: string.hxx:277
friend libreoffice_internal::CharPtrDetector< T, bool >::Type operator==(const OString &rStr1, const T &value)
Definition: string.hxx:1181
sal_uInt32 toUInt32(sal_Int16 radix=10) const
Returns the uint32 value from this string.
Definition: string.hxx:1838
static OString number(float f)
Returns the string representation of the float argument.
Definition: string.hxx:1993
friend libreoffice_internal::CharPtrDetector< T, bool >::Type operator!=(const T &value, const OString &rStr2)
Definition: string.hxx:1261
bool equalsIgnoreAsciiCaseL(const char *asciiStr, sal_Int32 asciiStrLength) const
Perform an ASCII lowercase comparison of two strings.
Definition: string.hxx:829
bool matchIgnoreAsciiCase(const OString &str, sal_Int32 fromIndex=0) const
Match against a substring appearing in this string, ignoring the case of ASCII letters.
Definition: string.hxx:947
friend libreoffice_internal::NonConstCharArrayDetector< T, bool >::Type operator!=(T &value, const OString &rStr2)
Definition: string.hxx:1267
A helper to use OStrings with hash maps.
Definition: string.hxx:2194
size_t operator()(const OString &rString) const
Compute a hash code for a string.
Definition: string.hxx:2204
Equality functor for classic c-strings (i.e., null-terminated char* strings).
Definition: string.hxx:2210
bool operator()(const char *p1, const char *p2) const
Definition: string.hxx:2211
Hashing functor for classic c-strings (i.e., null-terminated char* strings).
Definition: string.hxx:2217
size_t operator()(const char *p) const
Definition: string.hxx:2218
Definition: stringutils.hxx:136
Definition: stringutils.hxx:139