Apache Log4cxx  Version 1.3.1
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 #include <log4cxx/layout.h>
25 
26 namespace LOG4CXX_NS
27 {
28 LOG4CXX_LIST_DEF(LoggingEventPatternConverterList, LOG4CXX_NS::pattern::LoggingEventPatternConverterPtr);
30 
446 class LOG4CXX_EXPORT PatternLayout : public Layout
447 {
448  LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(PatternLayoutPrivate, m_priv)
449 
450  public:
456 
457 
461 
465  PatternLayout(const LogString& pattern);
466 
468 
475  void setConversionPattern(const LogString& conversionPattern);
476 
480  LogString getConversionPattern() const;
481 
487  void activateOptions(helpers::Pool& p) override;
488 
513  void setOption(const LogString& option, const LogString& value) override;
514 
520  bool ignoresThrowable() const override
521  {
522  return true;
523  }
524 
528  void format( LogString& output,
529  const spi::LoggingEventPtr& event,
530  helpers::Pool& pool) const override;
531 
532  protected:
534 
535  private:
536  pattern::PatternConverterPtr createColorStartPatternConverter(const std::vector<LogString>& options);
537 };
538 
540 } // namespace log4cxx
541 
542 #endif //_LOG4CXX_PATTERN_LAYOUT_H
Extend this abstract class to create your own log layout format.
Definition: layout.h:34
A flexible layout configurable with pattern string.
Definition: patternlayout.h:447
virtual log4cxx::pattern::PatternMap getFormatSpecifiers()
void format(LogString &output, const spi::LoggingEventPtr &event, helpers::Pool &pool) const override
Produces a formatted string as specified by the conversion pattern.
Definition: pool.h:33
std::map< LogString, PatternConstructor > PatternMap
Definition: patternparser.h:35
std::shared_ptr< FormattingInfo > FormattingInfoPtr
Definition: formattinginfo.h:31
std::shared_ptr< LoggingEvent > LoggingEventPtr
Definition: appender.h:31
LOG4CXX_LIST_DEF(FormattingInfoList, log4cxx::pattern::FormattingInfoPtr)
LOG4CXX_PTR_DEF(PatternLayout)
std::basic_string< logchar > LogString
Definition: logstring.h:60
#define LOG4CXX_CAST_ENTRY(Interface)
Definition: object.h:158
#define END_LOG4CXX_CAST_MAP()
Definition: object.h:152
#define DECLARE_LOG4CXX_OBJECT(object)
Definition: object.h:43
#define LOG4CXX_CAST_ENTRY_CHAIN(Interface)
Definition: object.h:164
#define BEGIN_LOG4CXX_CAST_MAP()
Definition: object.h:146