Merge branch 'Paco' into staging

[lilypond.git] / flower / warn.cc

diff --git a/flower/warn.cc b/flower/warn.cc
index 870420380ed4729c9c9d54be25ab09011837b71b..f3f6e1c74369e8f92d0b4a9a849ac9889548ed5a 100644 (file)
--- a/flower/warn.cc
+++ b/flower/warn.cc
@@ -1,7 +1,7 @@
 /*
   This file is part of LilyPond, the GNU music typesetter.
 
-  Copyright (C) 1997--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  Copyright (C) 1997--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
   LilyPond is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
@@ -22,6 +22,7 @@
 #include <cstdlib>
 #include <cstdio>
 
+#include "std-vector.hh"
 #include "international.hh"
 
 using namespace std;
@@ -39,6 +40,7 @@ using namespace std;
 
 /* Define the loglevel (default is INFO) */
 int loglevel = LOGLEVEL_INFO;
+bool warning_as_error = false;
 
 bool
 is_loglevel (int level)
@@ -84,13 +86,58 @@ set_loglevel (string level)
         set_loglevel (l);
       else
         {
-          non_fatal_error (_f ("unknown log level `%s', using default (INFO)", 
+          non_fatal_error (_f ("unknown log level `%s', using default (INFO)",
                                level));
           set_loglevel (LOGLEVEL_INFO);
         }
     }
 }
 
+/**
+ * Register a warning string to be expected and the output suppressed.
+ * If the warning is encountered, it will be removed from the list of
+ * expected warnings again.
+ */
+vector<string> expected_warnings;
+void expect_warning (string msg)
+{
+  expected_warnings.push_back (msg);
+}
+
+void check_expected_warnings ()
+{
+  if (expected_warnings.size () > 0)
+    {
+      /* Some expected warning was not triggered, so print out a warning. */
+      string msg = _f ("%d expected warning(s) not encountered: ",
+                       expected_warnings.size ());
+      for (vsize i = 0; i < expected_warnings.size (); i++)
+        msg += "\n        " + expected_warnings[i];
+
+      warning (msg);
+    }
+  expected_warnings.clear ();
+}
+
+bool is_expected (string s)
+{
+  bool expected = false;
+  for (vsize i = 0; i < expected_warnings.size (); i++)
+    {
+      // Compare the msg with the suppressed string; If the beginning matches,
+      // i.e. the msg can have additional content AFTER the full (exact)
+      // suppressed message, suppress the warning.
+      // This is needed for the Input class, where the message contains
+      // the input file contents after the real message.
+      if (s.compare (0, expected_warnings[i].size (), expected_warnings[i]) == 0)
+        {
+          expected = true;
+          expected_warnings.erase (expected_warnings.begin () + i);
+          break;
+        }
+    }
+  return expected;
+}
 
 /**
  * Helper functions: print_message_part (no newline prepended)
@@ -124,7 +171,6 @@ print_message (int level, string location, string s, bool newline)
     message_newline = s[s.length () - 1] == '\n';
 }
 
-
 /** The actual output functions to be called in lilypond code.
  *  Sorted in descending order of importance (errors, warnings, progress, info,
  *  debug). Each prints a message on a separate line.
@@ -142,29 +188,46 @@ error (string s, string location)
 void
 programming_error (string s, string location)
 {
-  print_message (LOG_ERROR, location, _f ("programming error: %s", s) + "\n");
-  print_message (LOG_ERROR, location, _ ("continuing, cross fingers") + "\n");
+  if (is_expected (s))
+    print_message (LOG_DEBUG, location, _f ("suppressed programming error: %s", s) + "\n");
+  else if (warning_as_error)
+    error (s, location);
+  else
+    {
+      print_message (LOG_ERROR, location, _f ("programming error: %s", s) + "\n");
+      print_message (LOG_ERROR, location, _ ("continuing, cross fingers") + "\n");
+    }
 }
 
 /* Display a non-fatal error message, don't exit.  */
 void
 non_fatal_error (string s, string location)
 {
-  print_message (LOG_ERROR, location, _f ("error: %s", s) + "\n");
+  if (is_expected (s))
+    print_message (LOG_DEBUG, location, _f ("suppressed error: %s", s) + "\n");
+  else if (warning_as_error)
+    error (s, location);
+  else
+    print_message (LOG_ERROR, location, _f ("error: %s", s) + "\n");
 }
 
 /* Display a warning message. */
 void
 warning (string s, string location)
 {
-  print_message (LOG_WARN, location, _f ("warning: %s", s) + "\n");
+  if (is_expected (s))
+    print_message (LOG_DEBUG, location, _f ("suppressed warning: %s", s) + "\n");
+  else if (warning_as_error)
+    error (s, location);
+  else
+    print_message (LOG_WARN, location, _f ("warning: %s", s) + "\n");
 }
 
 /* Display a success message.  */
 void
-successful (string s, string location)
+basic_progress (string s, string location)
 {
-  print_message (LOG_BASIC, location, _f ("success: %s", s) + "\n", true);
+  print_message (LOG_BASIC, location, s + "\n", true);
 }
 
 /* Display information about the progress.  */