/* * Copyright 1999-2001,2004 The Apache Software Foundation. *  * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at *  *      http://www.apache.org/licenses/LICENSE-2.0 *  * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. *//* * $Log: TransService.hpp,v $ * Revision 1.14  2004/09/08 13:56:23  peiyongz * Apache License Version 2.0 * * Revision 1.13  2004/05/19 20:51:20  peiyongz * XML1.0-3rd Edition: UTF_8 * * Revision 1.12  2004/01/29 11:48:46  cargilld * Code cleanup changes to get rid of various compiler diagnostic messages. * * Revision 1.11  2003/12/24 15:24:13  cargilld * More updates to memory management so that the static memory manager. * * Revision 1.10  2003/11/24 19:52:06  neilg * allow classes derived from XMLTransService to tailor the intrinsic maps to their taste. * * Revision 1.9  2003/06/03 18:12:29  knoaman * Add default value for memory manager argument. * * Revision 1.8  2003/05/15 19:07:45  knoaman * Partial implementation of the configurable memory manager. * * Revision 1.7  2003/03/07 18:11:55  tng * Return a reference instead of void for operator= * * Revision 1.6  2003/02/04 22:11:52  peiyongz * bug#16784: Obsolete documentation on XMLTranscoder -- reported by * Colin Paul Adams, Preston Lancashire * * Revision 1.5  2002/11/25 21:27:52  tng * Performance: use XMLRecognizer::Encodings enum to make new transcode, faster than comparing the encoding string every time. * * Revision 1.4  2002/11/04 15:22:04  tng * C++ Namespace Support. * * Revision 1.3  2002/07/18 20:05:31  knoaman * Add a new feature to control strict IANA encoding name. * * Revision 1.2  2002/04/09 15:44:00  knoaman * Add lower case string support. * * Revision 1.1.1.1  2002/02/01 22:22:13  peiyongz * sane_include * * Revision 1.14  2001/11/01 23:37:07  jasons * 2001-11-01  Jason E. Stewart  <jason@openinformatics.com> * * 	* src/util/TransService.hpp (Repository): * 	Updated Doxygen documentation for XMLTranscoder class * * Revision 1.13  2001/05/11 13:26:30  tng * Copyright update. * * Revision 1.12  2001/01/25 19:19:32  tng * Let user add their encoding to the intrinsic mapping table.  Added by Khaled Noaman. * * Revision 1.11  2000/04/12 22:57:45  roddey * A couple of fixes to comments and parameter names to make them * more correct. * * Revision 1.10  2000/03/28 19:43:19  roddey * Fixes for signed/unsigned warnings. New work for two way transcoding * stuff. * * Revision 1.9  2000/03/17 23:59:54  roddey * Initial updates for two way transcoding support * * Revision 1.8  2000/03/02 19:54:46  roddey * This checkin includes many changes done while waiting for the * 1.1.0 code to be finished. I can't list them all here, but a list is * available elsewhere. * * Revision 1.7  2000/02/24 20:05:25  abagchi * Swat for removing Log from API docs * * Revision 1.6  2000/02/06 07:48:04  rahulj * Year 2K copyright swat. * * Revision 1.5  2000/01/25 22:49:55  roddey * Moved the supportsSrcOfs() method from the individual transcoder to the * transcoding service, where it should have been to begin with. * * Revision 1.4  2000/01/25 19:19:07  roddey * Simple addition of a getId() method to the xcode and netacess abstractions to * allow each impl to give back an id string. * * Revision 1.3  1999/12/18 00:18:10  roddey * More changes to support the new, completely orthagonal support for * intrinsic encodings. * * Revision 1.2  1999/12/15 19:41:28  roddey * Support for the new transcoder system, where even intrinsic encodings are * done via the same transcoder abstraction as external ones. * * Revision 1.1.1.1  1999/11/09 01:05:16  twl * Initial checkin * * Revision 1.2  1999/11/08 20:45:16  rahul * Swat for adding in Product name and CVS comment log variable. * */#ifndef TRANSSERVICE_HPP#define TRANSSERVICE_HPP#include <xercesc/util/XMemory.hpp>#include <xercesc/util/PlatformUtils.hpp>#include <xercesc/framework/XMLRecognizer.hpp>#include <xercesc/util/RefHashTableOf.hpp>#include <xercesc/util/RefVectorOf.hpp>XERCES_CPP_NAMESPACE_BEGIN// Forward references//class XMLPlatformUtils;class XMLLCPTranscoder;class XMLTranscoder;class ENameMap;////  This class is an abstract base class which are used to abstract the//  transcoding services that Xerces uses. The parser's actual transcoding//  needs are small so it is desirable to allow different implementations//  to be provided.////  The transcoding service has to provide a couple of required string//  and character operations, but its most important service is the creation//  of transcoder objects. There are two types of transcoders, which are//  discussed below in the XMLTranscoder class' description.//class XMLUTIL_EXPORT XMLTransService : public XMemory{public :    // -----------------------------------------------------------------------    //  Class specific types    // -----------------------------------------------------------------------    enum Codes    {        Ok        , UnsupportedEncoding        , InternalFailure        , SupportFilesNotFound    };    struct TransRec    {        XMLCh       intCh;        XMLByte     extCh;    };    // -----------------------------------------------------------------------    //  Public constructors and destructor    // -----------------------------------------------------------------------    virtual ~XMLTransService();    // -----------------------------------------------------------------------    //  Non-virtual API    // -----------------------------------------------------------------------    XMLTranscoder* makeNewTranscoderFor    (        const   XMLCh* const            encodingName        ,       XMLTransService::Codes& resValue        , const unsigned int            blockSize        , MemoryManager* const          manager = XMLPlatformUtils::fgMemoryManager    );    XMLTranscoder* makeNewTranscoderFor    (        const   char* const             encodingName        ,       XMLTransService::Codes& resValue        , const unsigned int            blockSize        , MemoryManager* const          manager = XMLPlatformUtils::fgMemoryManager    );    XMLTranscoder* makeNewTranscoderFor    (        XMLRecognizer::Encodings        encodingEnum        ,       XMLTransService::Codes& resValue        , const unsigned int            blockSize        , MemoryManager* const          manager = XMLPlatformUtils::fgMemoryManager    );    // -----------------------------------------------------------------------    //  The virtual transcoding service API    // -----------------------------------------------------------------------    virtual int compareIString    (        const   XMLCh* const    comp1        , const XMLCh* const    comp2    ) = 0;    virtual int compareNIString    (        const   XMLCh* const    comp1        , const XMLCh* const    comp2        , const unsigned int    maxChars    ) = 0;    virtual const XMLCh* getId() const = 0;    virtual bool isSpace(const XMLCh toCheck) const = 0;    virtual XMLLCPTranscoder* makeNewLCPTranscoder() = 0;    virtual bool supportsSrcOfs() const = 0;    virtual void upperCase(XMLCh* const toUpperCase) const = 0;    virtual void lowerCase(XMLCh* const toLowerCase) const = 0;	// -----------------------------------------------------------------------    //	Allow users to add their own encodings to the intrinsinc mapping	//	table	//	Usage:	//		XMLTransService::addEncoding (	//			gMyEncodingNameString    //			, new ENameMapFor<MyTransClassType>(gMyEncodingNameString)	//		);    // -----------------------------------------------------------------------	static void addEncoding(const XMLCh* const encoding, ENameMap* const ownMapping);protected :    // -----------------------------------------------------------------------    //  Hidden constructors    // -----------------------------------------------------------------------    XMLTransService();    // -----------------------------------------------------------------------    //  Protected virtual methods.    // -----------------------------------------------------------------------    virtual XMLTranscoder* makeNewXMLTranscoder    (        const   XMLCh* const            encodingName        ,       XMLTransService::Codes& resValue        , const unsigned int            blockSize        , MemoryManager* const          manager    ) = 0;    // -----------------------------------------------------------------------    //  Protected init method for platform utils to call    // -----------------------------------------------------------------------    friend class XMLPlatformUtils;    virtual void initTransService();    // -----------------------------------------------------------------------    // protected static members    //  gMappings    //      This is a hash table of ENameMap objects. It is created and filled    //      in when the platform init calls our initTransService() method.    //    //  gMappingsRecognizer    //      This is an array of ENameMap objects, predefined for those    //      already recognized by XMLRecognizer::Encodings.    //    static RefHashTableOf<ENameMap>*    gMappings;    static RefVectorOf<ENameMap>*       gMappingsRecognizer;private :    // -----------------------------------------------------------------------    //  Unimplemented constructors and operators    // -----------------------------------------------------------------------    XMLTransService(const XMLTransService&);    XMLTransService& operator=(const XMLTransService&);    // -----------------------------------------------------------------------    //  Hidden method to enable/disable strict IANA encoding check    //  Caller: XMLPlatformUtils    // -----------------------------------------------------------------------    void strictIANAEncoding(const bool newState);    bool isStrictIANAEncoding();