]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/spacing-engraver.cc
Run grand-replace (issue 3765)
[lilypond.git] / lily / spacing-engraver.cc
index 4aeebc586a74437cb19134e810808aaa32b542f7..80892fac6bed75ba90fdab2c27f04e496fcce436 100644 (file)
@@ -1,18 +1,33 @@
 /*
-  spacing-engraver.cc -- implement Spacing_engraver
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 1999--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 1999--2005 Han-Wen Nienhuys <hanwen@cs.uu.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 "paper-column.hh"
 #include "engraver.hh"
-#include "pqueue.hh"
+#include "moment.hh"
 #include "note-spacing.hh"
-#include "staff-spacing.hh"
-#include "group-interface.hh"
+#include "paper-column.hh"
+#include "pointer-group-interface.hh"
+#include "pqueue.hh"
 #include "spanner.hh"
+#include "staff-spacing.hh"
+#include "stream-event.hh"
+
+#include "translator.icc"
 
 struct Rhythmic_tuple
 {
@@ -30,59 +45,95 @@ struct Rhythmic_tuple
   static int time_compare (Rhythmic_tuple const &, Rhythmic_tuple const &);
 };
 
-/**
-   Acknowledge rhythmic elements, for initializing spacing fields in
-   the columns.
+inline int
+compare (Rhythmic_tuple const &a, Rhythmic_tuple const &b)
+{
+  return Rhythmic_tuple::time_compare (a, b);
+}
+
+int
+Rhythmic_tuple::time_compare (Rhythmic_tuple const &h1,
+                              Rhythmic_tuple const &h2)
+{
+  return (h1.end_ - h2.end_).main_part_.sign ();
+}
+
+/****************************************************************/
 
-   should be the  last one of the toplevel context
+/*
+  Acknowledge rhythmic elements, for initializing spacing fields in
+  the columns.
 */
 class Spacing_engraver : public Engraver
 {
   PQueue<Rhythmic_tuple> playing_durations_;
-  Array<Rhythmic_tuple> now_durations_;
-  Array<Rhythmic_tuple> stopped_durations_;
+  vector<Rhythmic_tuple> now_durations_;
+  vector<Rhythmic_tuple> stopped_durations_;
   Moment now_;
   Spanner *spacing_;
+  Stream_event *start_section_;
 
   TRANSLATOR_DECLARATIONS (Spacing_engraver);
+
 protected:
-  virtual void acknowledge_grob (Grob_info);
-  virtual void start_translation_timestep ();
-  virtual void stop_translation_timestep ();
-  virtual void process_music ();
+  DECLARE_ACKNOWLEDGER (staff_spacing);
+  DECLARE_ACKNOWLEDGER (note_spacing);
+  DECLARE_ACKNOWLEDGER (rhythmic_head);
+  DECLARE_ACKNOWLEDGER (rhythmic_grob);
+  DECLARE_TRANSLATOR_LISTENER (spacing_section);
+
+  void start_translation_timestep ();
+  void stop_translation_timestep ();
+  void process_music ();
+  void add_starter_duration (Grob_info i);
+
   virtual void finalize ();
+
+  void start_spanner ();
+  void stop_spanner ();
 };
 
-inline int
-compare (Rhythmic_tuple const &a, Rhythmic_tuple const &b)
+Spacing_engraver::Spacing_engraver ()
 {
-  return Rhythmic_tuple::time_compare (a, b);
+  spacing_ = 0;
+  start_section_ = 0;
 }
 
-int
-Rhythmic_tuple::time_compare (Rhythmic_tuple const &h1,
-                             Rhythmic_tuple const &h2)
+IMPLEMENT_TRANSLATOR_LISTENER (Spacing_engraver, spacing_section);
+void
+Spacing_engraver::listen_spacing_section (Stream_event *ev)
 {
-  return (h1.end_ - h2.end_).main_part_.sign ();
+  ASSIGN_EVENT_ONCE (start_section_, ev);
 }
 
-Spacing_engraver::Spacing_engraver ()
+void
+Spacing_engraver::process_music ()
 {
-  spacing_ = 0;
+  if (start_section_ && spacing_)
+    stop_spanner ();
+
+  if (!spacing_)
+    start_spanner ();
 }
 
 void
-Spacing_engraver::process_music ()
+Spacing_engraver::start_spanner ()
 {
-  if (!spacing_)
-    {
-      spacing_ = make_spanner ("SpacingSpanner", SCM_EOL);
-      spacing_->set_bound (LEFT, unsmob_grob (get_property ("currentCommandColumn")));
-    }
+  assert (!spacing_);
+
+  spacing_ = make_spanner ("SpacingSpanner", SCM_EOL);
+  spacing_->set_bound (LEFT,
+                       unsmob_grob (get_property ("currentCommandColumn")));
 }
 
 void
 Spacing_engraver::finalize ()
