Synesis Software STLSoft - ... Robust, Lightweight, Cross-platform, Template Software ...

b64/b64.h

Go to the documentation of this file.
00001 /* /////////////////////////////////////////////////////////////////////////
00002  * File:        b64/b64.h
00003  *
00004  * Purpose:     Header file for the b64 library
00005  *
00006  * Created:     18th October 2004
00007  * Updated:     18th November 2009
00008  *
00009  * Thanks:      To Adam McLaurin, for ideas regarding the b64_decode2() and
00010  *              b64_encode2().
00011  *
00012  * Home:        http://synesis.com.au/software/
00013  *
00014  * Copyright (c) 2004-2009, Matthew Wilson and Synesis Software
00015  * All rights reserved.
00016  *
00017  * Redistribution and use in source and binary forms, with or without
00018  * modification, are permitted provided that the following conditions are met:
00019  *
00020  * - Redistributions of source code must retain the above copyright notice, this
00021  *   list of conditions and the following disclaimer.
00022  * - Redistributions in binary form must reproduce the above copyright notice,
00023  *   this list of conditions and the following disclaimer in the documentation
00024  *   and/or other materials provided with the distribution.
00025  * - Neither the name(s) of Matthew Wilson and Synesis Software nor the names of
00026  *   any contributors may be used to endorse or promote products derived from
00027  *   this software without specific prior written permission.
00028  *
00029  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00030  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00031  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00032  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
00033  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00034  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00035  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00036  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00037  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00038  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00039  * POSSIBILITY OF SUCH DAMAGE.
00040  *
00041  * ////////////////////////////////////////////////////////////////////// */
00042 
00043 
00049 #ifndef B64_INCL_B64_H_B64
00050 #define B64_INCL_B64_H_B64
00051 
00052 /* /////////////////////////////////////////////////////////////////////////
00053  * Version information
00054  */
00055 
00056 #ifndef B64_DOCUMENTATION_SKIP_SECTION
00057 # define B64_VER_B64_H_B64_MAJOR    1
00058 # define B64_VER_B64_H_B64_MINOR    6
00059 # define B64_VER_B64_H_B64_REVISION 1
00060 # define B64_VER_B64_H_B64_EDIT     31
00061 #endif /* !B64_DOCUMENTATION_SKIP_SECTION */
00062 
00079 #ifndef B64_DOCUMENTATION_SKIP_SECTION
00080 # define B64_VER_1_0_1          0x01000100
00081 # define B64_VER_1_0_2          0x01000200
00082 # define B64_VER_1_0_3          0x01000300
00083 # define B64_VER_1_1_1          0x01010100
00084 # define B64_VER_1_1_2          0x01010200
00085 # define B64_VER_1_1_3          0x01010300
00086 # define B64_VER_1_2_1          0x01020100
00087 # define B64_VER_1_2_2          0x01020200
00088 # define B64_VER_1_2_3          0x01020300
00089 # define B64_VER_1_2_4          0x01020400
00090 # define B64_VER_1_2_5          0x01020500
00091 # define B64_VER_1_2_6          0x01020600
00092 # define B64_VER_1_2_7          0x01020700
00093 # define B64_VER_1_3_1          0x010301ff
00094 # define B64_VER_1_3_2          0x010302ff
00095 # define B64_VER_1_3_3          0x010303ff
00096 # define B64_VER_1_3_4          0x010304ff
00097 # define B64_VER_1_4_1_ALPHA_1  0x01040101
00098 #endif /* !B64_DOCUMENTATION_SKIP_SECTION */
00099 
00100 #define B64_VER_MAJOR       1
00101 #define B64_VER_MINOR       4
00102 #define B64_VER_REVISION    1
00103 #define B64_VER             0x01040101
00104 
00105 /* /////////////////////////////////////////////////////////////////////////
00106  * Includes
00107  */
00108 
00109 #include <stddef.h>
00110 
00111 /* /////////////////////////////////////////////////////////////////////////
00112  * Features
00113  */
00114 
00115 /* If the Synesis pre-processor symbol SYNESIS_VARIANT_TEST is defined, then we
00116  * automatically define B64_VARIANT_TEST, which requests a test build: i.e.
00117  * debug information off, optimisations on, contract enforcements on
00118  */
00119 #if defined(SYNESIS_VARIANT_TEST)
00120 # if !defined(B64_VARIANT_TEST)
00121 #  define B64_VARIANT_TEST
00122 # endif /* !B64_VARIANT_TEST */
00123 #endif /* SYNESIS_VARIANT_TEST */
00124 
00125 /* /////////////////////////////////////////////////////////////////////////
00126  * Namespace
00127  */
00128 
00129 #if !defined(B64_NO_NAMESPACE) && \
00130     !defined(__cplusplus)
00131 # define B64_NO_NAMESPACE
00132 #endif /* !B64_NO_NAMESPACE && !__cplusplus */
00133 
00134 #ifdef B64_NAMESPACE
00135 # undef B64_NAMESPACE
00136 #endif /* B64_NAMESPACE */
00137 
00138 #ifdef B64_NAMESPACE_QUALIFIER
00139 # undef B64_NAMESPACE_QUALIFIER
00140 #endif /* B64_NAMESPACE_QUALIFIER */
00141 
00142 
00143 #ifndef B64_NO_NAMESPACE
00144 
00145 # ifdef B64_CUSTOM_NAMESPACE
00146 #  define B64_NAMESPACE     B64_CUSTOM_NAMESPACE
00147 # else /* ? B64_CUSTOM_NAMESPACE */
00148 #  define B64_NAMESPACE     b64
00149 # endif /* B64_CUSTOM_NAMESPACE */
00150 
00151 # if defined(B64_CUSTOM_NAMESPACE) && \
00152      defined(B64_CUSTOM_NAMESPACE_QUALIFIER)
00153 #  define B64_NAMESPACE_QUALIFIER       B64_CUSTOM_NAMESPACE_QUALIFIER
00154 # else /* B64_CUSTOM_NAMESPACE && B64_CUSTOM_NAMESPACE_QUALIFIER */
00155 #  define B64_NAMESPACE_QUALIFIER       ::B64_NAMESPACE
00156 # endif /* B64_CUSTOM_NAMESPACE && B64_CUSTOM_NAMESPACE_QUALIFIER */
00157 
00158 
00167 namespace B64_NAMESPACE
00168 {
00169 #endif /* !B64_NO_NAMESPACE */
00170 
00171 /* /////////////////////////////////////////////////////////////////////////
00172  * Typedefs
00173  */
00174 
00179 typedef char    b64_char_t;
00180 
00183 enum B64_RC
00184 {
00185         B64_RC_OK                   =   0   
00186     ,   B64_RC_INSUFFICIENT_BUFFER  =   1   
00187     ,   B64_RC_TRUNCATED_INPUT      =   2   
00188     ,   B64_RC_DATA_ERROR           =   3   
00189 #ifndef B64_DOCUMENTATION_SKIP_SECTION
00190     ,   B64_max_RC_value
00191 #endif /* !B64_DOCUMENTATION_SKIP_SECTION */
00192 };
00193 
00194 #ifndef __cplusplus
00195 typedef enum B64_RC B64_RC;
00196 #endif /* !__cplusplus */
00197 
00200 enum B64_FLAGS
00201 {
00202         B64_F_LINE_LEN_USE_PARAM    =   0x0000  
00203     ,   B64_F_LINE_LEN_INFINITE     =   0x0001  
00204     ,   B64_F_LINE_LEN_64           =   0x0002  
00205     ,   B64_F_LINE_LEN_76           =   0x0003  
00206     ,   B64_F_LINE_LEN_MASK         =   0x000f  
00207     ,   B64_F_STOP_ON_NOTHING       =   0x0000  
00208     ,   B64_F_STOP_ON_UNKNOWN_CHAR  =   0x0100  
00209     ,   B64_F_STOP_ON_UNEXPECTED_WS =   0x0200  
00210     ,   B64_F_STOP_ON_BAD_CHAR      =   0x0300  
00211 };
00212 
00213 #ifndef __cplusplus
00214 typedef enum B64_FLAGS  B64_FLAGS;
00215 #endif /* !__cplusplus */
00216 
00217 /* /////////////////////////////////////////////////////////////////////////
00218  * Functions
00219  */
00220 
00221 #ifdef __cplusplus
00222 extern "C" {
00223 #endif /* __cplusplus */
00224 
00248 size_t b64_encode(
00249     void const* src
00250 ,   size_t      srcSize
00251 ,   b64_char_t* dest
00252 ,   size_t      destLen
00253 );
00254 
00283 size_t b64_encode2(
00284     void const* src
00285 ,   size_t      srcSize
00286 ,   b64_char_t* dest
00287 ,   size_t      destLen
00288 ,   unsigned    flags
00289 ,   int         lineLen /* = 0 */
00290 ,   B64_RC*     rc     /* = NULL */
00291 );
00292 
00326 size_t b64_decode(
00327     b64_char_t const*   src
00328 ,   size_t              srcLen
00329 ,   void*               dest
00330 ,   size_t              destSize
00331 );
00332 
00373 size_t b64_decode2(
00374     b64_char_t const*   src
00375 ,   size_t              srcLen
00376 ,   void*               dest
00377 ,   size_t              destSize
00378 ,   unsigned            flags
00379 ,   b64_char_t const**  badChar /* = NULL */
00380 ,   B64_RC*             rc      /* = NULL */
00381 );
00382 
00387 char const* b64_getErrorString(B64_RC code);
00388 
00395 size_t b64_getErrorStringLength(B64_RC code);
00396 
00397 
00398 #ifdef __cplusplus
00399 } /* extern "C" */
00400 #endif /* __cplusplus */
00401 
00402 /* /////////////////////////////////////////////////////////////////////////
00403  * Namespace
00404  */
00405 
00406 #ifndef B64_NO_NAMESPACE
00407 } /* namespace B64_NAMESPACE */
00408 
00409 # ifndef B64_DOCUMENTATION_SKIP_SECTION
00410 
00411 namespace stlsoft
00412 {
00413 
00414     inline char const *c_str_data_a( B64_NAMESPACE_QUALIFIER::B64_RC code)
00415     {
00416         return B64_NAMESPACE_QUALIFIER::b64_getErrorString(code);
00417     }
00418     inline char const *c_str_data( B64_NAMESPACE_QUALIFIER::B64_RC code)
00419     {
00420         return B64_NAMESPACE_QUALIFIER::b64_getErrorString(code);
00421     }
00422 
00423     inline size_t c_str_len_a( B64_NAMESPACE_QUALIFIER::B64_RC code)
00424     {
00425         return B64_NAMESPACE_QUALIFIER::b64_getErrorStringLength(code);
00426     }
00427     inline size_t c_str_len( B64_NAMESPACE_QUALIFIER::B64_RC code)
00428     {
00429         return B64_NAMESPACE_QUALIFIER::b64_getErrorStringLength(code);
00430     }
00431 
00432     inline char const *c_str_ptr_a( B64_NAMESPACE_QUALIFIER::B64_RC code)
00433     {
00434         return B64_NAMESPACE_QUALIFIER::b64_getErrorString(code);
00435     }
00436     inline char const *c_str_ptr( B64_NAMESPACE_QUALIFIER::B64_RC code)
00437     {
00438         return B64_NAMESPACE_QUALIFIER::b64_getErrorString(code);
00439     }
00440 
00441 } /* namespace stlsoft */
00442 
00443 # endif /* !B64_DOCUMENTATION_SKIP_SECTION */
00444 
00445 #endif /* !B64_NO_NAMESPACE */
00446 
00447 /* ////////////////////////////////////////////////////////////////////// */
00448 
00449 #endif /* B64_INCL_B64_H_B64 */
00450 
00451 /* ///////////////////////////// end of file //////////////////////////// */

b64 Library documentation © Synesis Software Pty Ltd, 2004-2007