| 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_TRANSFORM_H
|
|---|
| 19 | #define _LOG4CXX_HELPERS_TRANSFORM_H
|
|---|
| 20 |
|
|---|
| 21 | #include <log4cxx/logstring.h>
|
|---|
| 22 |
|
|---|
| 23 | namespace log4cxx
|
|---|
| 24 | {
|
|---|
| 25 | namespace helpers
|
|---|
| 26 | {
|
|---|
| 27 | /**
|
|---|
| 28 | Utility class for transforming strings.
|
|---|
| 29 | */
|
|---|
| 30 | class LOG4CXX_EXPORT Transform
|
|---|
| 31 | {
|
|---|
| 32 | public:
|
|---|
| 33 | /**
|
|---|
| 34 | * This method takes a string which may contain HTML tags (ie,
|
|---|
| 35 | * <b>, <table>, etc) and replaces any '<' and '>'
|
|---|
| 36 | * characters with respective predefined entity references.
|
|---|
| 37 | *
|
|---|
| 38 | * @param buf output stream where to write the modified string.
|
|---|
| 39 | * @param input The text to be converted.
|
|---|
| 40 | * @return The input string with the characters '<' and '>' replaced with
|
|---|
| 41 | * &lt; and &gt; respectively.
|
|---|
| 42 | * */
|
|---|
| 43 | static void appendEscapingTags(
|
|---|
| 44 | LogString& buf, const LogString& input);
|
|---|
| 45 |
|
|---|
| 46 | /**
|
|---|
| 47 | * Ensures that embeded CDEnd strings (]]>) are handled properly
|
|---|
| 48 | * within message, NDC and throwable tag text.
|
|---|
| 49 | *
|
|---|
| 50 | * @param buf output stream holding the XML data to this point. The
|
|---|
| 51 | * initial CDStart (<![CDATA[) and final CDEnd (]]>) of the CDATA
|
|---|
| 52 | * section are the responsibility of the calling method.
|
|---|
| 53 | * @param input The String that is inserted into an existing CDATA
|
|---|
| 54 | * Section within buf.
|
|---|
| 55 | */
|
|---|
| 56 | static void appendEscapingCDATA(
|
|---|
| 57 | LogString& buf, const LogString& input);
|
|---|
| 58 | }; // class Transform
|
|---|
| 59 | } // namespace helpers
|
|---|
| 60 | } //namespace log4cxx
|
|---|
| 61 |
|
|---|
| 62 | #endif // _LOG4CXX_HELPERS_TRANSFORM_H
|
|---|
