doxygen: add newline after \file
[blender.git] / intern / string / STR_String.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup string
22  */
23
24
25 /**
26
27  * Copyright (C) 2001 NaN Technologies B.V.
28  * This file was formerly known as: GEN_StdString.h.
29  * @date        April, 25, 2001
30  */
31
32 #ifndef __STR_STRING_H__
33 #define __STR_STRING_H__
34
35 #ifndef STR_NO_ASSERTD
36 #undef  assertd
37 #define assertd(exp)                    ((void)NULL)
38 #endif
39
40 #include <vector>
41 #include <limits.h>
42
43 #include <cstring>
44 #include <cstdlib>
45
46 #ifdef WITH_CXX_GUARDEDALLOC
47 #include "MEM_guardedalloc.h"
48 #endif
49
50 #ifdef _WIN32
51 #define stricmp _stricmp
52 #endif
53
54 class STR_String;
55
56 typedef  unsigned long dword;
57 typedef const STR_String& rcSTR_String;
58 typedef unsigned char byte;
59
60 /**
61  * Smart String Value class. Is used by parser when an expression tree is build containing string.
62  */
63
64 class STR_String
65 {
66 public:
67         // Initialization
68         STR_String();
69         STR_String(char c);
70         STR_String(char c, int len);
71         STR_String(const char *str);
72         STR_String(const char *str, int len);
73         STR_String(const STR_String &str);
74         STR_String(const STR_String & str, int len);
75         STR_String(const char *src1, int src1_len, const char *src2, int src2_len);
76         explicit STR_String(int val);
77         explicit STR_String(dword val);
78         explicit STR_String(float val);
79         explicit STR_String(double val);
80         inline ~STR_String()                                                                                    { delete[] this->m_data; }
81
82         // Operations
83         STR_String&                     Format(const char *fmt, ...)                            // Set formatted text to string
84 #ifdef __GNUC__
85         __attribute__ ((format(printf, 2, 3)))
86 #endif
87         ;
88         STR_String&                     FormatAdd(const char *fmt, ...)                         // Add formatted text to string
89 #ifdef __GNUC__
90         __attribute__ ((format(printf, 2, 3)))
91 #endif
92         ;
93         inline void                     Clear()                                                                         { this->m_len = this->m_data[0] = 0; }
94         inline const STR_String & Reverse()
95         {
96                 for (int i1 = 0, i2 = this->m_len - 1; i1 < i2; i1++, i2--) {
97                         std::swap(this->m_data[i1], this->m_data[i2]);
98                 }
99                 return *this;
100         }
101
102         // Properties
103         bool                            IsUpper() const;
104         bool                            IsLower() const;
105         inline bool                     IsEmpty() const                                                         { return this->m_len == 0; }
106         inline int                      Length() const                                                          { return this->m_len; }
107
108         // Data access
109         inline STR_String&      SetLength(int len)                                                      { AllocBuffer(len, true); this->m_len = len; this->m_data[len] = 0; return *this; }
110         inline char                     GetAt(int pos) const                                            { assertd(pos<this->m_len); return this->m_data[pos]; }
111         inline void                     SetAt(int pos, char c)                                          { assertd(pos<this->m_len); this->m_data[pos] = c; }
112         inline void                     SetAt(int pos, rcSTR_String str);
113         inline void                     SetAt(int pos, int num, rcSTR_String str);
114         void                            Replace(int pos, rcSTR_String str);
115         void                            Replace(int pos, int num, rcSTR_String str);
116
117         // Substrings
118         inline STR_String       Left(int num) const                                                     { num = (num < this->m_len ? num:this->m_len ); return STR_String(this->m_data, num); }
119         inline STR_String       Right(int num) const                                            { num = (num < this->m_len ? num:this->m_len ); return STR_String(this->m_data + this->m_len - num, num); }
120         inline STR_String       Mid(int pos, int num = INT_MAX) const           { pos = (pos < this->m_len ? pos:this->m_len ); num = (num < (this->m_len - pos) ? num : (this->m_len - pos)); return STR_String(this->m_data + pos, num); }
121
122         // Comparison
123         int                                     Compare(rcSTR_String rhs) const;
124         int                                     CompareNoCase(rcSTR_String rhs) const;
125         inline bool                     IsEqual(rcSTR_String rhs) const                         { return (Compare(rhs) == 0); }
126         inline bool                     IsEqualNoCase(rcSTR_String rhs) const           { return (CompareNoCase(rhs) == 0); }
127
128         // Search/replace
129         int                                     Find(char c, int pos = 0) const;
130         int                                     Find(const char *str, int pos = 0) const;
131         int                                     Find(rcSTR_String str, int pos = 0) const;
132         int                                     RFind(char c) const;
133         int                                     FindOneOf(const char *set, int pos = 0) const;
134         int                                     RFindOneOf(const char *set, int pos = 0) const;
135
136         std::vector<STR_String> Explode(char c) const;
137
138         // Formatting
139         STR_String&                     Upper();
140         STR_String&                     Lower();
141         STR_String&                     Capitalize();
142         STR_String&                     TrimLeft();
143         STR_String&                     TrimLeft(char *set);
144         STR_String&                     TrimRight();
145         STR_String&                     TrimRight(char *set);
146         STR_String&                     Trim();
147         STR_String&                     Trim(char *set);
148         STR_String&                     TrimQuotes();
149
150         // Conversions
151 //      inline operator char*()                                                         { return this->m_data; }
152         inline operator const char *() const                            { return this->m_data; }
153         inline char *Ptr()                                                                      { return this->m_data; }
154         inline const char *ReadPtr() const                                      { return this->m_data; }
155         inline float    ToFloat() const                                         { float x=(float)(atof(this->m_data)); return x; }
156         inline int              ToInt() const                                           { return atoi(this->m_data); }
157
158         // Operators
159         inline rcSTR_String     operator=(const byte *rhs)              { return Copy((const char *)rhs, strlen((const char *)rhs)); }
160         inline rcSTR_String     operator=(rcSTR_String rhs)             { return Copy(rhs.ReadPtr(), rhs.Length()); }
161         inline rcSTR_String     operator=(char rhs)                             { return Copy(&rhs, 1); }
162         inline rcSTR_String     operator=(const char *rhs)              { return Copy(rhs, strlen(rhs)); }
163
164         inline rcSTR_String     operator+=(const char *rhs)             { return Concat(rhs, strlen(rhs)); }
165         inline rcSTR_String     operator+=(rcSTR_String rhs)    { return Concat(rhs.ReadPtr(), rhs.Length()); }
166         inline rcSTR_String     operator+=(char rhs)                    { return Concat(&rhs, 1); }
167
168
169         inline friend bool operator<(rcSTR_String      lhs, rcSTR_String     rhs)       { return (strcmp(lhs, rhs)<0); }
170         inline friend bool operator<(rcSTR_String      lhs, const char      *rhs)       { return (strcmp(lhs, rhs)<0); }
171         inline friend bool operator<(const char       *lhs, rcSTR_String     rhs)       { return (strcmp(lhs, rhs)<0); }
172         inline friend bool operator>(rcSTR_String      lhs, rcSTR_String     rhs)       { return (strcmp(lhs, rhs)>0); }
173         inline friend bool operator>(rcSTR_String      lhs, const char      *rhs)       { return (strcmp(lhs, rhs)>0); }
174         inline friend bool operator>(const char       *lhs, rcSTR_String     rhs)       { return (strcmp(lhs, rhs)>0); }
175         inline friend bool operator<=(rcSTR_String     lhs, rcSTR_String     rhs)       { return (strcmp(lhs, rhs)<=0); }
176         inline friend bool operator<=(rcSTR_String     lhs, const char      *rhs)       { return (strcmp(lhs, rhs)<=0); }
177         inline friend bool operator<=(const char      *lhs, rcSTR_String     rhs)       { return (strcmp(lhs, rhs)<=0); }
178         inline friend bool operator>=(rcSTR_String     lhs, rcSTR_String     rhs)       { return (strcmp(lhs, rhs)>=0); }
179         inline friend bool operator>=(rcSTR_String     lhs, const char      *rhs)       { return (strcmp(lhs, rhs)>=0); }
180         inline friend bool operator>=(const char      *lhs, rcSTR_String     rhs)       { return (strcmp(lhs, rhs)>=0); }
181         inline friend bool operator==(rcSTR_String     lhs, rcSTR_String     rhs)       { return ((lhs.Length() == rhs.Length()) && (memcmp(lhs, rhs, lhs.Length()) == 0)); }
182         inline friend bool operator==(rcSTR_String     lhs, const char      *rhs)       { return (strncmp(lhs, rhs, lhs.Length() + 1) == 0); }
183         inline friend bool operator==(const char      *lhs, rcSTR_String     rhs)       { return (strncmp(lhs, rhs, rhs.Length() + 1) == 0); }
184         inline friend bool operator!=(rcSTR_String     lhs, rcSTR_String     rhs)       { return ((lhs.Length() != rhs.Length()) || (memcmp(lhs, rhs, lhs.Length()) != 0)); }
185         inline friend bool operator!=(rcSTR_String     lhs, const char      *rhs)       { return (strncmp(lhs, rhs, lhs.Length() + 1) != 0); }
186         inline friend bool operator!=(const char       *lhs, rcSTR_String    rhs)       { return (strncmp(lhs, rhs, rhs.Length() + 1) != 0); }
187
188         // serializing
189         //int                   Serialize(pCStream stream);
190
191 protected:
192         // Implementation
193         void    AllocBuffer(int len, bool keep_contents);
194         rcSTR_String Copy(const char *src, int len);
195         rcSTR_String Concat(const char *data, int len);
196
197         static bool             isLower(char c)                                                                 { return !isUpper(c); }
198         static bool             isUpper(char c)                                                                 { return (c>='A') && (c <= 'Z'); }
199         static bool             isSpace(char c)                                                                 { return (c==' ') || (c=='\t'); }
200
201         char  *m_data;                                                                                                  // -> STR_String data
202         int    m_len;                                                                                                   //z Data length
203         int    m_max;                                                                                                   // Space in data buffer
204
205
206 #ifdef WITH_CXX_GUARDEDALLOC
207         MEM_CXX_CLASS_ALLOC_FUNCS("CXX:STR_String")
208 #endif
209 };
210
211 inline  STR_String operator+(rcSTR_String    lhs, rcSTR_String rhs)     { return STR_String(lhs.ReadPtr(), lhs.Length(), rhs.ReadPtr(), rhs.Length()); }
212 inline  STR_String operator+(rcSTR_String    lhs, char         rhs)     { return STR_String(lhs.ReadPtr(), lhs.Length(), &rhs, 1); }
213 inline  STR_String operator+(char            lhs, rcSTR_String rhs)     { return STR_String(&lhs, 1, rhs.ReadPtr(), rhs.Length()); }
214 inline  STR_String operator+(rcSTR_String    lhs, const char  *rhs)     { return STR_String(lhs.ReadPtr(), lhs.Length(), rhs, strlen(rhs)); }
215 inline  STR_String operator+(const char     *lhs, rcSTR_String rhs)     { return STR_String(lhs, strlen(lhs), rhs.ReadPtr(), rhs.Length()); }
216
217 #endif //__STR_STRING_H__