]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/multi-measure-rest-engraver.cc
lilypond-manuals.css: edit color scheme and some spacing
[lilypond.git] / lily / multi-measure-rest-engraver.cc
index 0e973b19bf701ce78f6d9130539c34fe3e67f21b..ff1e155abc1eaef3d4e8e0fc794425a22d32aa4c 100644 (file)
@@ -1,8 +1,21 @@
 /*
-  multi_measure_rest-engraver.cc -- implement Multi_measure_rest_engraver
+  This file is part of LilyPond, the GNU music typesetter.
 
-  (c) 1998--2005 Jan Nieuwenhuizen <janneke@gnu.org>
-  Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  Copyright (C) 1998--2015 Jan Nieuwenhuizen <janneke@gnu.org>
+  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
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  LilyPond is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #include "multi-measure-rest.hh"
 #include "engraver-group.hh"
 #include "side-position-interface.hh"
 #include "staff-symbol-referencer.hh"
+#include "stream-event.hh"
 #include "moment.hh"
+#include "spanner.hh"
+
+#include "translator.icc"
 
 /**
    The name says it all: make multi measure rests
@@ -21,242 +38,238 @@ public:
   TRANSLATOR_DECLARATIONS (Multi_measure_rest_engraver);
 
 protected:
-  virtual bool try_music (Music *);
   void process_music ();
-  void stop_translation_timestep ();
   void start_translation_timestep ();
-  virtual void finalize ();
+  void listen_multi_measure_rest (Stream_event *);
+  void listen_multi_measure_text (Stream_event *);
 
 private:
-  Music *rest_ev_;
-  Link_array<Music> text_events_;
-  int start_measure_;
-  Rational last_main_moment_;
-  Moment stop_moment_;
+  void add_bound_item_to_grobs (Item *);
+  void clear_lapsed_events (const Moment &now);
+  bool grobs_initialized () const { return mmrest_; }
+  void initialize_grobs ();
+  void reset_grobs ();
+  void set_measure_count (int n);
 
-  bool bar_seen_;
-  Item *last_command_item_;
-  Spanner *last_rest_;
+private:
+  vector<Stream_event *> text_events_;
+  // text_[0] is a MultiMeasureRestNumber grob
+  // the rest are optional MultiMeasureRestText grobs
+  vector<Spanner *> text_;
+  Stream_event *rest_ev_;
   Spanner *mmrest_;
-
-  Link_array<Spanner> numbers_;
-  Link_array<Spanner> last_numbers_;
+  Moment stop_moment_;
+  int start_measure_;
+  // Ugh, this is a kludge - need this for multi-measure-rest-grace.ly
+  Item *last_command_item_;
+  bool first_time_;
 };
 
-Multi_measure_rest_engraver::Multi_measure_rest_engraver ()
+Multi_measure_rest_engraver::Multi_measure_rest_engraver (Context *c)
+  : Engraver (c),
+    rest_ev_ (0),
+    mmrest_ (0),
+    start_measure_ (0),
+    last_command_item_ (0),
+    first_time_ (true)
 {
-  last_command_item_ = 0;
+}
 
+void
+Multi_measure_rest_engraver::listen_multi_measure_rest (Stream_event *ev)
+{
+  /* FIXME: Should use ASSIGN_EVENT_ONCE. Can't do that yet because of
+     the kill-mm-rests hack in part-combine-iterator. */
+  rest_ev_ = ev;
+  const Moment now (now_mom ());
+  stop_moment_ = now + get_event_length (rest_ev_, now);
   /*
-    For the start of a score.
+  if (ASSIGN_EVENT_ONCE (rest_ev_, ev))
+    stop_moment_ = now_mom () + get_event_length (rest_ev_);
   */
-  bar_seen_ = true;
-  start_measure_ = 0;
-  mmrest_ = 0;
-  last_rest_ = 0;
-  rest_ev_ = 0;
+
+  clear_lapsed_events (now);
 }
 
