]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/multi-measure-rest-engraver.cc
Issue 2491: Macro for(UP_and_DOWN) and 3 similar.
[lilypond.git] / lily / multi-measure-rest-engraver.cc
index d34a75adbdc374299700eaf66c8b91cee1df15c1..7fede1a3e70a095d71401d65b65cf7035b5d4054 100644 (file)
 /*
-  multi_measure_rest-engraver.cc -- implement Multi_measure_rest_engraver
+  This file is part of LilyPond, the GNU music typesetter.
 
-  (c) 1998--2000 Jan Nieuwenhuizen <janneke@gnu.org>
-       Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  Copyright (C) 1998--2012 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 "proto.hh"
-#include "musical-request.hh"
 #include "multi-measure-rest.hh"
 #include "paper-column.hh"
-#include "engraver-group-engraver.hh"
-#include "timing-translator.hh"
-#include "bar.hh"
+#include "engraver-group.hh"
+#include "side-position-interface.hh"
 #include "staff-symbol-referencer.hh"
-#include "engraver.hh"
+#include "stream-event.hh"
 #include "moment.hh"
+#include "spanner.hh"
+
+#include "translator.icc"
 
 /**
- */
+   The name says it all: make multi measure rests
+*/
 class Multi_measure_rest_engraver : public Engraver
 {
 public:
-  VIRTUAL_COPY_CONS(Translator);
-  Multi_measure_rest_engraver ();
+  TRANSLATOR_DECLARATIONS (Multi_measure_rest_engraver);
 
 protected:
-  virtual void acknowledge_element (Score_element_info i);
-  virtual void do_process_requests ();
-  virtual bool do_try_music (Music*);
-  virtual void do_pre_move_processing ();
-  virtual void do_post_move_processing ();
-  virtual void do_removal_processing ();
+  void process_music ();
+  void stop_translation_timestep ();
+  void start_translation_timestep ();
+  virtual void finalize ();
+  DECLARE_TRANSLATOR_LISTENER (multi_measure_rest);
+  DECLARE_TRANSLATOR_LISTENER (multi_measure_text);
+
 private:
-  Span_req * new_req_l_;
-  Span_req * busy_span_req_l_;
-  Span_req * stop_req_l_;
-  int start_measure_i_;
-  Moment start_moment_;
-  
-  Multi_measure_rest *mmrest_p_;
-  Multi_measure_rest *lastrest_p_;
-};
+  Stream_event *rest_ev_;
+  vector<Stream_event *> text_events_;
+  int start_measure_;
+  Rational last_main_moment_;
+  Moment stop_moment_;
+
+  bool bar_seen_;
+  Item *last_command_item_;
+  Spanner *last_rest_;
+  Spanner *mmrest_;
 
-ADD_THIS_TRANSLATOR (Multi_measure_rest_engraver);
+  vector<Spanner *> numbers_;
+  vector<Spanner *> last_numbers_;
+};
 
 Multi_measure_rest_engraver::Multi_measure_rest_engraver ()
 {
-  start_measure_i_ = 0;
-  mmrest_p_  = lastrest_p_ =0;
-  new_req_l_ = busy_span_req_l_ = stop_req_l_ =0;
+  last_command_item_ = 0;
+
+  /*
+    For the start of a score.
+  */
+  bar_seen_ = true;
+  start_measure_ = 0;
+  mmrest_ = 0;
+  last_rest_ = 0;
+  rest_ev_ = 0;
 }
 
+IMPLEMENT_TRANSLATOR_LISTENER (Multi_measure_rest_engraver, multi_measure_rest);
 void
-Multi_measure_rest_engraver::acknowledge_element (Score_element_info i)
+Multi_measure_rest_engraver::listen_multi_measure_rest (Stream_event *ev)
 {
-  if (Bar *c = dynamic_cast<Bar*> (i.elem_l_))
-    {
-      if (mmrest_p_)
-       mmrest_p_->add_column (c);
-      if (lastrest_p_)
-       lastrest_p_->add_column (c);
-    }
+  /* 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;
+  stop_moment_ = now_mom () + get_event_length (rest_ev_, now_mom ());
+  /*
+  if (ASSIGN_EVENT_ONCE (rest_ev_, ev))
+    stop_moment_ = now_mom () + get_event_length (rest_ev_);
+  */
 }
 
-bool
-Multi_measure_rest_engraver::do_try_music (Music* req_l)
+IMPLEMENT_TRANSLATOR_LISTENER (Multi_measure_rest_engraver, multi_measure_text);
+void
+Multi_measure_rest_engraver::listen_multi_measure_text (Stream_event *ev)
 {
-  if (Span_req * sp = dynamic_cast<Span_req*> (req_l))
-    {
-      if (sp->span_type_str_ == "rest")
-       {
-         if (sp->span_dir_ == STOP)
-           {
-             stop_req_l_ = sp;
-           }
-         else if (sp->span_dir_ == START && !new_req_l_)
-           {
-             new_req_l_ = sp;
-           }
-         return true;
-       }
-    }
-  return false;
+  text_events_.push_back (ev);
 }
 
-
-
 void
