Base64.hpp Source 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.2 2001/05/28 21:11:16 tng Exp $
00059  */
00060 
00061 #ifndef BASE64_HPP
00062 #define BASE64_HPP
00063 
00064 #include <util/XercesDefs.hpp>
00065 #include <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 
00090     static int getDataLength(const XMLCh* const base64Data);
00091 
00098     static XMLCh* decode(const XMLCh* const base64Data, int& base64DataLen);
00099 
00101 
00102 private :
00103 
00104     // -----------------------------------------------------------------------
00105     //  Helper methods
00106     // -----------------------------------------------------------------------
00107 
00108     static void init();
00109 
00110     static bool isData(const XMLCh& octect);
00111 
00112     static bool isPad(const XMLCh& octect);
00113 
00114     static XMLCh set1stOctect(const XMLCh&, const XMLCh&);
00115 
00116     static XMLCh set2ndOctect(const XMLCh&, const XMLCh&);
00117 
00118     static XMLCh set3rdOctect(const XMLCh&, const XMLCh&);
00119 
00120     // -----------------------------------------------------------------------
00121     //  Unimplemented constructors and operators
00122     // -----------------------------------------------------------------------
00123     Base64();
00124     Base64(const Base64&);
00125 
00126     // -----------------------------------------------------------------------
00127     //  Private data members
00128     //
00129     //  isInitialized
00130     //
00131     //     set once hexNumberTable is initalized.
00132     //
00133     //  base64Alphabet
00134     //
00135     //     table used in decoding base64
00136     //
00137     // -----------------------------------------------------------------------
00138 
00139     static bool    isInitialized;
00140     static XMLCh   base64Alphabet[];
00141 
00142 };
00143 
00144 // -----------------------------------------------------------------------
00145 //  Helper methods
00146 // -----------------------------------------------------------------------
00147 inline bool Base64::isPad(const XMLCh& octect) 
00148 {
00149     return(octect == chEqual);
00150 }
00151 
00152 inline XMLCh Base64::set1stOctect(const XMLCh& b1, const XMLCh& b2)
00153 {
00154     return (( b1 <<2 ) | ( b2>>4 ));
00155 }
00156 
00157 inline XMLCh Base64::set2ndOctect(const XMLCh& b2, const XMLCh& b3)
00158 {
00159     return ((( b2 & 0xf )<<4 ) | (( b3>>2 ) & 0xf));
00160 }
00161 
00162 inline XMLCh Base64::set3rdOctect(const XMLCh& b3, const XMLCh& b4)
00163 {
00164     return (( b3<<6 ) | b4 );
00165 }
00166 
00167 #endif
00168