ustring.h

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version.
 *
 * xoreos 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef COMMON_USTRING_H
#define COMMON_USTRING_H

#include <string>
#include <sstream>
#include <vector>

#include <boost/functional/hash.hpp>

#include "src/common/types.h"
#include "src/common/system.h"

#include "utf8cpp/utf8.h"

namespace Common {

class UString {
public:
    typedef utf8::iterator<std::string::const_iterator> iterator;

    // Case sensitive compare
    struct sless : std::binary_function<UString, UString, bool> {
        bool operator() (const UString &str1, const UString &str2) const {
            return str1.less(str2);
        }
    };

    // Case insensitive compare
    struct iless : std::binary_function<UString, UString, bool> {
        bool operator() (const UString &str1, const UString &str2) const {
            return str1.lessIgnoreCase(str2);
        }
    };

    UString();
    UString(const UString &str);
    UString(const std::string &str);
    UString(const char *str);
    UString(const char *str, size_t n);
    explicit UString(uint32 c, size_t n = 1);
    UString(iterator sBegin, iterator sEnd);
    ~UString();

    UString &operator=(const UString &str);
    UString &operator=(const std::string &str);
    UString &operator=(const char *str);

    bool operator==(const UString &str) const;
    bool operator!=(const UString &str) const;
    bool operator<(const UString &str) const;
    bool operator>(const UString &str) const;

    UString operator+(const UString &str) const;
    UString operator+(const std::string &str) const;
    UString operator+(const char *str) const;
    UString operator+(uint32 c) const;

    UString &operator+=(const UString &str);
    UString &operator+=(const std::string &str);
    UString &operator+=(const char *str);
    UString &operator+=(uint32 c);

    int strcmp(const UString &str) const;
    int stricmp(const UString &str) const;

    bool equals(const UString &str) const;
    bool equalsIgnoreCase(const UString &str) const;

    bool less(const UString &str) const;
    bool lessIgnoreCase(const UString &str) const;

    void swap(UString &str);

    void clear();

    size_t size() const;

    bool empty() const;

    const char *c_str() const;

    iterator begin() const;
    iterator end() const;

    iterator findFirst(uint32 c) const;
    iterator findFirst(const UString &what) const;
    iterator findLast(uint32 c) const;

    bool beginsWith(const UString &with) const;
    bool endsWith(const UString &with) const;

    bool contains(const UString &what) const;
    bool contains(uint32 c) const;

    void truncate(const iterator &it);
    void truncate(size_t n);

    void trimLeft();
    void trimRight();
    void trim();

    void replaceAll(uint32 what, uint32 with);
    void replaceAll(const UString &what, const UString &with);

    void makeLower();
    void makeUpper();

    UString toLower() const;
    UString toUpper() const;

    iterator getPosition(size_t n)    const;
    size_t   getPosition(iterator it) const;

    void insert(iterator pos, uint32 c);
    void insert(iterator pos, const UString &str);
    void replace(iterator pos, uint32 c);
    void replace(iterator pos, const UString &str);
    void erase(iterator from, iterator to);
    void erase(iterator pos);

    void split(iterator splitPoint, UString &left, UString &right, bool remove = false) const;

    UString substr(iterator from, iterator to) const;

    static UString format(const char *s, ...) GCC_PRINTF(1, 2);

    static size_t split(const UString &text, uint32 delim, std::vector<UString> &texts);

    static void splitTextTokens(const UString &text, std::vector<UString> &tokens);

    static uint32 toLower(uint32 c);
    static uint32 toUpper(uint32 c);

    static bool isASCII(uint32 c); 

    static bool isSpace(uint32 c); 
    static bool isDigit(uint32 c); 
    static bool isAlpha(uint32 c); 
    static bool isAlNum(uint32 c); 
    static bool isCntrl(uint32 c); 

    static uint32 fromUTF16(uint16 c);

private:
    std::string _string; 

    size_t _size;

    void recalculateSize();
};


// Right-binding concatenation operators
static inline UString operator+(const std::string &left, const UString &right) {
    return UString(left) + right;
}

static inline UString operator+(const char *left, const UString &right) {
    return UString(left) + right;
}


// Hash functions

struct hashUStringCaseSensitive {
    size_t operator()(const UString &str) const {
        size_t seed = 0;

        for (UString::iterator it = str.begin(); it != str.end(); ++it)
            boost::hash_combine<uint32>(seed, *it);

        return seed;
    }
};

struct hashUStringCaseInsensitive {
    size_t operator()(const UString &str) const {
        size_t seed = 0;

        for (UString::iterator it = str.begin(); it != str.end(); ++it)
            boost::hash_combine<uint32>(seed, UString::toLower(*it));

        return seed;
    }
};

} // End of namespace Common

#endif // COMMON_USTRING_H