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