Main Page   Class Hierarchy   Compound List   File List   Compound Members  

XMLUTF8Transcoder.hpp

00001 /*
00002  * The Apache Software License, Version 1.1
00003  * 
00004  * Copyright (c) 1999-2000 The Apache Software Foundation.  All rights
00005  * reserved.
00006  * 
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions
00009  * are met:
00010  * 
00011  * 1. Redistributions of source code must retain the above copyright
00012  *    notice, this list of conditions and the following disclaimer. 
00013  * 
00014  * 2. Redistributions in binary form must reproduce the above copyright
00015  *    notice, this list of conditions and the following disclaimer in
00016  *    the documentation and/or other materials provided with the
00017  *    distribution.
00018  * 
00019  * 3. The end-user documentation included with the redistribution,
00020  *    if any, must include the following acknowledgment:  
00021  *       "This product includes software developed by the
00022  *        Apache Software Foundation (http://www.apache.org/)."
00023  *    Alternately, this acknowledgment may appear in the software itself,
00024  *    if and wherever such third-party acknowledgments normally appear.
00025  * 
00026  * 4. The names "Xerces" and "Apache Software Foundation" must
00027  *    not be used to endorse or promote products derived from this
00028  *    software without prior written permission. For written 
00029  *    permission, please contact apache\@apache.org.
00030  * 
00031  * 5. Products derived from this software may not be called "Apache",
00032  *    nor may "Apache" appear in their name, without prior written
00033  *    permission of the Apache Software Foundation.
00034  * 
00035  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00036  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00037  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00038  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00039  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00040  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00041  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00042  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00043  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00044  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00045  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00046  * SUCH DAMAGE.
00047  * ====================================================================
00048  * 
00049  * This software consists of voluntary contributions made by many
00050  * individuals on behalf of the Apache Software Foundation, and was
00051  * originally based on software copyright (c) 1999, International
00052  * Business Machines, Inc., http://www.ibm.com .  For more information
00053  * on the Apache Software Foundation, please see
00054  * <http://www.apache.org/>.
00055  */
00056 
00057 #ifndef XMLUTF8TRANSCODER_HPP
00058 #define XMLUTF8TRANSCODER_HPP
00059 
00060 #include <xercesc/util/XercesDefs.hpp>
00061 #include <xercesc/util/TransService.hpp>
00062 
00063 //
00064 //  This class provides an implementation of the XMLTranscoder interface
00065 //  for a simple UTF8 transcoder. The parser does some encodings
00066 //  intrinsically without depending upon external transcoding services.
00067 //  To make everything more orthagonal, we implement these internal
00068 //  transcoders using the same transcoder abstraction as the pluggable
00069 //  transcoding services do.
00070 //
00071 class XMLUTIL_EXPORT XMLUTF8Transcoder : public XMLTranscoder
00072 {
00073 public :
00074     // -----------------------------------------------------------------------
00075     //  Public constructors and destructor
00076     // -----------------------------------------------------------------------
00077     XMLUTF8Transcoder
00078     (
00079         const   XMLCh* const    encodingName
00080         , const unsigned int    blockSize
00081     );
00082 
00083     virtual ~XMLUTF8Transcoder();
00084 
00085 
00086     // -----------------------------------------------------------------------
00087     //  Implementation of the XMLTranscoder interface
00088     // -----------------------------------------------------------------------
00089     virtual unsigned int transcodeFrom
00090     (
00091         const   XMLByte* const          srcData
00092         , const unsigned int            srcCount
00093         ,       XMLCh* const            toFill
00094         , const unsigned int            maxChars
00095         ,       unsigned int&           bytesEaten
00096         ,       unsigned char* const    charSizes
00097     );
00098 
00099     virtual unsigned int transcodeTo
00100     (
00101         const   XMLCh* const    srcData
00102         , const unsigned int    srcCount
00103         ,       XMLByte* const  toFill
00104         , const unsigned int    maxBytes
00105         ,       unsigned int&   charsEaten
00106         , const UnRepOpts       options
00107     );
00108 
00109     virtual bool canTranscodeTo
00110     (
00111         const   unsigned int    toCheck
00112     )   const;
00113 
00114 
00115 private :
00116     // -----------------------------------------------------------------------
00117     //  Unimplemented constructors and operators
00118     // -----------------------------------------------------------------------
00119     XMLUTF8Transcoder(const XMLUTF8Transcoder&);
00120     void operator=(const XMLUTF8Transcoder&);
00121 };
00122 
00123 #endif

Generated on Tue Nov 19 09:36:36 2002 by doxygen1.3-rc1