]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/multi-measure-rest-engraver.cc
Issue 5167/1: Reorganize markup commands to use object properties
[lilypond.git] / lily / multi-measure-rest-engraver.cc
index 6a5d06ed7d975d7cc47188bf62f9b07f7ac5b7c2..ff1e155abc1eaef3d4e8e0fc794425a22d32aa4c 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--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 "proto.hh"
-#include "musical-request.hh"
 #include "multi-measure-rest.hh"
 #include "paper-column.hh"
-#include "engraver-group-engraver.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 
- */
+   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_music ();
-  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 start_translation_timestep ();
+  void listen_multi_measure_rest (Stream_event *);
+  void listen_multi_measure_text (Stream_event *);
+
 private:
-  Span_req * new_req_l_;
-  Span_req * busy_span_req_l_;
-  Span_req * stop_req_l_;
-  int start_measure_i_;
-  Moment start_moment_;
-  
-  Spanner *mmrest_p_;
-  Spanner *lastrest_p_;
+  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);
+
+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_;
+  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_;
 };
 
-ADD_THIS_TRANSLATOR (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)
+{
+}
 
-Multi_measure_rest_engraver::Multi_measure_rest_engraver ()
+void
+Multi_measure_rest_engraver::listen_multi_measure_rest (Stream_event *ev)
 {
-  start_measure_i_ = 0;
-  mmrest_p_  = lastrest_p_ =0;
-  new_req_l_ = busy_span_req_l_ = stop_req_l_ =0;
+  /* 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);
+  /*
+  if (ASSIGN_EVENT_ONCE (rest_ev_, ev))
+    stop_moment_ = now_mom () + get_event_length (rest_ev_);
+  */
+
+  clear_lapsed_events (now);
 }
 
 void
-Multi_measure_rest_engraver::acknowledge_element (Score_element_info i)
+Multi_measure_rest_engraver::listen_multi_measure_text (Stream_event *ev)
 {
-  Item * item = dynamic_cast<Item*> (i.elem_l_); 
-  if (item && Bar::has_interface (item))
-    {
-      if (mmrest_p_)
-       Multi_measure_rest::add_column (mmrest_p_,item);
-      if (lastrest_p_)
-       Multi_measure_rest::add_column (lastrest_p_,item);
-    }
+  text_events_.push_back (ev);
+}
+
+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);
 }
 
-bool
-Multi_measure_rest_engraver::do_try_music (Music* req_l)
+void
+Multi_measure_rest_engraver::clear_lapsed_events (const Moment &now)
 {
-  if (Span_req * sp = dynamic_cast<Span_req*> (req_l))
+  if (now.main_part_ >= stop_moment_.main_part_)
     {
-      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;
-       }
+      rest_ev_ = 0;
+      text_events_.clear ();
     }
-  return false;
 }
 
-
-
 void
