]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/spacing-engraver.cc
Release: bump VERSION_DEVEL.
[lilypond.git] / lily / spacing-engraver.cc
index 0f26e7ca16c17c2949835f847d1afb113f2e4a2f..00dc8227609b68fd2eb067d317399d1b678057b2 100644 (file)
-/*   
-  spacing-engraver.cc --  implement Spacing_engraver
-  
-  source file of the GNU LilyPond music typesetter
-  
-  (c) 1999--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-  
- */
-
-#include "musical-request.hh"
+/*
+  This file is part of LilyPond, the GNU music typesetter.
+
+  Copyright (C) 1999--2015 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 "engraver.hh"
+#include "moment.hh"
+#include "note-spacing.hh"
 #include "paper-column.hh"
-#include "spacing-engraver.hh"
-#include "spacing-spanner.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
+{
+  Grob_info info_;
+  Moment end_;
+
+  Rhythmic_tuple ()
+  {
+  }
+  Rhythmic_tuple (Grob_info i, Moment m)
+  {
+    info_ = i;
+    end_ = m;
+  }
+  static int time_compare (Rhythmic_tuple const &, Rhythmic_tuple const &);
+};
 
 inline int
 compare (Rhythmic_tuple const &a, Rhythmic_tuple const &b)
 {
-  return Rhythmic_tuple::time_compare (a,b);
+  return Rhythmic_tuple::time_compare (a, b);
 }
 
 int
 Rhythmic_tuple::time_compare (Rhythmic_tuple const &h1,
-                             Rhythmic_tuple const &h2)
+                              Rhythmic_tuple const &h2)
+{
+  return (h1.end_ - h2.end_).main_part_.sign ();
+}
+
+/****************************************************************/
+
+/*
+  Acknowledge rhythmic elements, for initializing spacing fields in
+  the columns.
+*/
+class Spacing_engraver : public Engraver
+{
+  PQueue<Rhythmic_tuple> playing_durations_;
+  vector<Rhythmic_tuple> now_durations_;
+  vector<Rhythmic_tuple> stopped_durations_;
+  Moment now_;
+  Spanner *spacing_;
+  Stream_event *start_section_;
+
+  TRANSLATOR_DECLARATIONS (Spacing_engraver);
+
+protected:
+  void acknowledge_staff_spacing (Grob_info);
+  void acknowledge_note_spacing (Grob_info);
+  void acknowledge_rhythmic_head (Grob_info);
+  void acknowledge_rhythmic_grob (Grob_info);
+  void listen_spacing_section (Stream_event *);
+
+  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 ();
+};
+
+Spacing_engraver::Spacing_engraver (Context *c)
+  : Engraver (c)
 {
-  
-  return (h1.end_ - h2.end_ ).sign ();
+  spacing_ = 0;
+  start_section_ = 0;
 }
 
-Spacing_engraver::Spacing_engraver()
+void
+Spacing_engraver::listen_spacing_section (Stream_event *ev)
 {
-  spacing_p_ = 0;
+  ASSIGN_EVENT_ONCE (start_section_, ev);
 }
 
 void
-Spacing_engraver::do_creation_processing ()
+Spacing_engraver::process_music ()
 {
-  spacing_p_  =new Spacing_spanner (SCM_EOL);
-  spacing_p_->set_bound (LEFT, unsmob_element (get_property ("currentCommandColumn")));  
-  announce_element (Score_element_info (spacing_p_, 0));
+  if (start_section_ && spacing_)
+    stop_spanner ();
+
+  if (!spacing_)
+    start_spanner ();
 }
 
 void
-Spacing_engraver::do_removal_processing ()
+Spacing_engraver::start_spanner ()
 {
-  Score_element * p = unsmob_element (get_property ("currentCommandColumn"));
-  spacing_p_->set_bound (RIGHT, p);
-  typeset_element (spacing_p_);
-  spacing_p_ =0;
+  assert (!spacing_);
+
+  spacing_ = make_spanner ("SpacingSpanner", SCM_EOL);
+  spacing_->set_bound (LEFT,
+                       unsmob<Grob> (get_property ("currentCommandColumn")));
 }
 
 void
