Base64.h.in 4.52 KB
Newer Older
1 2 3
/*============================================================================
  KWSys - Kitware System Library
  Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
4

5 6
  Distributed under the OSI-approved BSD License (the "License");
  see accompanying file Copyright.txt for details.
7

8 9 10 11
  This software is distributed WITHOUT ANY WARRANTY; without even the
  implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  See the License for more information.
============================================================================*/
12 13 14
#ifndef @KWSYS_NAMESPACE@_Base64_h
#define @KWSYS_NAMESPACE@_Base64_h

Brad King's avatar
Brad King committed
15 16
#include <@KWSYS_NAMESPACE@/Configure.h>

17 18
#include <stddef.h> /* size_t */

19 20 21 22
/* Redefine all public interface symbol names to be in the proper
   namespace.  These macros are used internally to kwsys only, and are
   not visible to user code.  Use kwsysHeaderDump.pl to reproduce
   these macros after making changes to the interface.  */
23 24 25 26
#if !defined(KWSYS_NAMESPACE)
# define kwsys_ns(x) @KWSYS_NAMESPACE@##x
# define kwsysEXPORT @KWSYS_NAMESPACE@_EXPORT
#endif
27 28 29 30 31 32 33 34 35
#if !@KWSYS_NAMESPACE@_NAME_IS_KWSYS
# define kwsysBase64          kwsys_ns(Base64)
# define kwsysBase64_Decode   kwsys_ns(Base64_Decode)
# define kwsysBase64_Decode3  kwsys_ns(Base64_Decode3)
# define kwsysBase64_Encode   kwsys_ns(Base64_Encode)
# define kwsysBase64_Encode1  kwsys_ns(Base64_Encode1)
# define kwsysBase64_Encode2  kwsys_ns(Base64_Encode2)
# define kwsysBase64_Encode3  kwsys_ns(Base64_Encode3)
#endif
36 37 38 39 40 41

#if defined(__cplusplus)
extern "C"
{
#endif

42 43 44
/**
 * Encode 3 bytes into a 4 byte string.
 */
Brad King's avatar
Brad King committed
45 46
kwsysEXPORT void kwsysBase64_Encode3(const unsigned char *src,
                                     unsigned char *dest);
47

48 49 50
/**
 * Encode 2 bytes into a 4 byte string.
 */
Brad King's avatar
Brad King committed
51 52
kwsysEXPORT void kwsysBase64_Encode2(const unsigned char *src,
                                     unsigned char *dest);
53

54 55 56
/**
 * Encode 1 bytes into a 4 byte string.
 */
Brad King's avatar
Brad King committed
57 58
kwsysEXPORT void kwsysBase64_Encode1(const unsigned char *src,
                                     unsigned char *dest);
59

60 61 62 63 64 65 66 67 68 69 70 71 72
/**
 * Encode 'length' bytes from the input buffer and store the encoded
 * stream into the output buffer. Return the length of the encoded
 * buffer (output). Note that the output buffer must be allocated by
 * the caller (length * 1.5 should be a safe estimate).  If 'mark_end'
 * is true than an extra set of 4 bytes is added to the end of the
 * stream if the input is a multiple of 3 bytes.  These bytes are
 * invalid chars and therefore they will stop the decoder thus
 * enabling the caller to decode a stream without actually knowing how
 * much data to expect (if the input is not a multiple of 3 bytes then
 * the extra padding needed to complete the encode 4 bytes will stop
 * the decoding anyway).
 */
73 74 75 76
kwsysEXPORT size_t kwsysBase64_Encode(const unsigned char *input,
                                      size_t length,
                                      unsigned char *output,
                                      int mark_end);
77 78 79 80 81

/**
 * Decode 4 bytes into a 3 byte string.  Returns the number of bytes
 * actually decoded.
 */
Brad King's avatar
Brad King committed
82 83
kwsysEXPORT int kwsysBase64_Decode3(const unsigned char *src,
                                    unsigned char *dest);
84

85 86 87 88 89 90 91 92 93 94 95 96
/**
 * Decode bytes from the input buffer and store the decoded stream
 * into the output buffer until 'length' bytes have been decoded.
 * Return the real length of the decoded stream (which should be equal
 * to 'length'). Note that the output buffer must be allocated by the
 * caller.  If 'max_input_length' is not null, then it specifies the
 * number of encoded bytes that should be at most read from the input
 * buffer. In that case the 'length' parameter is ignored. This
 * enables the caller to decode a stream without actually knowing how
 * much decoded data to expect (of course, the buffer must be large
 * enough).
 */
97 98 99 100
kwsysEXPORT size_t kwsysBase64_Decode(const unsigned char *input,
                                      size_t length,
                                      unsigned char *output,
                                      size_t max_input_length);
101 102 103 104 105

#if defined(__cplusplus)
} /* extern "C" */
#endif

106 107 108
/* If we are building a kwsys .c or .cxx file, let it use these macros.
   Otherwise, undefine them to keep the namespace clean.  */
#if !defined(KWSYS_NAMESPACE)
109
# undef kwsys_ns
Brad King's avatar
Brad King committed
110
# undef kwsysEXPORT
111 112 113 114 115 116 117 118 119
# if !@KWSYS_NAMESPACE@_NAME_IS_KWSYS
#  undef kwsysBase64
#  undef kwsysBase64_Decode
#  undef kwsysBase64_Decode3
#  undef kwsysBase64_Encode
#  undef kwsysBase64_Encode1
#  undef kwsysBase64_Encode2
#  undef kwsysBase64_Encode3
# endif
120 121 122
#endif

#endif