Base64.h.in 4.07 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
/*=========================================================================

  Program:   KWSys - Kitware System Library
  Module:    Base64.h.in
  Language:  C++
  Date:      $Date$
  Version:   $Revision$

  Copyright (c) 2002 Kitware, Inc., Insight Consortium.  All rights reserved.
  See http://www.cmake.org/HTML/Copyright.html for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

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

/* 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
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)
32 33 34 35 36 37

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

38 39 40
/**
 * Encode 3 bytes into a 4 byte string.
 */
41 42
void kwsysBase64_Encode3(const unsigned char *src, unsigned char *dest);

43 44 45
/**
 * Encode 2 bytes into a 4 byte string.
 */
46 47
void kwsysBase64_Encode2(const unsigned char *src, unsigned char *dest);

48 49 50
/**
 * Encode 1 bytes into a 4 byte string.
 */
51 52
void kwsysBase64_Encode1(const unsigned char *src, unsigned char *dest);

53 54 55 56 57 58 59 60 61 62 63 64 65
/**
 * 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).
 */
66
unsigned long kwsysBase64_Encode(const unsigned char *input,
67 68 69 70 71 72 73 74
                                 unsigned long length,
                                 unsigned char *output,
                                 int mark_end);

/**
 * Decode 4 bytes into a 3 byte string.  Returns the number of bytes
 * actually decoded.
 */
75 76
int kwsysBase64_Decode3(const unsigned char *src, unsigned char *dest);

77 78 79 80 81 82 83 84 85 86 87 88
/**
 * 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).
 */
89
unsigned long kwsysBase64_Decode(const unsigned char *input, 
90 91 92
                                 unsigned long length,
                                 unsigned char *output,
                                 unsigned long max_input_length);
93 94 95 96 97

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

98 99 100
/* 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)
101 102
# undef kwsys
# undef kwsysBase64
103 104 105 106 107 108
# undef kwsysBase64_Decode
# undef kwsysBase64_Decode3
# undef kwsysBase64_Encode
# undef kwsysBase64_Encode1
# undef kwsysBase64_Encode2
# undef kwsysBase64_Encode3
109 110 111
#endif

#endif