1 // © 2016 and later: Unicode, Inc. and others. 2 // License & terms of use: http://www.unicode.org/copyright.html 3 /* 4 ********************************************************************** 5 * Copyright (c) 2001-2015, International Business Machines 6 * Corporation and others. All Rights Reserved. 7 ********************************************************************** 8 * Date Name Description 9 * 11/19/2001 aliu Creation. 10 * 05/19/2010 markus Rewritten from scratch 11 ********************************************************************** 12 */ 13 14 #ifndef CHARSTRING_H 15 #define CHARSTRING_H 16 17 #include "unicode/utypes.h" 18 #include "unicode/unistr.h" 19 #include "unicode/uobject.h" 20 #include "cmemory.h" 21 22 U_NAMESPACE_BEGIN 23 24 // Windows needs us to DLL-export the MaybeStackArray template specialization, 25 // but MacOS X cannot handle it. Same as in digitlst.h. 26 #if !U_PLATFORM_IS_DARWIN_BASED 27 template class U_COMMON_API MaybeStackArray<char, 40>; 28 #endif 29 30 /** 31 * ICU-internal char * string class. 32 * This class does not assume or enforce any particular character encoding. 33 * Raw bytes can be stored. The string object owns its characters. 34 * A terminating NUL is stored, but the class does not prevent embedded NUL characters. 35 * 36 * This class wants to be convenient but is also deliberately minimalist. 37 * Please do not add methods if they only add minor convenience. 38 * For example: 39 * cs.data()[5]='a'; // no need for setCharAt(5, 'a') 40 */ 41 class U_COMMON_API CharString : public UMemory { 42 public: CharString()43 CharString() : len(0) { buffer[0]=0; } CharString(StringPiece s,UErrorCode & errorCode)44 CharString(StringPiece s, UErrorCode &errorCode) : len(0) { 45 buffer[0]=0; 46 append(s, errorCode); 47 } CharString(const CharString & s,UErrorCode & errorCode)48 CharString(const CharString &s, UErrorCode &errorCode) : len(0) { 49 buffer[0]=0; 50 append(s, errorCode); 51 } CharString(const char * s,int32_t sLength,UErrorCode & errorCode)52 CharString(const char *s, int32_t sLength, UErrorCode &errorCode) : len(0) { 53 buffer[0]=0; 54 append(s, sLength, errorCode); 55 } ~CharString()56 ~CharString() {} 57 58 /** 59 * Move constructor; might leave src in an undefined state. 60 * This string will have the same contents and state that the source string had. 61 */ 62 CharString(CharString &&src) U_NOEXCEPT; 63 /** 64 * Move assignment operator; might leave src in an undefined state. 65 * This string will have the same contents and state that the source string had. 66 * The behavior is undefined if *this and src are the same object. 67 */ 68 CharString &operator=(CharString &&src) U_NOEXCEPT; 69 70 /** 71 * Replaces this string's contents with the other string's contents. 72 * CharString does not support the standard copy constructor nor 73 * the assignment operator, to make copies explicit and to 74 * use a UErrorCode where memory allocations might be needed. 75 */ 76 CharString ©From(const CharString &other, UErrorCode &errorCode); 77 isEmpty()78 UBool isEmpty() const { return len==0; } length()79 int32_t length() const { return len; } 80 char operator[](int32_t index) const { return buffer[index]; } toStringPiece()81 StringPiece toStringPiece() const { return StringPiece(buffer.getAlias(), len); } 82 data()83 const char *data() const { return buffer.getAlias(); } data()84 char *data() { return buffer.getAlias(); } 85 86 /** @return last index of c, or -1 if c is not in this string */ 87 int32_t lastIndexOf(char c) const; 88 clear()89 CharString &clear() { len=0; buffer[0]=0; return *this; } 90 CharString &truncate(int32_t newLength); 91 92 CharString &append(char c, UErrorCode &errorCode); append(StringPiece s,UErrorCode & errorCode)93 CharString &append(StringPiece s, UErrorCode &errorCode) { 94 return append(s.data(), s.length(), errorCode); 95 } append(const CharString & s,UErrorCode & errorCode)96 CharString &append(const CharString &s, UErrorCode &errorCode) { 97 return append(s.data(), s.length(), errorCode); 98 } 99 CharString &append(const char *s, int32_t sLength, UErrorCode &status); 100 /** 101 * Returns a writable buffer for appending and writes the buffer's capacity to 102 * resultCapacity. Guarantees resultCapacity>=minCapacity if U_SUCCESS(). 103 * There will additionally be space for a terminating NUL right at resultCapacity. 104 * (This function is similar to ByteSink.GetAppendBuffer().) 105 * 106 * The returned buffer is only valid until the next write operation 107 * on this string. 108 * 109 * After writing at most resultCapacity bytes, call append() with the 110 * pointer returned from this function and the number of bytes written. 111 * 112 * @param minCapacity required minimum capacity of the returned buffer; 113 * must be non-negative 114 * @param desiredCapacityHint desired capacity of the returned buffer; 115 * must be non-negative 116 * @param resultCapacity will be set to the capacity of the returned buffer 117 * @param errorCode in/out error code 118 * @return a buffer with resultCapacity>=min_capacity 119 */ 120 char *getAppendBuffer(int32_t minCapacity, 121 int32_t desiredCapacityHint, 122 int32_t &resultCapacity, 123 UErrorCode &errorCode); 124 125 CharString &appendInvariantChars(const UnicodeString &s, UErrorCode &errorCode); 126 CharString &appendInvariantChars(const UChar* uchars, int32_t ucharsLen, UErrorCode& errorCode); 127 128 /** 129 * Appends a filename/path part, e.g., a directory name. 130 * First appends a U_FILE_SEP_CHAR if necessary. 131 * Does nothing if s is empty. 132 */ 133 CharString &appendPathPart(StringPiece s, UErrorCode &errorCode); 134 135 /** 136 * Appends a U_FILE_SEP_CHAR if this string is not empty 137 * and does not already end with a U_FILE_SEP_CHAR or U_FILE_ALT_SEP_CHAR. 138 */ 139 CharString &ensureEndsWithFileSeparator(UErrorCode &errorCode); 140 141 private: 142 MaybeStackArray<char, 40> buffer; 143 int32_t len; 144 145 UBool ensureCapacity(int32_t capacity, int32_t desiredCapacityHint, UErrorCode &errorCode); 146 147 CharString(const CharString &other); // forbid copying of this class 148 CharString &operator=(const CharString &other); // forbid copying of this class 149 }; 150 151 U_NAMESPACE_END 152 153 #endif 154 //eof 155