Apache log4cxx  Version 0.12.0
patternlayout.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_PATTERN_LAYOUT_H
19 #define _LOG4CXX_PATTERN_LAYOUT_H
20 
21 #if defined(_MSC_VER)
22  #pragma warning ( push )
23  #pragma warning ( disable: 4231 4251 4275 4786 )
24 #endif
25 
26 #include <log4cxx/layout.h>
30 
31 namespace log4cxx
32 {
33 LOG4CXX_LIST_DEF(LoggingEventPatternConverterList, log4cxx::pattern::LoggingEventPatternConverterPtr);
35 
334 class LOG4CXX_EXPORT PatternLayout : public Layout
335 {
339  LogString conversionPattern;
340 
344  LoggingEventPatternConverterList patternConverters;
345 
349  FormattingInfoList patternFields;
350 
351  public:
357 
358 
361  PatternLayout();
362 
366  PatternLayout(const LogString& pattern);
367 
373  void setConversionPattern(const LogString& conversionPattern);
374 
379  {
380  return conversionPattern;
381  }
382 
386  virtual void activateOptions(log4cxx::helpers::Pool& p);
387 
388  virtual void setOption(const LogString& option, const LogString& value);
389 
395  virtual bool ignoresThrowable() const
396  {
397  return true;
398  }
399 
403  virtual void format( LogString& output,
404  const spi::LoggingEventPtr& event,
405  log4cxx::helpers::Pool& pool) const;
406 
407  protected:
408  virtual log4cxx::pattern::PatternMap getFormatSpecifiers();
409 };
410 
412 } // namespace log4cxx
413 
414 #if defined(_MSC_VER)
415  #pragma warning ( pop )
416 #endif
417 
418 #endif //_LOG4CXX_PATTERN_LAYOUT_H
std::shared_ptr< FormattingInfo > FormattingInfoPtr
Definition: formattinginfo.h:31
#define LOG4CXX_CAST_ENTRY(Interface)
Definition: object.h:148
#define END_LOG4CXX_CAST_MAP()
Definition: object.h:142
std::shared_ptr< LoggingEvent > LoggingEventPtr
Definition: appender.h:37
#define BEGIN_LOG4CXX_CAST_MAP()
Definition: object.h:136
Extend this abstract class to create your own log layout format.
Definition: layout.h:37
LOG4CXX_PTR_DEF(Appender)
LogString getConversionPattern() const
Returns the value of the ConversionPattern option.
Definition: patternlayout.h:378
#define DECLARE_LOG4CXX_OBJECT(object)
Definition: object.h:39
virtual bool ignoresThrowable() const
The PatternLayout does not handle the throwable contained within LoggingEvents.
Definition: patternlayout.h:395
Definition: pool.h:32
#define LOG4CXX_CAST_ENTRY_CHAIN(Interface)
Definition: object.h:154
LOG4CXX_LIST_DEF(AppenderList, AppenderPtr)
A flexible layout configurable with pattern string.
Definition: patternlayout.h:334
std::map< LogString, PatternConstructor > PatternMap
Definition: patternparser.h:41
Definition: appender.h:32
std::basic_string< logchar > LogString
Definition: logstring.h:66