-Spacing_engraver::acknowledge_element (Score_element_info i)
+Spacing_engraver::finalize ()
 {
-  if (to_boolean (i.elem_l_->get_elt_property ("grace")))
-    return;
+  stop_spanner ();
+}
+
+void
+Spacing_engraver::stop_spanner ()
+{
+  if (spacing_)
+    {
+      Grob *p = unsmob<Grob> (get_property ("currentCommandColumn"));
+
+      spacing_->set_bound (RIGHT, p);
+      spacing_ = 0;
+    }
+}
+
+void
+Spacing_engraver::acknowledge_note_spacing (Grob_info i)
+{
+  Pointer_group_interface::add_grob (spacing_, ly_symbol2scm ("wishes"), i.grob ());
+}
 
-  if (to_boolean (i.elem_l_->get_elt_property ("non-rhythmic")))
+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-interface")))
     return;
-  
-  if (Rhythmic_req * r = dynamic_cast<Rhythmic_req*>(i.req_l_))
+
+  /*
+    only pay attention to durations that are not grace notes.
+  */
+  if (!now_.grace_part_)
     {
-      Rhythmic_tuple t(i, now_mom () + r->length_mom ());
-      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::do_pre_move_processing ()
+Spacing_engraver::stop_translation_timestep ()
 {
+  Paper_column *musical_column
+    = unsmob<Paper_column> (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++)
     {
-      Moment m = (playing_durations_[i].info_.req_l_)->length_mom ();
-      if (m)
-       {
-         shortest_playing = 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, inf;
-  inf.set_infinite (1);
-  starter=inf;
-  for (int i=0; i < now_durations_.size (); i++)
-    {
-      Moment m = now_durations_[i].info_.req_l_->length_mom ();
-      if (m)
-       starter = starter <? m;
+  Moment starter;
+  starter.set_infinite (1);
 
-      playing_durations_.insert (now_durations_[i]);
+  for (vsize i = 0; i < now_durations_.size (); i++)
+    {
+      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]);
+        }
     }
   now_durations_.clear ();
-  
-  shortest_playing = shortest_playing <? starter;
-  
-  Paper_column * sc
-    = dynamic_cast<Paper_column*> (unsmob_element (get_property ("currentMusicalColumn")));
 
-  SCM sh = smobify (new Moment (shortest_playing));
-  SCM st = smobify (new Moment (starter));
+  shortest_playing = min (shortest_playing, starter);
+
+  assert (starter.to_bool ());
+  SCM sh = shortest_playing.smobbed_copy ();
+  SCM st = starter.smobbed_copy ();
 
-  sc->set_elt_property ("shortest-playing-duration", sh);  
-  sc->set_elt_property ("shortest-starter-duration", st);
+  musical_column->set_property ("shortest-playing-duration", sh);
+  musical_column->set_property ("shortest-starter-duration", st);
 }
 
 void
-Spacing_engraver::do_post_move_processing ()
+Spacing_engraver::start_translation_timestep ()
 {
-  Moment now = now_mom ();
+  start_section_ = 0;
+
+  now_ = now_mom ();
   stopped_durations_.clear ();
-  while (playing_durations_.size () && playing_durations_.front ().end_ < now)
+
+  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 ());
+  while (playing_durations_.size () && playing_durations_.front ().end_ == now_)
+    stopped_durations_.push_back (playing_durations_.get ());
+}
+
+
+void
+Spacing_engraver::boot ()
+{
+  ADD_LISTENER (Spacing_engraver, spacing_section);
+  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_THIS_TRANSLATOR(Spacing_engraver);
+ADD_TRANSLATOR (Spacing_engraver,
+                /* doc */
+                "Make a @code{SpacingSpanner} and do bookkeeping of shortest"
+                " starting and playing notes.",
+
+                /* create */
+                "SpacingSpanner ",
 
+                /* read */
+                "currentMusicalColumn "
+                "currentCommandColumn "
+                "proportionalNotationDuration ",
 
+                /* write */
+                ""
+               );