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
  29 using System;
  30 using System.Text;
  31 using Microsoft.Build.Framework;
  32
  33 namespace Microsoft.Build.Utilities
  34 {
  35         public abstract class Logger : ILogger
  36         {
  37                 string          parameters;
  38                 LoggerVerbosity verbosity;
  39
  40                 protected Logger ()
  41                 {
  42                 }
  43
  44                 public virtual string Parameters {
  45                         get {
  46                                 return parameters;
  47                         }
  48                         set {
  49                                 parameters = value;
  50                         }
  51                 }
  52
  53                 public virtual LoggerVerbosity Verbosity {
  54                         get {
  55                                 return verbosity;
  56                         }
  57                         set {
  58                                 verbosity = value;
  59                         }
  60                 }
  61
  62                 public virtual string FormatErrorEvent (BuildErrorEventArgs args)
  63                 {
  64                         StringBuilder sb = new StringBuilder ();
  65
  66                         sb.Append (args.File);
  67                         AppendLineNumbers (sb, args.LineNumber, args.ColumnNumber, args.EndLineNumber, args.EndColumnNumber);
  68                         sb.Append (": ");
  69                         sb.Append (args.Subcategory);
  70                         sb.Append (" error ");
  71                         sb.Append (args.Code);
  72                         sb.Append (": ");
  73                         sb.Append (args.Message);
  74
  75                         return sb.ToString ();
  76                 }
  77
  78                 public virtual string FormatWarningEvent (BuildWarningEventArgs args)
  79                 {
  80                         StringBuilder sb = new StringBuilder ();
  81
  82                         sb.Append (args.File);
  83                         AppendLineNumbers (sb, args.LineNumber, args.ColumnNumber, args.EndLineNumber, args.EndColumnNumber);
  84                         sb.Append (": ");
  85                         sb.Append (args.Subcategory);
  86                         sb.Append (" warning ");
  87                         sb.Append (args.Code);
  88                         sb.Append (": ");
  89                         sb.Append (args.Message);
  90
  91                         return sb.ToString ();
  92                 }
  93
  94                 void AppendLineNumbers (StringBuilder sb, int line, int column, int endLine, int endColumn)
  95                 {
  96                         if (line != 0 && column != 0 && endLine != 0 && endColumn != 0) {
  97                                 sb.AppendFormat ("({0},{1},{2},{3})", line, column, endLine, endColumn);
  98                         } else if (line != 0 && column != 0) {
  99                                 sb.AppendFormat ("({0},{1})", line, column);
 100                         } else if (line != 0) {
 101                                 sb.AppendFormat ("({0})", line);
 102                         } else {
 103                                 sb.Append (" ");
 104                         }
 105                 }
 106
 107                 public abstract void Initialize (IEventSource eventSource);
 108
 109                 public virtual void Shutdown ()
 110                 {
 111                 }
 112
 113                 [MonoTODO]
 114                 public bool IsVerbosityAtLeast (LoggerVerbosity checkVerbosity)
 115                 {
 116                         return this.verbosity >= checkVerbosity;
 117                 }
 118         }
 119 }
 120