class/System/System.Diagnostics/TraceImpl.cs

   1 //
   2 // System.Diagnostics.TraceImpl.cs
   3 //
   4 // Authors:
   5 //   Jonathan Pryor (jonpryor@vt.edu)
   6 //
   7 // (C) 2002, 2005 Jonathan Pryor
   8 //
   9
  10 //
  11 // Permission is hereby granted, free of charge, to any person obtaining
  12 // a copy of this software and associated documentation files (the
  13 // "Software"), to deal in the Software without restriction, including
  14 // without limitation the rights to use, copy, modify, merge, publish,
  15 // distribute, sublicense, and/or sell copies of the Software, and to
  16 // permit persons to whom the Software is furnished to do so, subject to
  17 // the following conditions:
  18 //
  19 // The above copyright notice and this permission notice shall be
  20 // included in all copies or substantial portions of the Software.
  21 //
  22 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  23 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  24 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  25 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  26 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  27 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  28 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  29 //
  30
  31
  32 using System;
  33 using System.Collections;
  34 using System.Diagnostics;
  35 using System.Configuration;
  36 using System.Threading;
  37
  38 namespace System.Diagnostics {
  39
  40         internal class TraceImplSettings {
  41                 public const string Key = ".__TraceInfoSettingsKey__.";
  42
  43                 public bool AutoFlush;
  44                 public int IndentLevel, IndentSize = 4;
  45                 public TraceListenerCollection Listeners = new TraceListenerCollection (false);
  46
  47                 public TraceImplSettings ()
  48                 {
  49                         Listeners.Add (new DefaultTraceListener (), this);
  50                 }
  51         }
  52
  53         internal class TraceImpl {
  54
  55                 private static object initLock = new object ();
  56
  57                 private static bool autoFlush;
  58
  59 #if TARGET_JVM
  60                 static readonly LocalDataStoreSlot _indentLevelStore = System.Threading.Thread.AllocateDataSlot ();
  61                 static readonly LocalDataStoreSlot _indentSizeStore = System.Threading.Thread.AllocateDataSlot ();
  62
  63                 private static int indentLevel {
  64                         get {
  65                                 object o = System.Threading.Thread.GetData (_indentLevelStore);
  66                                 if (o == null)
  67                                         return 0;
  68                                 return (int) o;
  69                         }
  70                         set { System.Threading.Thread.SetData (_indentLevelStore, value); }
  71                 }
  72
  73                 private static int indentSize {
  74                         get {
  75                                 object o = System.Threading.Thread.GetData (_indentSizeStore);
  76                                 if (o == null)
  77                                         return 0;
  78                                 return (int) o;
  79                         }
  80                         set { System.Threading.Thread.SetData (_indentSizeStore, value); }
  81                 }
  82 #else
  83                 [ThreadStatic]
  84                 private static int indentLevel = 0;
  85
  86                 [ThreadStatic]
  87                 private static int indentSize;
  88 #endif
  89
  90                 private TraceImpl ()
  91                 {
  92                 }
  93
  94                 public static bool AutoFlush {
  95                         get {
  96                                 InitOnce ();
  97                                 return autoFlush;
  98                         }
  99                         set {
 100                                 InitOnce ();
 101                                 autoFlush = value;
 102                         }
 103                 }
 104
 105                 public static int IndentLevel {
 106                         get {
 107                                 InitOnce ();
 108                                 return indentLevel;
 109                         }
 110                         set {
 111                                 lock (ListenersSyncRoot) {
 112                                         indentLevel = value;
 113
 114                                         foreach (TraceListener t in Listeners) {
 115                                                 t.IndentLevel = indentLevel;
 116                                         }
 117                                 }
 118                         }
 119                 }
 120
 121                 public static int IndentSize {
 122                         get {
 123                                 InitOnce ();
 124                                 return indentSize;
 125                         }
 126                         set {
 127                                 lock (ListenersSyncRoot) {
 128                                         indentSize = value;
 129
 130                                         foreach (TraceListener t in Listeners) {
 131                                                 t.IndentSize = indentSize;
 132                                         }
 133                                 }
 134                         }
 135                 }
 136
 137                 private static TraceListenerCollection listeners;
 138
 139                 public static TraceListenerCollection Listeners {
 140                         get {
 141                                 InitOnce ();
 142
 143                                 return listeners;
 144                         }
 145                 }
 146
 147                 private static object ListenersSyncRoot {
 148                         get {
 149                                 return ((ICollection) Listeners).SyncRoot;
 150                         }
 151                 }
 152
 153                 static bool use_global_lock;
 154 #if NET_2_0
 155                 static CorrelationManager correlation_manager = new CorrelationManager ();
 156
 157                 public static CorrelationManager CorrelationManager {
 158                         get {
 159                                 InitOnce ();
 160                                 return correlation_manager;
 161                         }
 162                 }
 163 #endif
 164
 165                 [MonoLimitation ("the property exists but it does nothing.")]
 166                 public static bool UseGlobalLock {
 167                         get {
 168                                 InitOnce ();
 169                                 return use_global_lock;
 170                         }
 171                         set {
 172                                 InitOnce ();
 173                                 use_global_lock = value;
 174                         }
 175                 }
 176
 177                 // Initialize the world.
 178                 //
 179                 // This logically belongs in the static constructor (as it only needs
 180                 // to be done once), except for one thing: if the .config file has a
 181                 // syntax error, .NET throws a ConfigurationException.  If we read the
 182                 // .config file in the static ctor, we throw a ConfigurationException
 183                 // from the static ctor, which results in a TypeLoadException.  Oops.
 184                 // Reading the .config file here will allow the static ctor to
 185                 // complete successfully, allowing us to throw a normal
 186                 // ConfigurationException should the .config file contain an error.
 187                 //
 188                 // There are also some ordering issues.
 189                 //
 190                 // DiagnosticsConfigurationHandler doesn't store values within TraceImpl,
 191                 // but instead stores values it reads from the .config file within a
 192                 // TraceImplSettings object (accessible via the TraceImplSettings.Key key
 193                 // in the IDictionary returned).
 194                 private static void InitOnce ()
 195                 {
 196                         if (initLock != null) {
 197                                 lock (initLock) {
 198                                         if (listeners == null) {
 199                                                 IDictionary       d = DiagnosticsConfiguration.Settings;
 200                                                 TraceImplSettings s = (TraceImplSettings) d [TraceImplSettings.Key];
 201
 202                                                 d.Remove (TraceImplSettings.Key);
 203
 204                                                 autoFlush   = s.AutoFlush;
 205                                                 indentLevel = s.IndentLevel;
 206                                                 indentSize  = s.IndentSize;
 207                                                 listeners   = s.Listeners;
 208                                         }
 209                                 }
 210                                 initLock = null;
 211                         }
 212                 }
 213
 214                 // FIXME: According to MSDN, this method should display a dialog box
 215                 [MonoTODO]
 216                 public static void Assert (bool condition)
 217                 {
 218                         if (!condition)
 219                                 Fail (new StackTrace(true).ToString());
 220                 }
 221
 222                 // FIXME: According to MSDN, this method should display a dialog box
 223                 [MonoTODO]
 224                 public static void Assert (bool condition, string message)
 225                 {
 226                         if (!condition)
 227                                 Fail (message);
 228                 }
 229
 230                 // FIXME: According to MSDN, this method should display a dialog box
 231                 [MonoTODO]
 232                 public static void Assert (bool condition, string message,
 233                         string detailMessage)
 234                 {
 235                         if (!condition)
 236                                 Fail (message, detailMessage);
 237                 }
 238
 239                 public static void Close ()
 240                 {
 241                         lock (ListenersSyncRoot) {
 242                                 foreach (TraceListener listener in Listeners) {
 243                                         listener.Close ();
 244                                 }
 245                         }
 246                 }
 247
 248                 // FIXME: From testing .NET, this method should display a dialog
 249                 //(it probably depends on the listener)p
 250                 [MonoTODO]
 251                 public static void Fail (string message)
 252                 {
 253                         lock (ListenersSyncRoot) {
 254                                 foreach (TraceListener listener in Listeners) {
 255                                         listener.Fail (message);
 256                                 }
 257                         }
 258                 }
 259
 260                 // FIXME: From testing .NET, this method should display a dialog
 261                 // (it probably depends on the listener)p
 262                 [MonoTODO]
 263                 public static void Fail (string message, string detailMessage)
 264                 {
 265                         lock (ListenersSyncRoot) {
 266                                 foreach (TraceListener listener in Listeners) {
 267                                         listener.Fail (message, detailMessage);
 268                                 }
 269                         }
 270                 }
 271
 272                 public static void Flush ()
 273                 {
 274                         lock (ListenersSyncRoot) {
 275                                 foreach (TraceListener listener in Listeners){
 276                                         listener.Flush ();
 277                                 }
 278                         }
 279                 }
 280
 281                 public static void Indent ()
 282                 {
 283                         IndentLevel ++;
 284                 }
 285
 286                 public static void Unindent ()
 287                 {
 288                         IndentLevel --;
 289                 }
 290
 291                 public static void Write (object value)
 292                 {
 293                         lock (ListenersSyncRoot) {
 294                                 foreach (TraceListener listener in Listeners) {
 295                                         listener.Write (value);
 296
 297                                         if (AutoFlush)
 298                                                 listener.Flush ();
 299                                 }
 300                         }
 301                 }
 302
 303                 public static void Write (string message)
 304                 {
 305                         lock (ListenersSyncRoot) {
 306                                 foreach (TraceListener listener in Listeners) {
 307                                         listener.Write (message);
 308
 309                                         if (AutoFlush)
 310                                                 listener.Flush ();
 311                                 }
 312                         }
 313                 }
 314
 315                 public static void Write (object value, string category)
 316                 {
 317                         lock (ListenersSyncRoot) {
 318                                 foreach (TraceListener listener in Listeners) {
 319                                         listener.Write (value, category);
 320
 321                                         if (AutoFlush)
 322                                                 listener.Flush ();
 323                                 }
 324                         }
 325                 }
 326
 327                 public static void Write (string message, string category)
 328                 {
 329                         lock (ListenersSyncRoot) {
 330                                 foreach (TraceListener listener in Listeners) {
 331                                         listener.Write (message, category);
 332
 333                                         if (AutoFlush)
 334                                                 listener.Flush ();
 335                                 }
 336                         }
 337                 }
 338
 339                 public static void WriteIf (bool condition, object value)
 340                 {
 341                         if (condition)
 342                                 Write (value);
 343                 }
 344
 345                 public static void WriteIf (bool condition, string message)
 346                 {
 347                         if (condition)
 348                                 Write (message);
 349                 }
 350
 351                 public static void WriteIf (bool condition, object value,
 352                         string category)
 353                 {
 354                         if (condition)
 355                                 Write (value, category);
 356                 }
 357
 358                 public static void WriteIf (bool condition, string message,
 359                         string category)
 360                 {
 361                         if (condition)
 362                                 Write (message, category);
 363                 }
 364
 365                 public static void WriteLine (object value)
 366                 {
 367                         lock (ListenersSyncRoot) {
 368                                 foreach (TraceListener listener in Listeners) {
 369                                         listener.WriteLine (value);
 370
 371                                         if (AutoFlush)
 372                                                 listener.Flush ();
 373                                 }
 374                         }
 375                 }
 376
 377                 public static void WriteLine (string message)
 378                 {
 379                         lock (ListenersSyncRoot) {
 380                                 foreach (TraceListener listener in Listeners) {
 381                                         listener.WriteLine (message);
 382
 383                                         if (AutoFlush)
 384                                                 listener.Flush ();
 385                                 }
 386                         }
 387                 }
 388
 389                 public static void WriteLine (object value, string category)
 390                 {
 391                         lock (ListenersSyncRoot) {
 392                                 foreach (TraceListener listener in Listeners) {
 393                                         listener.WriteLine (value, category);
 394
 395                                         if (AutoFlush)
 396                                                 listener.Flush ();
 397                                 }
 398                         }
 399                 }
 400
 401                 public static void WriteLine (string message, string category)
 402                 {
 403                         lock (ListenersSyncRoot) {
 404                                 foreach (TraceListener listener in Listeners) {
 405                                         listener.WriteLine (message, category);
 406
 407                                         if (AutoFlush)
 408                                                 listener.Flush ();
 409                                 }
 410                         }
 411                 }
 412
 413                 public static void WriteLineIf (bool condition, object value)
 414                 {
 415                         if (condition)
 416                                 WriteLine (value);
 417                 }
 418
 419                 public static void WriteLineIf (bool condition, string message)
 420                 {
 421                         if (condition)
 422                                 WriteLine (message);
 423                 }
 424
 425                 public static void WriteLineIf (bool condition, object value,
 426                         string category)
 427                 {
 428                         if (condition)
 429                                 WriteLine (value, category);
 430                 }
 431
 432                 public static void WriteLineIf (bool condition, string message,
 433                         string category)
 434                 {
 435                         if (condition)
 436                                 WriteLine (message, category);
 437                 }
 438         }
 439 }
 440