http://xml.apache.org/http://www.apache.org/http://www.w3.org/

Home

Readme
Installation
Build

API Docs
Samples
Programming
Migration
FAQs

Releases
Feedback

PDF Document

Download
Dev Snapshots
CVS Repository
Mail Archive

API Docs for SAX and DOM
 

Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

XML256TableTranscoder.hpp

Go to the documentation of this file.
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 /*
00058  * $Log: XML256TableTranscoder.hpp,v $
00059  * Revision 1.1  2000/03/18 00:00:32  roddey
00060  * Initial updates for two way transcoding support
00061  *
00062  */
00063 
00064 
00065 #ifndef XML256TABLETRANSCODER_HPP
00066 #define XML256TABLETRANSCODER_HPP
00067 
00068 #include <util/TransService.hpp>
00069 
00070 //
00071 //  This class implements the functionality of a common type of transcoder
00072 //  for an 8 bit, single byte encoding based on a set of 'to' and 'from'
00073 //  translation tables. Actual derived classes are trivial and just have to
00074 //  provide us with pointers to their tables and we do all the work.
00075 //
00076 class  XML256TableTranscoder : public XMLTranscoder
00077 {
00078 public :
00079     // -----------------------------------------------------------------------
00080     //  Public constructors and destructor
00081     // -----------------------------------------------------------------------
00082     virtual ~XML256TableTranscoder();
00083 
00084 
00085     // -----------------------------------------------------------------------
00086     //  The virtual transcoding interface
00087     // -----------------------------------------------------------------------
00088     virtual unsigned int transcodeFrom
00089     (
00090         const   XMLByte* const          srcData
00091         , const unsigned int            srcCount
00092         ,       XMLCh* const            toFill
00093         , const unsigned int            maxChars
00094         ,       unsigned int&           bytesEaten
00095         ,       unsigned char* const    charSizes
00096     );
00097 
00098     virtual unsigned int transcodeTo
00099     (
00100         const   XMLCh* const    srcData
00101         , const unsigned int    srcCount
00102         ,       XMLByte* const  toFill
00103         , const unsigned int    maxBytes
00104         ,       unsigned int&   charsEaten
00105         , const UnRepOpts       options
00106     );
00107 
00108     virtual bool canTranscodeTo
00109     (
00110         const   unsigned int    toCheck
00111     )   const;
00112 
00113 
00114 protected :
00115     // -----------------------------------------------------------------------
00116     //  Hidden constructors
00117     // -----------------------------------------------------------------------
00118     XML256TableTranscoder
00119     (
00120         const   XMLCh* const                        encodingName
00121         , const unsigned int                        blockSize
00122         , const XMLCh* const                        fromTable
00123         , const XMLTransService::TransRec* const    toTable
00124         , const unsigned int                        toTableSize
00125     );
00126 
00127 
00128     // -----------------------------------------------------------------------
00129     //  Protected helper methods
00130     // -----------------------------------------------------------------------
00131     XMLByte xlatOneTo
00132     (
00133         const   XMLCh       toXlat
00134     )   const;
00135 
00136 
00137 private :
00138     // -----------------------------------------------------------------------
00139     //  Unimplemented constructors and operators
00140     // -----------------------------------------------------------------------
00141     XML256TableTranscoder();
00142     XML256TableTranscoder(const XML256TableTranscoder&);
00143     void operator=(const XML256TableTranscoder&);
00144 
00145 
00146     // -----------------------------------------------------------------------
00147     //  Private data members
00148     //
00149     //  fFromTable
00150     //      This is the 'from' table that we were given during construction.
00151     //      It is a 256 entry table of XMLCh chars. Each entry is the
00152     //      Unicode code point for the external encoding point of that value.
00153     //      So fFromTable[N] is the Unicode translation of code point N of
00154     //      the source encoding.
00155     //
00156     //      We don't own this table, we just refer to it. It is assumed that
00157     //      the table is static, for performance reasons.
00158     //
00159     //  fToSize
00160     //      The 'to' table is variable sized. This indicates how many records
00161     //      are in it.
00162     //
00163     //  fToTable
00164     //      This is a variable sized table of TransRec structures. It must
00165     //      be sorted by the intCh field, i.e. the XMLCh field. It is searched
00166     //      binarily to find the record for a particular Unicode char. Then
00167     //      that record's extch field is the translation record.
00168     //
00169     //      We don't own this table, we just refer to it. It is assumed that
00170     //      the table is static, for performance reasons.
00171     //
00172     //      NOTE: There may be dups of the extCh field, since there might be
00173     //      multiple Unicode code points which map to the same external code
00174     //      point. Normally this won't happen, since the parser assumes that
00175     //      internalization is normalized, but we have to be prepared to do
00176     //      the right thing if some client code gives us non-normalized data
00177     //      itself.
00178     // -----------------------------------------------------------------------
00179     const XMLCh*                        fFromTable;
00180     unsigned int                        fToSize;
00181     const XMLTransService::TransRec*    fToTable;
00182 };
00183 
00184 #endif


Copyright © 2000 The Apache Software Foundation. All Rights Reserved.