optionally use guarded alloc for tiles compositor, also replace allocation functions...
[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[] pData; }
89
90         // Operations
91         STR_String&                     Format(const char *fmt, ...);                           // Set formatted text to string
92         STR_String&                     FormatAdd(const char *fmt, ...);                        // Add formatted text to string
93         inline void                     Clear()                                                                         { Len = pData[0] = 0; }
94         inline const STR_String & Reverse()
95         {
96                 for (int i1 = 0, i2 = Len - 1; i1 < i2; i1++, i2--) {
97                         std::swap(pData[i1], pData[i2]);
98                 }
99                 return *this;
100         }
101
102         // Properties
103         bool                            IsUpper() const;
104         bool                            IsLower() const;
105         inline bool                     IsEmpty() const                                                         { return Len==0; }
106         inline int                      Length() const                                                          { return Len; }
107
108         // Data access
109         inline STR_String&      SetLength(int len)                                                      { AllocBuffer(len, true); Len=len; pData[len]=0; return *this; }
110         inline char                     GetAt(int pos) const                                            { assertd(pos<Len); return pData[pos]; }
111         inline void                     SetAt(int pos, char c)                                          { assertd(pos<Len); pData[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 < Len ? num:Len ); return STR_String(pData, num); }
119         inline STR_String       Right(int num) const                                                    { num = (num < Len ? num:Len ); return STR_String(pData+Len-num, num); }
120         inline STR_String       Mid(int pos, int num = INT_MAX) const                   { pos = (pos < Len ? pos:Len ); num = (num < (Len - pos) ? num : (Len - pos)); return STR_String(pData+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 pData; }
152         inline operator const char *() const                                                            { return pData; }
153         inline char *Ptr()                                                                                                      { return pData; }
154         inline const char *ReadPtr() const                                                                      { return pData; }
155         inline float    ToFloat() const                                                                         { float x=(float)(atof(pData)); return x; }
156         inline int              ToInt() const                                                                           { return atoi(pData); }
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 (memcmp(lhs, rhs, lhs.Length()+1)==0); }
183         inline friend bool operator==(const char        *lhs, rcSTR_String     rhs)     { return (memcmp(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 (memcmp(lhs, rhs, lhs.Length()+1)!=0); }
186         inline friend bool operator!=(const char        *lhs, rcSTR_String     rhs)     { return (memcmp(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   *pData;                                                                                                  // -> STR_String data
202         int        Len;                                                                                                         // Data length
203         int        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
218 #endif //__STR_STRING_H__
219