TAO: UTF8_Latin1_Translator.h Source File

Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 //=============================================================================
00004 /**
00005  *  @file    UTF8_Latin1_Translator.h
00006  *
00007  *  $Id: UTF8_Latin1_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 UTF8_LATIN1_TRANSLATOR_H
00016 #define UTF8_LATIN1_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 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
00032 
00033 /**
00034  * @class UTF8_Latin1_Translator
00035  *
00036  * @brief Codeset translation specialization - Manages Byte Order Marker
00037  *
00038  * This class performs the codeset translation:
00039  *   - Native:        ISO-8859-1 (i.e. Latin 1)
00040  *   - Stream:        UTF-8 (8 bit unicode mapping)
00041  *
00042  * When writing chars, it is possible to raise a DATA_CONVERSION exception
00043  * because some valid Latin codepoints map to 2-byte utf-8 codepoints.
00044  *
00045  * When reading strings, it is possible to raise a DATA_CONVERSION exception
00046  * because the string may include utf-8 unicode codepoints > 0x00FF.
00047  */
00048 class TAO_Codeset_Export TAO_UTF8_Latin1_Translator
00049   : public ACE_Char_Codeset_Translator
00050 {
00051 public:
00052   /// constructor
00053   TAO_UTF8_Latin1_Translator ();
00054 
00055   /// Virtual destruction
00056   virtual ~TAO_UTF8_Latin1_Translator (void);
00057 
00058   // = Documented in $ACE_ROOT/ace/CDR_Stream.h
00059   virtual ACE_CDR::Boolean read_char (ACE_InputCDR &,
00060                                       ACE_CDR::Char &);
00061   virtual ACE_CDR::Boolean read_string (ACE_InputCDR &,
00062                                         ACE_CDR::Char *&);
00063   virtual ACE_CDR::Boolean read_char_array (ACE_InputCDR &,
00064                                             ACE_CDR::Char *,
00065                                             ACE_CDR::ULong);
00066   virtual ACE_CDR::Boolean write_char (ACE_OutputCDR &,
00067                                        ACE_CDR::Char);
00068   virtual ACE_CDR::Boolean write_string (ACE_OutputCDR &,
00069                                          ACE_CDR::ULong,
00070                                          const ACE_CDR::Char *);
00071   virtual ACE_CDR::Boolean write_char_array (ACE_OutputCDR &,
00072                                              const ACE_CDR::Char *,
00073                                              ACE_CDR::ULong);
00074   virtual ACE_CDR::ULong ncs () {return 0x00010001U;}
00075   virtual ACE_CDR::ULong tcs () {return 0x05010001U;}
00076 
00077 private:
00078   ACE_CDR::ULong read_char_i (ACE_InputCDR &,
00079                                 ACE_CDR::Char &);
00080 
00081   ACE_CDR::Boolean write_char_i (ACE_OutputCDR &,
00082                                  ACE_CDR::Char);
00083 
00084 };
00085 
00086 TAO_END_VERSIONED_NAMESPACE_DECL
00087 
00088 #include /**/ "ace/post.h"
00089 #endif /* UTF8_LATIN1_TRANSLATOR_H */