Apache Log4cxx  Version 1.3.1
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_NS
25 {
26 
27 namespace helpers
28 {
29 class ByteBuffer;
30 class 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 
123  static bool isTriviallyCopyable(const LogString& src, const CharsetEncoderPtr& enc);
124 
125 
126  private:
134  CharsetEncoder& operator=(const CharsetEncoder&);
135 
136  static CharsetEncoder* createDefaultEncoder();
137 };
138 
139 } // namespace helpers
140 
141 } //namespace log4cxx
142 
143 #endif //_LOG4CXX_HELPERS_CHARSETENCODER_H
A byte buffer.
Definition: bytebuffer.h:34
An engine to transform LogStrings into bytes for the specific character set.
Definition: charsetencoder.h:38
virtual void reset()
Resets any internal state.
CharsetEncoder()
Protected constructor.
virtual ~CharsetEncoder()
Destructor.
virtual log4cxx_status_t encode(const LogString &in, LogString::const_iterator &iter, ByteBuffer &out)=0
Encodes as many characters from the input string as possible to the output buffer.
static CharsetEncoderPtr getUTF8Encoder()
Get encoder for UTF-8.
virtual void flush(ByteBuffer &out)
Flushes the encoder.
static bool isError(log4cxx_status_t stat)
Determines if the return value from encode indicates an unconvertable character.
Definition: charsetencoder.h:114
static void encode(CharsetEncoderPtr &enc, const LogString &src, LogString::const_iterator &iter, ByteBuffer &dst)
Encodes a string replacing unmappable characters with escape sequences.
static CharsetEncoderPtr getEncoder(const LogString &charset)
Get encoder for specified character set.
static CharsetEncoderPtr getDefaultEncoder()
Get encoder for default charset.
static bool isTriviallyCopyable(const LogString &src, const CharsetEncoderPtr &enc)
Is the data of src unchanged by enc.
base class for java-like objects.
Definition: object.h:106
LOG4CXX_PTR_DEF(CharsetEncoder)
std::basic_string< logchar > LogString
Definition: logstring.h:60
#define LOG4CXX_CAST_ENTRY(Interface)
Definition: object.h:158
#define DECLARE_ABSTRACT_LOG4CXX_OBJECT(object)
Definition: object.h:39
#define END_LOG4CXX_CAST_MAP()
Definition: object.h:152
#define BEGIN_LOG4CXX_CAST_MAP()
Definition: object.h:146