+{
+  stop_spanner ();
+}
+
+void
+Spacing_engraver::stop_spanner ()
 {
   if (spacing_)
     {
@@ -94,15 +145,34 @@ Spacing_engraver::finalize ()
 }
 
 void
-Spacing_engraver::acknowledge_grob (Grob_info i)
+Spacing_engraver::acknowledge_note_spacing (Grob_info i)
 {
-  if (Note_spacing::has_interface (i.grob ()) || Staff_spacing::has_interface (i.grob ()))
-    {
-      Pointer_group_interface::add_grob (spacing_, ly_symbol2scm ("wishes"), i.grob ());
-    }
+  Pointer_group_interface::add_grob (spacing_, ly_symbol2scm ("wishes"), i.grob ());
+}
 
+void
+Spacing_engraver::acknowledge_staff_spacing (Grob_info i)
+{
+  Pointer_group_interface::add_grob (spacing_, ly_symbol2scm ("wishes"), i.grob ());
+}
+
+void
+Spacing_engraver::acknowledge_rhythmic_grob (Grob_info i)
+{
+  add_starter_duration (i);
+}
+
+void
+Spacing_engraver::acknowledge_rhythmic_head (Grob_info i)
+{
+  add_starter_duration (i);
+}
+
+void
+Spacing_engraver::add_starter_duration (Grob_info i)
+{
   if (i.grob ()->internal_has_interface (ly_symbol2scm ("lyric-syllable-interface"))
-      || i.grob ()->internal_has_interface (ly_symbol2scm ("multi-measure-event")))
+      || i.grob ()->internal_has_interface (ly_symbol2scm ("multi-measure-interface")))
     return;
 
   /*
@@ -110,72 +180,105 @@ Spacing_engraver::acknowledge_grob (Grob_info i)
   */
   if (!now_.grace_part_)
     {
-      Music *r = i.music_cause ();
-      if (r && r->is_mus_type ("rhythmic-event"))
-       {
-         Moment len = r->get_length ();
-         Rhythmic_tuple t (i, now_mom () + len);
-         now_durations_.push (t);
-       }
+      Stream_event *r = i.event_cause ();
+      if (r && r->in_event_class ("rhythmic-event"))
+        {
+          Moment len = get_event_length (r, now_);
+          Rhythmic_tuple t (i, now_mom () + len);
+          now_durations_.push_back (t);
+        }
     }
 }
 
 void
 Spacing_engraver::stop_translation_timestep ()
 {
+  Paper_column *musical_column
+    = dynamic_cast<Paper_column *> (unsmob_grob (get_property ("currentMusicalColumn")));
+
+  if (!spacing_)
+    start_spanner ();
+
+  musical_column->set_object ("spacing", spacing_->self_scm ());
+  unsmob_grob (get_property ("currentCommandColumn"))
+  ->set_object ("spacing", spacing_->self_scm ());
+
+  SCM proportional = get_property ("proportionalNotationDuration");
+  if (unsmob_moment (proportional))
+    {
+      musical_column->set_property ("shortest-playing-duration", proportional);
+      musical_column->set_property ("shortest-starter-duration", proportional);
+      musical_column->set_property ("used", SCM_BOOL_T);
+      return;
+    }
+
   Moment shortest_playing;
   shortest_playing.set_infinite (1);
-  for (int i = 0; i < playing_durations_.size (); i++)
+  for (vsize i = 0; i < playing_durations_.size (); i++)
     {
-      Music *mus = playing_durations_[i].info_.music_cause ();
-      if (mus)
-       {
-         Moment m = mus->get_length ();
-         shortest_playing = min (shortest_playing, m);
-       }
+      Stream_event *ev = playing_durations_[i].info_.event_cause ();
+      if (ev)
+        {
+          Moment m = get_event_length (ev);
+          shortest_playing = min (shortest_playing, m);
+        }
     }
   Moment starter;
   starter.set_infinite (1);
 
-  for (int i = 0; i < now_durations_.size (); i++)
+  for (vsize i = 0; i < now_durations_.size (); i++)
     {
-      Moment m = now_durations_[i].info_.music_cause ()->get_length ();
+      Moment m = get_event_length (now_durations_[i].info_.event_cause ());
       if (m.to_bool ())
-       {
-         starter = min (starter, m);
-         playing_durations_.insert (now_durations_[i]);
-       }
+        {
+          starter = min (starter, m);
+          playing_durations_.insert (now_durations_[i]);
+        }
     }
   now_durations_.clear ();
 
   shortest_playing = min (shortest_playing, starter);
 
-  Paper_column *sc
-    = dynamic_cast<Paper_column *> (unsmob_grob (get_property ("currentMusicalColumn")));
-
   assert (starter.to_bool ());
   SCM sh = shortest_playing.smobbed_copy ();
   SCM st = starter.smobbed_copy ();
 
-  sc->set_property ("shortest-playing-duration", sh);
-  sc->set_property ("shortest-starter-duration", st);
+  musical_column->set_property ("shortest-playing-duration", sh);
+  musical_column->set_property ("shortest-starter-duration", st);
 }
 
 void
 Spacing_engraver::start_translation_timestep ()
 {
+  start_section_ = 0;
+
   now_ = now_mom ();
   stopped_durations_.clear ();
+
   while (playing_durations_.size () && playing_durations_.front ().end_ < now_)
     playing_durations_.delmin ();
   while (playing_durations_.size () && playing_durations_.front ().end_ == now_)
-    stopped_durations_.push (playing_durations_.get ());
+    stopped_durations_.push_back (playing_durations_.get ());
 }
 
+ADD_ACKNOWLEDGER (Spacing_engraver, staff_spacing);
+ADD_ACKNOWLEDGER (Spacing_engraver, note_spacing);
+ADD_ACKNOWLEDGER (Spacing_engraver, rhythmic_head);
+ADD_ACKNOWLEDGER (Spacing_engraver, rhythmic_grob);
+
 ADD_TRANSLATOR (Spacing_engraver,
-               /* descr */ "make a SpacingSpanner and do bookkeeping of shortest starting and playing notes  ",
-               /* creats*/ "SpacingSpanner",
-               /* accepts */ "",
-               /* acks  */ "grob-interface",
-               /* reads */ "",
-               /* write */ "");
+                /* doc */
+                "Make a @code{SpacingSpanner} and do bookkeeping of shortest"
+                " starting and playing notes.",
+
+                /* create */
+                "SpacingSpanner ",
+
+                /* read */
+                "currentMusicalColumn "
+                "currentCommandColumn "
+                "proportionalNotationDuration ",
+
+                /* write */
+                ""
+               );