encoding.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_ENCODING_H
#define COMMON_ENCODING_H

#include "src/common/types.h"

namespace Common {

class UString;
class SeekableReadStream;
class MemoryReadStream;
class WriteStream;

enum Encoding {
    kEncodingInvalid = -1,

    kEncodingASCII,   

    kEncodingUTF8,    

    kEncodingUTF16LE, 
    kEncodingUTF16BE, 

    kEncodingLatin9,  

    kEncodingCP1250,  
    kEncodingCP1251,  
    kEncodingCP1252,  

    kEncodingCP932,   
    kEncodingCP936,   
    kEncodingCP949,   
    kEncodingCP950,   

    kEncodingMAX      
};

UString getEncodingName(Encoding encoding);

bool hasSupportEncoding(Encoding encoding);

UString readString(SeekableReadStream &stream, Encoding encoding);

UString readStringFixed(SeekableReadStream &stream, Encoding encoding, size_t length);

UString readStringLine(SeekableReadStream &stream, Encoding encoding);

UString readString(const byte *data, size_t size, Encoding encoding);

size_t writeString(WriteStream &stream, const Common::UString &str, Encoding encoding, bool terminate = true);

void writeStringFixed(WriteStream &stream, const Common::UString &str, Encoding encoding, size_t length);

MemoryReadStream *convertString(const UString &str, Encoding encoding, bool terminateString = true);

size_t getBytesPerCodepoint(Encoding encoding);

bool isValidCodepoint(Encoding encoding, uint32 cp);

} // End of namespace Common

#endif // COMMON_ENCODING_H