TextEncoding.h

Go to the documentation of this file.

//
// TextEncoding.h
//
// $Id: //poco/1.3/Foundation/include/Poco/TextEncoding.h#2 $
//
// Library: Foundation
// Package: Text
// Module:  TextEncoding
//
// Definition of the abstract TextEncoding class.
//
// Copyright (c) 2004-2007, Applied Informatics Software Engineering GmbH.
// and Contributors.
//
// Permission is hereby granted, free of charge, to any person or organization
// obtaining a copy of the software and accompanying documentation covered by
// this license (the "Software") to use, reproduce, display, distribute,
// execute, and transmit the Software, and to prepare derivative works of the
// Software, and to permit third-parties to whom the Software is furnished to
// do so, all subject to the following:
// 
// The copyright notices in the Software and this entire statement, including
// the above license grant, this restriction and the following disclaimer,
// must be included in all copies of the Software, in whole or in part, and
// all derivative works of the Software, unless such copies or derivative
// works are solely in the form of machine-executable object code generated by
// a source language processor.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//


#ifndef Foundation_TextEncoding_INCLUDED
#define Foundation_TextEncoding_INCLUDED


#include "Poco/Foundation.h"
#include "Poco/SharedPtr.h"


namespace Poco {


class TextEncodingManager;


class Foundation_API TextEncoding
{
public:
        typedef SharedPtr<TextEncoding> Ptr;
        
        enum
        {
                MAX_SEQUENCE_LENGTH = 6 
        };
        
        typedef int CharacterMap[256];

        virtual ~TextEncoding();

        virtual const char* canonicalName() const = 0;

        virtual bool isA(const std::string& encodingName) const = 0;
                        
        virtual const CharacterMap& characterMap() const = 0;
                
        virtual int convert(const unsigned char* bytes) const;

        virtual int convert(int ch, unsigned char* bytes, int length) const;

        static TextEncoding& byName(const std::string& encodingName);
                
        static TextEncoding::Ptr find(const std::string& encodingName);

        static void add(TextEncoding::Ptr encoding);

        static void add(TextEncoding::Ptr encoding, const std::string& name);

        static void remove(const std::string& encodingName);

        static TextEncoding::Ptr global(TextEncoding::Ptr encoding);

        static TextEncoding& global();

        static const std::string GLOBAL;
                
protected:
        static TextEncodingManager& manager();
};


} // namespace Poco


#endif // Foundation_TextEncoding_INCLUDED