This is an automated email from the ASF dual-hosted git repository.
rmiddleton pushed a commit to branch next_stable
in repository https://gitbox.apache.org/repos/asf/logging-log4cxx.git
The following commit(s) were added to refs/heads/next_stable by this push:
new 68f92779 LOGCXX-566 (#155)
68f92779 is described below
commit 68f927795150014d3e5b7150b81c26bc7c911fff
Author: Robert Middleton <[email protected]>
AuthorDate: Wed Dec 7 18:07:21 2022 -0500
LOGCXX-566 (#155)
Added tests and documentation for color pattern converter to allow it to be
user-configurable.
---
src/main/cpp/colorendpatternconverter.cpp | 5 +-
src/main/cpp/colorstartpatternconverter.cpp | 212 ++++++++++++++++-
src/main/cpp/patternlayout.cpp | 48 +++-
.../log4cxx/pattern/colorstartpatternconverter.h | 13 +-
src/main/include/log4cxx/pattern/patternparser.h | 3 +-
src/main/include/log4cxx/patternlayout.h | 77 +++++-
src/test/cpp/pattern/CMakeLists.txt | 6 +-
.../cpp/pattern/colorstartpatternconvertertest.cpp | 265 +++++++++++++++++++++
src/test/resources/witness/patternLayout.13 | 20 +-
9 files changed, 623 insertions(+), 26 deletions(-)
diff --git a/src/main/cpp/colorendpatternconverter.cpp
b/src/main/cpp/colorendpatternconverter.cpp
index 56f39e5f..9fa49793 100644
--- a/src/main/cpp/colorendpatternconverter.cpp
+++ b/src/main/cpp/colorendpatternconverter.cpp
@@ -47,6 +47,7 @@ void ColorEndPatternConverter::format(
Pool& p) const
{
- toAppendTo.append(LOG4CXX_STR("\x1B[39m"));
-
+ // Reset all colors on the output(code 0)
+ // Code 39 would be to reset colors only
+ toAppendTo.append(LOG4CXX_STR("\x1B[0m"));
}
diff --git a/src/main/cpp/colorstartpatternconverter.cpp
b/src/main/cpp/colorstartpatternconverter.cpp
index 02a8d779..72eb9f32 100644
--- a/src/main/cpp/colorstartpatternconverter.cpp
+++ b/src/main/cpp/colorstartpatternconverter.cpp
@@ -20,6 +20,7 @@
#include <log4cxx/spi/loggingevent.h>
#include <log4cxx/spi/location/locationinfo.h>
#include <log4cxx/helpers/stringhelper.h>
+#include <log4cxx/private/patternconverter_priv.h>
using namespace log4cxx;
using namespace log4cxx::pattern;
@@ -28,9 +29,125 @@ using namespace log4cxx::helpers;
IMPLEMENT_LOG4CXX_OBJECT(ColorStartPatternConverter)
+#define priv static_cast<ColorPatternConverterPrivate*>(m_priv.get())
+
+static LogString colorToANSISequence(const LogString& color, bool
isForeground, Pool& pool){
+ int numberToConvert = 0;
+
+ if(StringHelper::equalsIgnoreCase(color, LOG4CXX_STR("BLACK"),
LOG4CXX_STR("black"))){
+ numberToConvert = 30;
+ }else if(StringHelper::equalsIgnoreCase(color, LOG4CXX_STR("RED"),
LOG4CXX_STR("red"))){
+ numberToConvert = 31;
+ }else if(StringHelper::equalsIgnoreCase(color, LOG4CXX_STR("GREEN"),
LOG4CXX_STR("green"))){
+ numberToConvert = 32;
+ }else if(StringHelper::equalsIgnoreCase(color, LOG4CXX_STR("YELLOW"),
LOG4CXX_STR("yellow"))){
+ numberToConvert = 33;
+ }else if(StringHelper::equalsIgnoreCase(color, LOG4CXX_STR("BLUE"),
LOG4CXX_STR("blue"))){
+ numberToConvert = 34;
+ }else if(StringHelper::equalsIgnoreCase(color, LOG4CXX_STR("MAGENTA"),
LOG4CXX_STR("magenta"))){
+ numberToConvert = 35;
+ }else if(StringHelper::equalsIgnoreCase(color, LOG4CXX_STR("CYAN"),
LOG4CXX_STR("cyan"))){
+ numberToConvert = 36;
+ }else if(StringHelper::equalsIgnoreCase(color, LOG4CXX_STR("WHITE"),
LOG4CXX_STR("white"))){
+ numberToConvert = 37;
+ }
+
+ if( numberToConvert == 0 ){
+ return LOG4CXX_STR("");
+ }
+ LogString ret;
+ if( isForeground == false ){
+ numberToConvert += 10;
+ }
+ StringHelper::toString(numberToConvert, pool, ret);
+ return ret;
+}
+
+static LogString graphicsModeToANSISequence(const LogString& graphicsMode,
Pool& pool){
+ int numberToConvert = 0;
+
+ if(StringHelper::equalsIgnoreCase(graphicsMode, LOG4CXX_STR("BOLD"),
LOG4CXX_STR("bold"))){
+ numberToConvert = 1;
+ }else if(StringHelper::equalsIgnoreCase(graphicsMode,
LOG4CXX_STR("DIM"), LOG4CXX_STR("dim"))){
+ numberToConvert = 2;
+ }else if(StringHelper::equalsIgnoreCase(graphicsMode,
LOG4CXX_STR("ITALIC"), LOG4CXX_STR("italic"))){
+ numberToConvert = 3;
+ }else if(StringHelper::equalsIgnoreCase(graphicsMode,
LOG4CXX_STR("UNDERLINE"), LOG4CXX_STR("underline"))){
+ numberToConvert = 4;
+ }else if(StringHelper::equalsIgnoreCase(graphicsMode,
LOG4CXX_STR("BLINKING"), LOG4CXX_STR("blinking"))){
+ numberToConvert = 5;
+ }else if(StringHelper::equalsIgnoreCase(graphicsMode,
LOG4CXX_STR("INVERSE"), LOG4CXX_STR("inverse"))){
+ numberToConvert = 7;
+ }else if(StringHelper::equalsIgnoreCase(graphicsMode,
LOG4CXX_STR("STRIKETHROUGH"), LOG4CXX_STR("strikethrough"))){
+ numberToConvert = 9;
+ }
+
+ if( numberToConvert == 0 ){
+ return LOG4CXX_STR("");
+ }
+ LogString ret;
+ StringHelper::toString(numberToConvert, pool, ret);
+ return ret;
+}
+
+static LogString convertSingleSequence(const LogString& sequence, Pool& pool){
+ LogString strInParens;
+ bool inParens = false;
+ bool hasParens = false;
+ size_t x = 0;
+
+ for(x = 0; x < sequence.length(); x++){
+ if( sequence[x] == '(' && !inParens ){
+ inParens = true;
+ hasParens = true;
+ continue;
+ }else if( sequence[x] == '(' && inParens ){
+ // Unbalanced parens - parse invalid
+ return LOG4CXX_STR("");
+ }
+
+ if( sequence[x] == ')' && inParens ){
+ hasParens = true;
+ inParens = false;
+ break;
+ }
+
+ if( inParens ){
+ strInParens.push_back(sequence[x]);
+ }
+ }
+
+ if( (x != (sequence.length() - 1) || inParens) && hasParens ){
+ // Unbalanced parens, or more data in the string than we
expected - parse invalid
+ return LOG4CXX_STR("");
+ }
+
+ if(StringHelper::startsWith(sequence, "fg(")){
+ // Parse foreground
+ return colorToANSISequence(strInParens, true, pool);
+ }else if(StringHelper::startsWith(sequence, "bg(")){
+ return colorToANSISequence(strInParens, false, pool);
+ }else{
+ return graphicsModeToANSISequence(sequence, pool);
+ }
+}
+
+struct ColorStartPatternConverter::ColorPatternConverterPrivate : public
PatternConverterPrivate
+{
+ ColorPatternConverterPrivate( const LogString& name, const LogString&
style ) :
+ PatternConverterPrivate( name, style ){}
+
+ LogString m_fatalColor;
+ LogString m_errorColor;
+ LogString m_warnColor;
+ LogString m_infoColor;
+ LogString m_debugColor;
+ LogString m_traceColor;
+};
+
ColorStartPatternConverter::ColorStartPatternConverter() :
- LoggingEventPatternConverter(LOG4CXX_STR("Color Start"),
- LOG4CXX_STR("colorStart"))
+
LoggingEventPatternConverter(std::make_unique<ColorPatternConverterPrivate>(LOG4CXX_STR("Color
Start"),
+ LOG4CXX_STR("colorStart")))
{
}
@@ -52,30 +169,109 @@ void ColorStartPatternConverter::format(
switch (lvl->toInt())
{
case log4cxx::Level::FATAL_INT:
- toAppendTo.append(LOG4CXX_STR("\x1B[35m")); //magenta
+ toAppendTo.append(priv->m_fatalColor);
break;
case log4cxx::Level::ERROR_INT:
- toAppendTo.append(LOG4CXX_STR("\x1B[91m")); //red
+ toAppendTo.append(priv->m_errorColor);
break;
case log4cxx::Level::WARN_INT:
- toAppendTo.append(LOG4CXX_STR("\x1B[33m")); //yellow
+ toAppendTo.append(priv->m_warnColor);
break;
case log4cxx::Level::INFO_INT:
- toAppendTo.append(LOG4CXX_STR("\x1B[32m")); //green
+ toAppendTo.append(priv->m_infoColor);
break;
case log4cxx::Level::DEBUG_INT:
- toAppendTo.append(LOG4CXX_STR("\x1B[36m")); //cyan
+ toAppendTo.append(priv->m_debugColor);
break;
case log4cxx::Level::TRACE_INT:
- toAppendTo.append(LOG4CXX_STR("\x1B[34m")); //blue
+ toAppendTo.append(priv->m_traceColor);
break;
default:
break;
}
}
+
+void ColorStartPatternConverter::setFatalColor(const LogString& color){
+ parseColor(color, &(priv->m_fatalColor));
+}
+
+void ColorStartPatternConverter::setErrorColor(const LogString& color){
+ parseColor(color, &(priv->m_errorColor));
+}
+
+void ColorStartPatternConverter::setWarnColor(const LogString& color){
+ parseColor(color, &(priv->m_warnColor));
+}
+
+void ColorStartPatternConverter::setInfoColor(const LogString& color){
+ parseColor(color, &(priv->m_infoColor));
+}
+
+void ColorStartPatternConverter::setDebugColor(const LogString& color){
+ parseColor(color, &(priv->m_debugColor));
+}
+
+void ColorStartPatternConverter::setTraceColor(const LogString& color){
+ parseColor(color, &(priv->m_traceColor));
+}
+
+void ColorStartPatternConverter::parseColor(const LogString& color, LogString*
result){
+ LogString lower = StringHelper::toLowerCase(color);
+ Pool pool;
+
+ // If the color we are trying to parse is blank, clear our result
+ if(StringHelper::trim(color).empty() ||
+ StringHelper::equalsIgnoreCase(color,
+
LOG4CXX_STR("NONE"),
+
LOG4CXX_STR("none"))){
+ result->clear();
+ return;
+ }
+
+ if( StringHelper::startsWith(lower, "\\x1b") ){
+ if( color[color.size() - 1] != 'm' ){
+ // In order for this to be a valid ANSI escape sequence,
+ // it must end with an 'm'. If it does not, reject.
+ return;
+ }
+ // We start with an escape sequence, copy the data over after
the escape byte
+ result->clear();
+ result->append("\x1b");
+ for( size_t x = 4; x < color.size(); x++ ){
+ result->push_back(color[x]);
+ }
+ }else{
+ // We do not start with an escape sequence: try to parse color
+ // Escape sequence information:
+ // https://gist.github.com/fnky/458719343aabd01cfb17a3a4f7296797
+ // https://en.wikipedia.org/wiki/ANSI_escape_code
+ result->clear();
+ result->append("\x1b[");
+ LogString tmp;
+ for( size_t x = 0; x < color.size(); x++ ){
+ if(color[x] == '|' ){
+ LogString toAppend = convertSingleSequence(tmp,
pool);
+ tmp.clear();
+ if(!toAppend.empty()){
+ result->push_back(';');
+ result->append(toAppend);
+ }
+ }else{
+ tmp.push_back(color[x]);
+ }
+ }
+ LogString toAppend = convertSingleSequence(tmp, pool);
+ tmp.clear();
+ if(!toAppend.empty()){
+ result->push_back(';');
+ result->append(toAppend);
+ }
+ result->append("m");
+ }
+}
diff --git a/src/main/cpp/patternlayout.cpp b/src/main/cpp/patternlayout.cpp
index 4d119f80..b2f6c56b 100644
--- a/src/main/cpp/patternlayout.cpp
+++ b/src/main/cpp/patternlayout.cpp
@@ -74,6 +74,13 @@ struct PatternLayout::PatternLayoutPrivate
* Field widths and alignment corresponding to pattern converters.
*/
FormattingInfoList patternFields;
+
+ LogString m_fatalColor = LOG4CXX_STR("\\x1B[35m"); //magenta
+ LogString m_errorColor = LOG4CXX_STR("\\x1B[31m"); //red
+ LogString m_warnColor = LOG4CXX_STR("\\x1B[33m"); //yellow
+ LogString m_infoColor = LOG4CXX_STR("\\x1B[32m"); //green
+ LogString m_debugColor = LOG4CXX_STR("\\x1B[36m"); //cyan;
+ LogString m_traceColor = LOG4CXX_STR("\\x1B[34m"); //blue;
};
IMPLEMENT_LOG4CXX_OBJECT(PatternLayout)
@@ -129,6 +136,32 @@ void PatternLayout::setOption(const LogString& option,
const LogString& value)
LOG4CXX_STR("conversionpattern")))
{
m_priv->conversionPattern =
OptionConverter::convertSpecialChars(value);
+ }else if(StringHelper::equalsIgnoreCase(option,
+
LOG4CXX_STR("ERRORCOLOR"),
+
LOG4CXX_STR("errorcolor"))){
+ m_priv->m_errorColor = value;
+ LogLog::debug("Setting error color to ");
+ LogLog::debug(value);
+ }else if(StringHelper::equalsIgnoreCase(option,
+
LOG4CXX_STR("FATALCOLOR"),
+
LOG4CXX_STR("fatalcolor"))){
+ m_priv->m_fatalColor = value;
+ }else if(StringHelper::equalsIgnoreCase(option,
+
LOG4CXX_STR("WARNCOLOR"),
+
LOG4CXX_STR("warncolor"))){
+ m_priv->m_warnColor = value;
+ }else if(StringHelper::equalsIgnoreCase(option,
+
LOG4CXX_STR("INFOCOLOR"),
+
LOG4CXX_STR("infocolor"))){
+ m_priv->m_infoColor = value;
+ }else if(StringHelper::equalsIgnoreCase(option,
+
LOG4CXX_STR("DEBUGCOLOR"),
+
LOG4CXX_STR("debugcolor"))){
+ m_priv->m_debugColor = value;
+ }else if(StringHelper::equalsIgnoreCase(option,
+
LOG4CXX_STR("TRACECOLOR"),
+
LOG4CXX_STR("tracecolor"))){
+ m_priv->m_traceColor = value;
}
}
@@ -168,7 +201,7 @@ void PatternLayout::activateOptions(Pool&)
}
#define RULES_PUT(spec, cls) \
- specs.insert(PatternMap::value_type(LogString(LOG4CXX_STR(spec)),
(PatternConstructor) cls ::newInstance))
+ specs.insert(PatternMap::value_type(LogString(LOG4CXX_STR(spec)), cls
::newInstance))
log4cxx::pattern::PatternMap PatternLayout::getFormatSpecifiers()
@@ -180,7 +213,7 @@ log4cxx::pattern::PatternMap
PatternLayout::getFormatSpecifiers()
RULES_PUT("C", ClassNamePatternConverter);
RULES_PUT("class", ClassNamePatternConverter);
- RULES_PUT("Y", ColorStartPatternConverter);
+ specs.insert(PatternMap::value_type(LogString(LOG4CXX_STR("Y")),
std::bind(&PatternLayout::createColorStartPatternConverter, this,
std::placeholders::_1)));
RULES_PUT("y", ColorEndPatternConverter);
RULES_PUT("d", DatePatternConverter);
@@ -231,7 +264,18 @@ LogString PatternLayout::getConversionPattern() const
return m_priv->conversionPattern;
}
+pattern::PatternConverterPtr
PatternLayout::createColorStartPatternConverter(const std::vector<LogString>&
options){
+ std::shared_ptr<ColorStartPatternConverter> colorPatternConverter =
std::make_shared<ColorStartPatternConverter>();
+
+ colorPatternConverter->setErrorColor(m_priv->m_errorColor);
+ colorPatternConverter->setFatalColor(m_priv->m_fatalColor);
+ colorPatternConverter->setWarnColor(m_priv->m_warnColor);
+ colorPatternConverter->setInfoColor(m_priv->m_infoColor);
+ colorPatternConverter->setDebugColor(m_priv->m_debugColor);
+ colorPatternConverter->setTraceColor(m_priv->m_traceColor);
+ return colorPatternConverter;
+}
diff --git a/src/main/include/log4cxx/pattern/colorstartpatternconverter.h
b/src/main/include/log4cxx/pattern/colorstartpatternconverter.h
index 3ce700ab..c84d0619 100644
--- a/src/main/include/log4cxx/pattern/colorstartpatternconverter.h
+++ b/src/main/include/log4cxx/pattern/colorstartpatternconverter.h
@@ -35,6 +35,8 @@ namespace pattern
class LOG4CXX_EXPORT ColorStartPatternConverter
: public LoggingEventPatternConverter
{
+ struct ColorPatternConverterPrivate;
+
public:
DECLARE_LOG4CXX_PATTERN(ColorStartPatternConverter)
BEGIN_LOG4CXX_CAST_MAP()
@@ -44,7 +46,6 @@ class LOG4CXX_EXPORT ColorStartPatternConverter
ColorStartPatternConverter();
-
/**
* Obtains an instance of pattern converter.
* @param options options, may be null.
@@ -58,6 +59,16 @@ class LOG4CXX_EXPORT ColorStartPatternConverter
void format(const spi::LoggingEventPtr& event,
LogString& toAppendTo,
helpers::Pool& p) const override;
+
+ void setFatalColor(const LogString& color);
+ void setErrorColor(const LogString& color);
+ void setWarnColor(const LogString& color);
+ void setInfoColor(const LogString& color);
+ void setDebugColor(const LogString& color);
+ void setTraceColor(const LogString& color);
+
+ private:
+ void parseColor(const LogString& color, LogString* result);
};
}
diff --git a/src/main/include/log4cxx/pattern/patternparser.h
b/src/main/include/log4cxx/pattern/patternparser.h
index 2c328ae3..66aea74e 100644
--- a/src/main/include/log4cxx/pattern/patternparser.h
+++ b/src/main/include/log4cxx/pattern/patternparser.h
@@ -21,6 +21,7 @@
#include <map>
#include <vector>
+#include <functional>
#include <log4cxx/helpers/class.h>
#include <log4cxx/pattern/patternconverter.h>
#include <log4cxx/pattern/formattinginfo.h>
@@ -30,7 +31,7 @@ namespace log4cxx
namespace pattern
{
-typedef PatternConverterPtr (*PatternConstructor)(const
std::vector<LogString>& options);
+typedef std::function<PatternConverterPtr(const std::vector<LogString>&
options)> PatternConstructor;
typedef std::map<LogString, PatternConstructor> PatternMap;
diff --git a/src/main/include/log4cxx/patternlayout.h
b/src/main/include/log4cxx/patternlayout.h
index f7b844d8..3aa1f748 100644
--- a/src/main/include/log4cxx/patternlayout.h
+++ b/src/main/include/log4cxx/patternlayout.h
@@ -236,13 +236,15 @@ LOG4CXX_LIST_DEF(FormattingInfoList,
log4cxx::pattern::FormattingInfoPtr);
* <td align="center"><strong>Y</strong></td>
* <td>
* Used to wrap log with color. The <strong>Y</strong> is the start
of a color block.
- * Color will be taken from the log level.
+ * Color will be taken from the log level. The default colors are:
* - `TRACE` - blue
* - `DEBUG` - cyan
* - `INFO` - green
* - `WARN` - yellow
* - `ERROR` - red
* - `FATAL` - magenta
+ *
+ * These colors are all customizable.
* </td>
* </tr>
* <tr>
@@ -354,6 +356,76 @@ LOG4CXX_LIST_DEF(FormattingInfoList,
log4cxx::pattern::FormattingInfoPtr);
* The above text is largely inspired from Peter A. Darnell and Philip E.
Margolis' highly
* recommended book "C -- a Software Engineering Approach", ISBN
0-387-97389-3.
* </p>
+ *
+ * <h2>Colorizing log output</h2>
+ *
+ * In order to customize the colors for the %Y specifier, options have been
added to the
+ * PatternLayout in order to let users define their own colors.
Foreground/background colors
+ * can be set, as well as other text effects. A user can also set the ANSI
escape pattern
+ * directly if they want.
+ *
+ * Each level can be set individually. The configuration options for the
levels are as follows:
+ * <ul>
+ * <li>FatalColor</li>
+ * <li>ErrorColor</li>
+ * <li>WarnColor</li>
+ * <li>InfoColor</li>
+ * <li>DebugColor</li>
+ * <li>ErrorColor</li>
+ * </ul>
+ *
+ * Foreground colors may be set by using fg(), background colors may be set by
using bg(), and
+ * other options(such as bold) may be set as well.
+ *
+ * Available colors:
+ * <ul>
+ * <li>Black</li>
+ * <li>Red</li>
+ * <li>Green</li>
+ * <li>Yellow</li>
+ * <li>Blue</li>
+ * <li>Magenta</li>
+ * <li>Cyan</li>
+ * <li>White</li>
+ * </ul>
+ *
+ * Available graphics modes:
+ * <ul>
+ * <li>Bold</li>
+ * <li>Dim</li>
+ * <li>Italic</li>
+ * <li>Underline</li>
+ * <li>Blinking</li>
+ * <li>Inverse</li>
+ * <li>Strikethrough</li>
+ * </ul>
+ *
+ * Combining these together, we can configure our colors as we want, shown
here in XML:
+ *
+ * Set the background color to red, make text blinking and bold:
+ * <pre>
+ * <param name="FatalColor" value="bg(red)|blinking|bold"/>
+ * </pre>
+ *
+ * Set the foreground color to blue:
+ * <pre>
+ * <param name="FatalColor" value="fg(blue)"/>
+ * </pre>
+ *
+ * Set the foreground color to white and the background color to black:
+ * <pre>
+ * <param name="FatalColor" value="fg(white)|bg(black)"/>
+ * </pre>
+ *
+ * Clear the formatting for the specified level(no formatting will be applied):
+ * <pre>
+ * <param name="FatalColor" value="none"/>
+ * </pre>
+ *
+ * Set a color based off on an ANSI escape sequence(equivalent to setting
fg(red)):
+ * <pre>
+ * <param name="FatalColor" value="\x1b[31m"/>
+ * </pre>
*/
class LOG4CXX_EXPORT PatternLayout : public Layout
{
@@ -416,6 +488,9 @@ class LOG4CXX_EXPORT PatternLayout : public Layout
protected:
virtual log4cxx::pattern::PatternMap getFormatSpecifiers();
+
+ private:
+ pattern::PatternConverterPtr
createColorStartPatternConverter(const std::vector<LogString>& options);
};
LOG4CXX_PTR_DEF(PatternLayout);
diff --git a/src/test/cpp/pattern/CMakeLists.txt
b/src/test/cpp/pattern/CMakeLists.txt
index c0eb8aed..4ebf7509 100644
--- a/src/test/cpp/pattern/CMakeLists.txt
+++ b/src/test/cpp/pattern/CMakeLists.txt
@@ -15,5 +15,9 @@
# limitations under the License.
#
-add_executable(patternparsertestcase patternparsertestcase.cpp
num343patternconverter.cpp)
+add_executable(patternparsertestcase
+ patternparsertestcase.cpp
+ num343patternconverter.cpp
+ colorstartpatternconvertertest.cpp
+)
set(ALL_LOG4CXX_TESTS ${ALL_LOG4CXX_TESTS} patternparsertestcase PARENT_SCOPE)
diff --git a/src/test/cpp/pattern/colorstartpatternconvertertest.cpp
b/src/test/cpp/pattern/colorstartpatternconvertertest.cpp
new file mode 100644
index 00000000..0bf6a662
--- /dev/null
+++ b/src/test/cpp/pattern/colorstartpatternconvertertest.cpp
@@ -0,0 +1,265 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include <log4cxx/logger.h>
+#include <log4cxx/spi/loggingevent.h>
+#include <log4cxx/helpers/system.h>
+#include <log4cxx/level.h>
+
+#include "../testchar.h"
+#include "../insertwide.h"
+#include "../logunit.h"
+#include <log4cxx/spi/loggerrepository.h>
+
+#include <log4cxx/helpers/loglog.h>
+#include <log4cxx/pattern/colorstartpatternconverter.h>
+
+#define LOG4CXX_TEST 1
+#include <log4cxx/private/log4cxx_private.h>
+#include <thread>
+
+
+using namespace log4cxx;
+using namespace log4cxx::helpers;
+using namespace log4cxx::spi;
+using namespace log4cxx::pattern;
+
+
+LOGUNIT_CLASS(ColorStartPatternConverterTestCase)
+{
+ LOGUNIT_TEST_SUITE(ColorStartPatternConverterTestCase);
+ LOGUNIT_TEST(testParseForeground);
+ LOGUNIT_TEST(testParseBackground);
+ LOGUNIT_TEST(testParseForegroundAndBackground);
+ LOGUNIT_TEST(testParseUnbalancedParens1);
+ LOGUNIT_TEST(testParseUnbalancedParens2);
+ LOGUNIT_TEST(testParseUnbalancedParens3);
+ LOGUNIT_TEST(testANSICode);
+ LOGUNIT_TEST(testInvalidANSICode);
+ LOGUNIT_TEST(testUnterminatedANSICode);
+ LOGUNIT_TEST(testForegroundBackgroundBlink);
+ LOGUNIT_TEST(testClearColor);
+ LOGUNIT_TEST_SUITE_END();
+
+
+public:
+ void setUp()
+ {
+ }
+
+ void tearDown()
+ {
+ }
+
+ void testParseForeground()
+ {
+ ColorStartPatternConverter colorPatternConverter;
+ LogString outputString;
+ Pool p;
+
+ LoggingEventPtr event= LoggingEventPtr(new LoggingEvent(
+
LOG4CXX_STR("org.foobar"),
+
Level::getInfo(),
+
LOG4CXX_STR("msg 1"),
+
LOG4CXX_LOCATION));
+
+ colorPatternConverter.setInfoColor("fg(red)");
+ colorPatternConverter.format(event, outputString, p);
+
+ LOGUNIT_ASSERT_EQUAL("\x1b[;31m", outputString);
+ }
+
+ void testParseBackground()
+ {
+ ColorStartPatternConverter colorPatternConverter;
+ LogString outputString;
+ Pool p;
+
+ LoggingEventPtr event= LoggingEventPtr(new LoggingEvent(
+
LOG4CXX_STR("org.foobar"),
+
Level::getInfo(),
+
LOG4CXX_STR("msg 1"),
+
LOG4CXX_LOCATION));
+
+ colorPatternConverter.setInfoColor("bg(red)");
+ colorPatternConverter.format(event, outputString, p);
+
+ LOGUNIT_ASSERT_EQUAL("\x1b[;41m", outputString);
+ }
+
+ void testParseForegroundAndBackground()
+ {
+ ColorStartPatternConverter colorPatternConverter;
+ LogString outputString;
+ Pool p;
+
+ LoggingEventPtr event= LoggingEventPtr(new LoggingEvent(
+
LOG4CXX_STR("org.foobar"),
+
Level::getInfo(),
+
LOG4CXX_STR("msg 1"),
+
LOG4CXX_LOCATION));
+
+ colorPatternConverter.setInfoColor("fg(green)|bg(red)");
+ colorPatternConverter.format(event, outputString, p);
+
+ LOGUNIT_ASSERT_EQUAL("\x1b[;32;41m", outputString);
+ }
+
+ void testParseUnbalancedParens1(){
+ ColorStartPatternConverter colorPatternConverter;
+ LogString outputString;
+ Pool p;
+
+ LoggingEventPtr event= LoggingEventPtr(new LoggingEvent(
+
LOG4CXX_STR("org.foobar"),
+
Level::getInfo(),
+
LOG4CXX_STR("msg 1"),
+
LOG4CXX_LOCATION));
+
+ colorPatternConverter.setInfoColor("fg(green))");
+ colorPatternConverter.format(event, outputString, p);
+
+ LOGUNIT_ASSERT_EQUAL("\x1b[m", outputString);
+ }
+
+ void testParseUnbalancedParens2(){
+ ColorStartPatternConverter colorPatternConverter;
+ LogString outputString;
+ Pool p;
+
+ LoggingEventPtr event= LoggingEventPtr(new LoggingEvent(
+
LOG4CXX_STR("org.foobar"),
+
Level::getInfo(),
+
LOG4CXX_STR("msg 1"),
+
LOG4CXX_LOCATION));
+
+ colorPatternConverter.setInfoColor("fg(green");
+ colorPatternConverter.format(event, outputString, p);
+
+ LOGUNIT_ASSERT_EQUAL("\x1b[m", outputString);
+ }
+
+ void testParseUnbalancedParens3(){
+ ColorStartPatternConverter colorPatternConverter;
+ LogString outputString;
+ Pool p;
+
+ LoggingEventPtr event= LoggingEventPtr(new LoggingEvent(
+
LOG4CXX_STR("org.foobar"),
+
Level::getInfo(),
+
LOG4CXX_STR("msg 1"),
+
LOG4CXX_LOCATION));
+
+ colorPatternConverter.setInfoColor("fg(green|bg(red)");
+ colorPatternConverter.format(event, outputString, p);
+
+ // The background should be parsed correctly, but since the
foreground
+ // is bad it will not work
+ LOGUNIT_ASSERT_EQUAL("\x1b[;41m", outputString);
+ }
+
+ void testANSICode(){
+ ColorStartPatternConverter colorPatternConverter;
+ LogString outputString;
+ Pool p;
+
+ LoggingEventPtr event= LoggingEventPtr(new LoggingEvent(
+
LOG4CXX_STR("org.foobar"),
+
Level::getInfo(),
+
LOG4CXX_STR("msg 1"),
+
LOG4CXX_LOCATION));
+
+ colorPatternConverter.setInfoColor("\\x1b[34;40m");
+ colorPatternConverter.format(event, outputString, p);
+
+ LOGUNIT_ASSERT_EQUAL("\x1b[34;40m", outputString);
+ }
+
+ void testInvalidANSICode(){
+ ColorStartPatternConverter colorPatternConverter;
+ LogString outputString;
+ Pool p;
+
+ LoggingEventPtr event= LoggingEventPtr(new LoggingEvent(
+
LOG4CXX_STR("org.foobar"),
+
Level::getInfo(),
+
LOG4CXX_STR("msg 1"),
+
LOG4CXX_LOCATION));
+
+ colorPatternConverter.setInfoColor("\\x1b");
+ colorPatternConverter.format(event, outputString, p);
+
+ LOGUNIT_ASSERT_EQUAL("", outputString);
+ }
+
+ void testUnterminatedANSICode(){
+ ColorStartPatternConverter colorPatternConverter;
+ LogString outputString;
+ Pool p;
+
+ LoggingEventPtr event= LoggingEventPtr(new LoggingEvent(
+
LOG4CXX_STR("org.foobar"),
+
Level::getInfo(),
+
LOG4CXX_STR("msg 1"),
+
LOG4CXX_LOCATION));
+
+ colorPatternConverter.setInfoColor("\\x1b[31");
+ colorPatternConverter.format(event, outputString, p);
+
+ LOGUNIT_ASSERT_EQUAL("", outputString);
+ }
+
+ void testForegroundBackgroundBlink(){
+ ColorStartPatternConverter colorPatternConverter;
+ LogString outputString;
+ Pool p;
+
+ LoggingEventPtr event= LoggingEventPtr(new LoggingEvent(
+
LOG4CXX_STR("org.foobar"),
+
Level::getInfo(),
+
LOG4CXX_STR("msg 1"),
+
LOG4CXX_LOCATION));
+
+
colorPatternConverter.setInfoColor("fg(white)|bg(black)|blinking");
+ colorPatternConverter.format(event, outputString, p);
+
+ LOGUNIT_ASSERT_EQUAL("\x1b[;37;40;5m", outputString);
+ }
+
+ void testClearColor(){
+ ColorStartPatternConverter colorPatternConverter;
+ LogString outputString;
+ Pool p;
+
+ LoggingEventPtr event= LoggingEventPtr(new LoggingEvent(
+
LOG4CXX_STR("org.foobar"),
+
Level::getInfo(),
+
LOG4CXX_STR("msg 1"),
+
LOG4CXX_LOCATION));
+
+
colorPatternConverter.setInfoColor("fg(white)|bg(black)|blinking");
+ colorPatternConverter.setInfoColor("");
+ colorPatternConverter.format(event, outputString, p);
+
+ LOGUNIT_ASSERT_EQUAL("", outputString);
+ }
+
+};
+
+#if !defined(_MSC_VER) || _MSC_VER > 1200
+ LOGUNIT_TEST_SUITE_REGISTRATION(ColorStartPatternConverterTestCase);
+#endif
diff --git a/src/test/resources/witness/patternLayout.13
b/src/test/resources/witness/patternLayout.13
index d6ba50a1..64b83e6e 100644
--- a/src/test/resources/witness/patternLayout.13
+++ b/src/test/resources/witness/patternLayout.13
@@ -1,10 +1,10 @@
-[36mDEBUG -[39m Message 0
-[36mDEBUG -[39m Message 0
-[32mINFO -[39m Message 1
-[32mINFO -[39m Message 1
-[33mWARN -[39m Message 2
-[33mWARN -[39m Message 2
-[91mERROR -[39m Message 3
-[91mERROR -[39m Message 3
-[35mFATAL -[39m Message 4
-[35mFATAL -[39m Message 4
\ No newline at end of file
+[36mDEBUG -[0m Message 0
+[36mDEBUG -[0m Message 0
+[32mINFO -[0m Message 1
+[32mINFO -[0m Message 1
+[33mWARN -[0m Message 2
+[33mWARN -[0m Message 2
+[31mERROR -[0m Message 3
+[31mERROR -[0m Message 3
+[35mFATAL -[0m Message 4
+[35mFATAL -[0m Message 4
