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

   1 //
   2 // System.Diagnostics.StackFrame.cs
   3 //
   4 // Author:
   5 //      Alexander Klyubin (klyubin@aqris.com)
   6 //      Dietmar Maurer (dietmar@ximian.com)
   7 //
   8 // (C) 2001
   9 // Copyright (C) 2004-2005 Novell, Inc (http://www.novell.com)
  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 using System.IO;
  32 using System.Reflection;
  33 using System.Runtime.CompilerServices;
  34 using System.Security;
  35 using System.Security.Permissions;
  36 using System.Text;
  37 using System.Runtime.InteropServices;
  38
  39 namespace System.Diagnostics {
  40
  41         [Serializable]
  42         [ComVisible (true)]
  43         [MonoTODO ("Serialized objects are not compatible with MS.NET")]
  44         [StructLayout (LayoutKind.Sequential)]
  45         public class StackFrame {
  46
  47                 public const int OFFSET_UNKNOWN = -1;
  48
  49                 #region Keep in sync with object-internals.h
  50                 private int ilOffset = OFFSET_UNKNOWN;
  51                 private int nativeOffset = OFFSET_UNKNOWN;
  52                 private long methodAddress;
  53                 private MethodBase methodBase;
  54                 private string fileName;
  55                 private int lineNumber;
  56                 private int columnNumber;
  57         #pragma warning disable 649
  58                 private string internalMethodName;
  59                 #pragma warning restore 649
  60                 #endregion
  61
  62                 [MethodImplAttribute(MethodImplOptions.InternalCall)]
  63                 extern static bool get_frame_info (int skip, bool needFileInfo, out MethodBase method,
  64                                                    out int iloffset, out int native_offset,
  65                                                    out string file, out int line, out int column);
  66
  67                 public StackFrame ()
  68                 {
  69                         get_frame_info (2, false, out methodBase, out ilOffset,
  70                                         out nativeOffset, out fileName, out lineNumber,
  71                                         out columnNumber);
  72                 }
  73
  74                 public StackFrame (bool fNeedFileInfo)
  75                 {
  76                         get_frame_info (2, fNeedFileInfo, out methodBase, out ilOffset,
  77                                         out nativeOffset, out fileName, out lineNumber,
  78                                         out columnNumber);
  79                 }
  80
  81                 public StackFrame (int skipFrames)
  82                 {
  83                         get_frame_info (skipFrames + 2, false, out methodBase, out ilOffset,
  84                                         out nativeOffset, out fileName, out lineNumber,
  85                                         out columnNumber);
  86                 }
  87
  88                 public StackFrame (int skipFrames, bool fNeedFileInfo)
  89                 {
  90                         get_frame_info (skipFrames + 2, fNeedFileInfo, out methodBase, out ilOffset,
  91                                         out nativeOffset, out fileName, out lineNumber,
  92                                         out columnNumber);
  93                 }
  94
  95                 // LAMESPEC: According to the MSDN docs, this creates a frame with _only_
  96                 // the filename and lineNumber, but MS fills out the frame info as well.
  97                 public StackFrame (string fileName, int lineNumber)
  98                 {
  99                         get_frame_info (2, false, out methodBase, out ilOffset,
 100                                         out nativeOffset, out fileName, out lineNumber,
 101                                         out columnNumber);
 102                         this.fileName = fileName;
 103                         this.lineNumber = lineNumber;
 104                         this.columnNumber = 0;
 105                 }
 106
 107                 // LAMESPEC: According to the MSDN docs, this creates a frame with _only_
 108                 // the filename, lineNumber and colNumber, but MS fills out the frame info as well.
 109                 public StackFrame (string fileName, int lineNumber, int colNumber)
 110                 {
 111                         get_frame_info (2, false, out methodBase, out ilOffset,
 112                                         out nativeOffset, out fileName, out lineNumber,
 113                                         out columnNumber);
 114                         this.fileName = fileName;
 115                         this.lineNumber = lineNumber;
 116                         this.columnNumber = colNumber;
 117                 }
 118
 119                 public virtual int GetFileLineNumber()
 120                 {
 121                         return lineNumber;
 122                 }
 123
 124                 public virtual int GetFileColumnNumber()
 125                 {
 126                         return columnNumber;
 127                 }
 128
 129                 public virtual string GetFileName()
 130                 {
 131 #if !NET_2_1
 132                         if (SecurityManager.SecurityEnabled && (fileName != null) && (fileName.Length > 0)) {
 133                                 string fn = Path.GetFullPath (fileName);
 134                                 new FileIOPermission (FileIOPermissionAccess.PathDiscovery, fn).Demand ();
 135                         }
 136 #endif
 137                         return fileName;
 138                 }
 139
 140                 internal string GetSecureFileName ()
 141                 {
 142                         string filename = "<filename unknown>";
 143                         if (fileName == null)
 144                                 return filename;
 145                         try {
 146                                 filename = GetFileName ();
 147                         }
 148                         catch (SecurityException) {
 149                                 // CAS check failure
 150                         }
 151                         return filename;
 152                 }
 153
 154                 public virtual int GetILOffset()
 155                 {
 156                         return ilOffset;
 157                 }
 158
 159                 public virtual MethodBase GetMethod ()
 160                 {
 161                         return methodBase;
 162                 }
 163
 164                 public virtual int GetNativeOffset()
 165                 {
 166                         return nativeOffset;
 167                 }
 168
 169                 internal long GetMethodAddress ()
 170                 {
 171                         return methodAddress;
 172                 }
 173
 174                 internal string GetInternalMethodName ()
 175                 {
 176                         return internalMethodName;
 177                 }
 178
 179                 public override string ToString ()
 180                 {
 181                         StringBuilder sb = new StringBuilder ();
 182
 183                         if (methodBase == null) {
 184                                 sb.Append (Locale.GetText ("<unknown method>"));
 185                         } else {
 186                                 sb.Append (methodBase.Name);
 187                         }
 188
 189                         sb.Append (Locale.GetText (" at "));
 190
 191                         if (ilOffset == OFFSET_UNKNOWN) {
 192                                 sb.Append (Locale.GetText ("<unknown offset>"));
 193                         } else {
 194                                 sb.Append (Locale.GetText ("offset "));
 195                                 sb.Append (ilOffset);
 196                         }
 197
 198                         sb.Append (Locale.GetText (" in file:line:column "));
 199                         sb.Append (GetSecureFileName ());
 200                         sb.AppendFormat (":{0}:{1}", lineNumber, columnNumber);
 201                         return sb.ToString ();
 202                 }
 203         }
 204 }