-bool
-Multi_measure_rest_engraver::try_music (Music *event)
+void
+Multi_measure_rest_engraver::listen_multi_measure_text (Stream_event *ev)
 {
-  if (event->is_mus_type ("multi-measure-rest-event"))
-    {
-      rest_ev_ = event;
-      stop_moment_ = now_mom () + rest_ev_->get_length ();
+  text_events_.push_back (ev);
+}
 
-      return true;
-    }
-  else if (event->is_mus_type ("multi-measure-text-event"))
-    {
-      text_events_.push (event);
-      return true;
-    }
-  return false;
+void
+Multi_measure_rest_engraver::add_bound_item_to_grobs (Item *item)
+{
+  add_bound_item (mmrest_, item);
+  for (vsize i = 0; i < text_.size (); ++i)
+    add_bound_item (text_[i], item);
 }
 
 void
-Multi_measure_rest_engraver::process_music ()
+Multi_measure_rest_engraver::clear_lapsed_events (const Moment &now)
 {
-  if (rest_ev_ && !mmrest_
-      && stop_moment_ > now_mom ())
+  if (now.main_part_ >= stop_moment_.main_part_)
     {
-      mmrest_ = make_spanner ("MultiMeasureRest", rest_ev_->self_scm ());
-
-      Spanner *sp
-       = make_spanner ("MultiMeasureRestNumber", rest_ev_->self_scm ());
-      numbers_.push (sp);
-
-      if (text_events_.size ())
-       {
-         for (int i = 0; i < text_events_.size (); i++)
-           {
-
-             Music *e = text_events_[i];
-             Spanner *sp
-               = make_spanner ("MultiMeasureRestText", e->self_scm ());
-             SCM t = e->get_property ("text");
-             SCM dir = e->get_property ("direction");
-             sp->set_property ("text", t);
-             if (is_direction (dir))
-               sp->set_property ("direction", dir);
-
-             numbers_.push (sp);
-           }
-
-         /*
-           Stack different scripts.
-         */
-         Direction d = DOWN;
-         do
-           {
-             Grob *last = 0;
-             for (int i = 0; i < numbers_.size (); i++)
-               {
-                 if (scm_from_int (d) == numbers_[i]->get_property ("direction"))
-                   {
-                     if (last)
-                       Side_position_interface::add_support (numbers_[i], last);
-                     last = numbers_[i];
-                   }
-               }
-           }
-         while (flip (&d) != DOWN);
-       }
-
-      for (int i = 0; i < numbers_.size (); i++)
-       {
-         Side_position_interface::add_support (numbers_[i], mmrest_);
-         numbers_[i]->set_parent (mmrest_, Y_AXIS);
-       }
-
-      start_measure_
-       = scm_to_int (get_property ("currentBarNumber"));
+      rest_ev_ = 0;
+      text_events_.clear ();
     }
-
-  bar_seen_ = bar_seen_ || scm_is_string (get_property ("whichBar"));
 }
 
 void
