vala/valareport.vala

   1 /* valareport.vala
   2  *
   3  * Copyright (C) 2006-2008  Jürg Billeter
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA
  18  *
  19  * Author:
  20  *      Jürg Billeter <j@bitron.ch>
  21  */
  22
  23 using GLib;
  24
  25 /**
  26  * Namespace to centralize reporting warnings and errors.
  27  */
  28 namespace Vala.Report {
  29         public int warnings;
  30         public int errors;
  31
  32         public bool verbose_errors;
  33
  34         /**
  35          * Set the error verbosity.
  36          */
  37         public void set_verbose_errors (bool verbose) {
  38                 verbose_errors = verbose;
  39         }
  40
  41         /**
  42          * Returns the total number of warnings reported.
  43          */
  44         public int get_warnings () {
  45                 return warnings;
  46         }
  47
  48         /**
  49          * Returns the total number of errors reported.
  50          */
  51         public int get_errors () {
  52                 return errors;
  53         }
  54
  55         /**
  56          * Pretty-print the actual line of offending code if possible.
  57          */
  58         public void report_source (SourceReference source) {
  59                 if (source.first_line != source.last_line) {
  60                         // FIXME Cannot report multi-line issues currently
  61                         return;
  62                 }
  63
  64                 string offending_line = source.file.get_source_line (source.first_line);
  65
  66                 if (offending_line != null) {
  67                         stderr.printf ("%s\n", offending_line);
  68                         int idx;
  69
  70                         /* We loop in this manner so that we don't fall over on differing
  71                          * tab widths. This means we get the ^s in the right places.
  72                          */
  73                         for (idx = 1; idx < source.first_column; ++idx) {
  74                                 if (offending_line[idx - 1] == '\t') {
  75                                         stderr.printf ("\t");
  76                                 } else {
  77                                         stderr.printf (" ");
  78                                 }
  79                         }
  80
  81                         for (idx = source.first_column; idx <= source.last_column; ++idx) {
  82                                 if (offending_line[idx - 1] == '\t') {
  83                                         stderr.printf ("\t");
  84                                 } else {
  85                                         stderr.printf ("^");
  86                                 }
  87                         }
  88
  89                         stderr.printf ("\n");
  90                 }
  91         }
  92
  93         /**
  94          * Reports the specified message as warning.
  95          *
  96          * @param source  reference to source code
  97          * @param message warning message
  98          */
  99         public void warning (SourceReference? source, string message) {
 100                 warnings++;
 101                 if (source == null) {
 102                         stderr.printf ("warning: %s\n", message);
 103                 } else {
 104                         stderr.printf ("%s: warning: %s\n", source.to_string (), message);
 105                         if (verbose_errors) {
 106                                 report_source (source);
 107                         }
 108                 }
 109         }
 110
 111         /**
 112          * Reports the specified message as error.
 113          *
 114          * @param source  reference to source code
 115          * @param message error message
 116          */
 117         public void error (SourceReference? source, string message) {
 118                 errors++;
 119                 if (source == null) {
 120                         stderr.printf ("error: %s\n", message);
 121                 } else {
 122                         stderr.printf ("%s: error: %s\n", source.to_string (), message);
 123                         if (verbose_errors) {
 124                                 report_source (source);
 125                         }
 126                 }
 127         }
 128 }