mcs/gmcs/report.cs

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