tstring.h

Go to the documentation of this file.

/***************************************************************************
    copyright            : (C) 2002 - 2008 by Scott Wheeler
    email                : wheeler@kde.org
 ***************************************************************************/

/***************************************************************************
 *   This library is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU Lesser General Public License version   *
 *   2.1 as published by the Free Software Foundation.                     *
 *                                                                         *
 *   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     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the Free Software   *
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA         *
 *   02110-1301  USA                                                       *
 *                                                                         *
 *   Alternatively, this file is available under the Mozilla Public        *
 *   License Version 1.1.  You may obtain a copy of the License at         *
 *   http://www.mozilla.org/MPL/                                           *
 ***************************************************************************/

#ifndef TAGLIB_STRING_H
#define TAGLIB_STRING_H

#include "taglib_export.h"
#include "taglib.h"
#include "tbytevector.h"

#include <string>
#include <iostream>

#define QStringToTString(s) TagLib::String(s.utf8().data(), TagLib::String::UTF8)

#define TStringToQString(s) QString::fromUtf8(s.toCString(true))

namespace TagLib {

  class StringList;


  class TAGLIB_EXPORT String
  {
  public:

#ifndef DO_NOT_DOCUMENT
    typedef std::basic_string<wchar>::iterator Iterator;
    typedef std::basic_string<wchar>::const_iterator ConstIterator;
#endif

    enum Type {
      Latin1 = 0,
      UTF16 = 1,
      UTF16BE = 2,
      UTF8 = 3,
      UTF16LE = 4
    };

    String();

    String(const String &s);

    String(const std::string &s, Type t = Latin1);

    String(const wstring &s, Type t = WCharByteOrder);

    String(const wchar_t *s, Type t = WCharByteOrder);

    String(char c, Type t = Latin1);

    String(wchar_t c, Type t = Latin1);


    String(const char *s, Type t = Latin1);

    String(const ByteVector &v, Type t = Latin1);

    virtual ~String();

    std::string to8Bit(bool unicode = false) const;

    wstring toWString() const;

    const char *toCString(bool unicode = false) const;
    
    const wchar_t *toCWString() const;
    
    Iterator begin();

    ConstIterator begin() const;

    Iterator end();

    ConstIterator end() const;

    int find(const String &s, int offset = 0) const;

    int rfind(const String &s, int offset = -1) const;

    StringList split(const String &separator = " ") const;

    bool startsWith(const String &s) const;

    String substr(uint position, uint n = 0xffffffff) const;

    String &append(const String &s);

    String upper() const;

    uint size() const;

    uint length() const;

    bool isEmpty() const;

    bool isNull() const;

    ByteVector data(Type t) const;

    // BIC: merge with the method below
    int toInt() const;

    int toInt(bool *ok) const;

    String stripWhiteSpace() const;

    bool isLatin1() const;

    bool isAscii() const;

    static String number(int n);

    wchar &operator[](int i);

    const wchar &operator[](int i) const;

    bool operator==(const String &s) const;

    bool operator!=(const String &s) const;

    String &operator+=(const String &s);

    String &operator+=(const wchar_t* s);

    String &operator+=(const char* s);

    String &operator+=(wchar_t c);

    String &operator+=(char c);

    String &operator=(const String &s);

    String &operator=(const std::string &s);

    String &operator=(const wstring &s);

    String &operator=(const wchar_t *s);

    String &operator=(char c);

    String &operator=(wchar_t c);

    String &operator=(const char *s);

    String &operator=(const ByteVector &v);

    bool operator<(const String &s) const;

    static String null;

  protected:
    void detach();

  private:
    void copyFromLatin1(const char *s, size_t length);

    void copyFromUTF8(const char *s, size_t length);

    void copyFromUTF16(const wchar_t *s, size_t length, Type t);

    void copyFromUTF16(const char *s, size_t length, Type t);
    
    static const Type WCharByteOrder;

    class StringPrivate;
    StringPrivate *d;
  };
}

TAGLIB_EXPORT const TagLib::String operator+(const TagLib::String &s1, const TagLib::String &s2);

TAGLIB_EXPORT const TagLib::String operator+(const char *s1, const TagLib::String &s2);

TAGLIB_EXPORT const TagLib::String operator+(const TagLib::String &s1, const char *s2);


TAGLIB_EXPORT std::ostream &operator<<(std::ostream &s, const TagLib::String &str);

#endif