mcs/class/corlib/System.Diagnostics/Debugger.cs

   1 //
   2 // System.Diagnostics.Debugger.cs
   3 //
   4 // Author:
   5 //      John R. Hicks (angryjohn69@nc.rr.com)
   6 //
   7 // (C) 2001
   8 //
   9
  10 //
  11 // Copyright (C) 2004 Novell, Inc (http://www.novell.com)
  12 //
  13 // Permission is hereby granted, free of charge, to any person obtaining
  14 // a copy of this software and associated documentation files (the
  15 // "Software"), to deal in the Software without restriction, including
  16 // without limitation the rights to use, copy, modify, merge, publish,
  17 // distribute, sublicense, and/or sell copies of the Software, and to
  18 // permit persons to whom the Software is furnished to do so, subject to
  19 // the following conditions:
  20 //
  21 // The above copyright notice and this permission notice shall be
  22 // included in all copies or substantial portions of the Software.
  23 //
  24 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  25 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  26 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  27 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  28 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  29 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  30 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  31 //
  32 using System;
  33 using System.Runtime.CompilerServices;
  34
  35 using System.Runtime.InteropServices;
  36
  37 namespace System.Diagnostics
  38 {
  39         /// <summary>
  40         /// Enables communication with a debugger.
  41         /// </summary>
  42         [ComVisible (true)]
  43         [MonoTODO ("The Debugger class is not functional")]
  44         public sealed class Debugger
  45         {
  46
  47                 /// <summary>
  48                 /// Represents the default category of a message with a constant.
  49                 /// </summary>
  50                 public static readonly string DefaultCategory = "";
  51
  52                 /// <summary>
  53                 /// Returns a Boolean indicating whether a debugger is attached to a process.
  54                 /// </summary>
  55                 /// <value>
  56                 /// true if debugger is attached; otherwise, false.
  57                 /// </value>
  58                 public static bool IsAttached
  59                 {
  60                         get
  61                         {
  62                                 return IsAttached_internal ();
  63                         }
  64                 }
  65
  66                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
  67                 private extern static bool IsAttached_internal ();
  68
  69                 /// <summary>
  70                 /// Causes a breakpoint to be signaled to an attached debugger.
  71                 /// </summary>
  72                 public static void Break()
  73                 {
  74                         // The JIT inserts a breakpoint on the caller.
  75                 }
  76
  77                 /// <summary>
  78                 /// Checks to see if logging is enabled by an attached debugger.
  79                 /// </summary>
  80                 [MethodImplAttribute(MethodImplOptions.InternalCall)]
  81                 public static extern bool IsLogging();
  82
  83                 /// <summary>
  84                 /// Launches and attaches a debugger to the process.
  85                 /// </summary>
  86                 [MonoTODO ("Not implemented")]
  87                 public static bool Launch()
  88                 {
  89                         throw new NotImplementedException();
  90                 }
  91
  92                 /// <summary>
  93                 /// Posts a message for the attached debugger.
  94                 /// </summary>
  95                 /// <param name="level">
  96                 /// A description of the importance of this message
  97                 /// </param>
  98                 /// <param name="category">
  99                 /// A string describing the category of this message.
 100                 /// </param>
 101                 /// <param name="message">
 102                 /// A string representing the message to show.
 103                 /// </param>
 104                 [MethodImplAttribute(MethodImplOptions.InternalCall)]
 105                 public static extern void Log(int level, string category, string message);
 106
 107 #if NET_4_0
 108                 [ObsoleteAttribute("Call the static methods directly on this type", true)]
 109 #endif
 110                 public Debugger()
 111                 {
 112                 }
 113         }
 114 }