Base64.hpp Source File

| 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.6 2003/05/20 21:32:02 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 #include <xercesc/framework/MemoryManager.hpp>
    00067
    00068 XERCES_CPP_NAMESPACE_BEGIN
    00069
    00070 //
    00071 // This class provides encode/decode for RFC 2045 Base64 as
    00072 // defined by RFC 2045, N. Freed and N. Borenstein.
    00073 // RFC 2045: Multipurpose Internet Mail Extensions (MIME)
    00074 // Part One: Format of Internet Message Bodies. Reference
    00075 // 1996 Available at: http://www.ietf.org/rfc/rfc2045.txt
    00076 // This class is used by XML Schema binary format validation
    00077 //
    00078 //
    00079 class  Base64
    00080 {
    00081 public :
    00082
    00084
    00103     static XMLByte* encode(const XMLByte* const inputData
    00104                          , const unsigned int   inputLength
    00105                          , unsigned int*        outputLength
    00106                          , MemoryManager* const memMgr = 0);
    00107
    00125     static XMLByte* decode(const XMLByte* const inputData
    00126                          , unsigned int*        outputLength
    00127                          , MemoryManager* const memMgr = 0);
    00128
    00146     static XMLCh* decode(const XMLCh* const   inputData
    00147                        , unsigned int*        outputLength
    00148                        , MemoryManager* const memMgr = 0);
    00149
    00160     static int getDataLength(const XMLCh* const inputData);
    00161
    00163
    00164 private :
    00165
    00166     // -----------------------------------------------------------------------
    00167     //  Helper methods
    00168     // -----------------------------------------------------------------------
    00169
    00170     static void init();
    00171
    00172     static bool isData(const XMLByte& octet);
    00173     static bool isPad(const XMLByte& octet);
    00174
    00175     static XMLByte set1stOctet(const XMLByte&, const XMLByte&);
    00176     static XMLByte set2ndOctet(const XMLByte&, const XMLByte&);
    00177     static XMLByte set3rdOctet(const XMLByte&, const XMLByte&);
    00178
    00179     static void split1stOctet(const XMLByte&, XMLByte&, XMLByte&);
    00180     static void split2ndOctet(const XMLByte&, XMLByte&, XMLByte&);
    00181     static void split3rdOctet(const XMLByte&, XMLByte&, XMLByte&);
    00182
    00183     // -----------------------------------------------------------------------
    00184     //  Unimplemented constructors and operators
    00185     // -----------------------------------------------------------------------
    00186     Base64();
    00187     Base64(const Base64&);
    00188
    00189     // -----------------------------------------------------------------------
    00190     //  Private data members
    00191     //
    00192     //  base64Alphabet
    00193     //     The Base64 alphabet (see RFC 2045).
    00194     //
    00195     //  base64Padding
    00196     //     Padding character (see RFC 2045).
    00197     //
    00198     //  base64Inverse
    00199     //     Table used in decoding base64.
    00200     //
    00201     //  isInitialized
    00202     //     Set once base64Inverse is initalized.
    00203     //
    00204     //  quadsPerLine
    00205     //     Number of quadruplets per one line. The encoded output
    00206     //     stream must be represented in lines of no more
    00207     //     than 19 quadruplets each.
    00208     //
    00209     // -----------------------------------------------------------------------
    00210
    00211     static const XMLByte  base64Alphabet[];
    00212     static const XMLByte  base64Padding;
    00213
    00214     static XMLByte  base64Inverse[];
    00215     static bool  isInitialized;
    00216
    00217     static const unsigned int  quadsPerLine;
    00218 };
    00219
    00220 // -----------------------------------------------------------------------
    00221 //  Helper methods
    00222 // -----------------------------------------------------------------------
    00223 inline bool Base64::isPad(const XMLByte& octet)
    00224 {
    00225     return ( octet == base64Padding );
    00226 }
    00227
    00228 inline XMLByte Base64::set1stOctet(const XMLByte& b1, const XMLByte& b2)
    00229 {
    00230     return (( b1 << 2 ) | ( b2 >> 4 ));
    00231 }
    00232
    00233 inline XMLByte Base64::set2ndOctet(const XMLByte& b2, const XMLByte& b3)
    00234 {
    00235     return (( b2 << 4 ) | ( b3 >> 2 ));
    00236 }
    00237
    00238 inline XMLByte Base64::set3rdOctet(const XMLByte& b3, const XMLByte& b4)
    00239 {
    00240     return (( b3 << 6 ) | b4 );
    00241 }
    00242
    00243 inline void Base64::split1stOctet(const XMLByte& ch, XMLByte& b1, XMLByte& b2) {
    00244     b1 = ch >> 2;
    00245     b2 = ( ch & 0x3 ) << 4;
    00246 }
    00247
    00248 inline void Base64::split2ndOctet(const XMLByte& ch, XMLByte& b2, XMLByte& b3) {
    00249     b2 |= ch >> 4;  // combine with previous value
    00250     b3 = ( ch & 0xf ) << 2;
    00251 }
    00252
    00253 inline void Base64::split3rdOctet(const XMLByte& ch, XMLByte& b3, XMLByte& b4) {
    00254     b3 |= ch >> 6;  // combine with previous value
    00255     b4 = ( ch & 0x3f );
    00256 }
    00257
    00258 XERCES_CPP_NAMESPACE_END
    00259
    00260 #endif

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