Unicode.hpp

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2009 Laurent Gomila (laurent.gom@gmail.com)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#ifndef SFML_UNICODE_HPP
#define SFML_UNICODE_HPP

// Headers
#include <SFML/Config.hpp>
#include <iterator>
#include <locale>
#include <string>
#include <stdlib.h>
 
 
namespace sf
{
class SFML_API Unicode
{
public :

    typedef std::basic_string<Uint8>  UTF8String;
    typedef std::basic_string<Uint16> UTF16String;
    typedef std::basic_string<Uint32> UTF32String;

    class SFML_API Text
    {
    public :

        /// Default constructor (empty text)
        ///
        ////////////////////////////////////////////////////////////
        Text();

        Text(const char*                 Str);
        Text(const wchar_t*              Str);
        Text(const Uint8*                Str);
        Text(const Uint16*               Str);
        Text(const Uint32*               Str);
        Text(const std::string&          Str);
        Text(const std::wstring&         Str);
        Text(const Unicode::UTF8String&  Str);
        Text(const Unicode::UTF16String& Str);
        Text(const Unicode::UTF32String& Str);

        operator       std::string          () const;
        operator       std::wstring         () const;
        operator       Unicode::UTF8String  () const;
        operator       Unicode::UTF16String () const;
        operator const Unicode::UTF32String&() const;
 
    private :

        // Data member
        sf::Unicode::UTF32String myUTF32String; 
    };

    template <typename In, typename Out>
    static Out UTF32ToANSI(In Begin, In End, Out Output, char Replacement = '?', const std::locale& Locale = GetDefaultLocale());

    template <typename In, typename Out>
    static Out ANSIToUTF32(In Begin, In End, Out Output, const std::locale& Locale = GetDefaultLocale());

    template <typename In, typename Out>
    static Out UTF8ToUTF16(In Begin, In End, Out Output, Uint16 Replacement = '?');


    ///
    /// \return Iterator to the end of the output sequence which has been written
    ///
    ////////////////////////////////////////////////////////////
    template <typename In, typename Out>
    static Out UTF8ToUTF32(In Begin, In End, Out Output, Uint32 Replacement = '?');

    template <typename In, typename Out>
    static Out UTF16ToUTF8(In Begin, In End, Out Output, Uint8 Replacement = '?');

    template <typename In, typename Out>
    static Out UTF16ToUTF32(In Begin, In End, Out Output, Uint32 Replacement = '?');


    /// \param Replacement : Replacement character for characters not convertible to output encoding ('?' by default -- use 0 to use no replacement character)
    ///
    /// \return Iterator to the end of the output sequence which has been written
    ///
    ////////////////////////////////////////////////////////////
    template <typename In, typename Out>
    static Out UTF32ToUTF8(In Begin, In End, Out Output, Uint8 Replacement = '?');

    template <typename In, typename Out>
    static Out UTF32ToUTF16(In Begin, In End, Out Output, Uint16 Replacement = '?');

    template <typename In>
    static std::size_t GetUTF8Length(In Begin, In End);

    template <typename In>
    static std::size_t GetUTF16Length(In Begin, In End);

    template <typename In>
    static std::size_t GetUTF32Length(In Begin, In End);
 
private :


    static const std::locale& GetDefaultLocale();

    // Static member data
    static const int    UTF8TrailingBytes[256]; 
    static const Uint32 UTF8Offsets[6];         
    static const Uint8  UTF8FirstBytes[7];      
};
 
#include <SFML/System/Unicode.inl>
 
} // namespace sf
 
 
#endif // SFML_UNICODE_HPP