locstring.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 AURORA_LOCSTRING_H
#define AURORA_LOCSTRING_H

#include <map>

#include "src/common/types.h"
#include "src/common/ustring.h"
#include "src/common/writestream.h"

#include "src/aurora/language.h"

namespace Common {
    class SeekableReadStream;
}

namespace Aurora {

class LocString {
public:
    LocString();
    ~LocString();

    void clear();

    bool empty() const;

    void swap(LocString &str);

    uint32 getNumStrings() const;

    uint32 getID() const;
    void setID(uint32 id);

    bool hasString(Language language, LanguageGender gender = kLanguageGenderCurrent) const;

    const Common::UString &getString(Language language, LanguageGender gender = kLanguageGenderCurrent) const;

    void setString(Language language, LanguageGender gender, const Common::UString &str);
    void setString(Language language, const Common::UString &str);

    const Common::UString &getStrRefString() const;

    const Common::UString &getFirstString() const;

    const Common::UString &getString() const;

    void readString(uint32 languageID, Common::SeekableReadStream &stream);
    void readLocSubString(Common::SeekableReadStream &stream);
    void readLocString(Common::SeekableReadStream &stream, uint32 id, uint32 count);
    void readLocString(Common::SeekableReadStream &stream);

    uint32 getWrittenSize(bool withNullTerminate = false) const;
    void writeLocString(Common::WriteStream &stream, bool withNullTerminate = false) const;

private:
    typedef std::map<uint32, Common::UString> StringMap;

    uint32 _id; 

    StringMap _strings;


    bool hasString(uint32 languageID) const;

    const Common::UString &getString(uint32 languageID) const;

    void setString(uint32 languageID, const Common::UString &str);
};

} // End of namespace Aurora

#endif // AURORA_LOCSTRING_H