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