Public API Reference

iutil/string.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_IUTIL_STRING_H__
#define __CS_IUTIL_STRING_H__

#include "csutil/scf_interface.h"


struct iString : public virtual iBase
{
  SCF_INTERFACE(iString, 2,0,0);
  virtual void SetCapacity (size_t NewSize) = 0;
  virtual size_t GetCapacity () const = 0;

  virtual void SetGrowsBy(size_t) = 0;
  virtual size_t GetGrowsBy() const = 0;

  virtual void Truncate (size_t Len) = 0;

  virtual void ShrinkBestFit () = 0;

  CS_DEPRECATED_METHOD_MSG("Use ShrinkBestFit() instead")
  virtual void Reclaim () = 0;

  virtual void Empty () = 0;

  CS_DEPRECATED_METHOD_MSG("Use Empty() instead")
  virtual void Clear () = 0;

  virtual csRef<iString> Clone () const = 0;

  virtual char const* GetData () const = 0;

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

  virtual size_t Length () const = 0;

  virtual bool IsEmpty () const = 0;

  virtual char& operator [] (size_t n) = 0;

  virtual char operator [] (size_t n) const = 0;

  virtual void SetAt (size_t n, char iChar) = 0;

  virtual char GetAt (size_t n) const = 0;

  virtual void Insert (size_t Pos, iString const* Str) = 0;

  virtual void Overwrite (size_t Pos, iString const* Str) = 0;

  virtual void Append (const char* Str, size_t Count = (size_t)-1) = 0;

  virtual void Append (const iString* Str, size_t Count = (size_t)-1) = 0;

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

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

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

  virtual size_t FindLast (const char c, size_t p = (size_t)-1) const = 0;
  
  virtual size_t Find (const char* search, size_t pos = 0) const = 0;

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

  virtual void Format (const char* format, ...) CS_GNUC_PRINTF (2, 3) = 0;

  virtual void FormatV (const char* format, va_list args) = 0;

  virtual void Replace (const iString* str, size_t count = (size_t)-1) = 0;

  virtual void Replace (const char* str, size_t count = (size_t)-1) = 0;

  virtual bool Compare (const iString* Str) const = 0;

  virtual bool CompareNoCase (const iString* Str) const = 0;

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

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

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

  virtual operator char const* () const = 0;

  virtual bool operator == (const iString& Str) const = 0;

  virtual bool operator != (const iString& Str) const = 0;

  virtual void Downcase() = 0;

  virtual void Upcase() = 0;
};

#endif // __CS_IUTIL_STRING_H__

---