Generic character string. More...
#include <String.h>
Inheritance diagram for pcl::GenericString< T, R, A >:
Public Types | |
| using | allocator = pcl::Allocator< T, A > |
| using | block_allocator = A |
| using | c_string = T * |
| using | char_traits = R |
| using | char_type = T |
| using | const_c_string = const T * |
| using | const_item_type = typename container_type::const_item_type |
| using | const_iterator = const T * |
| using | const_reverse_iterator = ReverseRandomAccessIterator< const_iterator, const T > |
| using | container_type = DirectContainer< T > |
| using | item_type = typename container_type::item_type |
| using | iterator = T * |
| using | reverse_iterator = ReverseRandomAccessIterator< iterator, T > |
| Public Types inherited from pcl::DirectContainer< T > | |
| using | const_item_type = const T |
| using | item_type = T |
Public Member Functions | |
| GenericString () | |
| GenericString (char_type c, size_type n=1) | |
| GenericString (const GenericString &s) | |
| GenericString (const_c_string t) | |
| GenericString (const_c_string t, size_type i, size_type n) | |
| GenericString (const_iterator i, const_iterator j) | |
| GenericString (GenericString &&s) | |
| GenericString (std::initializer_list< char_type > l) | |
| ~GenericString () | |
| void | Add (char_type c, size_type n=1) |
| template<class R1 , class A1 > | |
| void | Add (const GenericString< T, R1, A1 > &s) |
| void | Add (const_c_string t) |
| void | Add (const_c_string t, size_type n) |
| void | Add (const_iterator i, const_iterator j) |
| const allocator & | Allocator () const noexcept |
| void | Append (char_type c, size_type n=1) |
| template<class R1 , class A1 > | |
| void | Append (const GenericString< T, R1, A1 > &s) |
| void | Append (const_c_string t) |
| void | Append (const_c_string t, size_type n) |
| void | Append (const_iterator i, const_iterator j) |
| void | Assign (char_type c, size_type n=1) |
| void | Assign (const GenericString &s) |
| void | Assign (const GenericString &s, size_type i, size_type n) |
| void | Assign (const_c_string t) |
| void | Assign (const_c_string t, size_type i, size_type n) |
| void | Assign (const_iterator i, const_iterator j) |
| void | Assign (std::initializer_list< char_type > l) |
| iterator | At (size_type i) |
| const_iterator | At (size_type i) const noexcept |
| size_type | Available () const noexcept |
| iterator | Begin () |
| iterator | begin () |
| const_iterator | Begin () const noexcept |
| const_iterator | begin () const noexcept |
| template<class C > | |
| size_type | Break (C &list, char_type c, bool trim=false, size_type i=0) const |
| template<class C , typename S > | |
| size_type | Break (C &list, const Array< S > &ca, bool trim=false, size_type i=0) const |
| template<class C , class R1 , class A1 > | |
| size_type | Break (C &list, const GenericString< T, R1, A1 > &s, bool trim=false, size_type i=0) const |
| template<class C > | |
| size_type | Break (C &list, const_c_string s, bool trim=false, size_type i=0) const |
| template<class C > | |
| size_type | BreakIC (C &list, char_type c, bool trim=false, size_type i=0) const |
| template<class C , class R1 , class A1 > | |
| size_type | BreakIC (C &list, const GenericString< T, R1, A1 > &s, bool trim=false, size_type i=0) const |
| template<class C > | |
| size_type | BreakIC (C &list, const_c_string s, bool trim=false, size_type i=0) const |
| void | c_copy (iterator dst, size_type maxCharsToCopy, size_type i=0) const noexcept |
| const_c_string | c_str () const noexcept |
| size_type | Capacity () const noexcept |
| GenericString | CaseFolded () const |
| GenericString | CenterJustified (size_type width, char_type fill=R::Blank()) const |
| void | Clear () |
| int | Compare (char_type c, bool caseSensitive=true, bool localeAware=true) const noexcept |
| template<class R1 , class A1 > | |
| int | Compare (const GenericString< T, R1, A1 > &s, bool caseSensitive=true, bool localeAware=true) const noexcept |
| int | Compare (const_c_string t, bool caseSensitive=true, bool localeAware=true) const noexcept |
| int | CompareCodePoints (char_type c, bool caseSensitive=true) const noexcept |
| template<class R1 , class A1 > | |
| int | CompareCodePoints (const GenericString< T, R1, A1 > &s, bool caseSensitive=true) const noexcept |
| int | CompareCodePoints (const_c_string t, bool caseSensitive=true) const noexcept |
| int | CompareIC (char_type c, bool localeAware=true) const noexcept |
| template<class R1 , class A1 > | |
| int | CompareIC (const GenericString< T, R1, A1 > &s, bool localeAware=true) const noexcept |
| int | CompareIC (const_c_string t, bool localeAware=true) const noexcept |
| bool | Contains (char_type c) const noexcept |
| template<class R1 , class A1 > | |
| bool | Contains (const GenericString< T, R1, A1 > &s) const noexcept |
| bool | Contains (const_c_string t) const noexcept |
| bool | ContainsIC (char_type c) const noexcept |
| template<class R1 , class A1 > | |
| bool | ContainsIC (const GenericString< T, R1, A1 > &s) const noexcept |
| bool | ContainsIC (const_c_string t) const noexcept |
| void | Delete (size_type i, size_type n=1) |
| void | DeleteChar (char_type c, size_type i=0) |
| void | DeleteCharIC (char_type c, size_type i=0) |
| void | DeleteLeft (size_type i) |
| void | DeleteRight (size_type i) |
| template<class R1 , class A1 > | |
| void | DeleteString (const GenericString< T, R1, A1 > &s, size_type i=0) |
| void | DeleteString (const_c_string t, size_type i=0) |
| template<class R1 , class A1 > | |
| void | DeleteStringIC (const GenericString< T, R1, A1 > &s, size_type i=0) |
| void | DeleteStringIC (const_c_string t, size_type i=0) |
| GenericString | DoubleQuoted () const |
| GenericString | Enclosed (char_type c) const |
| iterator | End () |
| iterator | end () |
| const_iterator | End () const noexcept |
| const_iterator | end () const noexcept |
| bool | EndsWith (char_type c) const noexcept |
| template<class R1 , class A1 > | |
| bool | EndsWith (const GenericString< T, R1, A1 > &s) const noexcept |
| bool | EndsWith (const_c_string t) const noexcept |
| bool | EndsWithIC (char_type c) const noexcept |
| template<class R1 , class A1 > | |
| bool | EndsWithIC (const GenericString< T, R1, A1 > &s) const noexcept |
| bool | EndsWithIC (const_c_string t) const noexcept |
| void | EnsureDoubleQuoted () |
| void | EnsureEnclosed (char_type c) |
| void | EnsureSingleQuoted () |
| void | EnsureUnique () |
| void | Fill (char_type c) |
| void | Fill (char_type c, size_type i, size_type n=maxPos) |
| size_type | Find (char_type c, size_type i=0) const noexcept |
| template<class R1 , class A1 > | |
| size_type | Find (const GenericString< T, R1, A1 > &s, size_type i=0) const noexcept |
| size_type | Find (const_c_string t, size_type i=0) const noexcept |
| size_type | FindFirst (char_type c, size_type i=0) const noexcept |
| template<class R1 , class A1 > | |
| size_type | FindFirst (const GenericString< T, R1, A1 > &s, size_type i=0) const noexcept |
| size_type | FindFirst (const_c_string t, size_type i=0) const noexcept |
| size_type | FindFirstIC (char_type c, size_type i=0) const noexcept |
| template<class R1 , class A1 > | |
| size_type | FindFirstIC (const GenericString< T, R1, A1 > &s, size_type i=0) const noexcept |
| size_type | FindFirstIC (const_c_string t, size_type i=0) const noexcept |
| size_type | FindIC (char_type c, size_type i=0) const noexcept |
| template<class R1 , class A1 > | |
| size_type | FindIC (const GenericString< T, R1, A1 > &s, size_type i=0) const noexcept |
| size_type | FindIC (const_c_string t, size_type i=0) const noexcept |
| size_type | FindLast (char_type c, size_type r=maxPos) const noexcept |
| template<class R1 , class A1 > | |
| size_type | FindLast (const GenericString< T, R1, A1 > &s, size_type r=maxPos) const noexcept |
| size_type | FindLast (const_c_string t, size_type r=maxPos) const noexcept |
| size_type | FindLastIC (char_type c, size_type r=maxPos) const noexcept |
| template<class R1 , class A1 > | |
| size_type | FindLastIC (const GenericString< T, R1, A1 > &s, size_type r=maxPos) const noexcept |
| size_type | FindLastIC (const_c_string t, size_type r=maxPos) const noexcept |
| char_type | FirstChar () const noexcept |
| uint64 | Hash (uint64 seed=0) const noexcept |
| uint32 | Hash32 (uint32 seed=0) const noexcept |
| uint64 | Hash64 (uint64 seed=0) const noexcept |
| bool | HasWildcards () const noexcept |
| size_type | IndexAt (const_iterator i) const noexcept |
| void | Insert (size_type i, char_type c, size_type n=1) |
| template<class R1 , class A1 > | |
| void | Insert (size_type i, const GenericString< T, R1, A1 > &s) |
| void | Insert (size_type i, const_c_string t) |
| void | Insert (size_type i, const_c_string t, size_type n) |
| void | Insert (size_type i, const_iterator p, const_iterator q) |
| bool | IsAliasOf (const GenericString &s) const noexcept |
| bool | IsEmpty () const noexcept |
| bool | IsNumeral () const noexcept |
| bool | IsSymbol () const noexcept |
| bool | IsUnique () const noexcept |
| bool | IsValid () const noexcept |
| bool | IsValidIdentifier () const noexcept |
| bool | IsValidIdentifier (distance_type &pos) const noexcept |
| void | JustifyCenter (size_type width, char_type fill=R::Blank()) |
| void | JustifyLeft (size_type width, char_type fill=R::Blank()) |
| void | JustifyRight (size_type width, char_type fill=R::Blank()) |
| char_type | LastChar () const noexcept |
| GenericString | Left (size_type n) const |
| GenericString | LeftJustified (size_type width, char_type fill=R::Blank()) const |
| size_type | Length () const noexcept |
| size_type | LowerBound () const noexcept |
| GenericString | Lowercase () const |
| char_type & | operator* () |
| char_type | operator* () const noexcept |
| GenericString & | operator+= (char_type c) |
| template<class R1 , class A1 > | |
| GenericString & | operator+= (const GenericString< T, R1, A1 > &s) |
| GenericString & | operator+= (const_c_string t) |
| GenericString & | operator-= (char_type c) |
| template<class R1 , class A1 > | |
| GenericString & | operator-= (const GenericString< T, R1, A1 > &s) |
| GenericString & | operator-= (const_c_string t) |
| GenericString & | operator= (char_type c) |
| GenericString & | operator= (const GenericString &s) |
| GenericString & | operator= (const_c_string t) |
| GenericString & | operator= (GenericString &&s) |
| char_type & | operator[] (size_type i) |
| char_type | operator[] (size_type i) const noexcept |
| GenericString | Prefix (size_type i) const |
| void | Prepend (char_type c, size_type n=1) |
| template<class R1 , class A1 > | |
| void | Prepend (const GenericString< T, R1, A1 > &s) |
| void | Prepend (const_c_string t) |
| void | Prepend (const_c_string t, size_type n) |
| void | Prepend (const_iterator i, const_iterator j) |
| c_string | Release () |
| void | Replace (size_type i, size_type n, char_type c, size_type nc=1) |
| template<class R1 , class A1 > | |
| void | Replace (size_type i, size_type n, const GenericString< T, R1, A1 > &s) |
| void | Replace (size_type i, size_type n, const_c_string t) |
| void | ReplaceChar (char_type c1, char_type c2, size_type i=0, size_type n=maxPos) |
| void | ReplaceCharIC (char_type c1, char_type c2, size_type i=0, size_type n=maxPos) |
| template<class R1 , class A1 , class R2 , class A2 > | |
| void | ReplaceString (const GenericString< T, R1, A1 > &s1, const GenericString< T, R2, A2 > &s2, size_type i=0) |
| void | ReplaceString (const_c_string t1, const_c_string t2, size_type i=0) |
| template<class R1 , class A1 , class R2 , class A2 > | |
| void | ReplaceStringIC (const GenericString< T, R1, A1 > &s1, const GenericString< T, R2, A2 > &s2, size_type i=0) |
| void | ReplaceStringIC (const_c_string t1, const_c_string t2, size_type i=0) |
| void | Reserve (size_type n) |
| GenericString | ResizedToNullTerminated () const |
| void | ResizeToNullTerminated () |
| void | Reverse () |
| reverse_iterator | ReverseBegin () |
| const_reverse_iterator | ReverseBegin () const noexcept |
| GenericString | Reversed () const |
| reverse_iterator | ReverseEnd () |
| const_reverse_iterator | ReverseEnd () const noexcept |
| GenericString | Right (size_type n) const |
| GenericString | RightJustified (size_type width, char_type fill=R::Blank()) const |
| void | SecureFill (char c='\0') noexcept |
| void | SetAllocator (const allocator &a) |
| void | SetLength (size_type n) |
| GenericString | SetToLength (size_type n) const |
| GenericString | SingleQuoted () const |
| size_type | Size () const noexcept |
| void | Sort () |
| template<class BP > | |
| void | Sort (BP p) |
| GenericString | Sorted () const |
| template<class BP > | |
| GenericString | Sorted (BP p) const |
| void | Squeeze () |
| GenericString | Squeezed () const |
| bool | StartsWith (char_type c) const noexcept |
| template<class R1 , class A1 > | |
| bool | StartsWith (const GenericString< T, R1, A1 > &s) const noexcept |
| bool | StartsWith (const_c_string t) const noexcept |
| bool | StartsWithIC (char_type c) const noexcept |
| template<class R1 , class A1 > | |
| bool | StartsWithIC (const GenericString< T, R1, A1 > &s) const noexcept |
| bool | StartsWithIC (const_c_string t) const noexcept |
| GenericString | Substring (size_type i, size_type n=maxPos) const |
| GenericString | Suffix (size_type i) const |
| void | Swap (GenericString &s) noexcept |
| void | ToCaseFolded () |
| void | ToLowercase () |
| void | ToUppercase () |
| void | Transfer (GenericString &&s) |
| void | Transfer (GenericString &s) |
| void | Trim () |
| void | TrimLeft () |
| GenericString | Trimmed () const |
| GenericString | TrimmedLeft () const |
| GenericString | TrimmedRight () const |
| void | TrimRight () |
| void | Unquote () |
| GenericString | Unquoted () const |
| size_type | UpperBound () const noexcept |
| GenericString | Uppercase () const |
| template<class R1 , class A1 > | |
| bool | WildMatch (const GenericString< T, R1, A1 > &pattern, bool caseSensitive=true) const noexcept |
| bool | WildMatch (const_c_string pattern, bool caseSensitive=true) const noexcept |
| template<class R1 , class A1 > | |
| bool | WildMatchIC (const GenericString< T, R1, A1 > &pattern) const noexcept |
| bool | WildMatchIC (const_c_string pattern) const noexcept |
Static Public Member Functions | |
| static size_type | BytesPerChar () noexcept |
| static size_type | DeleteFreeList () |
Static Public Attributes | |
| static const size_type | maxPos = ~size_type( 0 ) |
| static const size_type | notFound = ~size_type( 0 ) |
Detailed Description
template<class T, class R, class A = PCL_STRING_ALLOCATOR>
class pcl::GenericString< T, R, A >
GenericString is a finite, ordered sequence of characters implemented as a reference-counted, dynamic array of objects of type T, whose fundamental behavior is specified by an instantiation type R of GenericCharTraits for the character type T (typically GenericCharTraits, or a derived class such as CharTraits or IsoCharTraits), and where the type A provides dynamic allocation for contiguous sequences of elements of type T (StandardAllocator is used by default).
On the PixInsight platform, all dynamically allocated strings have been implemented as two instantiations of the GenericString template class, namely the String (UTF-16 string) and IsoString (UTF-8 or ISO/IEC-8859-1 string) classes.
- See also
- String, IsoString, CharTraits, IsoCharTraits
Member Typedef Documentation
◆ allocator
| using pcl::GenericString< T, R, A >::allocator = pcl::Allocator<T,A> |
◆ block_allocator
| using pcl::GenericString< T, R, A >::block_allocator = A |
◆ c_string
| using pcl::GenericString< T, R, A >::c_string = T* |
◆ char_traits
| using pcl::GenericString< T, R, A >::char_traits = R |
◆ char_type
| using pcl::GenericString< T, R, A >::char_type = T |
◆ const_c_string
| using pcl::GenericString< T, R, A >::const_c_string = const T* |
◆ const_item_type
| using pcl::GenericString< T, R, A >::const_item_type = typename container_type::const_item_type |
◆ const_iterator
| using pcl::GenericString< T, R, A >::const_iterator = const T* |
◆ const_reverse_iterator
| using pcl::GenericString< T, R, A >::const_reverse_iterator = ReverseRandomAccessIterator<const_iterator, const T> |
◆ container_type
| using pcl::GenericString< T, R, A >::container_type = DirectContainer<T> |
◆ item_type
| using pcl::GenericString< T, R, A >::item_type = typename container_type::item_type |
◆ iterator
| using pcl::GenericString< T, R, A >::iterator = T* |
◆ reverse_iterator
| using pcl::GenericString< T, R, A >::reverse_iterator = ReverseRandomAccessIterator<iterator, T> |
Constructor & Destructor Documentation
◆ GenericString() [1/8]
|
inline |
◆ GenericString() [2/8]
|
inline |
◆ GenericString() [3/8]
|
inline |
◆ GenericString() [4/8]
|
inline |
◆ GenericString() [5/8]
|
inline |
Constructs a string with a copy of the character sequence defined by the range [i,j).
If i is greater than or equal to j, this constructor creates an empty string. Otherwise it will assign the specified sequence of characters.
Important - Note that this constructor is not equivalent to:
because the above call would assign a null-terminated sequence, while this function assigns the specified range unconditionally, even if it contains null characters. Since this constructor does not have to scan for a terminating character, it is potentially more efficient.
◆ GenericString() [6/8]
|
inline |
Constructs a string and initializes it with characters taken from the specified initializer list l.
This constructor is equivalent to:
◆ GenericString() [7/8]
|
inline |
Constructs a string with a copy of at most n characters stored in the null-terminated sequence t, starting from its i-th character.
Definition at line 660 of file String.h.
References pcl::Min().
◆ GenericString() [8/8]
|
inline |
◆ ~GenericString()
|
inline |
Member Function Documentation
◆ Add() [1/5]
|
inline |
A synonym for Append( char_type, size_type ), provided for compatibility with PCL container classes.
◆ Add() [2/5]
|
inline |
◆ Add() [3/5]
|
inline |
A synonym for Append( const_c_string ), provided for compatibility with PCL container classes.
◆ Add() [4/5]
|
inline |
A synonym for Append( const_c_string, size_type ), provided for compatibility with PCL container classes.
◆ Add() [5/5]
|
inline |
A synonym for Append( const_iterator, const_iterator ), provided for compatibility with PCL container classes.
◆ Allocator()
|
inlinenoexcept |
Returns a reference to the (immutable) allocator object in this string.
- See also
- SetAllocator()
◆ Append() [1/5]
|
inline |
◆ Append() [2/5]
|
inline |
Appends a copy of the specified string s to this string.
Definition at line 1766 of file String.h.
Referenced by pcl::operator+(), and pcl::operator<<().
◆ Append() [3/5]
|
inline |
◆ Append() [4/5]
|
inline |
◆ Append() [5/5]
|
inline |
◆ Assign() [1/7]
|
inline |
◆ Assign() [2/7]
|
inline |
Assigns a string s to this string.
If this instance and the specified source instance s reference different string data, then the data previously referenced by this object is dereferenced. If the previous data becomes unreferenced, it is destroyed and deallocated. Then the data being referenced by s is also referenced by this object.
If this instance and the specified source instance s already reference the same string data, then this function does nothing.
- See also
- Transfer()
◆ Assign() [3/7]
|
inline |
Assigns a substring of at most n characters from a source string s, starting from its i-th character, to this string.
Definition at line 1273 of file String.h.
References pcl::GenericString< T, R, A >::Substring().
◆ Assign() [4/7]
|
inline |
◆ Assign() [5/7]
|
inline |
Assigns a copy of at most n characters stored in the null-terminated sequence t, starting from its i-th character, to this string.
If t is the null pointer, or i is greater than the length of t, or n is zero, this function empties the string by calling Clear().
If t is a pointer to the contents of this string (or, equivalently, an iterator on this string), this function invokes undefined behavior.
The character count n will be constrained to copy existing characters from the null-terminated source sequence.
Definition at line 1353 of file String.h.
References pcl::Min().
◆ Assign() [6/7]
|
inline |
Assigns a copy of the character sequence defined by the range [i,j) to this string.
If i is greater than or equal to j, this function empties the string by calling Clear(). Otherwise this function will assign the specified sequence of characters.
If i and/or j are iterators on this string, this function invokes undefined behavior.
Important - Note that this function is not equivalent to:
because the above call would assign a null-terminated sequence, while this function assigns the specified range unconditionally, even if it contains null characters. Since this function does not have to scan for a terminating character, it is potentially much more efficient.
◆ Assign() [7/7]
|
inline |
◆ At() [1/2]
|
inline |
Returns an iterator located at the i-th character of this string. The character index i must be in the range [0,Length()).
If this string is not unique, it is made unique before returning from this member function.
If this string is empty, or if the specified index i is out of range, calling this member function is an error that leads to an invalid result.
- See also
- operator []( size_type )
◆ At() [2/2]
|
inlinenoexcept |
Returns an immutable iterator located at the i-th character in this string. The character index i must be in the range [0,Length()).
If this string is empty, or if the specified index i is out of range, calling this member function is an error that leads to an invalid result.
- See also
- operator []( size_type ) const
◆ Available()
|
inlinenoexcept |
Returns the number of characters available in this string.
The number of available characters is equal to Capacity() - Length().
- See also
- Capacity(), Length(), Size()
◆ Begin() [1/2]
|
inline |
Returns a mutable iterator pointing to the first character of this string.
If this string is not unique, it is made unique before returning from this member function.
If this string is empty, this member function returns nullptr.
- See also
- End()
Definition at line 988 of file String.h.
Referenced by pcl::AES256::AES256(), pcl::String::Assign(), pcl::XML::IsValidName(), pcl::IsoString::operator=(), pcl::File::OutText(), pcl::XML::ReferenceValue(), and pcl::IsoString::ToString().
◆ begin() [1/2]
|
inline |
◆ Begin() [2/2]
|
inlinenoexcept |
Returns an immutable iterator pointing to the first character of this string.
If this string is empty, this member function returns nullptr.
- See also
- End() const
◆ begin() [2/2]
|
inlinenoexcept |
STL-compatible iteration. Equivalent to Begin() const.
◆ Break() [1/4]
|
inline |
Gets a sequence of tokens (substrings) extracted from this string.
- Parameters
-
[out] list The list of extracted tokens. Must be a reference to a container, such as Array or List, or a derived class. Typically, this parameter is a reference to a StringList. c The token separator character. Tokens will be separated by sequences of one or more instances of this character. trim True to trim the extracted tokens. If this parameter is true, existing leading and trailing whitespace characters will be removed from each extracted token. i Starting character index.
Returns the number of tokens extracted and added to the list.
◆ Break() [2/4]
|
inline |
Gets a sequence of tokens (substrings) extracted from this string.
- Parameters
-
[out] list The list of extracted tokens. Must be a reference to a container, such as Array or List, or a derived class. Typically, this parameter is a reference to a StringList. ca An array of token separator characters. Tokens will be separated by instances of any character included in this array. The template argument S must have type conversion semantics to the character type of this string class (char_type). If this array is empty, calling this function has no effect and zero is returned. trim True to trim the extracted tokens. If this parameter is true, existing leading and trailing whitespace characters will be removed from each extracted token. i Starting character index.
Returns the number of tokens extracted and added to the list.
◆ Break() [3/4]
|
inline |
Gets a sequence of tokens (substrings) extracted from this string.
- Parameters
-
[out] list The list of extracted tokens. Must be a reference to a container, such as Array or List, or a derived class. Typically, this parameter is a reference to a StringList. s The token separator string. trim True to trim the extracted tokens. If this parameter is true, existing leading and trailing whitespace characters will be removed from each extracted token. i Starting character index.
Returns the number of tokens extracted and added to the list.
◆ Break() [4/4]
|
inline |
Gets a sequence of tokens (substrings) extracted from this string.
- Parameters
-
[out] list The list of extracted tokens. Must be a reference to a container, such as Array or List, or a derived class. Typically, this parameter is a reference to a StringList. s The token separator null-terminated string. trim True to trim the extracted tokens. If this parameter is true, existing leading and trailing whitespace characters will be removed from each extracted token. i Starting character index.
Returns the number of tokens extracted and added to the list.
◆ BreakIC() [1/3]
|
inline |
Gets a sequence of tokens (substrings) extracted from this string by performing case-insensitive comparisons with a token separator character.
- Parameters
-
[out] list The list of extracted tokens. Must be a reference to a container, such as Array or List, or a derived class. Typically, this parameter is a reference to a StringList. c The token separator character. Tokens will be separated by sequences of one or more instances of this character. This function performs case-insensitive character comparisons to locate instances of this character. trim True to trim the extracted tokens. If this parameter is true, existing leading and trailing whitespace characters will be removed from each extracted token. i Starting character index.
Returns the number of tokens extracted and added to the list.
◆ BreakIC() [2/3]
|
inline |
Gets a sequence of tokens (substrings) extracted from this string by performing case-insensitive comparisons with a token separation string.
- Parameters
-
[out] list The list of extracted tokens. Must be a reference to a container, such as Array or List, or a derived class. Typically, this parameter is a reference to a StringList. s The token separator string. This function performs case-insensitive string comparisons to locate instances of this string. trim True to trim the extracted tokens. If this parameter is true, existing leading and trailing whitespace characters will be removed from each extracted token. i Starting character index.
Returns the number of tokens extracted and added to the list.
◆ BreakIC() [3/3]
|
inline |
Gets a sequence of tokens (substrings) extracted from this string by performing case-insensitive comparisons with a null-terminated token separation string.
- Parameters
-
[out] list The list of extracted tokens. Must be a reference to a container, such as Array or List, or a derived class. Typically, this parameter is a reference to a StringList. s The token separator null-terminated string. This function performs case-insensitive string comparisons to locate instances of this string. trim True to trim the extracted tokens. If this parameter is true, existing leading and trailing whitespace characters will be removed from each extracted token. i Starting character index.
Returns the number of tokens extracted and added to the list.
◆ BytesPerChar()
|
inlinestaticnoexcept |
◆ c_copy()
|
inlinenoexcept |
Copies characters from this string to a null-terminated character array.
- Parameters
-
[out] dst Destination character array. maxCharsToCopy The total number of characters that can be stored at the dst array, including a null terminating character. i Index of the first character to be copied from this string.
This function copies at most maxCharsToCopy-1 characters from this string (or Length()-i, whichever is less) to the dst array. Then a null terminating character is appended to dst.
Definition at line 1672 of file String.h.
References pcl::Min().
◆ c_str()
|
inlinenoexcept |
Returns a pointer to the immutable internal data array of this string.
If this string is empty, this member function returns a pointer to a static, null-terminated, unmodifiable empty string (the "" C string). This function always returns a valid pointer to existing character data.
Definition at line 1162 of file String.h.
Referenced by pcl::Argument::Argument().
◆ Capacity()
|
inlinenoexcept |
Returns the total capacity of this string in characters.
The capacity of a string is the maximum number of characters that can be stored before requiring a reallocation of string data.
- See also
- Available(), Length(), Size()
◆ CaseFolded()
|
inline |
Returns a duplicate of this string with all characters replaced with their case folded counterparts.
Definition at line 4035 of file String.h.
References pcl::GenericString< T, R, A >::ToCaseFolded().
◆ CenterJustified()
|
inline |
Returns a duplicate of this string padded equally to the left and right, using the specified fill character, up to the specified width.
- See also
- JustifyCenter(), LeftJustified(), RightJustified()
Definition at line 3621 of file String.h.
References pcl::GenericString< T, R, A >::JustifyCenter().
◆ Clear()
|
inline |
Removes all characters in this string, yielding an empty string.
If this string is empty, then calling this member function has no effect.
If this string uniquely references its string data, it is destroyed and deallocated; otherwise its reference counter is decremented. Then a new, empty string data structure is created and uniquely referenced.
Definition at line 2276 of file String.h.
Referenced by pcl::ProcessInterface::ValidateProcess().
◆ Compare() [1/3]
|
inlinenoexcept |
Lexicographical comparison to a single character.
- Parameters
-
c A character to which this string will be compared. caseSensitive When true, a case-sensitive comparison is performed; otherwise the comparison does not distinguish between lowercase and uppercase characters (as defined by the selected locale). The default value of this parameter is true. localeAware When true, a locale-dependent comparison is done which takes into account the currently selected user locale (language and variants). When false, a locale-invariant comparison is carried out by comparing character code points (which is faster). The default value of this parameter is true.
Performs a comparison between this string and the specified character c, and returns an integer that indicates the comparison result:
- 0 if this string is equal to c.
- +1 if this string postcedes the character c.
- -1 if this string precedes the character c.
The performed comparison is equivalent to a comparison of this string with a fictitious string of length one, whose only character was equal to the specified character c.
Definition at line 3812 of file String.h.
References pcl::Compare().
◆ Compare() [2/3]
|
inlinenoexcept |
Lexicographical comparison between two strings.
- Parameters
-
s A string to which this string will be compared. caseSensitive When true, a case-sensitive comparison is performed; otherwise the comparison does not distinguish between lowercase and uppercase characters (as defined by the selected locale). The default value of this parameter is true. localeAware When true, a locale-dependent comparison is done which takes into account the currently selected user locale (language and variants). When false, a locale-invariant comparison is carried out by comparing character code points (which is faster). The default value of this parameter is true.
Performs a character-to-character comparison between this string and the specified string s, and returns an integer that indicates the comparison result:
- 0 if both strings are equal.
- +1 if this string postcedes the specified string s.
- -1 if this string precedes the specified string s.
Definition at line 3745 of file String.h.
References pcl::Compare().
◆ Compare() [3/3]
|
inlinenoexcept |
Lexicographical comparison to a null-terminated string.
- Parameters
-
t The starting address of a null-terminated string to which this string will be compared. caseSensitive When true, a case-sensitive comparison is performed; otherwise the comparison does not distinguish between lowercase and uppercase characters (as defined by the selected locale). The default value of this parameter is true. localeAware When true, a locale-dependent comparison is done which takes into account the currently selected user locale (language and variants). When false, a locale-invariant comparison is carried out by comparing character code points (which is faster). The default value of this parameter is true.
Performs a character-to-character comparison between this string and the specified null-terminated string t, and returns an integer that indicates the comparison result:
- 0 if both strings are equal.
- +1 if this string postcedes the specified string t.
- -1 if this string precedes the specified string t.
Definition at line 3778 of file String.h.
References pcl::Compare().
◆ CompareCodePoints() [1/3]
|
inlinenoexcept |
Compares numeric character values a string and a null-terminated string.
- Parameters
-
c A single character to which this string will be compared. caseSensitive When true, a case-sensitive comparison is performed; otherwise the comparison does not distinguish between lowercase and uppercase characters. The default value of this parameter is true.
Performs a comparison between this string and the specified character c, and returns an integer that indicates the comparison result:
- 0 if this string is equal to c.
- +1 if this string postcedes the character c.
- -1 if this string precedes the character c.
The performed comparison is equivalent to a comparison of this string with a fictitious string of length one, whose only character was equal to the specified character c.
This function ignores the current platform locale. It considers Unicode code points exclusively. For case-insensitive comparisons, a standard Unicode case folding transformation is applied to each character pair.
◆ CompareCodePoints() [2/3]
|
inlinenoexcept |
Compares numeric character values between two strings.
- Parameters
-
s A string to which this string will be compared. caseSensitive When true, a case-sensitive comparison is performed; otherwise the comparison does not distinguish between lowercase and uppercase characters. The default value of this parameter is true.
Performs a character-to-character comparison of numeric character values between this string and the specified string s, and returns an integer that indicates the comparison result:
- 0 if both strings are equal.
- +1 if this string postcedes the specified string s.
- -1 if this string precedes the specified string s.
This function ignores the current platform locale. It considers Unicode code points exclusively. For case-insensitive comparisons, a standard Unicode case folding transformation is applied to each character pair.
◆ CompareCodePoints() [3/3]
|
inlinenoexcept |
Compares numeric character values a string and a null-terminated string.
- Parameters
-
t The starting address of a null-terminated string to which this string will be compared. caseSensitive When true, a case-sensitive comparison is performed; otherwise the comparison does not distinguish between lowercase and uppercase characters. The default value of this parameter is true.
Performs a character-to-character comparison of numeric character values between this string and the specified null-terminated string t, and returns an integer that indicates the comparison result:
- 0 if both strings are equal.
- +1 if this string postcedes the specified string t.
- -1 if this string precedes the specified string t.
This function ignores the current platform locale. It considers Unicode code points exclusively. For case-insensitive comparisons, a standard Unicode case folding transformation is applied to each character pair.
◆ CompareIC() [1/3]
|
inlinenoexcept |
Case-insensitive lexicographical comparison to a single character.
- Parameters
-
c A character to which this string will be compared. localeAware When true, a locale-dependent comparison is done which takes into account the currently selected user locale (language and variants). When false, a locale-invariant comparison is carried out by comparing character code points (which is faster). The default value of this parameter is true.
Performs a case-insensitive comparison between this string and the specified character c, and returns an integer that indicates the comparison result:
- 0 if this string is equal to c.
- +1 if this string postcedes the character c.
- -1 if this string precedes the character c.
The performed comparison is equivalent to a case-insensitive comparison of this string with a fictitious string of length one, whose only character was equal to c.
Definition at line 3893 of file String.h.
References pcl::Compare().
◆ CompareIC() [2/3]
|
inlinenoexcept |
Case-insensitive lexicographical comparison between two strings.
- Parameters
-
s A string to which this string will be compared. localeAware When true, a locale-dependent comparison is done which takes into account the currently selected user locale (language and variants). When false, a locale-invariant comparison is carried out by comparing character code points (which is faster). The default value of this parameter is true.
Performs a character-to-character, case-insensitive comparison between this string and the specified string s, and returns an integer that indicates the comparison result:
- 0 if both strings are equal.
- +1 if this string postcedes the specified string s.
- -1 if this string precedes the specified string s.
Definition at line 3838 of file String.h.
References pcl::Compare().
Referenced by pcl::EphemerisConstant::operator<(), pcl::operator<(), pcl::EphemerisConstant::operator==(), and pcl::operator==().
◆ CompareIC() [3/3]
|
inlinenoexcept |
Case-insensitive lexicographical comparison to a null-terminated string.
- Parameters
-
t The starting address of a null-terminated string to which this string will be compared. localeAware When true, a locale-dependent comparison is done which takes into account the currently selected user locale (language and variants). When false, a locale-invariant comparison is carried out by comparing character code points (which is faster). The default value of this parameter is true.
Performs a character-to-character, case-insensitive comparison between this string and the specified null-terminated string t, and returns an integer that indicates the comparison result:
- 0 if both strings are equal.
- +1 if this string postcedes the specified string s.
- -1 if this string precedes the specified string s.
Definition at line 3864 of file String.h.
References pcl::Compare().
◆ Contains() [1/3]
|
inlinenoexcept |
◆ Contains() [2/3]
|
inlinenoexcept |
◆ Contains() [3/3]
|
inlinenoexcept |
◆ ContainsIC() [1/3]
|
inlinenoexcept |
◆ ContainsIC() [2/3]
|
inlinenoexcept |
◆ ContainsIC() [3/3]
|
inlinenoexcept |
◆ Delete()
|
inline |
Deletes a contiguous segment of at most n characters starting at the i-th character in this string.
Definition at line 2147 of file String.h.
References pcl::Min().
◆ DeleteChar()
|
inline |
Deletes all occurrences of the c character in a segment of contiguous characters starting from the i-th character and spanning to the end of this string.
Definition at line 2204 of file String.h.
Referenced by pcl::IsoString::ToBase64URL().
◆ DeleteCharIC()
|
inline |
◆ DeleteFreeList()
|
inlinestatic |
◆ DeleteLeft()
|
inline |
◆ DeleteRight()
|
inline |
◆ DeleteString() [1/2]
|
inline |
Deletes all occurrences of a string s in a segment of contiguous characters starting from the i-th character and spanning to the end of this string.
Definition at line 2227 of file String.h.
References pcl::GenericString< T, R, A >::Length().
◆ DeleteString() [2/2]
|
inline |
◆ DeleteStringIC() [1/2]
|
inline |
Deletes all occurrences of a string s in a segment of contiguous characters starting from the i-th character and spanning to the end of this string.
This member function performs case-insensitive string comparisons.
Definition at line 2250 of file String.h.
References pcl::GenericString< T, R, A >::Length().
◆ DeleteStringIC() [2/2]
|
inline |
◆ DoubleQuoted()
|
inline |
Returns a duplicate of this string enclosed by double quote characters ("). If this string is already double quoted, this function returns an unmodified copy.
- See also
- EnsureDoubleQuoted()
Definition at line 3478 of file String.h.
References pcl::GenericString< T, R, A >::EnsureDoubleQuoted().
◆ Enclosed()
|
inline |
Returns a duplicate of this string enclosed by the specified character. If this string is already enclosed by c, this function returns an unmodified copy.
- See also
- EnsureEnclosed()
Definition at line 3430 of file String.h.
References pcl::GenericString< T, R, A >::EnsureEnclosed().
◆ End() [1/2]
|
inline |
Returns a mutable iterator pointing to the end of this string. The returned iterator points to the next-to-last character of this string.
If this string is not unique, it is made unique before returning from this member function.
If this string is empty, this member function returns nullptr.
- See also
- Begin()
Definition at line 1018 of file String.h.
Referenced by pcl::XML::IsValidName(), pcl::File::OutText(), and pcl::XML::ReferenceValue().
◆ end() [1/2]
|
inline |
◆ End() [2/2]
|
inlinenoexcept |
Returns an immutable iterator pointing to the end of this string. The returned iterator points to the next-to-last character of this string.
If this string is empty, this member function returns nullptr.
- See also
- Begin() const
◆ end() [2/2]
|
inlinenoexcept |
STL-compatible iteration. Equivalent to End() const.
◆ EndsWith() [1/3]
|
inlinenoexcept |
◆ EndsWith() [2/3]
|
inlinenoexcept |
◆ EndsWith() [3/3]
|
inlinenoexcept |
◆ EndsWithIC() [1/3]
|
inlinenoexcept |
◆ EndsWithIC() [2/3]
|
inlinenoexcept |
◆ EndsWithIC() [3/3]
|
inlinenoexcept |
◆ EnsureDoubleQuoted()
|
inline |
Ensures that this string is enclosed by a leading and a trailing instance of the double quote character ("). If this string is already double quoted, this function does nothing.
- See also
- DoubleQuoted()
Definition at line 3467 of file String.h.
Referenced by pcl::GenericString< T, R, A >::DoubleQuoted().
◆ EnsureEnclosed()
|
inline |
Ensures that this string is enclosed by a leading and a trailing instance of the specified character c. If this string is already enclosed by c, this function does nothing.
- See also
- Enclosed()
Definition at line 3386 of file String.h.
Referenced by pcl::GenericString< T, R, A >::Enclosed().
◆ EnsureSingleQuoted()
|
inline |
Ensures that this string is enclosed by a leading and a trailing instance of the single quote character ('). If this string is already single quoted, this function does nothing.
- See also
- SingleQuoted()
Definition at line 3443 of file String.h.
Referenced by pcl::FITSHeaderKeyword::FixValueDelimiters(), and pcl::GenericString< T, R, A >::SingleQuoted().
◆ EnsureUnique()
|
inline |
Ensures that this string uniquely references its string data.
If necessary, this member function generates a duplicate of the string data, references it, and then decrements the reference counter of the original string data.
- See also
- IsUnique(), IsAliasOf()
◆ Fill() [1/2]
|
inline |
Fills this string (if not empty) with the specified character c.
- Note
- The null terminating character can legally be specified as a filling character with this function. In this case the internal string pointer will be seen as an empty string by C library routines (such as strlen or strcpy) and other applications after calling this function, although it will continue storing the same allocated data block.
◆ Fill() [2/2]
|
inline |
Fills a segment of at most n contiguous characters in this string with the specified character c, starting from the i-th character.
If i is greater than or equal to the length of this string, then calling this function has no effect. Otherwise the character count n will be constrained to replace existing characters in this string.
- Note
- The null terminating character can legally be specified as a filling character with this function. In this case the internal string pointer will be seen as an empty string by C library routines (such as strlen or strcpy) and other applications after calling this function, although it will continue storing the same allocated data block.
Definition at line 1427 of file String.h.
References pcl::Min().
◆ Find() [1/3]
|
inlinenoexcept |
◆ Find() [2/3]
|
inlinenoexcept |
◆ Find() [3/3]
|
inlinenoexcept |
◆ FindFirst() [1/3]
|
inlinenoexcept |
◆ FindFirst() [2/3]
|
inlinenoexcept |
Returns the starting index k of the first occurrence of a substring s in this string, such that k >= i. Returns notFound if such occurrence does not exist.
Definition at line 3002 of file String.h.
References pcl::GenericString< T, R, A >::Length().
◆ FindFirst() [3/3]
|
inlinenoexcept |
◆ FindFirstIC() [1/3]
|
inlinenoexcept |
◆ FindFirstIC() [2/3]
|
inlinenoexcept |
Returns the starting index k of the first occurrence of a substring s in this string, such that k >= i. Returns notFound if such occurrence does not exist.
This member function performs case-insensitive string comparisons to find an instance of the substring s.
Definition at line 3043 of file String.h.
References pcl::GenericString< T, R, A >::Length().
◆ FindFirstIC() [3/3]
|
inlinenoexcept |
Returns the starting index k of the first occurrence of a null-terminated substring s in this string, such that k >= i. Returns notFound if such occurrence does not exist.
This member function performs case-insensitive string comparisons to find an instance of the substring s.
◆ FindIC() [1/3]
|
inlinenoexcept |
◆ FindIC() [2/3]
|
inlinenoexcept |
◆ FindIC() [3/3]
|
inlinenoexcept |
◆ FindLast() [1/3]
|
inlinenoexcept |
Returns the index k of the last occurrence of a character c in this string, such that k < r. Returns notFound if such occurrence does not exist.
Definition at line 3170 of file String.h.
References pcl::Min().
◆ FindLast() [2/3]
|
inlinenoexcept |
Returns the starting index k of the last occurrence of a substring s in this string, such that:
k <= r - n,
where n is the length of the substring s. Returns notFound if such occurrence does not exist.
Definition at line 3142 of file String.h.
References pcl::Min().
◆ FindLast() [3/3]
|
inlinenoexcept |
Returns the starting index k of the last occurrence of a null-terminated substring t in this string, such that:
0 <= k <= r - n,
where n is the length of the substring t. Returns notFound if such occurrence does not exist.
Definition at line 3158 of file String.h.
References pcl::Min().
◆ FindLastIC() [1/3]
|
inlinenoexcept |
Returns the index k of the last occurrence of a character c in this string, such that k < r. Returns notFound if such occurrence does not exist.
This member function performs case-insensitive character comparisons to find an instance of the specified character c.
Definition at line 3226 of file String.h.
References pcl::Min().
◆ FindLastIC() [2/3]
|
inlinenoexcept |
Returns the starting index k of the last occurrence of a substring s in this string, such that:
k <= r - n,
where n is the length of the substring s. Returns notFound if such occurrence does not exist.
This member function performs case-insensitive string comparisons to find an instance of the specified substring s.
Definition at line 3192 of file String.h.
References pcl::Min().
◆ FindLastIC() [3/3]
|
inlinenoexcept |
Returns the starting index k of the last occurrence of a null-terminated substring t in this string, such that:
0 <= k <= r - n,
where n is the length of the substring t. Returns notFound if such occurrence does not exist.
This member function performs case-insensitive string comparisons to find an instance of the specified substring t.
Definition at line 3211 of file String.h.
References pcl::Min().
◆ FirstChar()
|
inlinenoexcept |
◆ Hash()
|
inlinenoexcept |
Returns a non-cryptographic hash value computed for this string. This function is a synonym for Hash64().
Definition at line 4272 of file String.h.
References pcl::Hash64().
◆ Hash32()
|
inlinenoexcept |
Returns a 32-bit non-cryptographic hash value computed for this string.
This function calls pcl::Hash32() for the internal string buffer.
The seed parameter can be used to generate repeatable hash values. It can also be set to a random value in compromised environments.
Definition at line 4263 of file String.h.
References pcl::Hash32().
Referenced by pcl::CryptographicHashFactory::CryptographicHashFactory().
◆ Hash64()
|
inlinenoexcept |
Returns a 64-bit non-cryptographic hash value computed for this string.
This function calls pcl::Hash64() for the internal string buffer.
The seed parameter can be used to generate repeatable hash values. It can also be set to a random value in compromised environments.
Definition at line 4250 of file String.h.
References pcl::Hash64().
◆ HasWildcards()
|
inlinenoexcept |
◆ IndexAt()
|
inlinenoexcept |
Returns the zero-based character index corresponding to a valid iterator i in this string. This is equivalent to i - Begin().
The specified iterator must be posterior to or located at the starting iterator of this string, as returned by Begin(). However, for performance reasons this condition is neither enforced nor verified. If an invalid iterator is specified, then this function, as well as any subsequent use of the returned character index, may invoke undefined behavior.
◆ Insert() [1/5]
|
inline |
◆ Insert() [2/5]
|
inline |
Inserts a copy of the string s at the index i in this string.
Definition at line 1696 of file String.h.
References pcl::GenericString< T, R, A >::Length().
◆ Insert() [3/5]
|
inline |
◆ Insert() [4/5]
|
inline |
Inserts at most the first n characters of a null-terminated character sequence t at the index i in this string.
Definition at line 1741 of file String.h.
References pcl::Min().
◆ Insert() [5/5]
|
inline |
◆ IsAliasOf()
|
inlinenoexcept |
Returns true iff this string is an alias of another string s.
Two strings are aliases if both share the same string data.
- See also
- IsUnique(), EnsureUnique()
◆ IsEmpty()
|
inlinenoexcept |
Returns true only if this string is empty.
An empty string has zero length and stores no characters.
- See also
- IsValid(), Length(), Available(), Capacity(), Size()
Definition at line 830 of file String.h.
Referenced by pcl::File::File(), pcl::GaiaDatabaseFile::GaiaDatabaseFile(), pcl::FITSHeaderKeyword::IsNull(), pcl::XML::IsValidName(), pcl::File::Error::Message(), pcl::AstrometricMetadata::ReferenceSystem(), pcl::XMLAttributeList::SetAttribute(), pcl::FileDataCache::SetTokenSeparator(), and pcl::FITSHeaderKeyword::StripValueDelimiters().
◆ IsNumeral()
|
inlinenoexcept |
Returns true iff this string can be interpreted as a numeric literal:
- The string is not empty.
- It is not exclusively composed of trimable characters.
- Its first non-trimable character is either a sign character, a decimal digit, or a decimal separator.
- Note
- This member function does not guarantee that this string contains a valid numeric literal. It only checks for the role of this string as a token in the context of a syntactic analysis.
Definition at line 4153 of file String.h.
Referenced by pcl::FITSHeaderKeyword::IsNumeric().
◆ IsSymbol()
|
inlinenoexcept |
Returns true iff this string can be interpreted as a symbol identifier:
- The string is not empty.
- It is not exclusively composed of trimable characters.
- Its first non-trimable character is either an alphabetic character or an underscore character.
- Note
- This member function does not guarantee that this string contains a valid symbol identifier. It only checks for the role of this string as a token in the context of a syntactic analysis.
◆ IsUnique()
|
inlinenoexcept |
Returns true iff this string uniquely references its string data.
- See also
- EnsureUnique(), IsAliasOf()
◆ IsValid()
|
inlinenoexcept |
Returns true only if this string is valid. A string is valid if it references an internal string structure, even if it is an empty string.
In general, all GenericString objects are valid with only two exceptions:
- Objects that have been move-copied or move-assigned to other strings.
- Objects that have been invalidated explicitly by calling Transfer().
An invalid string object cannot be used and should be destroyed immediately. Invalid strings are always destroyed automatically during move construction and move assignment operations.
- See also
- IsEmpty()
◆ IsValidIdentifier() [1/2]
|
inlinenoexcept |
Returns true only if this string contains a valid identifier:
- It is not an empty string.
- Its first character is either an alphabetic character or an underscore character.
- Its second and successive characters, if they exist, are all of them either alphabetic characters, decimal digits, or underscores.
◆ IsValidIdentifier() [2/2]
|
inlinenoexcept |
Returns true only if this string contains a valid identifier:
- It is not an empty string.
- Its first character is either an alphabetic character or an underscore character.
- Its second and successive characters, if they exist, are all of them either alphabetic characters, decimal digits, or underscores.
If this string is not a valid identifier, the pos variable will be set equal to the index of the first offending character (the first character that violates the above conditions).
◆ JustifyCenter()
|
inline |
Pads this string equally to the left and right, using the specified fill character, up to the specified width.
If the current length n of this string is less than the specified width, let m = width - n, and let m2 = m/2. Then m2 copies of the fill character will be prepended to the string, and m - m2 fill characters will be appended. If the current length is greater than or equal to width, this function has no effect.
- See also
- JustifyLeft(), JustifyRight(), CenterJustified()
Definition at line 3577 of file String.h.
Referenced by pcl::GenericString< T, R, A >::CenterJustified().
◆ JustifyLeft()
|
inline |
Pads this string to the right, using the specified fill character, up to the specified width.
If the current length n of this string is less than the specified width, width - n copies of the fill character will be appended to the string. If the current length is greater than or equal to width, this function has no effect.
- See also
- JustifyRight(), JustifyCenter(), LeftJustified()
Definition at line 3540 of file String.h.
Referenced by pcl::GenericString< T, R, A >::LeftJustified().
◆ JustifyRight()
|
inline |
Pads this string to the left, using the specified fill character, up to the specified width.
If the current length n of this string is less than the specified width, width - n copies of the fill character will be prepended to the string. If the current length is greater than or equal to width, this function has no effect.
- See also
- JustifyLeft(), JustifyCenter(), RightJustified()
Definition at line 3558 of file String.h.
Referenced by pcl::GenericString< T, R, A >::RightJustified().
◆ LastChar()
|
inlinenoexcept |
◆ Left()
|
inline |
Returns a string with a copy of the at most n contiguous initial characters of this string.
Definition at line 2318 of file String.h.
References pcl::Min().
◆ LeftJustified()
|
inline |
Returns a duplicate of this string padded to the right, using the specified fill character, up to the specified width.
- See also
- JustifyLeft(), RightJustified(), CenterJustified()
Definition at line 3595 of file String.h.
References pcl::GenericString< T, R, A >::JustifyLeft().
◆ Length()
|
inlinenoexcept |
Returns the length of this string in characters. This excludes the terminating null character.
- See also
- IsEmpty(), Available(), Capacity(), Size()
Definition at line 772 of file String.h.
Referenced by pcl::String::Assign(), pcl::GenericString< T, R, A >::DeleteString(), pcl::GenericString< T, R, A >::DeleteStringIC(), pcl::GenericString< T, R, A >::FindFirst(), pcl::GenericString< T, R, A >::FindFirstIC(), pcl::GenericString< T, R, A >::Insert(), pcl::GenericString< T, R, A >::Replace(), pcl::GenericString< T, R, A >::ReplaceString(), pcl::GenericString< T, R, A >::ReplaceStringIC(), and pcl::FITSHeaderKeyword::StripValueDelimiters().
◆ LowerBound()
|
inlinenoexcept |
Returns the minimum valid character index.
This member function exists for compatibility with PCL containers. It always returns zero.
- See also
- UpperBound(), Length()
◆ Lowercase()
|
inline |
Returns a duplicate of this string with all uppercase characters replaced with their lowercase counterparts.
Definition at line 4046 of file String.h.
References pcl::GenericString< T, R, A >::ToLowercase().
◆ operator*() [1/2]
|
inline |
Returns a reference to the first character in this string.
This is a convenience member function, equivalent to *At( 0 ).
- See also
- operator []( size_type ), At()
◆ operator*() [2/2]
|
inlinenoexcept |
Returns a copy of the first character in this string.
This is a convenience member function, equivalent to *At( 0 ).
- See also
- operator []( size_type ) const, At()
◆ operator+=() [1/3]
|
inline |
◆ operator+=() [2/3]
|
inline |
◆ operator+=() [3/3]
|
inline |
◆ operator-=() [1/3]
|
inline |
◆ operator-=() [2/3]
|
inline |
◆ operator-=() [3/3]
|
inline |
◆ operator=() [1/4]
|
inline |
◆ operator=() [2/4]
|
inline |
◆ operator=() [3/4]
|
inline |
◆ operator=() [4/4]
|
inline |
Move assignment operator. Returns a reference to this object.
This operator calls Transfer() with the specified source string s.
◆ operator[]() [1/2]
|
inline |
Returns a reference to the i-th character in this string. The character index i must be in the range [0,Length()).
If this string is not unique, it is made unique before returning from this member function.
If this string is empty, or if the specified index i is out of range, calling this member function is an error that leads to an invalid result.
- See also
- At(), operator *()
◆ operator[]() [2/2]
|
inlinenoexcept |
Returns a copy of the i-th character in this string. The character index i must be in the range [0,Length()).
If this string is empty, or if the specified index i is out of range, calling this member function is an error that leads to an invalid result.
- See also
- At() const, operator *() const
◆ Prefix()
|
inline |
Returns the prefix of this string ending at index i. Calling this member function is equivalent to:
◆ Prepend() [1/5]
|
inline |
◆ Prepend() [2/5]
|
inline |
Inserts a copy of the specified string s at the beginning of this string.
Definition at line 1890 of file String.h.
Referenced by pcl::operator+().
◆ Prepend() [3/5]
|
inline |
◆ Prepend() [4/5]
|
inline |
◆ Prepend() [5/5]
|
inline |
◆ Release()
|
inline |
Releases the data in this string.
This member function returns a pointer to the string data block referenced by this object, after ensuring that it is uniquely referenced. If the string is empty, this function may return the null pointer.
Before returning, this member function empties this string without deallocating its string data. The caller is then responsible for destructing and/or deallocating the returned block when it is no longer required.
◆ Replace() [1/3]
|
inline |
Replaces a segment of at most n contiguous characters, starting at the i-th character in this string, with nc copies of a character c.
Definition at line 2043 of file String.h.
References pcl::Min().
◆ Replace() [2/3]
|
inline |
Replaces a segment of n contiguous characters, starting at the i-th character in this string, with a copy of a string s.
Definition at line 1969 of file String.h.
References pcl::GenericString< T, R, A >::Length(), and pcl::Min().
◆ Replace() [3/3]
|
inline |
Replaces a segment of at most n contiguous characters, starting at the i-th character in this string, with a copy of a null-terminated sequence t.
If t is a pointer to the contents of this string (or, equivalently, an iterator on this string), this function invokes undefined behavior.
Definition at line 2008 of file String.h.
References pcl::Min().
◆ ReplaceChar()
◆ ReplaceCharIC()
◆ ReplaceString() [1/2]
|
inline |
Replaces all occurrences of a string s1 with s2 in a segment of contiguous characters starting at the i-th character, and spanning to the end of this string.
Definition at line 2101 of file String.h.
References pcl::GenericString< T, R, A >::Length().
◆ ReplaceString() [2/2]
|
inline |
◆ ReplaceStringIC() [1/2]
|
inline |
Replaces all occurrences of a string s1 with s2 in a segment of contiguous characters starting at the i-th character, and spanning to the end of this string.
This member function performs case-insensitive string comparisons.
Definition at line 2125 of file String.h.
References pcl::GenericString< T, R, A >::Length().
◆ ReplaceStringIC() [2/2]
|
inline |
◆ Reserve()
|
inline |
◆ ResizedToNullTerminated()
|
inline |
Returns a copy of this string resized to match the length of its internal null-terminated string buffer.
Definition at line 1578 of file String.h.
References pcl::GenericString< T, R, A >::ResizeToNullTerminated().
◆ ResizeToNullTerminated()
|
inline |
Resizes this string to match the length of the internal null-terminated string buffer.
This member function scans the internal string buffer for a terminating null character, then calls SetLength() to set the corresponding length in characters.
Definition at line 1569 of file String.h.
Referenced by pcl::GenericString< T, R, A >::ResizedToNullTerminated().
◆ Reverse()
|
inline |
Transposes the characters in this string, so that the first character becomes the last and the last becomes the first, the second becomes the next-to-last, and so on.
Definition at line 4069 of file String.h.
Referenced by pcl::GenericString< T, R, A >::Reversed().
◆ ReverseBegin() [1/2]
|
inline |
Returns a reverse mutable iterator pointing to the reverse beginning of this string. The returned iterator points to the last character of this string.
If this string is not unique, it is made unique before returning from this member function.
If this string is empty, this member function returns a null reverse iterator.
- See also
- ReverseEnd()
◆ ReverseBegin() [2/2]
|
inlinenoexcept |
Returns an immutable reverse iterator pointing to the reverse beginning of this string. The returned iterator points to the last character of this string.
If this string is empty, this member function returns a null reverse iterator.
- See also
- ReverseEnd() const
◆ Reversed()
|
inline |
Returns a duplicate of this string with its characters in reverse order.
Definition at line 4082 of file String.h.
References pcl::GenericString< T, R, A >::Reverse().
◆ ReverseEnd() [1/2]
|
inline |
Returns a reverse mutable iterator pointing to the reverse end of this string. The returned iterator points to the previous-to-first character of this string.
If this string is not unique, it is made unique before returning from this member function.
If this string is empty, this member function returns a null reverse iterator.
- See also
- ReverseBegin()
◆ ReverseEnd() [2/2]
|
inlinenoexcept |
Returns an immutable reverse iterator pointing to the reverse end of this string. The returned iterator points to the previous-to-first character of this string.
If this string is empty, this member function returns a null reverse iterator.
- See also
- ReverseBegin() const
◆ Right()
|
inline |
Returns a string with a copy of the at most n contiguous ending characters of this string.
Definition at line 2340 of file String.h.
References pcl::Min().
◆ RightJustified()
|
inline |
Returns a duplicate of this string padded to the left, using the specified fill character, up to the specified width.
- See also
- JustifyRight(), LeftJustified(), CenterJustified()
Definition at line 3608 of file String.h.
References pcl::GenericString< T, R, A >::JustifyRight().
◆ SecureFill()
|
inlinenoexcept |
Securely fills this string and all instances sharing its string data with the specified character c.
If no filling character c is specified, the string will be filled with zeros, or null characters.
The normal data sharing mechanism is ignored on purpose by this function, so if there are other objects sharing the same string data, all of them will be affected unconditionally after calling this function.
This function is useful to ensure that sensitive data, such as user passwords and user names, are destroyed without the risk of surviving duplicates as a result of implicit data sharing.
- Note
- If the specified filling character c is zero, or the null character (the default value), the internal string pointer will be seen as an empty string by C library routines (such as strlen or strcpy) and other applications after calling this function, although it will continue storing the same allocated data block.
Definition at line 1466 of file String.h.
Referenced by pcl::AES256::AES256().
◆ SetAllocator()
|
inline |
Sets the allocator object used by this string to a copy of the specified allocator a.
If this string is not unique, it is made unique before returning from this member function.
- See also
- Allocator()
◆ SetLength()
|
inline |
Causes this string to have the specified length n in characters.
If n is zero, this function calls Clear() to empty the string. Otherwise the string data will be shrunk or extended, and possibly reallocated. If the resulting string is larger than the original, newly allocated or reserved characters won't be initialized and will have unpredictable values; in this case it is the caller's responsibility to write them as appropriate.
After calling this member function, this object is guaranteed to uniquely reference its string data.
Definition at line 1523 of file String.h.
Referenced by pcl::GenericString< T, R, A >::SetToLength(), and pcl::IsoString::ToString().
◆ SetToLength()
|
inline |
Returns a copy of this string resized to have the specified length n in characters. This function is a wrapper for SetLength(); see that function for important information.
Definition at line 1553 of file String.h.
References pcl::GenericString< T, R, A >::SetLength().
◆ SingleQuoted()
|
inline |
Returns a duplicate of this string enclosed by single quote characters ('). If this string is already single quoted, this function returns an unmodified copy.
- See also
- EnsureSingleQuoted()
Definition at line 3454 of file String.h.
References pcl::GenericString< T, R, A >::EnsureSingleQuoted().
◆ Size()
|
inlinenoexcept |
Returns the total number of bytes required to store the string data referenced by this string, excluding the terminating null character.
- See also
- Length(), Capacity()
◆ Sort() [1/2]
|
inline |
Sorts the characters of this string in ascending order.
Definition at line 4092 of file String.h.
References pcl::Sort().
Referenced by pcl::GenericString< T, R, A >::Sorted().
◆ Sort() [2/2]
|
inline |
Sorts the characters of this string in ascending order. Ordering is defined such that for any pair a, b of characters, the specified binary predicate p( a, b ) is true if a precedes b.
Definition at line 4118 of file String.h.
References pcl::Sort().
◆ Sorted() [1/2]
|
inline |
Returns a duplicate of this string with its characters sorted in ascending order.
Definition at line 4105 of file String.h.
References pcl::GenericString< T, R, A >::Sort().
◆ Sorted() [2/2]
|
inline |
Returns a duplicate of this string with its characters sorted in ascending order with the specified binary predicate p.
Definition at line 4132 of file String.h.
References pcl::GenericString< T, R, A >::Sort().
◆ Squeeze()
|
inline |
Causes this string to allocate the exact required memory space to store its contained characters, plus a terminating null character.
If the string has excess capacity, a new copy of its existing characters is generated and stored in a newly allocated memory block that fits them exactly, then the previous memory block is deallocated.
If the string is empty, calling this function is equivalent to Clear(). Note that in this case a previously allocated memory block (by a call to Reserve()) may also be deallocated.
Definition at line 1597 of file String.h.
Referenced by pcl::GenericString< T, R, A >::Squeezed().
◆ Squeezed()
|
inline |
Returns a copy of this string allocated to the exact required memory space to store its contained characters and a terminating null character.
Definition at line 1628 of file String.h.
References pcl::GenericString< T, R, A >::Squeeze().
◆ StartsWith() [1/3]
|
inlinenoexcept |
◆ StartsWith() [2/3]
|
inlinenoexcept |
Returns true iff this string begins with the specified substring s.
Definition at line 2846 of file String.h.
Referenced by pcl::FITSHeaderKeyword::IsString().
◆ StartsWith() [3/3]
|
inlinenoexcept |
◆ StartsWithIC() [1/3]
|
inlinenoexcept |
◆ StartsWithIC() [2/3]
|
inlinenoexcept |
◆ StartsWithIC() [3/3]
|
inlinenoexcept |
◆ Substring()
|
inline |
Returns a string with a copy of at most n contiguous characters starting at the i-th character in this string.
Definition at line 2293 of file String.h.
References pcl::Min().
Referenced by pcl::GenericString< T, R, A >::Assign().
◆ Suffix()
|
inline |
Returns the suffix of this string starting at index i. Calling this member function is equivalent to:
◆ Swap()
|
inlinenoexcept |
Exchanges this string with another string s.
Definition at line 1384 of file String.h.
References pcl::Swap().
◆ ToCaseFolded()
|
inline |
Replaces all characters in this string with their case folded counterparts.
Definition at line 3993 of file String.h.
Referenced by pcl::GenericString< T, R, A >::CaseFolded().
◆ ToLowercase()
|
inline |
Replaces all uppercase characters in this string with their lowercase counterparts.
Definition at line 4007 of file String.h.
Referenced by pcl::GenericString< T, R, A >::Lowercase().
◆ ToUppercase()
|
inline |
Replaces all lowercase characters in this string with their uppercase counterparts.
Definition at line 4021 of file String.h.
Referenced by pcl::GenericString< T, R, A >::Uppercase().
◆ Transfer() [1/2]
|
inline |
Transfers data from another object s to this string.
See Transfer( GenericString& ) for detailed information.
◆ Transfer() [2/2]
|
inline |
Transfers data from another object s to this string.
Decrements the reference counter of the current string data. If the data becomes unreferenced, it is destroyed and deallocated. The string data referenced by the source object s is then transferred to this object.
- Warning
- The source string s will be an invalid object after calling this function, and hence should be destroyed immediately. Any attempt to access an invalid object will most likely lead to a crash.
- See also
- Assign()
◆ Trim()
|
inline |
Removes all leading and trailing trimable characters.
Trimable characters are determined by the traits class R. A character c is trimable if R::IsTrimable( c ) is true. Generally, the set of trimable characters corresponds to the set of white space characters.
- See also
- Trimmed();
Definition at line 3304 of file String.h.
Referenced by pcl::FITSHeaderKeyword::Trim(), and pcl::GenericString< T, R, A >::Trimmed().
◆ TrimLeft()
|
inline |
Removes all leading trimable characters.
Trimable characters are determined by the traits class R. A character c is trimable if R::IsTrimable( c ) is true. Generally, the set of trimable characters corresponds to the set of white space characters.
- See also
- TrimmedLeft();
Definition at line 3321 of file String.h.
Referenced by pcl::GenericString< T, R, A >::TrimmedLeft().
◆ Trimmed()
|
inline |
Returns a duplicate of this string with all leading and trailing trimable characters removed.
- See also
- Trim()
Definition at line 3349 of file String.h.
References pcl::GenericString< T, R, A >::Trim().
◆ TrimmedLeft()
|
inline |
Returns a duplicate of this string with all leading trimable characters removed.
- See also
- TrimLeft()
Definition at line 3361 of file String.h.
References pcl::GenericString< T, R, A >::TrimLeft().
◆ TrimmedRight()
|
inline |
Returns a duplicate of this string with all trailing trimable characters removed.
- See also
- TrimRight()
Definition at line 3373 of file String.h.
References pcl::GenericString< T, R, A >::TrimRight().
◆ TrimRight()
|
inline |
Removes all trailing trimable characters.
Trimable characters are determined by the traits class R. A character c is trimable if R::IsTrimable( c ) is true. Generally, the set of trimable characters corresponds to the set of white space characters.
- See also
- TrimmedRight();
Definition at line 3337 of file String.h.
Referenced by pcl::GenericString< T, R, A >::TrimmedRight().
◆ Unquote()
|
inline |
Unquotes this string.
If the string starts and ends with single quote characters, the result is the same string with the quotes removed and its length decremented by two. The same happens if the string starts and ends with double quote characters.
If the string does not start and end with the same quote character, this function has no effect.
- See also
- Unquoted()
Definition at line 3498 of file String.h.
Referenced by pcl::GenericString< T, R, A >::Unquoted().
◆ Unquoted()
|
inline |
Returns an unquoted duplicate of this string.
- See also
- Unquote()
Definition at line 3522 of file String.h.
References pcl::GenericString< T, R, A >::Unquote().
◆ UpperBound()
|
inlinenoexcept |
Returns the maximum valid character index.
The returned value is equal to Length()-1. If this string is empty, the index returned by this member function is invalid and equal to maxPos.
- See also
- LowerBound(), Length()
◆ Uppercase()
|
inline |
Returns a duplicate of this string with all lowercase characters replaced with their uppercase counterparts.
Definition at line 4057 of file String.h.
References pcl::GenericString< T, R, A >::ToUppercase().
◆ WildMatch() [1/2]
|
inlinenoexcept |
Wildcard string matching.
- Parameters
-
pattern The pattern string. May contain multiple instances of the wildcard characters '*' and '?'. caseSensitive When true, a case-sensitive comparison is performed; otherwise the comparison does not distinguish between lowercase and uppercase characters. The default value is true.
Returns true iff this string matches the specified pattern. If either this string or the pattern is empty, this function always returns false conventionally, even if the pattern is a single asterisk '*'.
◆ WildMatch() [2/2]
|
inlinenoexcept |
Wildcard string matching with a null-terminated pattern.
- Parameters
-
pattern The pattern string. May contain multiple instances of the wildcard characters '*' and '?'. caseSensitive When true, a case-sensitive comparison is performed; otherwise the comparison does not distinguish between lowercase and uppercase characters. The default value is true.
Returns true iff this string matches the specified pattern. If either this string or the pattern is empty, this function always returns false conventionally, even if the pattern is a single asterisk '*'.
◆ WildMatchIC() [1/2]
|
inlinenoexcept |
Wildcard string matching (case-insensitive).
- Parameters
-
pattern The pattern string. May contain multiple instances of the wildcard characters '*' and '?'.
This function performs case-insensitive comparisons between string and non-wild pattern characters.
Returns true iff this string matches the specified pattern. If either this string or the pattern is empty, this function always returns false conventionally, even if the pattern is a single asterisk '*'.
◆ WildMatchIC() [2/2]
|
inlinenoexcept |
Wildcard string matching with a null-terminated pattern (case-insensitive).
- Parameters
-
pattern The pattern string. May contain multiple instances of the wildcard characters '*' and '?'.
This function performs case-insensitive comparisons between string and non-wild pattern characters.
Returns true iff this string matches the specified pattern. If either this string or the pattern is empty, this function always returns false conventionally, even if the pattern is a single asterisk '*'.
Member Data Documentation
◆ maxPos
|
static |
◆ notFound
|
static |
The documentation for this class was generated from the following file:
