We need you! We're working hard on the next version of Developer Fusion - Let us know what you think we should be up to!

The Labs \ Source Viewer \ SSCLI \ System.Diagnostics \ Trace

SSCLI

//------------------------------------------------------------------------------
// <copyright file="Trace.cs" company="Microsoft">
//
//
// The use and distribution terms for this software are contained in the file
// named license.txt, which can be found in the root of this distribution.
// By using this software in any fashion, you are agreeing to be bound by the
// terms of this license.
//
// You must not remove this notice, or any other, from this software.
//
// </copyright>
//------------------------------------------------------------------------------
/*
*/
#define TRACE
namespace System.Diagnostics
{
using System;
using System.Collections;
using System.Security.Permissions;
using System.Threading;
/// <devdoc>
/// <para>Provides a set of properties and methods to trace the execution of your code.</para>
/// </devdoc>
public sealed class Trace
{
private static CorrelationManager correlationManager = null;
// not creatble...
//
private Trace()
{
}
/// <devdoc>
/// <para>Gets the collection of listeners that is monitoring the trace output.</para>
/// </devdoc>
public static TraceListenerCollection Listeners {
[HostProtection(SharedState = true)]
get {
// Do a full damand
new SecurityPermission(SecurityPermissionFlag.UnmanagedCode).Demand();
return TraceInternal.Listeners;
}
}
/// <devdoc>
/// <para>
/// Gets or sets whether <see cref='System.Diagnostics.Trace.Flush'/> should be called on the <see cref='System.Diagnostics.Trace.Listeners'/> after every write.
/// </para>
/// </devdoc>
public static bool AutoFlush {
[SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.UnmanagedCode)]
get { return TraceInternal.AutoFlush; }
[SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.UnmanagedCode)]
set { TraceInternal.AutoFlush = value; }
}
public static bool UseGlobalLock {
[SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.UnmanagedCode)]
get { return TraceInternal.UseGlobalLock; }
[SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.UnmanagedCode)]
set { TraceInternal.UseGlobalLock = value; }
}
public static CorrelationManager CorrelationManager {
[SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.UnmanagedCode)]
get {
if (correlationManager == null)
correlationManager = new CorrelationManager();
return correlationManager;
}
}
/// <devdoc>
/// <para>Gets or sets the indent level.</para>
/// </devdoc>
public static int IndentLevel {
get { return TraceInternal.IndentLevel; }
set { TraceInternal.IndentLevel = value; }
}
/// <devdoc>
/// <para>
/// Gets or sets the number of spaces in an indent.
/// </para>
/// </devdoc>
public static int IndentSize {
get { return TraceInternal.IndentSize; }
set { TraceInternal.IndentSize = value; }
}
/// <devdoc>
/// <para>Clears the output buffer, and causes buffered data to
/// be written to the <see cref='System.Diagnostics.Trace.Listeners'/>.</para>
/// </devdoc>
[System.Diagnostics.Conditional("TRACE")]
public static void Flush()
{
TraceInternal.Flush();
}
/// <devdoc>
/// <para>Clears the output buffer, and then closes the <see cref='System.Diagnostics.Trace.Listeners'/> so that they no
/// longer receive debugging output.</para>
/// </devdoc>
[System.Diagnostics.Conditional("TRACE")]
public static void Close()
{
// Do a full damand
new SecurityPermission(SecurityPermissionFlag.UnmanagedCode).Demand();
TraceInternal.Close();
}
/// <devdoc>
/// <para>Checks for a condition, and outputs the callstack if the
/// condition
/// is <see langword='false'/>.</para>
/// </devdoc>
[System.Diagnostics.Conditional("TRACE")]
public static void Assert(bool condition)
{
TraceInternal.Assert(condition);
}
/// <devdoc>
/// <para>Checks for a condition, and displays a message if the condition is
/// <see langword='false'/>. </para>
/// </devdoc>
[System.Diagnostics.Conditional("TRACE")]
public static void Assert(bool condition, string message)
{
TraceInternal.Assert(condition, message);
}
/// <devdoc>
/// <para>Checks for a condition, and displays both messages if the condition
/// is <see langword='false'/>. </para>
/// </devdoc>
[System.Diagnostics.Conditional("TRACE")]
public static void Assert(bool condition, string message, string detailMessage)
{
TraceInternal.Assert(condition, message, detailMessage);
}
/// <devdoc>
/// <para>Emits or displays a message for an assertion that always fails.</para>
/// </devdoc>
[System.Diagnostics.Conditional("TRACE")]
public static void Fail(string message)
{
TraceInternal.Fail(message);
}
/// <devdoc>
/// <para>Emits or displays both messages for an assertion that always fails.</para>
/// </devdoc>
[System.Diagnostics.Conditional("TRACE")]
public static void Fail(string message, string detailMessage)
{
TraceInternal.Fail(message, detailMessage);
}
public static void Refresh()
{
DiagnosticsConfiguration.Refresh();
Switch.RefreshAll();
TraceSource.RefreshAll();
}
[System.Diagnostics.Conditional("TRACE")]
public static void TraceInformation(string message)
{
TraceInternal.TraceEvent(TraceEventType.Information, 0, message, null);
}
[System.Diagnostics.Conditional("TRACE")]
public static void TraceInformation(string format, params object[] args)
{
TraceInternal.TraceEvent(TraceEventType.Information, 0, format, args);
}
[System.Diagnostics.Conditional("TRACE")]
public static void TraceWarning(string message)
{
TraceInternal.TraceEvent(TraceEventType.Warning, 0, message, null);
}
[System.Diagnostics.Conditional("TRACE")]
public static void TraceWarning(string format, params object[] args)
{
TraceInternal.TraceEvent(TraceEventType.Warning, 0, format, args);
}
[System.Diagnostics.Conditional("TRACE")]
public static void TraceError(string message)
{
TraceInternal.TraceEvent(TraceEventType.Error, 0, message, null);
}
[System.Diagnostics.Conditional("TRACE")]
public static void TraceError(string format, params object[] args)
{
TraceInternal.TraceEvent(TraceEventType.Error, 0, format, args);
}
/// <devdoc>
/// <para>Writes a message to the trace listeners in the <see cref='System.Diagnostics.Trace.Listeners'/>
/// collection.</para>
/// </devdoc>
[System.Diagnostics.Conditional("TRACE")]
public static void Write(string message)
{
TraceInternal.Write(message);
}
/// <devdoc>
/// <para>Writes the name of the <paramref name="value "/>
/// parameter to the trace listeners in the <see cref='System.Diagnostics.Trace.Listeners'/> collection.</para>
/// </devdoc>
[System.Diagnostics.Conditional("TRACE")]
public static void Write(object value)
{
TraceInternal.Write(value);
}
/// <devdoc>
/// <para>Writes a category name and message to the trace listeners
/// in the <see cref='System.Diagnostics.Trace.Listeners'/> collection.</para>
/// </devdoc>
[System.Diagnostics.Conditional("TRACE")]
public static void Write(string message, string category)
{
TraceInternal.Write(message, category);
}
/// <devdoc>
/// <para>Writes a category name and the name of the value parameter to the trace listeners
/// in the <see cref='System.Diagnostics.Trace.Listeners'/> collection.</para>
/// </devdoc>
[System.Diagnostics.Conditional("TRACE")]
public static void Write(object value, string category)
{
TraceInternal.Write(value, category);
}
/// <devdoc>
/// <para>Writes a message followed by a line terminator to the
/// trace listeners in the <see cref='System.Diagnostics.Trace.Listeners'/> collection.
/// The default line terminator is a carriage return followed by a line feed (\r\n).</para>
/// </devdoc>
[System.Diagnostics.Conditional("TRACE")]
public static void WriteLine(string message)
{
TraceInternal.WriteLine(message);
}
/// <devdoc>
/// <para>Writes the name of the <paramref name="value "/> parameter followed by a line terminator to the trace listeners in the <see cref='System.Diagnostics.Trace.Listeners'/> collection. The default line
/// terminator is a carriage return followed by a line feed (\r\n).</para>
/// </devdoc>
[System.Diagnostics.Conditional("TRACE")]
public static void WriteLine(object value)
{
TraceInternal.WriteLine(value);
}
/// <devdoc>
/// <para>Writes a category name and message followed by a line terminator to the trace
/// listeners in the <see cref='System.Diagnostics.Trace.Listeners'/>
/// collection. The default line terminator is a carriage return followed by a line
/// feed (\r\n).</para>
/// </devdoc>
[System.Diagnostics.Conditional("TRACE")]
public static void WriteLine(string message, string category)
{
TraceInternal.WriteLine(message, category);
}
/// <devdoc>
/// <para>Writes a <paramref name="category "/>name and the name of the <paramref name="value "/> parameter followed by a line
/// terminator to the trace listeners in the <see cref='System.Diagnostics.Trace.Listeners'/> collection. The default line
/// terminator is a carriage return followed by a line feed (\r\n).</para>
/// </devdoc>
[System.Diagnostics.Conditional("TRACE")]
public static void WriteLine(object value, string category)
{
TraceInternal.WriteLine(value, category);
}
/// <devdoc>
/// <para>Writes a message to the trace listeners in the <see cref='System.Diagnostics.Trace.Listeners'/> collection
/// if a condition is <see langword='true'/>.</para>
/// </devdoc>
[System.Diagnostics.Conditional("TRACE")]
public static void WriteIf(bool condition, string message)
{
TraceInternal.WriteIf(condition, message);
}
/// <devdoc>
/// <para>Writes the name of the <paramref name="value "/>
/// parameter to the trace listeners in the <see cref='System.Diagnostics.Trace.Listeners'/> collection if a condition is
/// <see langword='true'/>. </para>
/// </devdoc>
[System.Diagnostics.Conditional("TRACE")]
public static void WriteIf(bool condition, object value)
{
TraceInternal.WriteIf(condition, value);
}
/// <devdoc>
/// <para>Writes a category name and message to the trace listeners in the <see cref='System.Diagnostics.Trace.Listeners'/>
/// collection if a condition is <see langword='true'/>. </para>
/// </devdoc>
[System.Diagnostics.Conditional("TRACE")]
public static void WriteIf(bool condition, string message, string category)
{
TraceInternal.WriteIf(condition, message, category);
}
/// <devdoc>
/// <para>Writes a category name and the name of the <paramref name="value"/> parameter to the trace
/// listeners in the <see cref='System.Diagnostics.Trace.Listeners'/> collection
/// if a condition is <see langword='true'/>. </para>
/// </devdoc>
[System.Diagnostics.Conditional("TRACE")]
public static void WriteIf(bool condition, object value, string category)
{
TraceInternal.WriteIf(condition, value, category);
}
/// <devdoc>
/// <para>Writes a message followed by a line terminator to the trace listeners in the
/// <see cref='System.Diagnostics.Trace.Listeners'/> collection if a condition is
/// <see langword='true'/>. The default line terminator is a carriage return followed
/// by a line feed (\r\n).</para>
/// </devdoc>
[System.Diagnostics.Conditional("TRACE")]
public static void WriteLineIf(bool condition, string message)
{
TraceInternal.WriteLineIf(condition, message);
}
/// <devdoc>
/// <para>Writes the name of the <paramref name="value"/> parameter followed by a line terminator to the
/// trace listeners in the <see cref='System.Diagnostics.Trace.Listeners'/> collection
/// if a condition is
/// <see langword='true'/>. The default line
/// terminator is a carriage return followed by a line feed (\r\n).</para>
/// </devdoc>
[System.Diagnostics.Conditional("TRACE")]
public static void WriteLineIf(bool condition, object value)
{
TraceInternal.WriteLineIf(condition, value);
}
/// <devdoc>
/// <para>Writes a category name and message followed by a line terminator to the trace
/// listeners in the <see cref='System.Diagnostics.Trace.Listeners'/> collection if a condition is
/// <see langword='true'/>. The default line terminator is a carriage return followed by a line feed (\r\n).</para>
/// </devdoc>
[System.Diagnostics.Conditional("TRACE")]
public static void WriteLineIf(bool condition, string message, string category)
{
TraceInternal.WriteLineIf(condition, message, category);
}
/// <devdoc>
/// <para>Writes a category name and the name of the <paramref name="value "/> parameter followed by a line
/// terminator to the trace listeners in the <see cref='System.Diagnostics.Trace.Listeners'/> collection
/// if a <paramref name="condition"/> is <see langword='true'/>. The
/// default line terminator is a carriage return followed by a line feed (\r\n).</para>
/// </devdoc>
[System.Diagnostics.Conditional("TRACE")]
public static void WriteLineIf(bool condition, object value, string category)
{
TraceInternal.WriteLineIf(condition, value, category);
}
/// <devdoc>
/// <para>[To be supplied.]</para>
/// </devdoc>
[System.Diagnostics.Conditional("TRACE")]
public static void Indent()
{
TraceInternal.Indent();
}
/// <devdoc>
/// <para>[To be supplied.]</para>
/// </devdoc>
[System.Diagnostics.Conditional("TRACE")]
public static void Unindent()
{
TraceInternal.Unindent();
}
}
}