2 // report.cs: report errors and warnings.
4 // Author: Miguel de Icaza (miguel@ximian.com)
6 // (C) 2001 Ximian, Inc. (http://www.ximian.com)
10 // FIXME: currently our class library does not support custom number format strings
14 using System.Collections;
15 using System.Collections.Specialized;
16 using System.Diagnostics;
17 using System.Reflection;
19 namespace Mono.CSharp {
22 /// This class is used to report errors and warnings t te user.
26 /// Errors encountered so far
28 static public int Errors;
31 /// Warnings encountered so far
33 static public int Warnings;
36 /// Whether errors should be throw an exception
38 static public bool Fatal;
41 /// Whether warnings should be considered errors
43 static public bool WarningsAreErrors;
46 /// Whether to dump a stack trace on errors.
48 static public bool Stacktrace;
51 // If the 'expected' error code is reported then the
52 // compilation succeeds.
54 // Used for the test suite to excercise the error codes
56 static int expected_error = 0;
59 // Keeps track of the warnings that we are ignoring
61 static Hashtable warning_ignore_table;
63 static Hashtable warning_regions_table;
66 /// List of symbols related to reported error/warning. You have to fill it before error/warning is reported.
68 static StringCollection related_symbols = new StringCollection ();
70 abstract class AbstractMessage {
72 static void Check (int code)
74 if (code == expected_error) {
79 public abstract bool IsWarning { get; }
81 public abstract string MessageType { get; }
83 public virtual void Print (int code, string location, string text)
88 StringBuilder msg = new StringBuilder ();
89 if (location.Length != 0) {
90 msg.Append (location);
93 msg.AppendFormat ("{0} CS{1:0000}: {2}", MessageType, code, text);
94 Console.WriteLine (msg.ToString ());
96 foreach (string s in related_symbols) {
97 Console.WriteLine (String.Concat (s, MessageType, ')'));
99 related_symbols.Clear ();
102 Console.WriteLine (FriendlyStackTrace (new StackTrace (true)));
105 if (!IsWarning || WarningsAreErrors)
106 throw new Exception (text);
112 public virtual void Print (int code, Location location, string text)
114 if (location.Equals (Location.Null)) {
115 Print (code, "", text);
118 Print (code, String.Format ("{0}({1})", location.Name, location.Row), text);
122 sealed class WarningMessage: AbstractMessage {
123 Location loc = Location.Null;
126 public WarningMessage ():
129 public WarningMessage (int level)
134 public override bool IsWarning {
138 bool IsEnabled (int code)
140 if (RootContext.WarningLevel < Level)
143 if (warning_ignore_table != null) {
144 if (warning_ignore_table.Contains (code)) {
149 if (warning_regions_table == null || loc.Equals (Location.Null))
152 WarningRegions regions = (WarningRegions)warning_regions_table [loc.Name];
153 return regions.IsWarningEnabled (code, loc.Row);
156 public override void Print(int code, string location, string text)
158 if (!IsEnabled (code)) {
159 related_symbols.Clear ();
163 if (WarningsAreErrors) {
164 new ErrorMessage ().Print (code, location, text);
169 base.Print (code, location, text);
172 public override void Print(int code, Location location, string text)
175 base.Print (code, location, text);
178 public override string MessageType {
185 sealed class ErrorMessage: AbstractMessage {
187 public override void Print(int code, string location, string text)
190 base.Print (code, location, text);
193 public override bool IsWarning {
194 get { return false; }
197 public override string MessageType {
205 public static void FeatureIsNotStandardized (Location loc, string feature)
207 Report.Error (1644, loc, "Feature '{0}' cannot be used because it is not part of the standardized ISO C# language specification", feature);
210 public static string FriendlyStackTrace (Exception e)
212 return FriendlyStackTrace (new StackTrace (e, true));
215 static string FriendlyStackTrace (StackTrace t)
217 StringBuilder sb = new StringBuilder ();
219 bool foundUserCode = false;
221 for (int i = 0; i < t.FrameCount; i++) {
222 StackFrame f = t.GetFrame (i);
223 MethodBase mb = f.GetMethod ();
225 if (!foundUserCode && mb.ReflectedType == typeof (Report))
228 foundUserCode = true;
232 if (f.GetFileLineNumber () > 0)
233 sb.AppendFormat ("(at {0}:{1}) ", f.GetFileName (), f.GetFileLineNumber ());
235 sb.AppendFormat ("{0}.{1} (", mb.ReflectedType.Name, mb.Name);
238 foreach (ParameterInfo pi in mb.GetParameters ()) {
243 sb.Append (TypeManager.CSharpName (pi.ParameterType));
248 return sb.ToString ();
251 // !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
252 // IF YOU ADD A NEW WARNING YOU HAVE TO DUPLICATE ITS ID HERE
253 public static bool IsValidWarning (int code)
255 int[] all_warnings = new int[] { 28, 67, 78, 105, 108, 109, 114, 192, 168, 169, 183, 184, 219, 251, 612, 618, 626, 628, 642, 649,
256 659, 660, 661, 672, 1030, 1522, 1616, 1691, 1692, 1901, 2002, 2023, 3012, 3019, 8024, 8028
258 foreach (int i in all_warnings) {
265 static public void LocationOfPreviousError (Location loc)
267 Console.WriteLine (String.Format ("{0}({1}) (Location of symbol related to previous error)", loc.Name, loc.Row));
270 static public void RuntimeMissingSupport (string feature)
272 Report.Error (-88, "Your .NET Runtime does not support '{0}'. Please use the latest Mono runtime instead.", feature);
276 /// In most error cases is very useful to have information about symbol that caused the error.
277 /// Call this method before you call Report.Error when it makes sense.
279 static public void SymbolRelatedToPreviousError (Location loc, string symbol)
281 SymbolRelatedToPreviousError (String.Format ("{0}({1})", loc.Name, loc.Row), symbol);
284 static public void SymbolRelatedToPreviousError (MemberInfo mi)
286 TypeContainer temp_ds = TypeManager.LookupTypeContainer (mi.DeclaringType);
287 if (temp_ds == null) {
288 SymbolRelatedToPreviousError (mi.DeclaringType.Assembly.Location, TypeManager.GetFullNameSignature (mi));
290 if (mi is MethodBase) {
291 IMethodData md = TypeManager.GetMethod ((MethodBase)mi);
292 SymbolRelatedToPreviousError (md.Location, md.GetSignatureForError (temp_ds));
296 string name = String.Concat (temp_ds.Name, ".", mi.Name);
297 MemberCore mc = temp_ds.GetDefinition (name);
298 SymbolRelatedToPreviousError (mc);
302 static public void SymbolRelatedToPreviousError (MemberCore mc)
304 SymbolRelatedToPreviousError (mc.Location, mc.GetSignatureForError ());
307 static public void SymbolRelatedToPreviousError (Type type)
309 DeclSpace temp_ds = TypeManager.LookupDeclSpace (type);
311 SymbolRelatedToPreviousError (type.Assembly.Location, TypeManager.CSharpName (type));
313 SymbolRelatedToPreviousError (temp_ds.Location, TypeManager.CSharpName (type));
316 static void SymbolRelatedToPreviousError (string loc, string symbol)
318 related_symbols.Add (String.Format ("{0}: '{1}' (name of symbol related to previous ", loc, symbol));
321 public static WarningRegions RegisterWarningRegion (Location location)
323 if (warning_regions_table == null)
324 warning_regions_table = new Hashtable ();
326 WarningRegions regions = (WarningRegions)warning_regions_table [location.Name];
327 if (regions == null) {
328 regions = new WarningRegions ();
329 warning_regions_table.Add (location.Name, regions);
334 static public void Warning (int code, int level, Location loc, string format, params object[] args)
336 WarningMessage w = new WarningMessage (level);
337 w.Print (code, loc, String.Format (format, args));
340 static public void Warning (int code, Location loc, string format, params object[] args)
342 WarningMessage w = new WarningMessage ();
343 w.Print (code, loc, String.Format (format, args));
346 static public void Warning (int code, string format, params object[] args)
348 Warning (code, Location.Null, String.Format (format, args));
352 /// Did you test your WarningLevel, that you use this method
354 static public void Warning (int code, string text)
356 Warning (code, Location.Null, text);
359 static public void Error (int code, string format, params object[] args)
361 Error (code, Location.Null, String.Format (format, args));
364 static public void Error (int code, Location loc, string format, params object[] args)
366 ErrorMessage e = new ErrorMessage ();
367 e.Print (code, loc, String.Format (format, args));
370 static public void SetIgnoreWarning (int code)
372 if (warning_ignore_table == null)
373 warning_ignore_table = new Hashtable ();
375 warning_ignore_table [code] = true;
378 static public int ExpectedError {
380 expected_error = value;
383 return expected_error;
387 public static int DebugFlags = 0;
389 [Conditional ("MCS_DEBUG")]
390 static public void Debug (string message, params object[] args)
392 Debug (4, message, args);
395 [Conditional ("MCS_DEBUG")]
396 static public void Debug (int category, string message, params object[] args)
398 if ((category & DebugFlags) == 0)
401 StringBuilder sb = new StringBuilder (message);
403 if ((args != null) && (args.Length > 0)) {
407 foreach (object arg in args) {
414 else if (arg is ICollection)
415 sb.Append (PrintCollection ((ICollection) arg));
421 Console.WriteLine (sb.ToString ());
424 static public string PrintCollection (ICollection collection)
426 StringBuilder sb = new StringBuilder ();
428 sb.Append (collection.GetType ());
432 foreach (object o in collection) {
441 return sb.ToString ();
445 public enum TimerType {
455 public enum CounterType {
464 static DateTime[] timer_start;
465 static TimeSpan[] timers;
466 static long[] timer_counters;
467 static long[] counters;
471 timer_start = new DateTime [(int) TimerType.CountTimers];
472 timers = new TimeSpan [(int) TimerType.CountTimers];
473 timer_counters = new long [(int) TimerType.CountTimers];
474 counters = new long [(int) CounterType.CountCounters];
476 for (int i = 0; i < (int) TimerType.CountTimers; i++) {
477 timer_start [i] = DateTime.Now;
478 timers [i] = TimeSpan.Zero;
482 [Conditional("TIMER")]
483 static public void IncrementCounter (CounterType which)
485 ++counters [(int) which];
488 [Conditional("TIMER")]
489 static public void StartTimer (TimerType which)
491 timer_start [(int) which] = DateTime.Now;
494 [Conditional("TIMER")]
495 static public void StopTimer (TimerType which)
497 timers [(int) which] += DateTime.Now - timer_start [(int) which];
498 ++timer_counters [(int) which];
501 [Conditional("TIMER")]
502 static public void ShowTimers ()
504 ShowTimer (TimerType.FindMembers, "- FindMembers timer");
505 ShowTimer (TimerType.TcFindMembers, "- TypeContainer.FindMembers timer");
506 ShowTimer (TimerType.MemberLookup, "- MemberLookup timer");
507 ShowTimer (TimerType.CachedLookup, "- CachedLookup timer");
508 ShowTimer (TimerType.CacheInit, "- Cache init");
509 ShowTimer (TimerType.MiscTimer, "- Misc timer");
511 ShowCounter (CounterType.FindMembers, "- Find members");
512 ShowCounter (CounterType.MemberCache, "- Member cache");
513 ShowCounter (CounterType.MiscCounter, "- Misc counter");
516 static public void ShowCounter (CounterType which, string msg)
518 Console.WriteLine ("{0} {1}", counters [(int) which], msg);
521 static public void ShowTimer (TimerType which, string msg)
524 "[{0:00}:{1:000}] {2} (used {3} times)",
525 (int) timers [(int) which].TotalSeconds,
526 timers [(int) which].Milliseconds, msg,
527 timer_counters [(int) which]);
531 public class InternalErrorException : Exception {
532 public InternalErrorException ()
533 : base ("Internal error")
537 public InternalErrorException (string message)
544 /// Handles #pragma warning
546 public class WarningRegions {
548 abstract class PragmaCmd
552 protected PragmaCmd (int line)
557 public abstract bool IsEnabled (int code, bool previous);
560 class Disable: PragmaCmd
563 public Disable (int line, int code)
569 public override bool IsEnabled (int code, bool previous)
571 return this.code == code ? false : previous;
575 class DisableAll: PragmaCmd
577 public DisableAll (int line)
580 public override bool IsEnabled(int code, bool previous)
586 class Enable: PragmaCmd
589 public Enable (int line, int code)
595 public override bool IsEnabled(int code, bool previous)
597 return this.code == code ? true : previous;
601 class EnableAll: PragmaCmd
603 public EnableAll (int line)
606 public override bool IsEnabled(int code, bool previous)
613 ArrayList regions = new ArrayList ();
615 public void WarningDisable (int line)
617 regions.Add (new DisableAll (line));
620 public void WarningDisable (Location location, int code)
622 if (CheckWarningCode (code, location))
623 regions.Add (new Disable (location.Row, code));
626 public void WarningEnable (int line)
628 regions.Add (new EnableAll (line));
631 public void WarningEnable (Location location, int code)
633 if (CheckWarningCode (code, location))
634 regions.Add (new Enable (location.Row, code));
637 public bool IsWarningEnabled (int code, int src_line)
640 foreach (PragmaCmd pragma in regions) {
641 if (src_line < pragma.Line)
644 result = pragma.IsEnabled (code, result);
649 bool CheckWarningCode (int code, Location loc)
651 if (Report.IsValidWarning (code))
654 Report.Warning (1691, 1, loc, "'{0}' is not a valid warning number", code);