String.h

Go to the documentation of this file.

/*
 * Copyright (C) 2006-2011, SRI International (R)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#ifndef __OpenKarto_String_h__
#define __OpenKarto_String_h__

#include <stdio.h>
#include <ostream>
#include <sstream>

#include <OpenKarto/Macros.h>
#include <OpenKarto/Types.h>

namespace karto
{




#ifdef _DEBUG
  struct StringPrivate
  {
    std::string m_String;
  };
#else
  struct StringPrivate;
#endif

  class KARTO_EXPORT String
  {
  public:
    String();

    String(char c);

    String(const char* pString);

    String(const char* pString, kt_int32u size);

    String(const String& rOther);

    virtual ~String();

  public:
    void Append(const String& rString);

    const char* ToCString() const;

    kt_size_t Size() const;

    void Clear();

    String SubString(kt_size_t index) const;

    String SubString(kt_size_t index, kt_size_t length) const;
    
    kt_size_t Find(const String& rValue) const;

    kt_size_t FindFirstOf(const String& rValue) const;

    kt_size_t FindLastOf(const String& rValue) const;

    static String NewLine();

    void Erase(kt_size_t index, kt_size_t length);

  public:
    int operator[](kt_int32u index) const;

    String& operator=(const String& rOther);

    kt_bool operator==(const String& rOther) const;

    kt_bool operator!=(const String& rOther) const;

    kt_bool operator<(const String& rOther) const;

    kt_bool operator>(const String& rOther) const;

    String operator+(const String& rOther);

    String operator+(const char* pChar);

    friend String operator+(const char* pChar, const String& rOther)
    {
      String string(pChar);
      string.Append(rOther);
      return string;
    }

    friend String operator+(const String& rOther1, const String& rOther2)
    {
      String string;
      string.Append(rOther1);
      string.Append(rOther2);
      return string;
    }

    friend KARTO_FORCEINLINE std::ostream& operator << (std::ostream& rStream, const String& rString)
    {
      rStream << rString.ToCString();
      return rStream;
    }

  private:
    StringPrivate* m_pStringPrivate;
  }; // class String


}

#endif // __OpenKarto_String_h__