-Multi_measure_rest_engraver::do_process_requests ()
+Multi_measure_rest_engraver::process_music ()
 {
-  if (new_req_l_ && stop_req_l_)
-    stop_req_l_ = 0;
+  if (rest_ev_ && !mmrest_
+      && stop_moment_ > now_mom ())
+    {
+      mmrest_ = make_spanner ("MultiMeasureRest", rest_ev_->self_scm ());
 
-  if (new_req_l_)
-    start_moment_ = now_mom ();
+      Spanner *sp
+        = make_spanner ("MultiMeasureRestNumber", rest_ev_->self_scm ());
+      numbers_.push_back (sp);
 
-  if (stop_req_l_)
-    {
-      busy_span_req_l_ =0;
-      stop_req_l_ = 0;
-    }
-  
-  if (new_req_l_)
-    {
-      busy_span_req_l_ = new_req_l_;
-      new_req_l_ =0;
-    }
+      if (text_events_.size ())
+        {
+          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);
 
-  if (busy_span_req_l_ && !mmrest_p_)
-    {
-      Translator * tr = daddy_grav_l()->get_simple_translator ("Timing_engraver");     // ugh
-      Timing_translator * time = dynamic_cast<Timing_translator*> (tr);
+              numbers_.push_back (sp);
+            }
+
+          /*
+            Stack different scripts.
+          */
+          for (DOWN_and_UP (d))
+            {
+              Grob *last = 0;
+              for (vsize 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];
+                    }
+                }
+            }
+        }
 
-      mmrest_p_ = new Multi_measure_rest;
-      Staff_symbol_referencer_interface si (mmrest_p_);
-      si.set_interface ();
+      for (vsize i = 0; i < numbers_.size (); i++)
+        {
+          Side_position_interface::add_support (numbers_[i], mmrest_);
+          numbers_[i]->set_parent (mmrest_, Y_AXIS);
+        }
 
-      announce_element (Score_element_info (mmrest_p_, busy_span_req_l_));
-      start_measure_i_
-       = gh_scm2int (time->get_property ("currentBarNumber", 0));
+      start_measure_
+        = scm_to_int (get_property ("internalBarNumber"));
     }
+
+  bar_seen_ = bar_seen_ || scm_is_string (get_property ("whichBar"));
 }
 
 void
-Multi_measure_rest_engraver::do_pre_move_processing ()
+Multi_measure_rest_engraver::stop_translation_timestep ()
 {
-  Moment now (now_mom ());
-  Translator * tr = daddy_grav_l()->get_simple_translator ("Timing_engraver"); // ugh
-  Timing_translator * time  = dynamic_cast<Timing_translator*> (tr);
+  /* We cannot do this earlier, as breakableSeparationItem is not yet
+     there.
 
-  if (mmrest_p_ && (now >= start_moment_) 
-    && !time->measure_position ()
-    && (scm_ilength (mmrest_p_->get_elt_property ("columns")) >= 2))
+     Actually, we no longer use breakableSeparationItem -- should this be moved?
+     -- jneem */
+  if (bar_seen_)
     {
-      typeset_element (mmrest_p_);
-      /*
-       must keep mmrest_p_ around to set measures_i_
-       */
+      Grob *cmc = unsmob_grob (get_property ("currentCommandColumn"));
+
+      /* Ugh, this is a kludge - need this for multi-measure-rest-grace.ly  */
+      last_command_item_ = dynamic_cast<Item *> (cmc);
     }
-  if (lastrest_p_)
+
+  if (last_command_item_ && (mmrest_ || last_rest_))
     {
-      typeset_element (lastrest_p_);
-      lastrest_p_ = 0;
+      if (last_rest_)
+        {
+          add_bound_item (last_rest_, last_command_item_);
+          for (vsize 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 (vsize i = 0; i < numbers_.size (); i++)
+            add_bound_item (numbers_[i], last_command_item_);
+
+          last_command_item_ = 0;
+        }
     }
 
-  if (new_req_l_)
+  Moment mp (robust_scm2moment (get_property ("measurePosition"), Moment (0)));
+  if (last_rest_)
     {
-      busy_span_req_l_ = new_req_l_;
-      new_req_l_ =0;
+      last_rest_ = 0;
+      last_numbers_.clear ();
     }
-  
+
+  text_events_.clear ();
+  bar_seen_ = false;
 }
 
 void
-Multi_measure_rest_engraver::do_post_move_processing ()
+Multi_measure_rest_engraver::start_translation_timestep ()
 {
-  Translator * tr = daddy_grav_l()->get_simple_translator ("Timing_engraver"); // ugh
-  Timing_translator * time  = dynamic_cast<Timing_translator*> (tr);
+  if (now_mom ().main_part_ >= stop_moment_.main_part_)
+    rest_ev_ = 0;
 
-  Moment now (now_mom ());
+  Moment mp (robust_scm2moment (get_property ("measurePosition"), Moment (0)));
 
-  if (mmrest_p_ && !time->measure_position ())
+  Moment now = now_mom ();
+  if (mmrest_
+      && now.main_part_ != last_main_moment_
+      && mp.main_part_ == Rational (0))
     {
-      lastrest_p_ = mmrest_p_;
-      int cur = gh_scm2int (time->get_property ("currentBarNumber", 0));
-      lastrest_p_->set_elt_property ("measure-count",
-                                    gh_int2scm (cur - start_measure_i_));
-      mmrest_p_ = 0;
+      last_rest_ = mmrest_;
+      last_numbers_ = numbers_;
+
+      int cur = scm_to_int (get_property ("internalBarNumber"));
+      int num = cur - start_measure_;
+
+      /*
+        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));
+
+      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);
+            }
+        }
     }
-}
 
+  last_main_moment_ = now.main_part_;
+}
 
 void
-Multi_measure_rest_engraver::do_removal_processing ()
+Multi_measure_rest_engraver::finalize ()
 {
-  if (mmrest_p_)
-    typeset_element (mmrest_p_);
-  if (lastrest_p_)
-    typeset_element (lastrest_p_);
 }
+
+ADD_TRANSLATOR (Multi_measure_rest_engraver,
+                /* 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 ",
+
+                /* write */
+                ""
+               );