TAO: UTF16_BOM_Translator.h Source File

Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 //=============================================================================
00004 /**
00005  *  @file  UTF16_BOM_Translator.h
00006  *
00007  *  $Id: UTF16_BOM_Translator.h 71473 2006-03-10 07:19:20Z jtc $
00008  *
00009  *
00010  *
00011  *  @author Phil Mesnier <mesnier_p@ociweb.com>
00012  */
00013 //=============================================================================
00014 
00015 #ifndef UTF16_BOM_TRANSLATOR_H
00016 #define UTF16_BOM_TRANSLATOR_H
00017 #include /**/ "ace/pre.h"
00018 
00019 #include "ace/config-all.h"
00020 
00021 #if !defined (ACE_LACKS_PRAGMA_ONCE)
00022 # pragma once
00023 #endif /* ACE_LACKS_PRAGMA_ONCE */
00024 
00025 #include "tao/Codeset/codeset_export.h"
00026 #include "tao/Versioned_Namespace.h"
00027 #include "ace/CDR_Stream.h"
00028 
00029 
00030 // ****************************************************************
00031 
00032 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
00033 
00034 /**
00035  * @class TAO_UTF16_BOM_Translator
00036  *
00037  * @brief Codeset translation specialization - Manages Byte Order Marker
00038  *
00039  * This class performs the codeset translation:
00040  *   - Native:        UTF16 (i.e. Unicode)
00041  *   - Stream:        UTF16 with Byte Order Marker
00042  */
00043 class TAO_Codeset_Export TAO_UTF16_BOM_Translator
00044   : public ACE_WChar_Codeset_Translator
00045 {
00046 public:
00047   /// constructor
00048   /// @param forceBE: true forces all wchar, warray, and wstrings to big-endian byte order
00049   TAO_UTF16_BOM_Translator (bool forceBE);
00050 
00051   /// Virtual destruction
00052   virtual ~TAO_UTF16_BOM_Translator (void);
00053 
00054   // = Documented in $ACE_ROOT/ace/CDR_Stream.h
00055   virtual ACE_CDR::Boolean read_wchar (ACE_InputCDR &,
00056                                       ACE_CDR::WChar &);
00057   virtual ACE_CDR::Boolean read_wstring (ACE_InputCDR &,
00058                                         ACE_CDR::WChar *&);
00059   virtual ACE_CDR::Boolean read_wchar_array (ACE_InputCDR &,
00060                                             ACE_CDR::WChar *,
00061                                             ACE_CDR::ULong);
00062   virtual ACE_CDR::Boolean write_wchar (ACE_OutputCDR &,
00063                                        ACE_CDR::WChar);
00064   virtual ACE_CDR::Boolean write_wstring (ACE_OutputCDR &,
00065                                          ACE_CDR::ULong,
00066                                          const ACE_CDR::WChar *);
00067   virtual ACE_CDR::Boolean write_wchar_array (ACE_OutputCDR &,
00068                                              const ACE_CDR::WChar *,
00069                                              ACE_CDR::ULong);
00070   virtual ACE_CDR::ULong ncs () {return 0x00010109;}
00071   virtual ACE_CDR::ULong tcs () {return 0x00010109;}
00072 
00073 private:
00074   ACE_CDR::Boolean read_wchar_array_i (ACE_InputCDR &,
00075                                        ACE_CDR::WChar *,
00076                                        ACE_CDR::ULong&,
00077                                        int adjust_len = 0);
00078 
00079   ACE_CDR::Boolean write_wchar_array_i (ACE_OutputCDR &,
00080                                         const ACE_CDR::WChar *,
00081                                         ACE_CDR::ULong);
00082 
00083   ACE_CDR::Boolean write_swapped_wchar_array_i (ACE_OutputCDR & cdr,
00084                                             const ACE_CDR::WChar *x,
00085                                             ACE_CDR::ULong length);
00086 
00087 
00088   ACE_CDR::Boolean write_wchar_i (ACE_OutputCDR &,
00089                                   ACE_CDR::WChar ,
00090                                   bool allow_BOM);
00091 
00092 private:
00093   /// if this flag is true, force wchar's to big endian order
00094   bool forceBE_;
00095 
00096 };
00097 
00098 TAO_END_VERSIONED_NAMESPACE_DECL
00099 
00100 #include /**/ "ace/post.h"
00101 #endif /* UTF16_BOM_TRANSLATOR_H */