mcs/mcs/report.cs

   1 //
   2 // report.cs: report errors and warnings.
   3 //
   4 // Author: Miguel de Icaza (miguel@ximian.com)
   5 //
   6 // (C) 2001 Ximian, Inc. (http://www.ximian.com)
   7 //
   8
   9 //
  10 // FIXME: currently our class library does not support custom number format strings
  11 //
  12 using System;
  13 using System.Text;
  14 using System.Collections;
  15 using System.Collections.Specialized;
  16 using System.Diagnostics;
  17 using System.Reflection;
  18
  19 namespace Mono.CSharp {
  20
  21         /// <summary>
  22         ///   This class is used to report errors and warnings t te user.
  23         /// </summary>
  24         public class Report {
  25                 /// <summary>
  26                 ///   Errors encountered so far
  27                 /// </summary>
  28                 static public int Errors;
  29
  30                 /// <summary>
  31                 ///   Warnings encountered so far
  32                 /// </summary>
  33                 static public int Warnings;
  34
  35                 /// <summary>
  36                 ///   Whether errors should be throw an exception
  37                 /// </summary>
  38                 static public bool Fatal;
  39
  40                 /// <summary>
  41                 ///   Whether warnings should be considered errors
  42                 /// </summary>
  43                 static public bool WarningsAreErrors;
  44
  45                 /// <summary>
  46                 ///   Whether to dump a stack trace on errors.
  47                 /// </summary>
  48                 static public bool Stacktrace;
  49
  50                 //
  51                 // If the 'expected' error code is reported then the
  52                 // compilation succeeds.
  53                 //
  54                 // Used for the test suite to excercise the error codes
  55                 //
  56                 static int expected_error = 0;
  57
  58                 //
  59                 // Keeps track of the warnings that we are ignoring
  60                 //
  61                 static Hashtable warning_ignore_table;
  62
  63                 static Hashtable warning_regions_table;
  64
  65                 /// <summary>
  66                 /// List of symbols related to reported error/warning. You have to fill it before error/warning is reported.
  67                 /// </summary>
  68                 static StringCollection related_symbols = new StringCollection ();
  69
  70                 abstract class AbstractMessage {
  71
  72                         static void Check (int code)
  73                         {
  74                                 if (code == expected_error) {
  75                                         Environment.Exit (0);
  76                                 }
  77                         }
  78
  79                         public abstract bool IsWarning { get; }
  80
  81                         public abstract string MessageType { get; }
  82
  83                         public virtual void Print (int code, string location, string text)
  84                         {
  85                                 if (code < 0)
  86                                         code = 8000-code;
  87
  88                                 StringBuilder msg = new StringBuilder ();
  89                                 if (location.Length != 0) {
  90                                         msg.Append (location);
  91                                         msg.Append (' ');
  92                                 }
  93                                 msg.AppendFormat ("{0} CS{1:0000}: {2}", MessageType, code, text);
  94                                 Console.WriteLine (msg.ToString ());
  95
  96                                 foreach (string s in related_symbols) {
  97                                         Console.WriteLine (String.Concat (s, MessageType, ')'));
  98                                 }
  99                                 related_symbols.Clear ();
 100
 101                                 if (Stacktrace)
 102                                         Console.WriteLine (FriendlyStackTrace (new StackTrace (true)));
 103
 104                                 if (Fatal) {
 105                                         if (!IsWarning || WarningsAreErrors)
 106                                                 throw new Exception (text);
 107                                 }
 108
 109                                 Check (code);
 110                         }
 111
 112                         public virtual void Print (int code, Location location, string text)
 113                         {
 114                                 if (location.Equals (Location.Null)) {
 115                                         Print (code, "", text);
 116                                         return;
 117                                 }
 118                                 Print (code, String.Format ("{0}({1})", location.Name, location.Row), text);
 119                         }
 120                 }
 121
 122                 sealed class WarningMessage: AbstractMessage {
 123                         Location loc = Location.Null;
 124                         readonly int Level;
 125
 126                         public WarningMessage ():
 127                                 this (-1) {}
 128
 129                         public WarningMessage (int level)
 130                         {
 131                                 Level = level;
 132                         }
 133
 134                         public override bool IsWarning {
 135                                 get { return true; }
 136                         }
 137
 138                         bool IsEnabled (int code)
 139                         {
 140                                 if (RootContext.WarningLevel < Level)
 141                                         return false;
 142
 143                                 if (warning_ignore_table != null) {
 144                                         if (warning_ignore_table.Contains (code)) {
 145                                                 return false;
 146                                         }
 147                                 }
 148
 149                                 if (warning_regions_table == null || loc.Equals (Location.Null))
 150                                         return true;
 151
 152                                 WarningRegions regions = (WarningRegions)warning_regions_table [loc.Name];
 153                                 return regions.IsWarningEnabled (code, loc.Row);
 154                         }
 155
 156                         public override void Print(int code, string location, string text)
 157                         {
 158                                 if (!IsEnabled (code)) {
 159                                         related_symbols.Clear ();
 160                                         return;
 161                                 }
 162
 163                                 if (WarningsAreErrors) {
 164                                         new ErrorMessage ().Print (code, location, text);
 165                                         return;
 166                                 }
 167
 168                                 Warnings++;
 169                                 base.Print (code, location, text);
 170                         }
 171
 172                         public override void Print(int code, Location location, string text)
 173                         {
 174                                 loc = location;
 175                                 base.Print (code, location, text);
 176                         }
 177
 178                         public override string MessageType {
 179                                 get {
 180                                         return "warning";
 181                                 }
 182                         }
 183                 }
 184
 185                 sealed class ErrorMessage: AbstractMessage {
 186
 187                         public override void Print(int code, string location, string text)
 188                         {
 189                                 Errors++;
 190                                 base.Print (code, location, text);
 191                         }
 192
 193                         public override bool IsWarning {
 194                                 get { return false; }
 195                         }
 196
 197                         public override string MessageType {
 198                                 get {
 199                                         return "error";
 200                                 }
 201                         }
 202
 203                 }
 204
 205                 public static void FeatureIsNotStandardized (Location loc, string feature)
 206                 {
 207                         Report.Error (1644, loc, "Feature '{0}' cannot be used because it is not part of the standardized ISO C# language specification", feature);
 208                 }
 209
 210                 public static string FriendlyStackTrace (Exception e)
 211                 {
 212                         return FriendlyStackTrace (new StackTrace (e, true));
 213                 }
 214
 215                 static string FriendlyStackTrace (StackTrace t)
 216                 {
 217                         StringBuilder sb = new StringBuilder ();
 218
 219                         bool foundUserCode = false;
 220
 221                         for (int i = 0; i < t.FrameCount; i++) {
 222                                 StackFrame f = t.GetFrame (i);
 223                                 MethodBase mb = f.GetMethod ();
 224
 225                                 if (!foundUserCode && mb.ReflectedType == typeof (Report))
 226                                         continue;
 227
 228                                 foundUserCode = true;
 229
 230                                 sb.Append ("\tin ");
 231
 232                                 if (f.GetFileLineNumber () > 0)
 233                                         sb.AppendFormat ("(at {0}:{1}) ", f.GetFileName (), f.GetFileLineNumber ());
 234
 235                                 sb.AppendFormat ("{0}.{1} (", mb.ReflectedType.Name, mb.Name);
 236
 237                                 bool first = true;
 238                                 foreach (ParameterInfo pi in mb.GetParameters ()) {
 239                                         if (!first)
 240                                                 sb.Append (", ");
 241                                         first = false;
 242
 243                                         sb.Append (TypeManager.CSharpName (pi.ParameterType));
 244                                 }
 245                                 sb.Append (")\n");
 246                         }
 247
 248                         return sb.ToString ();
 249                 }
 250
 251                 // !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 252                 // IF YOU ADD A NEW WARNING YOU HAVE TO DUPLICATE ITS ID HERE
 253                 public static bool IsValidWarning (int code)
 254                 {
 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
 257                                                                                    };
 258                         foreach (int i in all_warnings) {
 259                                 if (i == code)
 260                                         return true;
 261                         }
 262                         return false;
 263                 }
 264
 265                 static public void LocationOfPreviousError (Location loc)
 266                 {
 267                         Console.WriteLine (String.Format ("{0}({1}) (Location of symbol related to previous error)", loc.Name, loc.Row));
 268                 }
 269
 270                 static public void RuntimeMissingSupport (Location loc, string feature)
 271                 {
 272                         Report.Error (-88, loc, "Your .NET Runtime does not support '{0}'. Please use the latest Mono runtime instead.", feature);
 273                 }
 274
 275                 /// <summary>
 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.
 278                 /// </summary>
 279                 static public void SymbolRelatedToPreviousError (Location loc, string symbol)
 280                 {
 281                         SymbolRelatedToPreviousError (String.Format ("{0}({1})", loc.Name, loc.Row), symbol);
 282                 }
 283
 284                 static public void SymbolRelatedToPreviousError (MemberInfo mi)
 285                 {
 286                         TypeContainer temp_ds = TypeManager.LookupTypeContainer (mi.DeclaringType);
 287                         if (temp_ds == null) {
 288                                 SymbolRelatedToPreviousError (mi.DeclaringType.Assembly.Location, TypeManager.GetFullNameSignature (mi));
 289                         } else {
 290                                 if (mi is MethodBase) {
 291                                         IMethodData md = TypeManager.GetMethod ((MethodBase)mi);
 292                                         SymbolRelatedToPreviousError (md.Location, md.GetSignatureForError (temp_ds));
 293                                         return;
 294                                 }
 295
 296                                 string name = String.Concat (temp_ds.Name, ".", mi.Name);
 297                                 MemberCore mc = temp_ds.GetDefinition (name);
 298                                 SymbolRelatedToPreviousError (mc);
 299                         }
 300                 }
 301
 302                 static public void SymbolRelatedToPreviousError (MemberCore mc)
 303                 {
 304                         SymbolRelatedToPreviousError (mc.Location, mc.GetSignatureForError ());
 305                 }
 306
 307                 static public void SymbolRelatedToPreviousError (Type type)
 308                 {
 309                         DeclSpace temp_ds = TypeManager.LookupDeclSpace (type);
 310                         if (temp_ds == null)
 311                                 SymbolRelatedToPreviousError (type.Assembly.Location, TypeManager.CSharpName (type));
 312                         else
 313                                 SymbolRelatedToPreviousError (temp_ds.Location, TypeManager.CSharpName (type));
 314                 }
 315
 316                 static void SymbolRelatedToPreviousError (string loc, string symbol)
 317                 {
 318                         related_symbols.Add (String.Format ("{0}: '{1}' (name of symbol related to previous ", loc, symbol));
 319                 }
 320
 321                 public static WarningRegions RegisterWarningRegion (Location location)
 322                 {
 323                         if (warning_regions_table == null)
 324                                 warning_regions_table = new Hashtable ();
 325
 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);
 330                         }
 331                         return regions;
 332                 }
 333
 334                 static public void Warning (int code, int level, Location loc, string format, params object[] args)
 335                 {
 336                         WarningMessage w = new WarningMessage (level);
 337                         w.Print (code, loc, String.Format (format, args));
 338                 }
 339
 340                 static public void Warning (int code, Location loc, string format, params object[] args)
 341                 {
 342                         WarningMessage w = new WarningMessage ();
 343                         w.Print (code, loc, String.Format (format, args));
 344                 }
 345
 346                 static public void Warning (int code, string format, params object[] args)
 347                 {
 348                         Warning (code, Location.Null, String.Format (format, args));
 349                 }
 350
 351                 /// <summary>
 352                 /// Did you test your WarningLevel, that you use this method
 353                 /// </summary>
 354                 static public void Warning (int code, string text)
 355                 {
 356                         Warning (code, Location.Null, text);
 357                 }
 358
 359                 static public void Error (int code, string format, params object[] args)
 360                 {
 361                         Error (code, Location.Null, String.Format (format, args));
 362                 }
 363
 364                 static public void Error (int code, Location loc, string format, params object[] args)
 365                 {
 366                         ErrorMessage e = new ErrorMessage ();
 367                         e.Print (code, loc, String.Format (format, args));
 368                 }
 369
 370                 static public void SetIgnoreWarning (int code)
 371                 {
 372                         if (warning_ignore_table == null)
 373                                 warning_ignore_table = new Hashtable ();
 374
 375                         warning_ignore_table [code] = true;
 376                 }
 377
 378                 static public int ExpectedError {
 379                         set {
 380                                 expected_error = value;
 381                         }
 382                         get {
 383                                 return expected_error;
 384                         }
 385                 }
 386
 387                 public static int DebugFlags = 0;
 388
 389                 [Conditional ("MCS_DEBUG")]
 390                 static public void Debug (string message, params object[] args)
 391                 {
 392                         Debug (4, message, args);
 393                 }
 394
 395                 [Conditional ("MCS_DEBUG")]
 396                 static public void Debug (int category, string message, params object[] args)
 397                 {
 398                         if ((category & DebugFlags) == 0)
 399                                 return;
 400
 401                         StringBuilder sb = new StringBuilder (message);
 402
 403                         if ((args != null) && (args.Length > 0)) {
 404                                 sb.Append (": ");
 405
 406                                 bool first = true;
 407                                 foreach (object arg in args) {
 408                                         if (first)
 409                                                 first = false;
 410                                         else
 411                                                 sb.Append (", ");
 412                                         if (arg == null)
 413                                                 sb.Append ("null");
 414                                         else if (arg is ICollection)
 415                                                 sb.Append (PrintCollection ((ICollection) arg));
 416                                         else
 417                                                 sb.Append (arg);
 418                                 }
 419                         }
 420
 421                         Console.WriteLine (sb.ToString ());
 422                 }
 423
 424                 static public string PrintCollection (ICollection collection)
 425                 {
 426                         StringBuilder sb = new StringBuilder ();
 427
 428                         sb.Append (collection.GetType ());
 429                         sb.Append ("(");
 430
 431                         bool first = true;
 432                         foreach (object o in collection) {
 433                                 if (first)
 434                                         first = false;
 435                                 else
 436                                         sb.Append (", ");
 437                                 sb.Append (o);
 438                         }
 439
 440                         sb.Append (")");
 441                         return sb.ToString ();
 442                 }
 443         }
 444
 445         public enum TimerType {
 446                 FindMembers     = 0,
 447                 TcFindMembers   = 1,
 448                 MemberLookup    = 2,
 449                 CachedLookup    = 3,
 450                 CacheInit       = 4,
 451                 MiscTimer       = 5,
 452                 CountTimers     = 6
 453         }
 454
 455         public enum CounterType {
 456                 FindMembers     = 0,
 457                 MemberCache     = 1,
 458                 MiscCounter     = 2,
 459                 CountCounters   = 3
 460         }
 461
 462         public class Timer
 463         {
 464                 static DateTime[] timer_start;
 465                 static TimeSpan[] timers;
 466                 static long[] timer_counters;
 467                 static long[] counters;
 468
 469                 static Timer ()
 470                 {
 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];
 475
 476                         for (int i = 0; i < (int) TimerType.CountTimers; i++) {
 477                                 timer_start [i] = DateTime.Now;
 478                                 timers [i] = TimeSpan.Zero;
 479                         }
 480                 }
 481
 482                 [Conditional("TIMER")]
 483                 static public void IncrementCounter (CounterType which)
 484                 {
 485                         ++counters [(int) which];
 486                 }
 487
 488                 [Conditional("TIMER")]
 489                 static public void StartTimer (TimerType which)
 490                 {
 491                         timer_start [(int) which] = DateTime.Now;
 492                 }
 493
 494                 [Conditional("TIMER")]
 495                 static public void StopTimer (TimerType which)
 496                 {
 497                         timers [(int) which] += DateTime.Now - timer_start [(int) which];
 498                         ++timer_counters [(int) which];
 499                 }
 500
 501                 [Conditional("TIMER")]
 502                 static public void ShowTimers ()
 503                 {
 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");
 510
 511                         ShowCounter (CounterType.FindMembers, "- Find members");
 512                         ShowCounter (CounterType.MemberCache, "- Member cache");
 513                         ShowCounter (CounterType.MiscCounter, "- Misc counter");
 514                 }
 515
 516                 static public void ShowCounter (CounterType which, string msg)
 517                 {
 518                         Console.WriteLine ("{0} {1}", counters [(int) which], msg);
 519                 }
 520
 521                 static public void ShowTimer (TimerType which, string msg)
 522                 {
 523                         Console.WriteLine (
 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]);
 528                 }
 529         }
 530
 531         public class InternalErrorException : Exception {
 532                 public InternalErrorException ()
 533                         : base ("Internal error")
 534                 {
 535                 }
 536
 537                 public InternalErrorException (string message)
 538                         : base (message)
 539                 {
 540                 }
 541         }
 542
 543         /// <summary>
 544         /// Handles #pragma warning
 545         /// </summary>
 546         public class WarningRegions {
 547
 548                 abstract class PragmaCmd
 549                 {
 550                         public int Line;
 551
 552                         protected PragmaCmd (int line)
 553                         {
 554                                 Line = line;
 555                         }
 556
 557                         public abstract bool IsEnabled (int code, bool previous);
 558                 }
 559
 560                 class Disable: PragmaCmd
 561                 {
 562                         int code;
 563                         public Disable (int line, int code)
 564                                 : base (line)
 565                         {
 566                                 this.code = code;
 567                         }
 568
 569                         public override bool IsEnabled (int code, bool previous)
 570                         {
 571                                 return this.code == code ? false : previous;
 572                         }
 573                 }
 574
 575                 class DisableAll: PragmaCmd
 576                 {
 577                         public DisableAll (int line)
 578                                 : base (line) {}
 579
 580                         public override bool IsEnabled(int code, bool previous)
 581                         {
 582                                 return false;
 583                         }
 584                 }
 585
 586                 class Enable: PragmaCmd
 587                 {
 588                         int code;
 589                         public Enable (int line, int code)
 590                                 : base (line)
 591                         {
 592                                 this.code = code;
 593                         }
 594
 595                         public override bool IsEnabled(int code, bool previous)
 596                         {
 597                                 return this.code == code ? true : previous;
 598                         }
 599                 }
 600
 601                 class EnableAll: PragmaCmd
 602                 {
 603                         public EnableAll (int line)
 604                                 : base (line) {}
 605
 606                         public override bool IsEnabled(int code, bool previous)
 607                         {
 608                                 return true;
 609                         }
 610                 }
 611
 612
 613                 ArrayList regions = new ArrayList ();
 614
 615                 public void WarningDisable (int line)
 616                 {
 617                         regions.Add (new DisableAll (line));
 618                 }
 619
 620                 public void WarningDisable (Location location, int code)
 621                 {
 622                         if (CheckWarningCode (code, location))
 623                                 regions.Add (new Disable (location.Row, code));
 624                 }
 625
 626                 public void WarningEnable (int line)
 627                 {
 628                         regions.Add (new EnableAll (line));
 629                 }
 630
 631                 public void WarningEnable (Location location, int code)
 632                 {
 633                         if (CheckWarningCode (code, location))
 634                                 regions.Add (new Enable (location.Row, code));
 635                 }
 636
 637                 public bool IsWarningEnabled (int code, int src_line)
 638                 {
 639                         bool result = true;
 640                         foreach (PragmaCmd pragma in regions) {
 641                                 if (src_line < pragma.Line)
 642                                         break;
 643
 644                                 result = pragma.IsEnabled (code, result);
 645                         }
 646                         return result;
 647                 }
 648
 649                 bool CheckWarningCode (int code, Location loc)
 650                 {
 651                         if (Report.IsValidWarning (code))
 652                                 return true;
 653
 654                         Report.Warning (1691, 1, loc, "'{0}' is not a valid warning number", code);
 655                         return false;
 656                 }
 657         }
 658 }