| API Docs for SAX and DOM |

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

# Base64.hpp

Go to the documentation of this file.

    00001 /*
    00002  * The Apache Software License, Version 1.1
    00003  *
    00004  * Copyright (c) 2001 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) 2001, 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  * $Id: Base64.hpp,v 1.3 2002/02/15 21:36:56 peiyongz Exp $
    00059  */
    00060
    00061 #ifndef BASE64_HPP
    00062 #define BASE64_HPP
    00063
    00064 #include <xercesc/util/XercesDefs.hpp>
    00065 #include <xercesc/util/XMLUniDefs.hpp>
    00066
    00067 //
    00068 // This class provides encode/decode for RFC 2045 Base64 as
    00069 // defined by RFC 2045, N. Freed and N. Borenstein.
    00070 // RFC 2045: Multipurpose Internet Mail Extensions (MIME)
    00071 // Part One: Format of Internet Message Bodies. Reference
    00072 // 1996 Available at: http://www.ietf.org/rfc/rfc2045.txt
    00073 // This class is used by XML Schema binary format validation
    00074 //
    00075 //
    00076 class  Base64
    00077 {
    00078 public :
    00079
    00081
    00091     static XMLByte* encode(const XMLByte* const inputData,
    00092                            const unsigned int   inputLength,
    00093                            unsigned int*        outputLength);
    00094
    00103     static XMLByte* decode(const XMLByte* const inputData,
    00104                            unsigned int*        outputLength);
    00105
    00114     static XMLCh* decode(const XMLCh* const inputData,
    00115                          unsigned int*      outputLength);
    00116
    00127     static int getDataLength(const XMLCh* const inputData );
    00128
    00130
    00131 private :
    00132
    00133     // -----------------------------------------------------------------------
    00134     //  Helper methods
    00135     // -----------------------------------------------------------------------
    00136
    00137     static void init();
    00138
    00139     static bool isData(const XMLByte& octet);
    00140     static bool isPad(const XMLByte& octet);
    00141
    00142     static XMLByte set1stOctet(const XMLByte&, const XMLByte&);
    00143     static XMLByte set2ndOctet(const XMLByte&, const XMLByte&);
    00144     static XMLByte set3rdOctet(const XMLByte&, const XMLByte&);
    00145
    00146     static void split1stOctet(const XMLByte&, XMLByte&, XMLByte&);
    00147     static void split2ndOctet(const XMLByte&, XMLByte&, XMLByte&);
    00148     static void split3rdOctet(const XMLByte&, XMLByte&, XMLByte&);
    00149
    00150     // -----------------------------------------------------------------------
    00151     //  Unimplemented constructors and operators
    00152     // -----------------------------------------------------------------------
    00153     Base64();
    00154     Base64(const Base64&);
    00155
    00156     // -----------------------------------------------------------------------
    00157     //  Private data members
    00158     //
    00159     //  base64Alphabet
    00160     //     The Base64 alphabet (see RFC 2045).
    00161     //
    00162     //  base64Padding
    00163     //     Padding character (see RFC 2045).
    00164     //
    00165     //  base64Inverse
    00166     //     Table used in decoding base64.
    00167     //
    00168     //  isInitialized
    00169     //     Set once base64Inverse is initalized.
    00170     //
    00171     //  quadsPerLine
    00172     //     Number of quadruplets per one line. The encoded output
    00173     //     stream must be represented in lines of no more
    00174     //     than 19 quadruplets each.
    00175     //
    00176     // -----------------------------------------------------------------------
    00177
    00178     static const XMLByte  base64Alphabet[];
    00179     static const XMLByte  base64Padding;
    00180
    00181     static XMLByte  base64Inverse[];
    00182     static bool  isInitialized;
    00183
    00184     static const unsigned int  quadsPerLine;
    00185 };
    00186
    00187 // -----------------------------------------------------------------------
    00188 //  Helper methods
    00189 // -----------------------------------------------------------------------
    00190 inline bool Base64::isPad(const XMLByte& octet)
    00191 {
    00192     return ( octet == base64Padding );
    00193 }
    00194
    00195 inline XMLByte Base64::set1stOctet(const XMLByte& b1, const XMLByte& b2)
    00196 {
    00197     return (( b1 << 2 ) | ( b2 >> 4 ));
    00198 }
    00199
    00200 inline XMLByte Base64::set2ndOctet(const XMLByte& b2, const XMLByte& b3)
    00201 {
    00202     return (( b2 << 4 ) | ( b3 >> 2 ));
    00203 }
    00204
    00205 inline XMLByte Base64::set3rdOctet(const XMLByte& b3, const XMLByte& b4)
    00206 {
    00207     return (( b3 << 6 ) | b4 );
    00208 }
    00209
    00210 inline void Base64::split1stOctet(const XMLByte& ch, XMLByte& b1, XMLByte& b2) {
    00211     b1 = ch >> 2;
    00212     b2 = ( ch & 0x3 ) << 4;
    00213 }
    00214
    00215 inline void Base64::split2ndOctet(const XMLByte& ch, XMLByte& b2, XMLByte& b3) {
    00216     b2 |= ch >> 4;  // combine with previous value
    00217     b3 = ( ch & 0xf ) << 2;
    00218 }
    00219
    00220 inline void Base64::split3rdOctet(const XMLByte& ch, XMLByte& b3, XMLByte& b4) {
    00221     b3 |= ch >> 6;  // combine with previous value
    00222     b4 = ( ch & 0x3f );
    00223 }
    00224
    00225 #endif

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