mcs/class/Microsoft.Build.Utilities/Microsoft.Build.Utilities/Logger.cs

   1 //
   2 // Logger.cs: Logs warning and errors.
   3 //
   4 // Author:
   5 //   Marek Sieradzki (marek.sieradzki@gmail.com)
   6 //
   7 // (C) 2005 Marek Sieradzki
   8 //
   9 // Permission is hereby granted, free of charge, to any person obtaining
  10 // a copy of this software and associated documentation files (the
  11 // "Software"), to deal in the Software without restriction, including
  12 // without limitation the rights to use, copy, modify, merge, publish,
  13 // distribute, sublicense, and/or sell copies of the Software, and to
  14 // permit persons to whom the Software is furnished to do so, subject to
  15 // the following conditions:
  16 //
  17 // The above copyright notice and this permission notice shall be
  18 // included in all copies or substantial portions of the Software.
  19 //
  20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  24 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  25 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  26 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  27
  28 #if NET_2_0
  29
  30 using System;
  31 using System.Text;
  32 using Microsoft.Build.Framework;
  33
  34 namespace Microsoft.Build.Utilities
  35 {
  36         public abstract class Logger : ILogger
  37         {
  38                 string          parameters;
  39                 LoggerVerbosity verbosity;
  40
  41                 protected Logger ()
  42                 {
  43                 }
  44
  45                 public virtual string Parameters {
  46                         get {
  47                                 return parameters;
  48                         }
  49                         set {
  50                                 parameters = value;
  51                         }
  52                 }
  53
  54                 public virtual LoggerVerbosity Verbosity {
  55                         get {
  56                                 return verbosity;
  57                         }
  58                         set {
  59                                 verbosity = value;
  60                         }
  61                 }
  62
  63                 public virtual string FormatErrorEvent (BuildErrorEventArgs args)
  64                 {
  65                         StringBuilder sb = new StringBuilder ();
  66
  67                         sb.Append (args.File);
  68                         AppendLineNumbers (sb, args.LineNumber, args.ColumnNumber, args.EndLineNumber, args.EndColumnNumber);
  69                         sb.Append (": ");
  70                         sb.Append (args.Subcategory);
  71                         sb.Append (" error ");
  72                         sb.Append (args.Code);
  73                         sb.Append (": ");
  74                         sb.Append (args.Message);
  75
  76                         return sb.ToString ();
  77                 }
  78
  79                 public virtual string FormatWarningEvent (BuildWarningEventArgs args)
  80                 {
  81                         StringBuilder sb = new StringBuilder ();
  82
  83                         sb.Append (args.File);
  84                         AppendLineNumbers (sb, args.LineNumber, args.ColumnNumber, args.EndLineNumber, args.EndColumnNumber);
  85                         sb.Append (": ");
  86                         sb.Append (args.Subcategory);
  87                         sb.Append (" warning ");
  88                         sb.Append (args.Code);
  89                         sb.Append (": ");
  90                         sb.Append (args.Message);
  91
  92                         return sb.ToString ();
  93                 }
  94
  95                 void AppendLineNumbers (StringBuilder sb, int line, int column, int endLine, int endColumn)
  96                 {
  97                         if (line != 0 && column != 0 && endLine != 0 && endColumn != 0) {
  98                                 sb.AppendFormat ("({0},{1},{2},{3})", line, column, endLine, endColumn);
  99                         } else if (line != 0 && column != 0) {
 100                                 sb.AppendFormat ("({0},{1})", line, column);
 101                         } else if (line != 0) {
 102                                 sb.AppendFormat ("({0})", line);
 103                         } else {
 104                                 sb.Append (" ");
 105                         }
 106                 }
 107
 108                 public abstract void Initialize (IEventSource eventSource);
 109
 110                 public virtual void Shutdown ()
 111                 {
 112                 }
 113
 114                 [MonoTODO]
 115                 public bool IsVerbosityAtLeast (LoggerVerbosity verbosity)
 116                 {
 117                         return (this.verbosity >= verbosity) ? true : false;
 118                 }
 119         }
 120 }
 121
 122 #endif