Updates will be applied on October 27th between 12pm - 12:45pm EDT (UTC-0400). Gitlab may be slow during the maintenance window.

Base64.h.in 4.41 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
23
/* 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.  */
#define kwsys(x) @KWSYS_NAMESPACE@##x
24
#define kwsysEXPORT          @KWSYS_NAMESPACE@_EXPORT
Brad King's avatar
Brad King committed
25
26
27
28
29
30
31
#define kwsysBase64          kwsys(Base64)
#define kwsysBase64_Decode   kwsys(Base64_Decode)
#define kwsysBase64_Decode3  kwsys(Base64_Decode3)
#define kwsysBase64_Encode   kwsys(Base64_Encode)
#define kwsysBase64_Encode1  kwsys(Base64_Encode1)
#define kwsysBase64_Encode2  kwsys(Base64_Encode2)
#define kwsysBase64_Encode3  kwsys(Base64_Encode3)
Andy Cedilnik's avatar
Andy Cedilnik committed
32
33
34
35
36
37

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

Brad King's avatar
Brad King committed
38
39
40
/**
 * Encode 3 bytes into a 4 byte string.
 */
Brad King's avatar
Brad King committed
41
42
kwsysEXPORT void kwsysBase64_Encode3(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 2 bytes into a 4 byte string.
 */
Brad King's avatar
Brad King committed
47
48
kwsysEXPORT void kwsysBase64_Encode2(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
/**
 * Encode 1 bytes into a 4 byte string.
 */
Brad King's avatar
Brad King committed
53
54
kwsysEXPORT void kwsysBase64_Encode1(const unsigned char *src,
                                     unsigned char *dest);
Andy Cedilnik's avatar
Andy Cedilnik committed
55

Brad King's avatar
Brad King committed
56
57
58
59
60
61
62
63
64
65
66
67
68
/**
 * 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
69
70
71
72
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
73
74
75
76
77

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

Brad King's avatar
Brad King committed
81
82
83
84
85
86
87
88
89
90
91
92
/**
 * 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
93
94
95
96
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
97
98
99
100
101

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

Brad King's avatar
Brad King committed
102
103
104
/* If we are building Base64.c, let it use these macros.  Otherwise,
   undefine them to keep the namespace clean.  */
#if !defined(KWSYS_IN_BASE64_C)
Andy Cedilnik's avatar
Andy Cedilnik committed
105
# undef kwsys
Brad King's avatar
Brad King committed
106
# undef kwsysEXPORT
Andy Cedilnik's avatar
Andy Cedilnik committed
107
# undef kwsysBase64
Brad King's avatar
Brad King committed
108
109
110
111
112
113
# 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
114
115
116
#endif

#endif