scummvm/engines/ultima/shared/std/string.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program 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 2
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */

#ifndef ULTIMA_STD_STRING_H
#define ULTIMA_STD_STRING_H

#include "common/str.h"

namespace Ultima {
namespace std {

class string : public Common::String {
public:
	typedef size_t size_type;
	static const size_type npos = (size_type) - 1;

	struct reverse_iterator {
	private:
		string *_owner;
		int _index;
	public:
		reverse_iterator(string *owner, int index) : _owner(owner), _index(index) {}
		reverse_iterator() : _owner(0), _index(-1) {}

		char &operator*() const { return (*_owner)[_index]; }

		reverse_iterator &operator++() {
			--_index;
			return *this;
		}

		bool operator==(const reverse_iterator &rhs) {
			return _owner == rhs._owner && _index == rhs._index;
		}
		bool operator!=(const reverse_iterator &rhs) {
			return !operator==(rhs);
		}
	};
public:
	string() : Common::String() {}
	string(const char *str) : Common::String(str) {}
	string(const char *str, uint32 len) : Common::String(str, len) {}
	string(const char *beginP, const char *endP) : Common::String(beginP, endP) {}
	string(const String &str) : Common::String(str) {}
	explicit string(char c) : Common::String(c) {}
	string(size_t n, char c);
	virtual ~string() {}

	size_t length() const { return size(); }

	/**
	 * String square brackets allows modifying characters
	 */
	char &operator[](size_t idx) {
		assert(idx < _size);
		return _str[idx];
	}

	/**
	 * Square brackets for const strings simply returns characters
	 */
	char operator[](size_t idx) const {
		return Common::String::operator[](idx);
	}

	/**
	 * Get a character at an index
	 */
	char at(size_t idx) { return operator[](idx); }

	virtual int Compare(const string &s) const {
		return compareTo(s);
	}

	/**
	 * Finds the index of a character in the string
	 */
	size_t find(char c, size_t pos = 0) const;

	/**
	 * Does a find for the passed string
	 */
	size_t find(const char *s) const;

	/**
	 * Does a reverse find for the passed string
	 */
	size_t rfind(const char *s) const;

	/**
	 * Does a reverse find for a passed character
	 */
	size_t rfind(char c, size_t pos = npos) const;

	/**
	 * Find first character in the string matching the passed character
	 */
	size_t find_first_of(char c, size_t pos = 0) const;

	/**
	 * Find first character in the string that's any character of the passed string
	 */
	size_t find_first_of(const char *chars, size_t pos = 0) const;

	/**
	 * Find first character in the string that's not the specified character
	 */
	size_t find_first_not_of(char c, size_t pos = 0) const;

	/**
	 * Find first character in the string that's not any character of the passed string
	 */
	size_t find_first_not_of(const char *chars, size_t pos = 0) const;

	/**
	 * Find the last character in the string that's not the specified character
	 */
	size_t find_last_not_of(char c) const;

	/**
	 * Find the last character in the string that's not in any of the passed characters
	 */
	size_t find_last_not_of(const char *chars) const;

	/**
	 * Return a substring of this string
	 */
	string substr(size_t pos = 0, size_t len = npos) const;

	/**
	 * Erases len number of characters from pos
	 */
	string &erase(size_t pos = 0, size_t len = npos);

	/**
	 * Resizes a string
	 */
	void resize(size_t count);

	void insert(size_t pos, size_t n, char c) {
		for (uint idx = 0; idx < n; ++idx)
			insertChar(c, pos);
	}

	void append(const string &str) {
		*this += str;
	}

	reverse_iterator rbegin() {
		return reverse_iterator(this, (int)size() - 1);
	}
	reverse_iterator rend() {
		return reverse_iterator(this, -1);
	}

	bool operator==(const string &x) const {
		return !Compare(x);
	}

	bool operator==(const char *x) const {
		return !Compare(x);
	}

	bool operator!=(const string &x) const {
		return Compare(x) != 0;
	}

	bool operator !=(const char *x) const {
		return Compare(x) != 0;
	}
};

extern const char *const endl;

} // End of namespace std
} // End of namespace Ultima

#endif