dep/ACE_wrappers/ace/Encoding_Converter_Factory.h

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