Fixme fixme fixme.
[mono.git] / mcs / gmcs / report.cs
index f5c90e4b4ddea74a2cd0099fde22a25e14d74ecd..b07fe6aea0ffa0f709ba3957d153ffc623321cbd 100644 (file)
@@ -12,7 +12,9 @@
 using System;
 using System.Text;
 using System.Collections;
+using System.Collections.Specialized;
 using System.Diagnostics;
+using System.Reflection;
 
 namespace Mono.CSharp {
 
@@ -57,6 +59,94 @@ namespace Mono.CSharp {
                // Keeps track of the warnings that we are ignoring
                //
                static Hashtable warning_ignore_table;
+
+               /// <summary>
+               /// List of symbols related to reported error/warning. You have to fill it before error/warning is reported.
+               /// </summary>
+               static StringCollection related_symbols = new StringCollection ();
+               
+               struct WarningData {
+                       public WarningData (int level, string text) {
+                               Level = level;
+                               Message = text;
+                       }
+
+                       public bool IsEnabled ()
+                       {
+                               return RootContext.WarningLevel >= Level;
+                       }
+
+                       public string Format (params object[] args)
+                       {
+                               return String.Format (Message, args);
+                       }
+
+                       readonly string Message;
+                       readonly int Level;
+               }
+
+               static string GetErrorMsg (int error_no)
+               {
+                       switch (error_no) {
+                               case 0122: return "'{0}' is inaccessible due to its protection level";
+                               case 0134: return "Cannot use qualified namespace names in nested namespace declarations";
+                               case 0145: return "A const field requires a value to be provided";
+                               case 0160: return "A previous catch clause already catches all exceptions of this or a super type '{0}'";
+                               case 0210: return "You must provide an initializer in a fixed or using statement declaration";
+                               case 0243: return "Conditional not valid on '{0}' because it is an override method";
+                               case 0247: return "Cannot use a negative size with stackalloc";
+                               case 0415: return "The 'IndexerName' attribute is valid only on an indexer that is not an explicit interface member declaration";
+                               case 0553: return "'{0}' : user defined conversion to/from base class";
+                               case 0554: return "'{0}' : user defined conversion to/from derived class";
+                               case 0577: return "Conditional not valid on '{0}' because it is a destructor, operator, or explicit interface implementation";
+                               case 0578: return "Conditional not valid on '{0}' because its return type is not void";
+                               case 0582: return "Conditional not valid on interface members";
+                               case 0592: return "Attribute '{0}' is not valid on this declaration type. It is valid on {1} declarations only.";
+                               case 0601: return "The DllImport attribute must be specified on a method marked `static' and `extern'";
+                               case 0609: return "Cannot set the 'IndexerName' attribute on an indexer marked override";
+                               case 0610: return "Field or property cannot be of type '{0}'";
+                               case 0619: return "'{0}' is obsolete: '{1}'";
+                               case 0626: return "Method, operator, or accessor '{0}' is marked external and has no attributes on it. Consider adding a DllImport attribute to specify the external implementation";
+                               case 0629: return "Conditional member '{0}' cannot implement interface member";
+                               case 0633: return "The argument to the 'IndexerName' attribute must be a valid identifier";
+                               case 0657: return "'{0}' is not a valid attribute location for this declaration. Valid attribute locations for this declaration are '{1}'";
+                               case 1555: return "Could not find '{0}' specified for Main method";
+                               case 1556: return "'{0}' specified for Main method must be a valid class or struct";                                    
+                               case 1618: return "Cannot create delegate with '{0}' because it has a Conditional attribute";
+                               case 1667: return "'{0}' is not valid on property or event accessors. It is valid on '{1}' declarations only";
+                               case 1669: return "__arglist is not valid in this context";                                    
+                               case 3000: return "Methods with variable arguments are not CLS-compliant";
+                               case 3001: return "Argument type '{0}' is not CLS-compliant";
+                               case 3002: return "Return type of '{0}' is not CLS-compliant";
+                               case 3003: return "Type of '{0}' is not CLS-compliant";
+                               case 3005: return "Identifier '{0}' differing only in case is not CLS-compliant";
+                               case 3006: return "Overloaded method '{0}' differing only in ref or out, or in array rank, is not CLS-compliant";
+                               case 3008: return "Identifier '{0}' is not CLS-compliant";
+                               case 3009: return "'{0}': base type '{1}' is not CLS-compliant";
+                               case 3010: return "'{0}': CLS-compliant interfaces must have only CLS-compliant members";
+                               case 3011: return "'{0}': only CLS-compliant members can be abstract";
+                               case 3013: return "Added modules must be marked with the CLSCompliant attribute to match the assembly";
+                               case 3014: return "'{0}' cannot be marked as CLS-compliant because the assembly does not have a CLSCompliant attribute";
+                               case 3015: return "'{0}' has no accessible constructors which use only CLS-compliant types";
+                               case 3016: return "Arrays as attribute arguments are not CLS-compliant";
+                       }
+                       throw new InternalErrorException (String.Format ("Missing error '{0}' text", error_no));
+               }
+
+               static WarningData GetWarningMsg (int warn_no)
+               {
+                       switch (warn_no) {
+                               case -24: return new WarningData (1, "The Microsoft Runtime cannot set this marshal info. Please use the Mono runtime instead.");
+                               case -28: return new WarningData (1, "The Microsoft .NET Runtime 1.x does not permit setting custom attributes on the return type");
+                               case 0612: return new WarningData (1, "'{0}' is obsolete");
+                               case 0618: return new WarningData (2, "'{0}' is obsolete: '{1}'");
+                               case 0672: return new WarningData (1, "Member '{0}' overrides obsolete member. Add the Obsolete attribute to '{0}'");
+                               case 3012: return new WarningData (1, "You must specify the CLSCompliant attribute on the assembly, not the module, to enable CLS compliance checking");
+                               case 3019: return new WarningData (2, "CLS compliance checking will not be performed on '{0}' because it is private or internal");
+                       }
+
+                       throw new InternalErrorException (String.Format ("Wrong warning number '{0}'", warn_no));
+               }
                
                static void Check (int code)
                {
@@ -68,17 +158,136 @@ namespace Mono.CSharp {
                        }
                }
                
+               public static string FriendlyStackTrace (Exception e)
+               {
+                       return FriendlyStackTrace (new StackTrace (e, true));
+               }
+               
+               static string FriendlyStackTrace (StackTrace t)
+               {               
+                       StringBuilder sb = new StringBuilder ();
+                       
+                       bool foundUserCode = false;
+                       
+                       for (int i = 0; i < t.FrameCount; i++) {
+                               StackFrame f = t.GetFrame (i);
+                               MethodBase mb = f.GetMethod ();
+                               
+                               if (!foundUserCode && mb.ReflectedType == typeof (Report))
+                                       continue;
+                               
+                               foundUserCode = true;
+                               
+                               sb.Append ("\tin ");
+                               
+                               if (f.GetFileLineNumber () > 0)
+                                       sb.AppendFormat ("(at {0}:{1}) ", f.GetFileName (), f.GetFileLineNumber ());
+                               
+                               sb.AppendFormat ("{0}.{1} (", mb.ReflectedType.Name, mb.Name);
+                               
+                               bool first = true;
+                               foreach (ParameterInfo pi in mb.GetParameters ()) {
+                                       if (!first)
+                                               sb.Append (", ");
+                                       first = false;
+                                       
+                                       sb.Append (TypeManager.CSharpName (pi.ParameterType));
+                               }
+                               sb.Append (")\n");
+                       }
+       
+                       return sb.ToString ();
+               }
+               
+               static public void LocationOfPreviousError (Location loc)
+               {
+                       Console.WriteLine (String.Format ("{0}({1}) (Location of symbol related to previous error)", loc.Name, loc.Row));
+               }                
+
+               /// <summary>
+                /// In most error cases is very useful to have information about symbol that caused the error.
+                /// Call this method before you call Report.Error when it makes sense.
+               /// </summary>
+               static public void SymbolRelatedToPreviousError (Location loc, string symbol)
+               {
+                       SymbolRelatedToPreviousError (String.Format ("{0}({1})", loc.Name, loc.Row), symbol);
+               }
+
+               static public void SymbolRelatedToPreviousError (MemberInfo mi)
+               {
+                       DeclSpace temp_ds = TypeManager.LookupDeclSpace (mi.DeclaringType);
+                       if (temp_ds == null) {
+                               SymbolRelatedToPreviousError (mi.DeclaringType.Assembly.Location, TypeManager.GetFullNameSignature (mi));
+                       } else {
+                               string name = String.Concat (temp_ds.Name, ".", mi.Name);
+                               MemberCore mc = temp_ds.GetDefinition (name) as MemberCore;
+                               SymbolRelatedToPreviousError (mc.Location, mc.GetSignatureForError ());
+                       }
+               }
+
+               static public void SymbolRelatedToPreviousError (Type type)
+               {
+                       SymbolRelatedToPreviousError (type.Assembly.Location, TypeManager.CSharpName (type));
+               }
+
+               static void SymbolRelatedToPreviousError (string loc, string symbol)
+               {
+                       related_symbols.Add (String.Format ("{0}: ('{1}' name of symbol related to previous error)", loc, symbol));
+               }
+
                static public void RealError (string msg)
                {
                        Errors++;
                        Console.WriteLine (msg);
 
+                       foreach (string s in related_symbols)
+                               Console.WriteLine (s);
+                       related_symbols.Clear ();
+
                        if (Stacktrace)
-                               Console.WriteLine (new StackTrace ().ToString ());
+                               Console.WriteLine (FriendlyStackTrace (new StackTrace (true)));
+                       
                        if (Fatal)
                                throw new Exception (msg);
                }
 
+
+               /// <summary>
+               /// Method reports warning message. Only one reason why exist Warning and Report methods is beter code readability.
+               /// </summary>
+               static public void Warning_T (int code, Location loc, params object[] args)
+               {
+                       WarningData warning = GetWarningMsg (code);
+                       if (warning.IsEnabled ())
+                               Warning (code, loc, warning.Format (args));
+
+                       related_symbols.Clear ();
+               }
+
+               /// <summary>
+               /// Reports error message.
+               /// </summary>
+               static public void Error_T (int code, Location loc, params object[] args)
+               {
+                       Error_T (code, String.Format ("{0}({1})", loc.Name, loc.Row), args);
+               }
+
+               static public void Error_T (int code, string location, params object[] args)
+               {
+                       string errorText = String.Format (GetErrorMsg (code), args);
+                       PrintError (code, location, errorText);
+               }
+
+               static void PrintError (int code, string l, string text)
+               {
+                       if (code < 0)
+                               code = 8000-code;
+                       
+                       string msg = String.Format ("{0} error CS{1:0000}: {2}", l, code, text);
+                       RealError (msg);
+                       Check (code);
+               }
+
                static public void Error (int code, Location l, string text)
                {
                        if (code < 0)
@@ -98,8 +307,10 @@ namespace Mono.CSharp {
                                code = 8000-code;
                        
                        if (warning_ignore_table != null){
-                               if (warning_ignore_table.Contains (code))
+                               if (warning_ignore_table.Contains (code)) {
+                                       related_symbols.Clear ();
                                        return;
+                               }
                        }
                        
                        if (WarningsAreErrors)
@@ -117,6 +328,11 @@ namespace Mono.CSharp {
 //                                     "{0}({1}) warning CS{2}: {3}",
                                        l.Name,  row, code, text));
                                Warnings++;
+
+                               foreach (string s in related_symbols)
+                                       Console.WriteLine (s);
+                               related_symbols.Clear ();
+
                                Check (code);
 
                                if (Stacktrace)
@@ -153,6 +369,21 @@ namespace Mono.CSharp {
                        Check (code);
                }
 
+               static public void Error (int code, Location loc, string format, params object[] args)
+               {
+                       Error (code, loc, String.Format (format, args));
+               }
+
+               static public void Warning (int code, Location loc, string format, params object[] args)
+               {
+                       Warning (code, loc, String.Format (format, args));
+               }
+
+               static public void Warning (int code, string format, params object[] args)
+               {
+                       Warning (code, String.Format (format, args));
+               }
+
                static public void Message (Message m)
                {
                        if (m is ErrorMessage)
@@ -207,6 +438,8 @@ namespace Mono.CSharp {
                                                sb.Append ("null");
                                        else if (arg is ICollection)
                                                sb.Append (PrintCollection ((ICollection) arg));
+                                       else if (arg is IntPtr)
+                                               sb.Append (String.Format ("IntPtr(0x{0:x})", ((IntPtr) arg).ToInt32 ()));
                                        else
                                                sb.Append (arg);
                                }
@@ -364,5 +597,9 @@ namespace Mono.CSharp {
                        : base (message)
                {
                }
+
+               public InternalErrorException (string format, params object[] args)
+                       : this (String.Format (format, args))
+               { }
        }
 }