Xalan-C++ API Documentation

The Xalan-C++ XSL Transformer Version 1.0

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

XalanTranscodingServices.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 2000 The Apache Software Foundation.  All rights 
00006  * reserved.
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions
00010  * are met:
00011  *
00012  * 1. Redistributions of source code must retain the above copyright
00013  *    notice, this list of conditions and the following disclaimer. 
00014  *
00015  * 2. Redistributions in binary form must reproduce the above copyright
00016  *    notice, this list of conditions and the following disclaimer in
00017  *    the documentation and/or other materials provided with the
00018  *    distribution.
00019  *
00020  * 3. The end-user documentation included with the redistribution,
00021  *    if any, must include the following acknowledgment:  
00022  *       "This product includes software developed by the
00023  *        Apache Software Foundation (http://www.apache.org/)."
00024  *    Alternately, this acknowledgment may appear in the software itself,
00025  *    if and wherever such third-party acknowledgments normally appear.
00026  *
00027  * 4. The names "Xalan" and "Apache Software Foundation" must
00028  *    not be used to endorse or promote products derived from this
00029  *    software without prior written permission. For written 
00030  *    permission, please contact apache@apache.org.
00031  *
00032  * 5. Products derived from this software may not be called "Apache",
00033  *    nor may "Apache" appear in their name, without prior written
00034  *    permission of the Apache Software Foundation.
00035  *
00036  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00037  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00038  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00039  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00040  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00041  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00042  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00043  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00044  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00045  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00046  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00047  * SUCH DAMAGE.
00048  * ====================================================================
00049  *
00050  * This software consists of voluntary contributions made by many
00051  * individuals on behalf of the Apache Software Foundation and was
00052  * originally based on software copyright (c) 1999, International
00053  * Business Machines, Inc., http://www.ibm.com.  For more
00054  * information on the Apache Software Foundation, please see
00055  * <http://www.apache.org/>.
00056  */
00057 #if !defined(XALANTRANSCODINGSERVICES_HEADER_GUARD_1357924680)
00058 #define XALANTRANSCODINGSERVICES_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 // Base include file.  Must be first.
00063 #include <PlatformSupport/PlatformSupportDefinitions.hpp>
00064 
00065 
00066 
00067 #include <vector>
00068 
00069 
00070 
00071 #include <XalanDOM/XalanDOMString.hpp>
00072 
00073 
00074 
00075 class XalanOutputTranscoder;
00076 
00077 
00078 
00079 class XALAN_PLATFORMSUPPORT_EXPORT XalanTranscodingServices
00080 {
00081 public:
00082 
00083     typedef unsigned char   XalanXMLByte;
00084 
00085 #if defined(XALAN_NO_NAMESPACES)
00086     typedef vector<XalanXMLByte>        XalanXMLByteVectorType;
00087 #else
00088     typedef std::vector<XalanXMLByte>   XalanXMLByteVectorType;
00089 #endif
00090 
00094     static void
00095     initialize();
00096 
00100     static void
00101     terminate();
00102 
00103     enum eCode
00104     {
00105         OK,
00106         UnsupportedEncoding,
00107         InternalFailure,
00108         SupportFilesNotFound
00109     };
00110 
00111 
00121     static XalanOutputTranscoder*
00122     makeNewTranscoder(
00123             const XalanDOMString&   theEncodingName,
00124             eCode&                  theResult,
00125             unsigned int            theBlockSize);
00126 
00132     static void
00133     destroyTranscoder(XalanOutputTranscoder*    theTranscoder);
00134 
00141     static bool
00142     encodingIsUTF16(const XalanDOMChar*     theEncodingName);
00143 
00150     static bool
00151     encodingIsUTF16(const XalanDOMString&   theEncodingName);
00152 
00164     static const XalanXMLByteVectorType&
00165     getStreamProlog(const XalanDOMString&   theEncodingName);
00166 
00167 private:
00168 
00169     static const XalanDOMChar   s_UTF8String[];
00170     static const XalanDOMChar   s_UTF16String[];
00171 };
00172 
00173 
00174 
00175 class XALAN_PLATFORMSUPPORT_EXPORT XalanOutputTranscoder
00176 {
00177 public:
00178 
00179     typedef XalanTranscodingServices::XalanXMLByte  XalanXMLByte;
00180     typedef XalanTranscodingServices::eCode         eCode;
00181 
00182     explicit
00183     XalanOutputTranscoder();
00184 
00185     virtual
00186     ~XalanOutputTranscoder();
00187 
00201     virtual eCode
00202     transcode(
00203             const XalanDOMChar*     theSourceData,
00204             unsigned int            theSourceCount,
00205             XalanXMLByte*           theTarget,
00206             unsigned int            theTargetSize,
00207             unsigned int&           theSourceCharsTranscoded,
00208             unsigned int&           theTargetBytesUsed) = 0;
00209 
00210 private:
00211 
00212     // Not implemented...
00213     XalanOutputTranscoder(const XalanOutputTranscoder&  theSource);
00214 
00215     bool
00216     operator==(const XalanOutputTranscoder& theRHS) const;
00217 
00218     XalanOutputTranscoder&
00219     operator=(const XalanOutputTranscoder&  theRHS);
00220 };
00221 
00222 
00223 
00224 #endif  // NULLTEXTOUTPUTSTREAM_HEADER_GUARD_1357924680

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

Xalan-C++ XSL Transformer Version 1.0
Copyright © 2000 The Apache Software Foundation. All Rights Reserved.