-Multi_measure_rest_engraver::do_process_music ()
+Multi_measure_rest_engraver::initialize_grobs ()
 {
-  if (new_req_l_ && stop_req_l_)
-    stop_req_l_ = 0;
-
-  if (new_req_l_)
-    start_moment_ = now_mom ();
+  mmrest_ = make_spanner ("MultiMeasureRest", rest_ev_->self_scm ());
+  text_.push_back (make_spanner ("MultiMeasureRestNumber",
+                                 mmrest_->self_scm ()));
 
-  if (stop_req_l_)
+  if (text_events_.size ())
     {
-      busy_span_req_l_ =0;
-      stop_req_l_ = 0;
+      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);
+        }
+
+      /*
+        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 (new_req_l_)
+
+  for (vsize i = 0; i < text_.size (); i++)
     {
-      busy_span_req_l_ = new_req_l_;
-      new_req_l_ =0;
+      Side_position_interface::add_support (text_[i], mmrest_);
+      text_[i]->set_parent (mmrest_, Y_AXIS);
+      text_[i]->set_parent (mmrest_, X_AXIS);
     }
+}
 
-  if (busy_span_req_l_ && !mmrest_p_)
-    {
-      mmrest_p_ = new Spanner (get_property ("basicMultiMeasureRestProperties"));
+void
+Multi_measure_rest_engraver::reset_grobs ()
+{
+  text_.clear ();
+  mmrest_ = 0;
+}
 
-      Multi_measure_rest::set_interface (mmrest_p_);
-      Staff_symbol_referencer::set_interface (mmrest_p_);
+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);
+
+  Grob *g = text_[0]; // the MultiMeasureRestNumber
+  assert (g);
+  if (scm_is_null (g->get_property ("text")))
+    {
+      SCM thres = get_property ("restNumberThreshold");
+      int t = 1;
+      if (scm_is_number (thres))
+        t = scm_to_int (thres);
 
-      announce_element (Score_element_info (mmrest_p_, busy_span_req_l_));
-      start_measure_i_
-       = gh_scm2int (get_property ("currentBarNumber"));
+      if (n <= t)
+        g->suicide ();
+      else
+        {
+          SCM text = scm_number_to_string (n_scm, scm_from_int (10));
+          g->set_property ("text", text);
+        }
     }
 }
 
 void
-Multi_measure_rest_engraver::do_pre_move_processing ()
+Multi_measure_rest_engraver::process_music ()
 {
-  SCM smp = get_property ("measurePosition");
-  Moment mp =  (unsmob_moment (smp)) ? *unsmob_moment (smp) : Moment (0);
+  const bool measure_end
+  = scm_is_string (get_property ("whichBar"))
+    && (robust_scm2moment (get_property ("measurePosition"),
+                           Moment (0)).main_part_ == Rational (0));
 
-  if (mmrest_p_ && (now_mom () >= start_moment_) 
-    && !mp
-    && (scm_ilength (mmrest_p_->get_elt_property ("columns")) >= 2))
-    {
-      typeset_element (mmrest_p_);
-      /*
-       must keep mmrest_p_ around to set measures_i_
-       */
-    }
-  if (lastrest_p_)
+  if (measure_end || first_time_)
     {
-      typeset_element (lastrest_p_);
-      lastrest_p_ = 0;
+      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 ();
+        }
     }
 
-  if (new_req_l_)
+  // Create new grobs if a rest event is (still) active.
+  if (!grobs_initialized () && rest_ev_)
     {
-      busy_span_req_l_ = new_req_l_;
-      new_req_l_ =0;
+      initialize_grobs ();
+      text_events_.clear ();
+
+      if (last_command_item_)
+        {
+          add_bound_item_to_grobs (last_command_item_);
+          last_command_item_ = 0;
+        }
+
+      start_measure_ = scm_to_int (get_property ("internalBarNumber"));
     }
-  
+
+  first_time_ = false;
 }
 
 void
-Multi_measure_rest_engraver::do_post_move_processing ()
+Multi_measure_rest_engraver::start_translation_timestep ()
 {
-  Moment now (now_mom ());
-  
-  
-  SCM smp = get_property ("measurePosition");
-  Moment mp =  (unsmob_moment (smp)) ? *unsmob_moment (smp) : Moment (0);
-  
-  if (mmrest_p_ && !mp)
-    {
-      lastrest_p_ = mmrest_p_;
-      int cur = gh_scm2int (get_property ("currentBarNumber"));
-      lastrest_p_->set_elt_property ("measure-count",
-                                    gh_int2scm (cur - start_measure_i_));
-      mmrest_p_ = 0;
-    }
+  clear_lapsed_events (now_mom ());
 }
 
-
 void
-Multi_measure_rest_engraver::do_removal_processing ()
+Multi_measure_rest_engraver::boot ()
 {
-  if (mmrest_p_)
-    typeset_element (mmrest_p_);
-  if (lastrest_p_)
-    typeset_element (lastrest_p_);
+  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 */
+                "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 */
+                ""
+               );