flower/warn.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include "warn.hh"
  21
  22 #include <cstdlib>
  23 #include <cstdio>
  24
  25 #include "std-vector.hh"
  26 #include "international.hh"
  27
  28 using namespace std;
  29
  30 /** We have several different loglevels, each with its own message function(s):
  31       ERROR: error, non_fatal_error, programming_error
  32       WARN: warning
  33       BASIC_PROGRESS: success/...
  34       PROGRESS: progress_indication
  35       INFO: message
  36       DEBUG: debug
  37   All these functions check whether the corresponding loglevel bit is set
  38   and print the message only if that's the case
  39 */
  40
  41 /* Define the loglevel (default is INFO) */
  42 int loglevel = LOGLEVEL_INFO;
  43 bool warning_as_error = false;
  44
  45 bool
  46 is_loglevel (int level)
  47 {
  48   // Check the bitmask containing the loglevel
  49   return (loglevel & level);
  50 }
  51
  52 void
  53 set_loglevel (int level)
  54 {
  55   loglevel = level;
  56   debug_output (_f ("Log level set to %d\n", loglevel));
  57 }
  58
  59 void
  60 set_loglevel (string level)
  61 {
  62   /* Convert the loglevel string to lower-case, so we allow
  63      both upper- and lower-case loglevels */
  64   std::transform (level.begin (), level.end (), level.begin (), ::tolower);
  65
  66   /* Compare just the first few characters, so the loglevels
  67      can be abbreviated */
  68   if (level.compare (0, 5, "debug") == 0) // debug
  69     set_loglevel (LOGLEVEL_DEBUG);
  70   else if (level.compare (0, 4, "info") == 0) // info
  71     set_loglevel (LOGLEVEL_INFO);
  72   else if (level.compare (0, 4, "prog") == 0) // progress
  73     set_loglevel (LOGLEVEL_PROGRESS);
  74   else if (level.compare (0, 5, "basic") == 0) // basic progress
  75     set_loglevel (LOGLEVEL_BASIC);
  76   else if (level.compare (0, 4, "warn") == 0) // warning
  77     set_loglevel (LOGLEVEL_WARN);
  78   else if (level.compare (0, 3, "err") == 0) // error
  79     set_loglevel (LOGLEVEL_ERROR);
  80   else if (level.compare (0, 4, "none") == 0) // none
  81     set_loglevel (LOGLEVEL_NONE);
  82   else
  83     {
  84       int l;
  85       if (sscanf (level.c_str (), "%d", &l))
  86         set_loglevel (l);
  87       else
  88         {
  89           non_fatal_error (_f ("unknown log level `%s', using default (INFO)",
  90                                level));
  91           set_loglevel (LOGLEVEL_INFO);
  92         }
  93     }
  94 }
  95
  96 /**
  97  * Register a warning string to be expected and the output suppressed.
  98  * If the warning is encountered, it will be removed from the list of
  99  * expected warnings again.
 100  */
 101 vector<string> expected_warnings;
 102 void expect_warning (const string &msg)
 103 {
 104   expected_warnings.push_back (msg);
 105 }
 106
 107 void check_expected_warnings ()
 108 {
 109   if (expected_warnings.size () > 0)
 110     {
 111       /* Some expected warning was not triggered, so print out a warning. */
 112       string msg = _f ("%d expected warning(s) not encountered: ",
 113                        expected_warnings.size ());
 114       for (vsize i = 0; i < expected_warnings.size (); i++)
 115         msg += "\n        " + expected_warnings[i];
 116
 117       warning (msg);
 118     }
 119   expected_warnings.clear ();
 120 }
 121
 122 bool is_expected (const string &s)
 123 {
 124   bool expected = false;
 125   for (vsize i = 0; i < expected_warnings.size (); i++)
 126     {
 127       // Compare the msg with the suppressed string; If the beginning matches,
 128       // i.e. the msg can have additional content AFTER the full (exact)
 129       // suppressed message, suppress the warning.
 130       // This is needed for the Input class, where the message contains
 131       // the input file contents after the real message.
 132       if (s.compare (0, expected_warnings[i].size (), expected_warnings[i]) == 0)
 133         {
 134           expected = true;
 135           expected_warnings.erase (expected_warnings.begin () + i);
 136           break;
 137         }
 138     }
 139   return expected;
 140 }
 141
 142 /**
 143  * Helper functions: print_message_part (no newline prepended)
 144  *                   print_message (always starts on a new line)
 145  */
 146
 147 /* Is output message at NEWLINE?  */
 148 static bool message_newline = true;
 149
 150 /* Display user information as a full message.
 151    if newline is true, start the message on a new line.
 152 */
 153 void
 154 print_message (int level, const string &location, string s, bool newline)
 155 {
 156   /* Only print the message if the current loglevel allows it: */
 157   if (!is_loglevel (level))
 158     return;
 159   if (newline && !message_newline)
 160     fputc ('\n', stderr);
 161
 162   /* Test if all silly progress_indication ("\n") can be dropped now.  */
 163   if (s == "\n")
 164     return;
 165
 166   if (!location.empty ())
 167     s = location + ": " + s;
 168   fputs (s.c_str (), stderr);
 169   fflush (stderr);
 170   if (s.length ())
 171     message_newline = s[s.length () - 1] == '\n';
 172 }
 173
 174 /** The actual output functions to be called in lilypond code.
 175  *  Sorted in descending order of importance (errors, warnings, progress, info,
 176  *  debug). Each prints a message on a separate line.
 177  */
 178
 179 /* Display a fatal error message.  Also exits lilypond.  */
 180 void
 181 error (string s, const string &location)
 182 {
 183   print_message (LOG_ERROR, location, _f ("fatal error: %s", s) + "\n");
 184   exit (1);
 185 }
 186
 187 /* Display a severe programming error message, but don't exit.  */
 188 void
 189 programming_error (const string &s, const string &location)
 190 {
 191   if (is_expected (s))
 192     print_message (LOG_DEBUG, location, _f ("suppressed programming error: %s", s) + "\n");
 193   else if (warning_as_error)
 194     error (s, location);
 195   else
 196     {
 197       print_message (LOG_ERROR, location, _f ("programming error: %s", s) + "\n");
 198       print_message (LOG_ERROR, location, _ ("continuing, cross fingers") + "\n");
 199     }
 200 }
 201
 202 /* Display a non-fatal error message, don't exit.  */
 203 void
 204 non_fatal_error (const string &s, const string &location)
 205 {
 206   if (is_expected (s))
 207     print_message (LOG_DEBUG, location, _f ("suppressed error: %s", s) + "\n");
 208   else if (warning_as_error)
 209     error (s, location);
 210   else
 211     print_message (LOG_ERROR, location, _f ("error: %s", s) + "\n");
 212 }
 213
 214 /* Display a warning message. */
 215 void
 216 warning (const string &s, const string &location)
 217 {
 218   if (is_expected (s))
 219     print_message (LOG_DEBUG, location, _f ("suppressed warning: %s", s) + "\n");
 220   else if (warning_as_error)
 221     error (s, location);
 222   else
 223     print_message (LOG_WARN, location, _f ("warning: %s", s) + "\n");
 224 }
 225
 226 /* Display a success message.  */
 227 void
 228 basic_progress (const string &s, const string &location)
 229 {
 230   print_message (LOG_BASIC, location, s + "\n", true);
 231 }
 232
 233 /* Display information about the progress.  */
 234 void
 235 progress_indication (const string &s, bool newline, const string &location)
 236 {
 237   print_message (LOG_PROGRESS, location, s, newline);
 238 }
 239
 240 /* Display a single info message.  */
 241 void
 242 message (const string &s, bool newline, const string &location)
 243 {
 244   // Use the progress loglevel for all normal messages (including progress msg)
 245   print_message (LOG_INFO, location, s, newline);
 246 }
 247
 248 /* Display a debug information, not necessarily on a new line.  */
 249 void
 250 debug_output (const string &s, bool newline, const string &location)
 251 {
 252   print_message (LOG_DEBUG, location, s, newline);
 253 }