5 // Miguel de Icaza (miguel@ximian.com)
8 // (C) Ximian, Inc. http://www.ximian.com
9 // Copyright (C) 2004-2005 Novell, Inc (http://www.novell.com)
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:
19 // The above copyright notice and this permission notice shall be
20 // included in all copies or substantial portions of the Software.
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.
31 using System.Collections;
32 using System.Collections.Generic;
33 using System.Diagnostics;
34 using System.Reflection;
36 using System.Runtime.InteropServices;
37 using System.Runtime.CompilerServices;
38 using System.Runtime.Serialization;
39 using System.Security.Permissions;
45 [ComDefaultInterface (typeof (_Exception))]
46 [ClassInterface (ClassInterfaceType.None)]
47 [StructLayout (LayoutKind.Sequential)]
49 public class Exception : ISerializable
51 public class Exception : ISerializable, _Exception
54 #pragma warning disable 169, 649
55 #region Sync with object-internals.h
56 /* Stores the IPs and the generic sharing infos
57 (vtable/MRGCTX) of the frames. */
59 Exception inner_exception;
60 internal string message;
64 // formerly known as remote_stack_trace (see #425512):
65 string _remoteStackTraceString;
66 int remote_stack_index;
67 internal int hresult = -2146233088;
70 StackTrace[] captured_traces;
71 IntPtr[] native_trace_ips;
73 #pragma warning restore 169, 649
75 /* Don't add fields here, the runtime depends on the layout of subclasses */
81 public Exception (string message)
83 this.message = message;
86 protected Exception (SerializationInfo info, StreamingContext context)
89 throw new ArgumentNullException ("info");
91 class_name = info.GetString ("ClassName");
92 message = info.GetString ("Message");
93 help_link = info.GetString ("HelpURL");
94 stack_trace = info.GetString ("StackTraceString");
95 _remoteStackTraceString = info.GetString ("RemoteStackTraceString");
96 remote_stack_index = info.GetInt32 ("RemoteStackIndex");
97 hresult = info.GetInt32 ("HResult");
98 source = info.GetString ("Source");
99 inner_exception = (Exception) info.GetValue ("InnerException", typeof (Exception));
102 _data = (IDictionary) info.GetValue ("Data", typeof (IDictionary));
103 } catch (SerializationException) {
104 // member did not exist in .NET 1.x
108 public Exception (string message, Exception innerException)
110 inner_exception = innerException;
111 this.message = message;
114 public Exception InnerException {
115 get { return inner_exception; }
118 public virtual string HelpLink {
119 get { return help_link; }
120 set { help_link = value; }
124 get { return hresult; }
125 protected set { hresult = value; }
128 internal void SetErrorCode(int hr)
133 internal void SetMessage (string s)
138 internal void SetStackTrace (string s)
145 if (class_name == null)
146 class_name = GetType ().ToString ();
151 public virtual string Message {
154 message = string.Format (Locale.GetText ("Exception of type '{0}' was thrown."),
162 protected event EventHandler<SafeSerializationEventArgs> SerializeObjectState {
169 public virtual string Source {
171 if (source == null) {
172 StackTrace st = new StackTrace (this, true);
173 if (st.FrameCount > 0) {
174 StackFrame sf = st.GetFrame (0);
176 MethodBase method = sf.GetMethod ();
177 if (method != null) {
178 source = method.DeclaringType.Assembly.UnprotectedGetName ().Name;
184 // source can be null
193 bool AddFrames (StringBuilder sb, string newline, string unknown, StackTrace st)
196 for (i = 0; i < st.FrameCount; i++) {
197 StackFrame frame = st.GetFrame (i);
199 sb.AppendFormat (" {0} ", Locale.GetText ("at"));
203 if (frame.GetMethod () == null) {
204 string internal_name = frame.GetInternalMethodName ();
205 if (internal_name != null)
206 sb.Append (internal_name);
208 sb.AppendFormat ("<0x{0:x5} + 0x{1:x5}> {2}", frame.GetMethodAddress (), frame.GetNativeOffset (), unknown);
210 GetFullNameForStackTrace (sb, frame.GetMethod ());
212 if (frame.GetILOffset () == -1)
213 sb.AppendFormat ("<0x{0:x5} + 0x{1:x5}> ", frame.GetMethodAddress (), frame.GetNativeOffset ());
215 sb.AppendFormat (" [0x{0:x5}] ", frame.GetILOffset ());
217 sb.AppendFormat ("in {0}:{1} ", frame.GetSecureFileName (),
218 frame.GetFileLineNumber ());
225 public virtual string StackTrace {
227 if (stack_trace != null)
230 if (trace_ips == null)
234 StringBuilder sb = new StringBuilder ();
236 string newline = String.Format ("{0} {1} ", Environment.NewLine, Locale.GetText ("at"));
237 string unknown = Locale.GetText ("<unknown method>");
239 // Add traces captured using ExceptionDispatchInfo
240 if (captured_traces != null) {
241 foreach (var t in captured_traces) {
242 if (!AddFrames (sb, newline, unknown, t))
245 sb.Append (Environment.NewLine);
246 sb.Append ("--- End of stack trace from previous location where exception was thrown ---");
247 sb.Append (Environment.NewLine);
251 StackTrace st = new StackTrace (this, 0, true, true);
252 AddFrames (sb, newline, unknown, st);
254 stack_trace = sb.ToString ();
260 public MethodBase TargetSite {
262 StackTrace st = new StackTrace (this, true);
263 if (st.FrameCount > 0)
264 return st.GetFrame (0).GetMethod ();
270 public virtual IDictionary Data {
273 // default to empty dictionary
274 _data = new Dictionary<object, object> ();
280 public virtual Exception GetBaseException ()
282 Exception inner = inner_exception;
284 while (inner != null)
286 if (inner.InnerException != null)
287 inner = inner.InnerException;
295 [SecurityPermission (SecurityAction.LinkDemand, SerializationFormatter = true)]
296 public virtual void GetObjectData (SerializationInfo info, StreamingContext context)
299 throw new ArgumentNullException ("info");
301 info.AddValue ("ClassName", ClassName);
302 info.AddValue ("Message", message);
303 info.AddValue ("InnerException", inner_exception);
304 info.AddValue ("HelpURL", help_link);
305 info.AddValue ("StackTraceString", StackTrace);
306 info.AddValue ("RemoteStackTraceString", _remoteStackTraceString);
307 info.AddValue ("RemoteStackIndex", remote_stack_index);
308 info.AddValue ("HResult", hresult);
309 info.AddValue ("Source", Source);
310 info.AddValue ("ExceptionMethod", null);
311 info.AddValue ("Data", _data, typeof (IDictionary));
314 public override string ToString ()
316 System.Text.StringBuilder result = new System.Text.StringBuilder (ClassName);
317 result.Append (": ").Append (Message);
319 if (null != _remoteStackTraceString)
320 result.Append (_remoteStackTraceString);
322 if (inner_exception != null)
324 result.Append (" ---> ").Append (inner_exception.ToString ());
325 result.Append (Environment.NewLine);
326 result.Append (Locale.GetText (" --- End of inner exception stack trace ---"));
329 if (StackTrace != null)
330 result.Append (Environment.NewLine).Append (StackTrace);
331 return result.ToString();
334 internal Exception FixRemotingException ()
336 string message = (0 == remote_stack_index) ?
337 Locale.GetText ("{0}{0}Server stack trace: {0}{1}{0}{0}Exception rethrown at [{2}]: {0}") :
338 Locale.GetText ("{1}{0}{0}Exception rethrown at [{2}]: {0}");
339 string tmp = String.Format (message, Environment.NewLine, StackTrace, remote_stack_index);
341 _remoteStackTraceString = tmp;
342 remote_stack_index++;
349 internal void GetFullNameForStackTrace (StringBuilder sb, MethodBase mi)
351 ParameterInfo[] p = mi.GetParametersInternal ();
352 sb.Append (mi.DeclaringType.ToString ());
356 if (mi.IsGenericMethod) {
357 Type[] gen_params = mi.GetGenericArguments ();
359 for (int j = 0; j < gen_params.Length; j++) {
362 sb.Append (gen_params [j].Name);
368 for (int i = 0; i < p.Length; ++i) {
371 Type pt = p[i].ParameterType;
372 if (pt.IsClass && !String.IsNullOrEmpty (pt.Namespace)) {
373 sb.Append (pt.Namespace);
377 if (p [i].Name != null) {
379 sb.Append (p [i].Name);
385 // For ExceptionDispatchInfo
386 internal void CaptureTrace ()
388 if (captured_traces != null) {
389 Array.Resize (ref captured_traces, captured_traces.Length + 1);
391 captured_traces = new StackTrace [1];
393 captured_traces [captured_traces.Length - 1] = new StackTrace (this, 0, true, true);
399 // The documentation states that this is available in 1.x,
400 // but it was not available (MemberRefing this would fail)
401 // and it states the signature is `override sealed', but the
402 // correct value is `newslot'
404 public new Type GetType ()
406 return base.GetType ();