Public API Reference

csutil/scfstr.h

Go to the documentation of this file.

/*
    Crystal Space String interface
    Copyright (C) 1999 by Brandon Ehle (Azverkan)

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the Free
    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#ifndef __CS_SCFSTR_H__
#define __CS_SCFSTR_H__

#include "csextern.h"

#include "csutil/csstring.h"
#include "csutil/scf_implementation.h"
#include "iutil/string.h"

#include "csutil/win32/msvc_deprecated_warn_off.h"

class CS_CRYSTALSPACE_EXPORT scfString : 
  public scfImplementation1<scfString, iString>
{
  csString s;

public:

  scfString ()
    : scfImplementationType (this)
  { }

  scfString (size_t iLength) 
    : scfImplementationType (this), s(iLength)
  { }

  scfString (const iString &copy) 
    : iBase(), scfImplementationType (this), s(copy.GetData())
  { }

  scfString (const char *copy) 
    : scfImplementationType (this), s(copy)
  { }

  virtual ~scfString ()
  { }

  const csString& GetCsString () const { return s; }

  csString& GetCsString () { return s; }

  virtual void SetCapacity (size_t NewSize);
  virtual size_t GetCapacity() const;
  virtual void SetGrowsBy(size_t);
  virtual size_t GetGrowsBy() const;

  virtual void Truncate (size_t iPos);

  virtual void ShrinkBestFit ();

  CS_DEPRECATED_METHOD_MSG("Use ShrinkBestFit() instead.")
  virtual void Reclaim ()
  { ShrinkBestFit(); }

  virtual void Empty ();

  /* CS_DEPRECATED_METHOD_MSG("Use Empty() instead.") */ 
  virtual void Clear ()
  { Empty(); }

  virtual csRef<iString> Clone () const;

  virtual char const* GetData () const;

  /*CS_DEPRECATED_METHOD*/ 
  // @@@ GCC and VC always seem to prefer this GetData() and barf "deprecated".
  virtual char* GetData ();

  virtual size_t Length () const;

  virtual bool IsEmpty () const;

  virtual char& operator [] (size_t iPos);

  virtual char operator [] (size_t iPos) const;

  virtual void SetAt (size_t iPos, char iChar);

  virtual char GetAt (size_t iPos) const;

  virtual void Insert (size_t iPos, iString const* iStr);

  virtual void Overwrite (size_t iPos, iString const* iStr);

  virtual void Append (const char* iStr, size_t iCount = (size_t)-1);

  virtual void Append (iString const* iStr, size_t iCount = (size_t)-1);

  virtual void Append (char c);

  virtual csRef<iString> Slice (size_t start=0, size_t len=(size_t)-1) const;

  virtual csRef<iString> ReverseSlice (size_t start,
        size_t len=(size_t)-1) const;

  virtual void SubString (iString* sub, size_t start,
        size_t len=(size_t)-1) const;

  virtual void ReverseSubString (iString* sub, size_t start=0,
        size_t len=(size_t)-1) const;

  virtual size_t FindFirst (const char c, size_t p = (size_t)-1) const;
  virtual size_t FindLast (const char c, size_t p = (size_t)-1) const;

  virtual size_t Find (const char* search, size_t pos = 0) const;

  virtual void ReplaceAll (const char* search, const char* replacement);

  virtual void Format (const char* format, ...) CS_GNUC_PRINTF (2, 3);
  virtual void FormatV (const char* format, va_list args);

  virtual void Replace (const iString* iStr, size_t iCount = (size_t)-1);

  virtual void Replace (const char* iStr, size_t iCount = (size_t)-1);

  virtual bool Compare (const iString* iStr) const;

  virtual bool CompareNoCase (const iString* iStr) const;

  virtual void operator += (const iString& iStr);

  virtual void operator += (const char* iStr);

  virtual void operator += (char c);

  virtual csRef<iString> operator + (const iString &iStr) const;

  virtual operator char const* () const;

  virtual bool operator == (const iString &iStr) const;

  virtual bool operator != (const iString &iStr) const;

  virtual void Downcase();

  virtual void Upcase();
};

#include "csutil/win32/msvc_deprecated_warn_on.h"

#endif // __CS_SCFSTR_H__

---