Base64.hpp

Go to the documentation of this file.
00001 /*
00002  * Licensed to the Apache Software Foundation (ASF) under one or more
00003  * contributor license agreements.  See the NOTICE file distributed with
00004  * this work for additional information regarding copyright ownership.
00005  * The ASF licenses this file to You under the Apache License, Version 2.0
00006  * (the "License"); you may not use this file except in compliance with
00007  * the License.  You may obtain a copy of the License at
00008  * 
00009  *      http://www.apache.org/licenses/LICENSE-2.0
00010  * 
00011  * Unless required by applicable law or agreed to in writing, software
00012  * distributed under the License is distributed on an "AS IS" BASIS,
00013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00014  * See the License for the specific language governing permissions and
00015  * limitations under the License.
00016  */
00017 
00018 /*
00019  * $Id: Base64.hpp 555320 2007-07-11 16:05:13Z amassari $
00020  */
00021 
00022 #if !defined(XERCESC_INCLUDE_GUARD_BASE64_HPP)
00023 #define XERCESC_INCLUDE_GUARD_BASE64_HPP
00024 
00025 #include <xercesc/util/XercesDefs.hpp>
00026 #include <xercesc/util/XMLUniDefs.hpp>
00027 #include <xercesc/framework/MemoryManager.hpp>
00028 
00029 XERCES_CPP_NAMESPACE_BEGIN
00030 
00031 //
00032 // This class provides encode/decode for RFC 2045 Base64 as
00033 // defined by RFC 2045, N. Freed and N. Borenstein.
00034 // RFC 2045: Multipurpose Internet Mail Extensions (MIME)
00035 // Part One: Format of Internet Message Bodies. Reference
00036 // 1996 Available at: http://www.ietf.org/rfc/rfc2045.txt
00037 // This class is used by XML Schema binary format validation
00038 //
00039 //
00040 class XMLUTIL_EXPORT Base64
00041 {
00042 public :
00043 
00044     enum Conformance
00045     {
00046         Conf_RFC2045
00047       , Conf_Schema
00048     };
00049 
00051 
00070     static XMLByte* encode(const XMLByte* const inputData
00071                          , const XMLSize_t      inputLength
00072                          , XMLSize_t*           outputLength
00073                          , MemoryManager* const memMgr = 0);
00074 
00097     static XMLByte* decode(
00098                            const XMLByte*        const   inputData
00099                          ,       XMLSize_t*              decodedLength
00100                          ,       MemoryManager*  const   memMgr = 0
00101                          ,       Conformance             conform = Conf_RFC2045
00102                           );
00103   
00126     static XMLByte* decodeToXMLByte(
00127                            const XMLCh*          const   inputData
00128                          ,       XMLSize_t*              decodedLength
00129                          ,       MemoryManager*  const   memMgr = 0
00130                          ,       Conformance             conform = Conf_RFC2045
00131                           );
00144     static int getDataLength(
00145                              const XMLCh*         const  inputData
00146                             ,      MemoryManager* const  memMgr = 0
00147                             ,      Conformance           conform = Conf_RFC2045
00148                              );
00149 
00151 
00167     static XMLCh* getCanonicalRepresentation
00168                   (
00169                       const XMLCh*          const inputData
00170                     ,       MemoryManager*  const memMgr = 0
00171                     ,       Conformance           conform = Conf_RFC2045
00172                   );
00173 
00174 private :
00175 
00176     // -----------------------------------------------------------------------
00177     //  Helper methods
00178     // -----------------------------------------------------------------------
00179 
00180     static XMLByte* decode(
00181                            const XMLByte*        const   inputData
00182                          ,       XMLSize_t*              outputLength
00183                          ,       XMLByte*&               canRepData
00184                          ,       MemoryManager*  const   memMgr = 0
00185                          ,       Conformance             conform = Conf_RFC2045
00186                           );
00187 
00188     static bool isData(const XMLByte& octet);
00189     static bool isPad(const XMLByte& octet);
00190 
00191     static XMLByte set1stOctet(const XMLByte&, const XMLByte&);
00192     static XMLByte set2ndOctet(const XMLByte&, const XMLByte&);
00193     static XMLByte set3rdOctet(const XMLByte&, const XMLByte&);
00194 
00195     static void split1stOctet(const XMLByte&, XMLByte&, XMLByte&);
00196     static void split2ndOctet(const XMLByte&, XMLByte&, XMLByte&);
00197     static void split3rdOctet(const XMLByte&, XMLByte&, XMLByte&);
00198 
00199     // -----------------------------------------------------------------------
00200     //  Unimplemented constructors and operators
00201     // -----------------------------------------------------------------------
00202     Base64();
00203     Base64(const Base64&);
00204 
00205     // -----------------------------------------------------------------------
00206     //  Private data members
00207     //
00208     //  base64Alphabet
00209     //     The Base64 alphabet (see RFC 2045).
00210     //
00211     //  base64Padding
00212     //     Padding character (see RFC 2045).
00213     //
00214     //  base64Inverse
00215     //     Table used in decoding base64.
00216     //
00217     //  isInitialized
00218     //     Set once base64Inverse is initalized.
00219     //
00220     //  quadsPerLine
00221     //     Number of quadruplets per one line. The encoded output
00222     //     stream must be represented in lines of no more
00223     //     than 19 quadruplets each.
00224     //
00225     // -----------------------------------------------------------------------
00226 
00227     static const XMLByte  base64Alphabet[];
00228     static const XMLByte  base64Padding;
00229 
00230     static const XMLByte  base64Inverse[];
00231 
00232     static const unsigned int  quadsPerLine;
00233 };
00234 
00235 // -----------------------------------------------------------------------
00236 //  Helper methods
00237 // -----------------------------------------------------------------------
00238 inline bool Base64::isPad(const XMLByte& octet)
00239 {
00240     return ( octet == base64Padding );
00241 }
00242 
00243 inline XMLByte Base64::set1stOctet(const XMLByte& b1, const XMLByte& b2)
00244 {
00245     return (( b1 << 2 ) | ( b2 >> 4 ));
00246 }
00247 
00248 inline XMLByte Base64::set2ndOctet(const XMLByte& b2, const XMLByte& b3)
00249 {
00250     return (( b2 << 4 ) | ( b3 >> 2 ));
00251 }
00252 
00253 inline XMLByte Base64::set3rdOctet(const XMLByte& b3, const XMLByte& b4)
00254 {
00255     return (( b3 << 6 ) | b4 );
00256 }
00257 
00258 inline void Base64::split1stOctet(const XMLByte& ch, XMLByte& b1, XMLByte& b2) {
00259     b1 = ch >> 2;
00260     b2 = ( ch & 0x3 ) << 4;
00261 }
00262 
00263 inline void Base64::split2ndOctet(const XMLByte& ch, XMLByte& b2, XMLByte& b3) {
00264     b2 |= ch >> 4;  // combine with previous value
00265     b3 = ( ch & 0xf ) << 2;
00266 }
00267 
00268 inline void Base64::split3rdOctet(const XMLByte& ch, XMLByte& b3, XMLByte& b4) {
00269     b3 |= ch >> 6;  // combine with previous value
00270     b4 = ( ch & 0x3f );
00271 }
00272 
00273 XERCES_CPP_NAMESPACE_END
00274 
00275 #endif

Generated on Wed Feb 18 07:56:09 2009 for Xerces-C++ by  doxygen 1.5.4