Base64.h.in 4.48 KB
Newer Older
Andy Cedilnik's avatar
Andy Cedilnik committed
1
2
3
4
5
/*=========================================================================

  Program:   KWSys - Kitware System Library
  Module:    $RCSfile$

Brad King's avatar
Brad King committed
6
7
  Copyright (c) Kitware, Inc., Insight Consortium.  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
Andy Cedilnik's avatar
Andy Cedilnik committed
8

Brad King's avatar
Brad King committed
9
10
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
Andy Cedilnik's avatar
Andy Cedilnik committed
11
12
13
14
15
16
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef @KWSYS_NAMESPACE@_Base64_h
#define @KWSYS_NAMESPACE@_Base64_h

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

Andy Cedilnik's avatar
Andy Cedilnik committed
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
#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)
Andy Cedilnik's avatar
Andy Cedilnik committed
34
35
36
37
38
39

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

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

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

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

Brad King's avatar
Brad King committed
58
59
60
61
62
63
64
65
66
67
68
69
70
/**
 * 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).
 */
Brad King's avatar
Brad King committed
71
72
73
74
kwsysEXPORT unsigned long kwsysBase64_Encode(const unsigned char *input,
                                             unsigned long length,
                                             unsigned char *output,
                                             int mark_end);
Brad King's avatar
Brad King committed
75
76
77
78
79

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

Brad King's avatar
Brad King committed
83
84
85
86
87
88
89
90
91
92
93
94
/**
 * 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).
 */
Brad King's avatar
Brad King committed
95
96
97
98
kwsysEXPORT unsigned long kwsysBase64_Decode(const unsigned char *input, 
                                             unsigned long length,
                                             unsigned char *output,
                                             unsigned long max_input_length);
Andy Cedilnik's avatar
Andy Cedilnik committed
99
100
101
102
103

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

104
105
106
/* 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)
107
# undef kwsys_ns
Brad King's avatar
Brad King committed
108
# undef kwsysEXPORT
Andy Cedilnik's avatar
Andy Cedilnik committed
109
# undef kwsysBase64
Brad King's avatar
Brad King committed
110
111
112
113
114
115
# undef kwsysBase64_Decode
# undef kwsysBase64_Decode3
# undef kwsysBase64_Encode
# undef kwsysBase64_Encode1
# undef kwsysBase64_Encode2
# undef kwsysBase64_Encode3
Andy Cedilnik's avatar
Andy Cedilnik committed
116
117
118
#endif

#endif