CrystalSpace

Public API Reference

Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

scfstr.h

00001 /*
00002     Crystal Space String interface
00003     Copyright (C) 1999 by Brandon Ehle (Azverkan)
00004 
00005     This library is free software; you can redistribute it and/or
00006     modify it under the terms of the GNU Library General Public
00007     License as published by the Free Software Foundation; either
00008     version 2 of the License, or (at your option) any later version.
00009 
00010     This library is distributed in the hope that it will be useful,
00011     but WITHOUT ANY WARRANTY; without even the implied warranty of
00012     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00013     Library General Public License for more details.
00014 
00015     You should have received a copy of the GNU Library General Public
00016     License along with this library; if not, write to the Free
00017     Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
00018 */
00019 
00020 #ifndef __CS_SCFSTR_H__
00021 #define __CS_SCFSTR_H__
00022 
00023 #include "csextern.h"
00024 #include "iutil/string.h"
00025 #include "csutil/csstring.h"
00026 
00028 class CS_CRYSTALSPACE_EXPORT scfString : public iString
00029 {
00030   csString s;
00031 
00032 public:
00033   SCF_DECLARE_IBASE;
00034 
00036   scfString ()
00037   { SCF_CONSTRUCT_IBASE (0); }
00038 
00040   scfString (size_t iLength) : s(iLength)
00041   { SCF_CONSTRUCT_IBASE (0); }
00042 
00044   scfString (const iString &copy) : s(copy.GetData())
00045   { SCF_CONSTRUCT_IBASE (0); }
00046 
00048   scfString (const char *copy) : s(copy)
00049   { SCF_CONSTRUCT_IBASE (0); }
00050 
00052   virtual ~scfString ()
00053   { SCF_DESTRUCT_IBASE(); }
00054 
00056   const csString& GetCsString () const { return s; }
00057 
00059   csString& GetCsString () { return s; }
00060 
00062   virtual void SetCapacity (size_t NewSize);
00064   virtual size_t GetCapacity() const;
00066   virtual void SetGrowsBy(size_t);
00068   virtual size_t GetGrowsBy() const;
00069 
00071   virtual void Truncate (size_t iPos);
00072 
00074   virtual void ShrinkBestFit ();
00075 
00080   CS_DEPRECATED_METHOD virtual void Reclaim ()
00081   { ShrinkBestFit(); }
00082 
00084   virtual void Empty ();
00085 
00090   /* CS_DEPRECATED_METHOD */ virtual void Clear ()
00091   { Empty(); }
00092 
00094   virtual csRef<iString> Clone () const;
00095 
00097   virtual char const* GetData () const;
00098 
00100   /*CS_DEPRECATED_METHOD*/ 
00101   // @@@ GCC and VC always seem to prefer this GetData() and barf "deprecated".
00102   virtual char* GetData ();
00103 
00105   virtual size_t Length () const;
00106 
00108   virtual bool IsEmpty () const;
00109 
00111   virtual char& operator [] (size_t iPos);
00112 
00114   virtual char operator [] (size_t iPos) const;
00115 
00117   virtual void SetAt (size_t iPos, char iChar);
00118 
00120   virtual char GetAt (size_t iPos) const;
00121 
00123   virtual void Insert (size_t iPos, iString const* iStr);
00124 
00126   virtual void Overwrite (size_t iPos, iString const* iStr);
00127 
00129   virtual void Append (const char* iStr, size_t iCount = (size_t)-1);
00130 
00132   virtual void Append (iString const* iStr, size_t iCount = (size_t)-1);
00133 
00135   virtual void Append (char c);
00136 
00143   virtual csRef<iString> Slice (size_t start=0, size_t len=(size_t)-1) const;
00144 
00152   virtual csRef<iString> ReverseSlice (size_t start, size_t len=(size_t)-1) const;
00153 
00160   virtual void SubString (iString* sub, size_t start, size_t len=(size_t)-1) const;
00161 
00171   virtual void ReverseSubString (iString* sub, size_t start=0, size_t len=(size_t)-1) const;
00172 
00177   virtual size_t FindFirst (const char c, size_t p = (size_t)-1) const;
00183   virtual size_t FindLast (const char c, size_t p = (size_t)-1) const;
00184 
00191   virtual size_t Find (const char* search, size_t pos = 0) const;
00192 
00197   virtual void ReplaceAll (const char* search, const char* replacement);
00198 
00203   virtual void Format (const char* format, ...) CS_GNUC_PRINTF (2, 3);
00208   virtual void FormatV (const char* format, va_list args);
00209 
00211   virtual void Replace (const iString* iStr, size_t iCount = (size_t)-1);
00212 
00214   virtual void Replace (const char* iStr, size_t iCount = (size_t)-1);
00215 
00217   virtual bool Compare (const iString* iStr) const;
00218 
00220   virtual bool CompareNoCase (const iString* iStr) const;
00221 
00223   virtual void operator += (const iString& iStr);
00224 
00226   virtual void operator += (const char* iStr);
00227 
00229   virtual void operator += (char c);
00230 
00232   virtual csRef<iString> operator + (const iString &iStr) const;
00233 
00235   virtual operator char const* () const;
00236 
00238   virtual bool operator == (const iString &iStr) const;
00239 
00241   virtual bool operator != (const iString &iStr) const;
00242 
00244   virtual void Downcase();
00245 
00247   virtual void Upcase();
00248 };
00249 
00250 #endif // __CS_SCFSTR_H__

Generated for Crystal Space by doxygen 1.4.4