#region Copyright & License
//
// Copyright 2001-2005 The Apache Software Foundation
//
// Licensed 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.
//
#endregion
using System;
using System.Globalization;
using System.Text;
using System.IO;
using log4net.Core;
using log4net.Util;
namespace log4net.Layout.Pattern
{
///
/// Converter to output and truncate '.' separated strings
///
///
///
/// This abstract class supports truncating a '.' separated string
/// to show a specified number of elements from the right hand side.
/// This is used to truncate class names that are fully qualified.
///
///
/// Subclasses should override the method to
/// return the fully qualified string.
///
///
/// Nicko Cadell
internal abstract class NamedPatternConverter : PatternLayoutConverter, IOptionHandler
{
protected int m_precision = 0;
#region Implementation of IOptionHandler
///
/// Initialize the converter
///
///
///
/// This is part of the delayed object
/// activation scheme. The method must
/// be called on this object after the configuration properties have
/// been set. Until is called this
/// object is in an undefined state and must not be used.
///
///
/// If any of the configuration properties are modified then
/// must be called again.
///
///
public void ActivateOptions()
{
m_precision = 0;
if (Option != null)
{
string optStr = Option.Trim();
if (optStr.Length > 0)
{
int precisionVal;
if (SystemInfo.TryParse(optStr, out precisionVal))
{
if (precisionVal <= 0)
{
LogLog.Error("NamedPatternConverter: Precision option (" + optStr + ") isn't a positive integer.");
}
else
{
m_precision = precisionVal;
}
}
else
{
LogLog.Error("NamedPatternConverter: Precision option \"" + optStr + "\" not a decimal integer.");
}
}
}
}
#endregion
///
/// Get the fully qualified string data
///
/// the event being logged
/// the fully qualified name
///
///
/// Overridden by subclasses to get the fully qualified name before the
/// precision is applied to it.
///
///
/// Return the fully qualified '.' (dot/period) separated string.
///
///
abstract protected string GetFullyQualifiedName(LoggingEvent loggingEvent);
///
/// Convert the pattern to the rendered message
///
/// that will receive the formatted result.
/// the event being logged
///
/// Render the to the precision
/// specified by the property.
///
override protected void Convert(TextWriter writer, LoggingEvent loggingEvent)
{
string name = GetFullyQualifiedName(loggingEvent);
if (m_precision <= 0)
{
writer.Write(name);
}
else
{
int len = name.Length;
// We subtract 1 from 'len' when assigning to 'end' to avoid out of
// bounds exception in return name.Substring(end+1, len). This can happen if
// precision is 1 and the logger name ends with a dot.
int end = len - 1;
for(int i=m_precision; i>0; i--)
{
end = name.LastIndexOf('.', end-1);
if (end == -1)
{
writer.Write(name);
return;
}
}
writer.Write(name.Substring(end+1, len-end-1));
}
}
}
}