Apache log4cxx  Version 0.12.0
charsetencoder.h
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 #ifndef _LOG4CXX_HELPERS_CHARSETENCODER_H
19 #define _LOG4CXX_HELPERS_CHARSETENCODER_H
20 
21 #include <log4cxx/helpers/object.h>
22 #include <log4cxx/helpers/pool.h>
23 
24 namespace log4cxx
25 {
26 
27 namespace helpers
28 {
29 class ByteBuffer;
30 class CharsetEncoder;
31 LOG4CXX_PTR_DEF(CharsetEncoder);
32 
37 class LOG4CXX_EXPORT CharsetEncoder : public Object
38 {
39  public:
44 
45  protected:
50 
51  public:
55  virtual ~CharsetEncoder();
59  static CharsetEncoderPtr getDefaultEncoder();
60 
69  static CharsetEncoderPtr getEncoder(const LogString& charset);
70 
71 
75  static CharsetEncoderPtr getUTF8Encoder();
76 
82  static void encode(CharsetEncoderPtr& enc,
83  const LogString& src,
84  LogString::const_iterator& iter,
85  ByteBuffer& dst);
86 
96  virtual log4cxx_status_t encode(const LogString& in,
97  LogString::const_iterator& iter,
98  ByteBuffer& out) = 0;
99 
103  virtual void reset();
104 
108  virtual void flush(ByteBuffer& out);
109 
114  inline static bool isError(log4cxx_status_t stat)
115  {
116  return (stat != 0);
117  }
118 
119 
120  private:
128  CharsetEncoder& operator=(const CharsetEncoder&);
129 
130  static CharsetEncoder* createDefaultEncoder();
131 };
132 
133 } // namespace helpers
134 
135 } //namespace log4cxx
136 
137 #endif //_LOG4CXX_HELPERS_CHARSETENCODER_H
#define DECLARE_ABSTRACT_LOG4CXX_OBJECT(object)
Definition: object.h:26
#define LOG4CXX_CAST_ENTRY(Interface)
Definition: object.h:148
#define END_LOG4CXX_CAST_MAP()
Definition: object.h:142
LOG4CXX_PTR_DEF(AppenderAttachableImpl)
#define BEGIN_LOG4CXX_CAST_MAP()
Definition: object.h:136
An engine to transform LogStrings into bytes for the specific character set.
Definition: charsetencoder.h:37
static bool isError(log4cxx_status_t stat)
Determines if the return value from encode indicates an unconvertable character.
Definition: charsetencoder.h:114
base class for java-like objects.
Definition: object.h:101
A byte buffer.
Definition: bytebuffer.h:33
Definition: appender.h:32
std::basic_string< logchar > LogString
Definition: logstring.h:66