-Multi_measure_rest_engraver::stop_translation_timestep ()
+Multi_measure_rest_engraver::initialize_grobs ()
 {
-  /* We cannot do this earlier, as breakableSeparationItem is not yet
-     there.  */
-  if (bar_seen_)
+  mmrest_ = make_spanner ("MultiMeasureRest", rest_ev_->self_scm ());
+  text_.push_back (make_spanner ("MultiMeasureRestNumber",
+                                 mmrest_->self_scm ()));
+
+  if (text_events_.size ())
     {
-      Grob *cmc = unsmob_grob (get_property ("breakableSeparationItem"));
-      if (!cmc)
-       cmc = unsmob_grob (get_property ("currentCommandColumn"));
+      for (vsize i = 0; i < text_events_.size (); i++)
+        {
+          Stream_event *e = text_events_[i];
+          Spanner *sp = make_spanner ("MultiMeasureRestText", e->self_scm ());
+          SCM t = e->get_property ("text");
+          SCM dir = e->get_property ("direction");
+          sp->set_property ("text", t);
+          if (is_direction (dir))
+            sp->set_property ("direction", dir);
+
+          text_.push_back (sp);
+        }
 
-      /* Ugh, this is a kludge - need this for multi-measure-rest-grace.ly  */
-      last_command_item_ = dynamic_cast<Item *> (cmc);
+      /*
+        Stack different scripts.
+      */
+      for (DOWN_and_UP (d))
+        {
+          SCM dir = scm_from_int (d);
+          Grob *last = 0;
+          for (vsize i = 0; i < text_.size (); i++)
+            {
+              if (ly_is_equal (dir, text_[i]->get_property ("direction")))
+                {
+                  if (last)
+                    Side_position_interface::add_support (text_[i], last);
+                  last = text_[i];
+                }
+            }
+        }
     }
 
-  if (last_command_item_ && (mmrest_ || last_rest_))
+  for (vsize i = 0; i < text_.size (); i++)
     {
-      if (last_rest_)
-       {
-         add_bound_item (last_rest_, last_command_item_);
-         for (int i = 0; i < last_numbers_.size (); i++)
-           add_bound_item (last_numbers_[i], last_command_item_);
-       }
-
-      if (mmrest_)
-       {
-         add_bound_item (mmrest_, last_command_item_);
-         for (int i = 0; i < numbers_.size (); i++)
-           add_bound_item (numbers_[i], last_command_item_);
-
-         last_command_item_ = 0;
-       }
+      Side_position_interface::add_support (text_[i], mmrest_);
+      text_[i]->set_parent (mmrest_, Y_AXIS);
+      text_[i]->set_parent (mmrest_, X_AXIS);
     }
+}
+
+void
+Multi_measure_rest_engraver::reset_grobs ()
+{
+  text_.clear ();
+  mmrest_ = 0;
+}
+
+void
+Multi_measure_rest_engraver::set_measure_count (int n)
+{
+  SCM n_scm = scm_from_int (n);
+  assert (mmrest_);
+  mmrest_->set_property ("measure-count", n_scm);
 
-  Moment mp (robust_scm2moment (get_property ("measurePosition"), Moment (0)));
-  if (last_rest_)
+  Grob *g = text_[0]; // the MultiMeasureRestNumber
+  assert (g);
+  if (scm_is_null (g->get_property ("text")))
     {
-      last_rest_ = 0;
-      last_numbers_.clear ();
+      SCM thres = get_property ("restNumberThreshold");
+      int t = 1;
+      if (scm_is_number (thres))
+        t = scm_to_int (thres);
+
+      if (n <= t)
+        g->suicide ();
+      else
+        {
+          SCM text = scm_number_to_string (n_scm, scm_from_int (10));
+          g->set_property ("text", text);
+        }
     }
-
-  text_events_.clear ();
-  bar_seen_ = false;
 }
 
 void
