ACE/ace/Codecs.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file   Codecs.h
   6  *
   7  *  @author Krishnakumar B <kitty@cs.wustl.edu>
   8  *
   9  *  Codecs is a generic wrapper for various encoding and decoding
  10  *  mechanisms. Currently it includes Base64 content transfer-encoding as
  11  *  specified by RFC 2045, Multipurpose Internet Mail Extensions (MIME) Part
  12  *  One: Format of Internet Message Bodies.
  13  */
  14 //=============================================================================
  15
  16 #ifndef ACE_CODECS_H
  17 #define ACE_CODECS_H
  18
  19 #include /**/ "ace/pre.h"
  20
  21 #include /**/ "ace/ACE_export.h"
  22
  23 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  24 # pragma once
  25 #endif /* ACE_LACKS_PRAGMA_ONCE */
  26
  27 #include "ace/Basic_Types.h"
  28 #include "ace/Global_Macros.h"
  29
  30 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  31
  32 /**
  33  * @class ACE_Base64
  34  *
  35  * @brief Encode/Decode a stream of bytes according to Base64 encoding.
  36  *
  37  * This class provides methods to encode or decode a stream of bytes
  38  * to/from Base64 encoding. It doesn't convert the input stream to a
  39  * canonical form before encoding.
  40  */
  41 class ACE_Export ACE_Base64
  42 {
  43 public:
  44   //@{
  45   /**
  46    * Encodes a stream of bytes to Base64 data
  47    *
  48    * @param input Binary data in byte stream.
  49    * @param input_len Length of the byte stream.
  50    * @param output_len Length of the encoded Base64 byte stream.
  51    * @param is_chunked If true, terminate 72 character blocks with newline
  52    * @return Encoded Base64 data in byte stream or NULL if input data cannot
  53    *         be encoded.
  54    */
  55   static ACE_Byte* encode (const ACE_Byte* input,
  56                            const size_t input_len,
  57                            size_t* output_len,
  58                            bool is_chunked = true);
  59   /**
  60    * Decodes a stream of Base64 to bytes data
  61    *
  62    * @param input Encoded Base64 data in byte stream.
  63    * @param output_len Length of the binary byte stream.
  64    * @return Binary data in byte stream or NULL if input data cannot
  65    *         be encoded.
  66    */
  67   static ACE_Byte* decode (const ACE_Byte* input,
  68                            size_t* output_len);
  69
  70   /**
  71    * Return the length of the encoded input data
  72    *
  73    * @param input Encoded Base64 data in byte stream.
  74    * @return Length of the encoded Base64 data.
  75    *
  76    */
  77   static size_t length (const ACE_Byte* input);
  78
  79   //@}
  80
  81 protected:
  82   // Prevent default construction.
  83   ACE_Base64 () = default;
  84
  85 private:
  86   ACE_Base64 (ACE_Base64 const &) = delete;
  87   ACE_Base64 & operator= (ACE_Base64 const &) = delete;
  88
  89   /// Initialize the tables for encoding/decoding.
  90   static void init ();
  91
  92 private:
  93   /// Alphabet used for decoding i.e decoder_[alphabet_[i = 0..63]] = i
  94   static ACE_Byte decoder_[];
  95
  96   /// Alphabet used to check valid range of encoded input i.e
  97   /// member_[alphabet_[0..63]] = 1
  98   static ACE_Byte member_[];
  99
 100   /// Boolean to denote whether initialization is complete
 101   static bool init_;
 102 };
 103
 104 ACE_END_VERSIONED_NAMESPACE_DECL
 105
 106 #include /**/ "ace/post.h"
 107
 108 #endif /* ACE_CODECS_H */