//
// Copyright (c) 2004-2006 Jaroslaw Kowalski <jaak@jkowalski.net>
//
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//
// * Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
//
// * Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation
// and/or other materials provided with the distribution.
//
// * Neither the name of Jaroslaw Kowalski nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
// THE POSSIBILITY OF SUCH DAMAGE.
//
#if !NETCF
using System;
using System.Text;
using System.Diagnostics;
using System.Reflection;
using System.IO;
namespace NLog.LayoutRenderers
{
/// <summary>
/// The call site (class name, method name and source information)
/// </summary>
[LayoutRenderer("callsite",UsingLogEventInfo=true)]
public class CallSiteLayoutRenderer: LayoutRenderer
{
private bool _className = true;
private bool _methodName = true;
private bool _sourceFile = false;
private bool _includeSourcePath = true;
/// <summary>
/// Render the class name.
/// </summary>
[System.ComponentModel.DefaultValue(true)]
public bool ClassName
{
get
{
return _className;
}
set
{
_className = value;
}
}
/// <summary>
/// Render the method name.
/// </summary>
[System.ComponentModel.DefaultValue(true)]
public bool MethodName
{
get
{
return _methodName;
}
set
{
_methodName = value;
}
}
/// <summary>
/// Render the source file name and line number.
/// </summary>
[System.ComponentModel.DefaultValue(false)]
public bool FileName
{
get
{
return _sourceFile;
}
set
{
_sourceFile = value;
}
}
/// <summary>
/// Include source file path.
/// </summary>
[System.ComponentModel.DefaultValue(true)]
public bool IncludeSourcePath
{
get
{
return _includeSourcePath;
}
set
{
_includeSourcePath = value;
}
}
/// <summary>
/// Returns the estimated number of characters that are needed to
/// hold the rendered value for the specified logging event.
/// </summary>
/// <param name="logEvent">Logging event information.</param>
/// <returns>The number of characters.</returns>
/// <remarks>
/// If the exact number is not known or
/// expensive to calculate this function should return a rough estimate
/// that's big enough in most cases, but not too big, in order to conserve memory.
/// </remarks>
protected internal override int GetEstimatedBufferSize(LogEventInfo logEvent)
{
return 200;
}
/// <summary>
/// Checks whether the stack trace is requested.
/// </summary>
/// <returns>2 when the source file information is requested, 1 otherwise.</returns>
protected internal override int NeedsStackTrace()
{
return _sourceFile ? 2 : 1;
}
/// <summary>
/// Renders the call site and appends it to the specified <see cref="StringBuilder" />.
/// </summary>
/// <param name="builder">The <see cref="StringBuilder"/> to append the rendered data to.</param>
/// <param name="logEvent">Logging event.</param>
protected internal override void Append(StringBuilder builder, LogEventInfo logEvent)
{
StackFrame frame = logEvent.UserStackFrame;
if (frame != null)
{
StringBuilder sb2 = builder;
if (Padding != 0)
sb2 = new StringBuilder();
MethodBase method = frame.GetMethod();
if (ClassName)
{
sb2.Append(method.DeclaringType.FullName);
}
if (MethodName)
{
if (ClassName)
{
sb2.Append(".");
}
sb2.Append(method.Name);
}
if (FileName)
{
string fileName = frame.GetFileName();
if (fileName != null)
{
sb2.Append("(");
if (IncludeSourcePath)
{
sb2.Append(fileName);
}
else
{
sb2.Append(Path.GetFileName(fileName));
}
sb2.Append(":");
sb2.Append(frame.GetFileLineNumber());
sb2.Append(")");
}
}
if (Padding != 0)
builder.Append(ApplyPadding(sb2.ToString()));
}
}
}
}
#endif