Base64.h.in 4.01 KB
Newer Older
1 2
/* Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
   file Copyright.txt or https://cmake.org/licensing#kwsys for details.  */
Andy Cedilnik's avatar
Andy Cedilnik committed
3 4 5
#ifndef @KWSYS_NAMESPACE@_Base64_h
#define @KWSYS_NAMESPACE@_Base64_h

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

8 9
#include <stddef.h> /* size_t */

Andy Cedilnik's avatar
Andy Cedilnik committed
10 11 12 13
/* 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.  */
14
#if !defined(KWSYS_NAMESPACE)
15 16
#define kwsys_ns(x) @KWSYS_NAMESPACE@##x
#define kwsysEXPORT @KWSYS_NAMESPACE@_EXPORT
17
#endif
18
#if !@KWSYS_NAMESPACE@_NAME_IS_KWSYS
19 20 21 22 23 24 25
#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)
26
#endif
Andy Cedilnik's avatar
Andy Cedilnik committed
27 28

#if defined(__cplusplus)
29
extern "C" {
Andy Cedilnik's avatar
Andy Cedilnik committed
30 31
#endif

Brad King's avatar
Brad King committed
32 33 34
/**
 * Encode 3 bytes into a 4 byte string.
 */
35 36
kwsysEXPORT void kwsysBase64_Encode3(const unsigned char* src,
                                     unsigned char* dest);
Andy Cedilnik's avatar
Andy Cedilnik committed
37

Brad King's avatar
Brad King committed
38 39 40
/**
 * Encode 2 bytes into a 4 byte string.
 */
41 42
kwsysEXPORT void kwsysBase64_Encode2(const unsigned char* src,
                                     unsigned char* dest);
Andy Cedilnik's avatar
Andy Cedilnik committed
43

Brad King's avatar
Brad King committed
44 45 46
/**
 * Encode 1 bytes into a 4 byte string.
 */
47 48
kwsysEXPORT void kwsysBase64_Encode1(const unsigned char* src,
                                     unsigned char* dest);
Andy Cedilnik's avatar
Andy Cedilnik committed
49

Brad King's avatar
Brad King committed
50 51 52 53 54 55 56 57 58 59 60 61 62
/**
 * 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).
 */
63 64
kwsysEXPORT size_t kwsysBase64_Encode(const unsigned char* input,
                                      size_t length, unsigned char* output,
65
                                      int mark_end);
Brad King's avatar
Brad King committed
66 67 68 69 70

/**
 * Decode 4 bytes into a 3 byte string.  Returns the number of bytes
 * actually decoded.
 */
71 72
kwsysEXPORT int kwsysBase64_Decode3(const unsigned char* src,
                                    unsigned char* dest);
Andy Cedilnik's avatar
Andy Cedilnik committed
73

Brad King's avatar
Brad King committed
74 75 76 77 78 79 80 81 82 83 84 85
/**
 * 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).
 */
86 87
kwsysEXPORT size_t kwsysBase64_Decode(const unsigned char* input,
                                      size_t length, unsigned char* output,
88
                                      size_t max_input_length);
Andy Cedilnik's avatar
Andy Cedilnik committed
89 90 91 92 93

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

94 95 96
/* 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)
97 98 99 100 101 102 103 104 105 106 107
#undef kwsys_ns
#undef kwsysEXPORT
#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
Andy Cedilnik's avatar
Andy Cedilnik committed
108 109 110
#endif

#endif