-Multi_measure_rest_engraver::start_translation_timestep ()
+Multi_measure_rest_engraver::process_music ()
 {
-  if (now_mom ().main_part_ >= stop_moment_.main_part_)
-    rest_ev_ = 0;
+  const bool measure_end
+  = scm_is_string (get_property ("whichBar"))
+    && (robust_scm2moment (get_property ("measurePosition"),
+                           Moment (0)).main_part_ == Rational (0));
 
-  Moment mp (robust_scm2moment (get_property ("measurePosition"), Moment (0)));
+  if (measure_end || first_time_)
+    {
+      last_command_item_ = unsmob<Item> (get_property ("currentCommandColumn"));
+
+      // Finalize the current grobs.
+      if (grobs_initialized ())
+        {
+          int curr_measure = scm_to_int (get_property ("internalBarNumber"));
+          set_measure_count (curr_measure - start_measure_);
+          if (last_command_item_)
+            add_bound_item_to_grobs (last_command_item_);
+          reset_grobs ();
+        }
+    }
 
-  Moment now = now_mom ();
-  if (mmrest_
-      && now.main_part_ != last_main_moment_
-      && mp.main_part_ == Rational (0))
+  // Create new grobs if a rest event is (still) active.
+  if (!grobs_initialized () && rest_ev_)
     {
-      last_rest_ = mmrest_;
-      last_numbers_ = numbers_;
+      initialize_grobs ();
+      text_events_.clear ();
 
-      int cur = scm_to_int (get_property ("currentBarNumber"));
-      int num = cur - start_measure_;
+      if (last_command_item_)
+        {
+          add_bound_item_to_grobs (last_command_item_);
+          last_command_item_ = 0;
+        }
 
-      /*
-       We can't plug a markup directly into the grob, since the
-       measure-count determines the formatting of the mmrest.
-      */
-      last_rest_->set_property ("measure-count", scm_from_int (num));
-
-      SCM sml = get_property ("measureLength");
-      Rational ml = (unsmob_moment (sml)) ? unsmob_moment (sml)->main_part_ : Rational (1);
-      if (ml >= Rational (2))
-       last_rest_->set_property ("use-breve-rest", SCM_BOOL_T);
-
-      mmrest_ = 0;
-      numbers_.clear ();
-
-      Grob *last = last_numbers_.size () ? last_numbers_[0] : 0;
-      if (last && last->get_property ("text") == SCM_EOL)
-       {
-         SCM thres = get_property ("restNumberThreshold");
-         int t = 1;
-         if (scm_is_number (thres))
-           t = scm_to_int (thres);
-
-         if (num <= t)
-           last->suicide ();
-         else
-           {
-             SCM text
-               = scm_number_to_string (scm_from_int (num), scm_from_int (10));
-             last->set_property ("text", text);
-           }
-       }
+      start_measure_ = scm_to_int (get_property ("internalBarNumber"));
     }
 
-  last_main_moment_ = now.main_part_;
+  first_time_ = false;
 }
 
 void
-Multi_measure_rest_engraver::finalize ()
+Multi_measure_rest_engraver::start_translation_timestep ()
 {
+  clear_lapsed_events (now_mom ());
 }
 
-#include "translator.icc"
+void
+Multi_measure_rest_engraver::boot ()
+{
+  ADD_LISTENER (Multi_measure_rest_engraver, multi_measure_rest);
+  ADD_LISTENER (Multi_measure_rest_engraver, multi_measure_text);
+}
 
 ADD_TRANSLATOR (Multi_measure_rest_engraver,
-               /* doc */
-               "Engraves multi-measure rests that are produced with @code{R}.  Reads "
-               "measurePosition and currentBarNumber to determine what number to print "
-               "over the MultiMeasureRest.  Reads measureLength to determine if it "
-               "should use a whole rest or a breve rest to represent 1 measure ",
-               /* create */ "MultiMeasureRest MultiMeasureRestNumber MultiMeasureRestText",
-               /* accept */ "multi-measure-rest-event multi-measure-text-event",
-               /* read */
-               "currentBarNumber "
-               "restNumberThreshold "
-               "breakableSeparationItem "
-               "currentCommandColumn "
-               "measurePosition "
-               "measureLength",
-               /* write */ "");
+                /* doc */
+                "Engrave multi-measure rests that are produced with"
+                " @samp{R}.  It reads @code{measurePosition} and"
+                " @code{internalBarNumber} to determine what number to print"
+                " over the @ref{MultiMeasureRest}.",
+
+                /* create */
+                "MultiMeasureRest "
+                "MultiMeasureRestNumber "
+                "MultiMeasureRestText ",
+
+                /* read */
+                "internalBarNumber "
+                "restNumberThreshold "
+                "currentCommandColumn "
+                "measurePosition "
+                "whichBar ",
+
+                /* write */
+                ""
+               );