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