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 uint methodIndex;
  54                 private MethodBase methodBase;
  55                 private string fileName;
  56                 private int lineNumber;
  57                 private int columnNumber;
  58         #pragma warning disable 649
  59                 private string internalMethodName;
  60                 #pragma warning restore 649
  61                 #endregion
  62
  63                 [MethodImplAttribute(MethodImplOptions.InternalCall)]
  64                 extern static bool get_frame_info (int skip, bool needFileInfo, out MethodBase method,
  65                                                    out int iloffset, out int native_offset,
  66                                                    out string file, out int line, out int column);
  67
  68                 public StackFrame ()
  69                 {
  70                         get_frame_info (2, false, out methodBase, out ilOffset,
  71                                         out nativeOffset, out fileName, out lineNumber,
  72                                         out columnNumber);
  73                 }
  74
  75                 public StackFrame (bool fNeedFileInfo)
  76                 {
  77                         get_frame_info (2, fNeedFileInfo, out methodBase, out ilOffset,
  78                                         out nativeOffset, out fileName, out lineNumber,
  79                                         out columnNumber);
  80                 }
  81
  82                 public StackFrame (int skipFrames)
  83                 {
  84                         get_frame_info (skipFrames + 2, false, out methodBase, out ilOffset,
  85                                         out nativeOffset, out fileName, out lineNumber,
  86                                         out columnNumber);
  87                 }
  88
  89                 public StackFrame (int skipFrames, bool fNeedFileInfo)
  90                 {
  91                         get_frame_info (skipFrames + 2, fNeedFileInfo, out methodBase, out ilOffset,
  92                                         out nativeOffset, out fileName, out lineNumber,
  93                                         out columnNumber);
  94                 }
  95
  96                 // LAMESPEC: According to the MSDN docs, this creates a frame with _only_
  97                 // the filename and lineNumber, but MS fills out the frame info as well.
  98                 public StackFrame (string fileName, int lineNumber)
  99                 {
 100                         get_frame_info (2, false, out methodBase, out ilOffset,
 101                                         out nativeOffset, out fileName, out lineNumber,
 102                                         out columnNumber);
 103                         this.fileName = fileName;
 104                         this.lineNumber = lineNumber;
 105                         this.columnNumber = 0;
 106                 }
 107
 108                 // LAMESPEC: According to the MSDN docs, this creates a frame with _only_
 109                 // the filename, lineNumber and colNumber, but MS fills out the frame info as well.
 110                 public StackFrame (string fileName, int lineNumber, int colNumber)
 111                 {
 112                         get_frame_info (2, false, out methodBase, out ilOffset,
 113                                         out nativeOffset, out fileName, out lineNumber,
 114                                         out columnNumber);
 115                         this.fileName = fileName;
 116                         this.lineNumber = lineNumber;
 117                         this.columnNumber = colNumber;
 118                 }
 119
 120                 public virtual int GetFileLineNumber()
 121                 {
 122                         return lineNumber;
 123                 }
 124
 125                 public virtual int GetFileColumnNumber()
 126                 {
 127                         return columnNumber;
 128                 }
 129
 130                 public virtual string GetFileName()
 131                 {
 132 #if !NET_2_1
 133                         if (SecurityManager.SecurityEnabled && (fileName != null) && (fileName.Length > 0)) {
 134                                 string fn = Path.GetFullPath (fileName);
 135                                 new FileIOPermission (FileIOPermissionAccess.PathDiscovery, fn).Demand ();
 136                         }
 137 #endif
 138                         return fileName;
 139                 }
 140
 141                 internal string GetSecureFileName ()
 142                 {
 143                         string filename = "<filename unknown>";
 144                         if (fileName == null)
 145                                 return filename;
 146                         try {
 147                                 filename = GetFileName ();
 148                         }
 149                         catch (SecurityException) {
 150                                 // CAS check failure
 151                         }
 152                         return filename;
 153                 }
 154
 155                 public virtual int GetILOffset()
 156                 {
 157                         return ilOffset;
 158                 }
 159
 160                 public virtual MethodBase GetMethod ()
 161                 {
 162                         return methodBase;
 163                 }
 164
 165                 public virtual int GetNativeOffset()
 166                 {
 167                         return nativeOffset;
 168                 }
 169
 170                 internal long GetMethodAddress ()
 171                 {
 172                         return methodAddress;
 173                 }
 174
 175                 internal uint GetMethodIndex ()
 176                 {
 177                         return methodIndex;
 178                 }
 179
 180                 internal string GetInternalMethodName ()
 181                 {
 182                         return internalMethodName;
 183                 }
 184
 185                 public override string ToString ()
 186                 {
 187                         StringBuilder sb = new StringBuilder ();
 188
 189                         if (methodBase == null) {
 190                                 sb.Append (Locale.GetText ("<unknown method>"));
 191                         } else {
 192                                 sb.Append (methodBase.Name);
 193                         }
 194
 195                         sb.Append (Locale.GetText (" at "));
 196
 197                         if (ilOffset == OFFSET_UNKNOWN) {
 198                                 sb.Append (Locale.GetText ("<unknown offset>"));
 199                         } else {
 200                                 sb.Append (Locale.GetText ("offset "));
 201                                 sb.Append (ilOffset);
 202                         }
 203
 204                         sb.Append (Locale.GetText (" in file:line:column "));
 205                         sb.Append (GetSecureFileName ());
 206                         sb.AppendFormat (":{0}:{1}", lineNumber, columnNumber);
 207                         return sb.ToString ();
 208                 }
 209         }
 210 }