2 // System.Diagnostics.DefaultTraceListener.cs
5 // Jonathan Pryor (jonpryor@vt.edu)
6 // Atsushi Enomoto (atsushi@ximian.com)
8 // Comments from John R. Hicks <angryjohn69@nc.rr.com> original implementation
9 // can be found at: /mcs/docs/apidocs/xml/en/System.Diagnostics
11 // (C) 2002 Jonathan Pryor
12 // (C) 2007 Novell, Inc.
16 // Permission is hereby granted, free of charge, to any person obtaining
17 // a copy of this software and associated documentation files (the
18 // "Software"), to deal in the Software without restriction, including
19 // without limitation the rights to use, copy, modify, merge, publish,
20 // distribute, sublicense, and/or sell copies of the Software, and to
21 // permit persons to whom the Software is furnished to do so, subject to
22 // the following conditions:
24 // The above copyright notice and this permission notice shall be
25 // included in all copies or substantial portions of the Software.
27 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
28 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
29 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
30 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
31 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
32 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
33 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
38 using System.Collections;
39 using System.Diagnostics;
40 using System.Reflection;
41 using System.Runtime.CompilerServices;
42 using System.Runtime.InteropServices;
43 using System.Threading;
45 namespace System.Diagnostics {
50 public class DefaultTraceListener : TraceListener {
52 private static readonly bool OnWin32;
54 private const string ConsoleOutTrace = "Console.Out";
55 private const string ConsoleErrorTrace = "Console.Error";
57 private static readonly string MonoTracePrefix;
58 private static readonly string MonoTraceFile;
60 static DefaultTraceListener ()
62 // Determine what platform we're on. This impacts how where we send
63 // messages. On Win32 platforms (OnWin32 = true), we use the
64 // `OutputDebugString' api.
66 // On Linux platforms, we use MONO_TRACE_LISTENER to figure things out. See the
67 // API documentation for more information on MONO_TRACE_LISTENER.
68 OnWin32 = (Path.DirectorySeparatorChar == '\\');
72 string trace = java.lang.System.getProperty("MONO_TRACE");
74 // If we're running on Unix, we don't have OutputDebugString.
75 // Instead, send output to...wherever the MONO_TRACE_LISTENER environment
77 String trace = Environment.GetEnvironmentVariable("MONO_TRACE_LISTENER");
82 trace = ConsoleOutTrace;
89 if (trace.StartsWith (ConsoleOutTrace)) {
90 file = ConsoleOutTrace;
91 prefix = GetPrefix (trace, ConsoleOutTrace);
93 else if (trace.StartsWith (ConsoleErrorTrace)) {
94 file = ConsoleErrorTrace;
95 prefix = GetPrefix (trace, ConsoleErrorTrace);
100 // We can't firgure out what the prefix would be, as ':' is a
101 // valid filename character. Thus, arbitrary files don't support
104 // I don't consider this to be a major issue. Prefixes are useful
105 // with Console.Out and Console.Error to help separate trace
106 // output from the actual program output. Writing to an arbitrary
107 // file doesn't introduce issues with disambiguation.
111 MonoTraceFile = file;
112 MonoTracePrefix = prefix;
118 * Get the prefix for the specified variable.
120 * "Prefixes" are used in the MONO_TRACE_LISTENER variable, and specify text that
121 * should precede each message printed to the console. The prefix is
122 * appended to the console location with a colon (':') separating them.
123 * For example, if MONO_TRACE_LISTENER is "Console.Out:** my prefix", the prefix is
126 * Everything after the colon, if the colon is present, is used as the
129 * @param var The current MONO_TRACE_LISTENER variable
130 * @param target The name of the output location, e.g. "Console.Out"
132 private static string GetPrefix (string var, string target)
134 // actually, we permit any character to separate `target' and the prefix;
135 // we just skip over target the ':' would be. This means that a space or
136 // anything else would suffice, as long as it was only a single
138 if (var.Length > target.Length)
139 return var.Substring (target.Length + 1);
143 private string logFileName = null;
145 private bool assertUiEnabled = false;
147 public DefaultTraceListener () : base ("Default")
151 public bool AssertUiEnabled {
152 get { return assertUiEnabled; }
153 set { assertUiEnabled = value; }
157 public string LogFileName {
158 get {return logFileName;}
159 set {logFileName = value;}
162 public override void Fail (string message)
167 public override void Fail (string message, string detailMessage)
169 base.Fail (message, detailMessage);
170 if (ProcessUI (message, detailMessage) == DialogResult.Abort)
171 Thread.CurrentThread.Abort ();
172 WriteLine (new StackTrace().ToString());
175 DialogResult ProcessUI (string message, string detailMessage)
178 if (!AssertUiEnabled)
179 return DialogResult.None;
181 object messageBoxButtonsAbortRetryIgnore;
182 MethodInfo msgboxShow;
185 Assembly wfAsm = Assembly.Load (Consts.AssemblySystem_Windows_Forms);
187 return DialogResult.None;
189 Type buttons = wfAsm.GetType ("System.Windows.Forms.MessageBoxButtons");
190 messageBoxButtonsAbortRetryIgnore = Enum.Parse (buttons, "AbortRetryIgnore");
191 msgboxShow = wfAsm.GetType ("System.Windows.Forms.MessageBox").GetMethod (
193 new Type [] {typeof (string), typeof (string), buttons});
195 return DialogResult.None;
198 if (msgboxShow == null || messageBoxButtonsAbortRetryIgnore == null)
199 return DialogResult.None;
201 string caption = String.Format ("Assertion Failed: {0} to quit, {1} to debug, {2} to continue", "Abort", "Retry", "Ignore");
202 string msg = String.Format ("{0}{1}{2}{1}{1}{3}", message, Environment.NewLine, detailMessage, new StackTrace ());
204 switch (msgboxShow.Invoke (null, new object [] {msg, caption, messageBoxButtonsAbortRetryIgnore}).ToString ()) {
206 return DialogResult.Ignore;
208 return DialogResult.Abort;
210 return DialogResult.Retry;
222 private void WriteDebugString (string message)
225 [MethodImplAttribute(MethodImplOptions.InternalCall)]
226 private extern static void WriteWindowsDebugString (string message);
228 private void WriteDebugString (string message)
231 WriteWindowsDebugString (message);
234 WriteMonoTrace (message);
237 private void WriteMonoTrace (string message)
239 switch (MonoTraceFile) {
240 case ConsoleOutTrace:
241 Console.Out.Write (message);
243 case ConsoleErrorTrace:
244 Console.Error.Write (message);
247 WriteLogFile (message, MonoTraceFile);
252 private void WritePrefix ()
255 WriteMonoTrace (MonoTracePrefix);
259 private void WriteImpl (string message)
266 WriteDebugString (message);
268 if (Debugger.IsLogging())
269 Debugger.Log (0, null, message);
271 WriteLogFile (message, LogFileName);
274 private void WriteLogFile (string message, string logFile)
276 string fname = logFile;
277 if (fname != null && fname.Length != 0) {
278 FileInfo info = new FileInfo (fname);
279 StreamWriter sw = null;
284 sw = info.AppendText ();
286 sw = info.CreateText ();
289 // We weren't able to open the file for some reason.
290 // We can't write to the log file; so give up.
301 public override void Write (string message)
306 public override void WriteLine (string message)
308 string msg = message + Environment.NewLine;