ACE/ace/Encoding_Converter_Factory.h

   1 // -*- C++ -*-
   2
   3 //=========================================================================
   4 /**
   5  * @file Encoding_Converter_Factory.h
   6  *
   7  * This class can be used to create encoding converters of various types.
   8  *
   9  * @author Chad Elliott <elliott_c@ociweb.com>
  10  */
  11 //=========================================================================
  12
  13 #ifndef ACE_ENCODING_CONVERTER_FACTORY_H
  14 #define ACE_ENCODING_CONVERTER_FACTORY_H
  15
  16 #include /**/ "ace/pre.h"
  17
  18 #include "ace/Basic_Types.h"
  19
  20 #if defined (ACE_USES_WCHAR)
  21 #include /**/ "ace/ACE_export.h"
  22
  23 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  24
  25 class ACE_Encoding_Converter;
  26
  27 /** Create an encoding converter based on the source or hint.
  28  * This class allows users to avoid knowing any concrete converter types.
  29  */
  30 class ACE_Export ACE_Encoding_Converter_Factory
  31 {
  32 public:
  33   /// This enum is used to tell what type of converter to create.
  34   enum Encoding_Hint { ACE_UTF_32BE, ACE_UTF_32LE,
  35                        ACE_UTF_16BE, ACE_UTF_16LE,
  36                        ACE_UTF_8, ACE_NONE
  37                      };
  38
  39   /// Create an encoding converter based on the source.  If a hint is
  40   /// given, it just creates the specified type of converter without looking
  41   /// at the source.
  42   static ACE_Encoding_Converter* create (const ACE_Byte* source,
  43                                          size_t source_size,
  44                                          Encoding_Hint hint = ACE_NONE);
  45 };
  46
  47 ACE_END_VERSIONED_NAMESPACE_DECL
  48 #endif /* ACE_USES_WCHAR */
  49
  50 #include /**/ "ace/post.h"
  51
  52 #endif /* ACE_ENCODING_CONVERTER_FACTORY_H */