* merge r22734 from trunk
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 /**
30
31  * $Id$
32  * Copyright (C) 2001 NaN Technologies B.V.
33  * This file was formerly known as: GEN_StdString.h.
34  * @date        April, 25, 2001
35  */
36
37 #ifndef _STR_String_H_
38 #define _STR_String_H_
39
40 #ifndef STR_NO_ASSERTD
41 #undef  assertd
42 #define assertd(exp)                    ((void)NULL)
43 #endif
44
45 #include <vector>
46 #include <limits.h>
47
48 #include <cstring>
49 #include <cstdlib>
50
51 using namespace std;
52
53 #ifdef WITH_CXX_GUARDEDALLOC
54 #include "MEM_guardedalloc.h"
55 #endif
56
57 class STR_String;
58
59 typedef  unsigned long dword;
60 typedef const STR_String& rcSTR_String;
61 typedef unsigned char byte;
62
63 /**
64  *      Smart String Value class. Is used by parser when an expression tree is build containing string.
65 */
66
67 class STR_String
68 {
69 public:
70         // Initialization
71         STR_String();
72         STR_String(char c);
73         STR_String(char c, int len);
74         STR_String(const char *str);
75         STR_String(const char *str, int len);
76         STR_String(const STR_String &str);
77         STR_String(const STR_String & str, int len);
78         STR_String(const char *src1, int src1_len, const char *src2, int src2_len);
79         explicit STR_String(int val);
80         explicit STR_String(dword val);
81         explicit STR_String(float val);
82         explicit STR_String(double val);
83         inline ~STR_String()                                                                                            { delete[] pData; }
84
85         // Operations
86         STR_String&                     Format(const char *fmt, ...);                           // Set formatted text to string
87         STR_String&                     FormatAdd(const char *fmt, ...);                        // Add formatted text to string
88         inline void                     Clear()                                                                         { Len = pData[0] = 0; }
89         inline const STR_String & Reverse()                                                                     
90         { 
91             for (int i1=0, i2=Len-1; i1<i2; i1++, i2--) 
92                 swap(pData[i1], pData[i2]); return *this; 
93         }
94
95         // Properties
96         bool                            IsUpper() const;
97         bool                            IsLower() const;
98         inline bool                     IsEmpty() const                                                         { return Len==0; }
99         inline int                      Length() const                                                          { return Len; }
100
101         // Data access
102         inline STR_String&      SetLength(int len)                                                      { AllocBuffer(len, true); Len=len; pData[len]=0; return *this; }
103         inline char                     GetAt(int pos) const                                            { assertd(pos<Len); return pData[pos]; }
104         inline void                     SetAt(int pos, char c)                                          { assertd(pos<Len); pData[pos]=c; }
105         inline void                     SetAt(int pos, rcSTR_String str);
106         inline void                     SetAt(int pos, int num, rcSTR_String str);
107         void                            Replace(int pos, rcSTR_String str);
108         void                            Replace(int pos, int num, rcSTR_String str);
109
110         // Substrings
111         inline STR_String       Left(int num) const                                                             { num = (num < Len ? num:Len ); return STR_String(pData, num); }
112         inline STR_String       Right(int num) const                                                    { num = (num < Len ? num:Len ); return STR_String(pData+Len-num, num); }
113         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); }
114
115         // Comparison
116         int                             Compare(rcSTR_String rhs) const;
117         int                             CompareNoCase(rcSTR_String rhs) const;
118         inline bool             IsEqual(rcSTR_String rhs) const                                 { return (Compare(rhs)==0); }
119         inline bool             IsEqualNoCase(rcSTR_String rhs) const                           { return (CompareNoCase(rhs)==0); }
120
121         // Search/replace
122         int                             Find(char c, int pos = 0) const;
123         int                             Find(const char *str, int pos = 0) const;
124         int                             Find(rcSTR_String str, int pos = 0) const;
125         int                             RFind(char c) const;
126         int                             FindOneOf(const char *set, int pos = 0) const;
127         int                             RFindOneOf(const char *set, int pos = 0) const;
128
129         vector<STR_String>      Explode(char c) const;
130
131         // Formatting
132         STR_String&                     Upper();
133         STR_String&                     Lower();
134         STR_String&                     Capitalize();
135         STR_String&                     TrimLeft();
136         STR_String&                     TrimLeft(char *set);
137         STR_String&                     TrimRight();
138         STR_String&                     TrimRight(char *set);
139         STR_String&                     Trim();
140         STR_String&                     Trim(char *set);
141         STR_String&                     TrimQuotes();
142
143         // Conversions
144 //      inline operator char*()                                                                                         { return pData; }
145         inline operator const char *() const                                                            { return pData; }
146         inline char *Ptr()                                                                                                      { return pData; }
147         inline const char *ReadPtr() const                                                                      { return pData; }
148         inline float    ToFloat() const                                                                         { float x=(float)(atof(pData)); return x; }
149         inline int              ToInt() const                                                                           { return atoi(pData); }
150
151         // Operators
152         inline rcSTR_String     operator=(const byte *rhs)                                              { return Copy((const char *)rhs, strlen((const char *)rhs)); }
153         inline rcSTR_String     operator=(rcSTR_String rhs)                                             { return Copy(rhs.ReadPtr(), rhs.Length()); }
154         inline rcSTR_String     operator=(char rhs)                                                             { return Copy(&rhs, 1); }
155         inline rcSTR_String     operator=(const char *rhs)                                              { return Copy(rhs, strlen(rhs)); }
156
157         inline rcSTR_String     operator+=(const char *rhs)                                             { return Concat(rhs, strlen(rhs)); }
158         inline rcSTR_String     operator+=(rcSTR_String rhs)                                            { return Concat(rhs.ReadPtr(), rhs.Length()); }
159         inline rcSTR_String     operator+=(char rhs)                                                    { return Concat(&rhs, 1); }
160
161         
162         inline friend bool operator<(rcSTR_String      lhs, rcSTR_String                rhs)    { return (strcmp(lhs, rhs)<0); }
163         inline friend bool operator<(rcSTR_String      lhs, const char          *rhs)   { return (strcmp(lhs, rhs)<0); };
164         inline friend bool operator<(const char         *lhs, rcSTR_String     rhs)     { return (strcmp(lhs, rhs)<0); }
165         inline friend bool operator>(rcSTR_String      lhs, rcSTR_String                rhs)    { return (strcmp(lhs, rhs)>0); }
166         inline friend bool operator>(rcSTR_String      lhs, const char          *rhs)   { return (strcmp(lhs, rhs)>0); }
167         inline friend bool operator>(const char         *lhs, rcSTR_String     rhs)     { return (strcmp(lhs, rhs)>0); }
168         inline friend bool operator<=(rcSTR_String     lhs, rcSTR_String                rhs)    { return (strcmp(lhs, rhs)<=0); }
169         inline friend bool operator<=(rcSTR_String     lhs, const char          *rhs)   { return (strcmp(lhs, rhs)<=0); }
170         inline friend bool operator<=(const char        *lhs, rcSTR_String     rhs)     { return (strcmp(lhs, rhs)<=0); }
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 ((lhs.Length() == rhs.Length()) && (memcmp(lhs, rhs, lhs.Length())==0)); }
175         inline friend bool operator==(rcSTR_String     lhs, const char          *rhs)   { return (memcmp(lhs, rhs, lhs.Length()+1)==0); }
176         inline friend bool operator==(const char        *lhs, rcSTR_String     rhs)     { return (memcmp(lhs, rhs, rhs.Length()+1)==0); }
177         inline friend bool operator!=(rcSTR_String     lhs, rcSTR_String                rhs)    { return ((lhs.Length() != rhs.Length()) || (memcmp(lhs, rhs, lhs.Length())!=0)); }
178         inline friend bool operator!=(rcSTR_String     lhs, const char          *rhs)   { return (memcmp(lhs, rhs, lhs.Length()+1)!=0); }
179         inline friend bool operator!=(const char        *lhs, rcSTR_String     rhs)     { return (memcmp(lhs, rhs, rhs.Length()+1)!=0); }
180
181         // serializing
182         //int                   Serialize(pCStream stream);
183
184 protected:
185         // Implementation
186         void    AllocBuffer(int len, bool keep_contents);
187         rcSTR_String Copy(const char *src, int len);
188         rcSTR_String Concat(const char *data, int len);
189
190         static bool             isLower(char c)                                                                 { return !isUpper(c); }
191         static bool             isUpper(char c)                                                                 { return (c>='A') && (c <= 'Z'); }
192         static bool             isSpace(char c)                                                                 { return (c==' ') || (c=='\t'); }
193
194         char   *pData;                                                                                                  // -> STR_String data
195         int        Len;                                                                                                         // Data length
196         int        Max;                                                                                                         // Space in data buffer
197
198
199 #ifdef WITH_CXX_GUARDEDALLOC
200 public:
201         void *operator new( unsigned int num_bytes) { return MEM_mallocN(num_bytes, "CXX:STR_String"); }
202         void operator delete( void *mem ) { MEM_freeN(mem); }
203 #endif
204 };
205
206 inline  STR_String operator+(rcSTR_String    lhs, rcSTR_String   rhs)   { return STR_String(lhs.ReadPtr(), lhs.Length(), rhs.ReadPtr(), rhs.Length()); }
207 inline  STR_String operator+(rcSTR_String    lhs, char        rhs)      { return STR_String(lhs.ReadPtr(), lhs.Length(), &rhs, 1); }
208 inline  STR_String operator+(char         lhs, rcSTR_String   rhs)      { return STR_String(&lhs, 1, rhs.ReadPtr(), rhs.Length()); }
209 inline  STR_String operator+(rcSTR_String    lhs, const char *rhs)      { return STR_String(lhs.ReadPtr(), lhs.Length(), rhs, strlen(rhs)); }
210 inline  STR_String operator+(const char  *lhs, rcSTR_String   rhs)      { return STR_String(lhs, strlen(lhs), rhs.ReadPtr(), rhs.Length()); }
211
212
213 #endif //_STR_String_H_
214