]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/tuplet-engraver.cc
Doc-es: various updates.
[lilypond.git] / lily / tuplet-engraver.cc
index f2838a32c46d2383491d1e7b053aafa8b1a2bdaa..61f623c54638d435d90b71212ac429b7cb48bf3c 100644 (file)
@@ -1,30 +1,54 @@
-/*   
-  tuplet-engraver.cc --  implement Tuplet_engraver
-  
-  source file of the GNU LilyPond music typesetter
-  
-  (c) 1998--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-  
- */
+/*
+  This file is part of LilyPond, the GNU music typesetter.
+
+  Copyright (C) 1998--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 "tuplet-bracket.hh"
-#include "note-column.hh"
-#include "time-scaled-music.hh"
 #include "beam.hh"
-#include "music-list.hh"
 #include "engraver.hh"
+#include "international.hh"
+#include "note-column.hh"
 #include "spanner.hh"
+#include "stream-event.hh"
+#include "tuplet-bracket.hh"
+#include "warn.hh"
+#include "item.hh"
+#include "moment.hh"
+
+#include "translator.icc"
 
 struct Tuplet_description
 {
-  Music *music_;
-  Rational stop_;
-  Rational span_stop_;
-  Spanner *spanner_;
-  Tuplet_description()
+  Stream_event *event_;
+  Spanner *bracket_;
+  Spanner *number_;
+
+  bool full_length_;
+  bool full_length_note_;
+  Moment stop_moment_;
+  Moment start_moment_;
+  Moment length_;
+
+  Tuplet_description ()
   {
-    music_ = 0;
-    spanner_ = 0;
+    event_ = 0;
+    full_length_note_ = false;
+    full_length_ = false;
+    bracket_ = 0;
+    number_ = 0;
   }
 };
 
@@ -34,112 +58,242 @@ public:
   TRANSLATOR_DECLARATIONS (Tuplet_engraver);
 
 protected:
-  Array<Tuplet_description> tuplets_;
+  vector<Tuplet_description> tuplets_;
+  vector<Tuplet_description> new_tuplets_;
+  vector<Tuplet_description> stopped_tuplets_;
+  vector<Spanner *> last_tuplets_;
 
-  virtual void acknowledge_grob (Grob_info);
-  virtual bool try_music (Music*r);
-  virtual void start_translation_timestep ();
-  virtual void process_music ();
+  void acknowledge_note_column (Grob_info);
+  void acknowledge_script (Grob_info);
+  void acknowledge_finger (Grob_info);
+  void acknowledge_string_number (Grob_info);
+  void listen_tuplet_span (Stream_event *);
+  virtual void finalize ();
+  void start_translation_timestep ();
+  void process_music ();
 };
 
-bool
-Tuplet_engraver::try_music (Music *music)
+void
+Tuplet_engraver::listen_tuplet_span (Stream_event *ev)
 {
-  if (music->is_mus_type ("time-scaled-music"))
+  Direction dir = to_dir (ev->get_property ("span-direction"));
+  if (dir == START)
     {
-      Music *el = unsmob_music (music->get_property ("element"));
-      if (el && !el->is_mus_type ("event-chord"))
-       {
-         Tuplet_description d;
-         d.music_ = music;
-         d.stop_  = now_mom ().main_part_ + music->get_length ().main_part_;
-         d.span_stop_ = d.stop_;
-         
-         SCM s = get_property ("tupletSpannerDuration");
-         if (unsmob_moment (s))
-           d.span_stop_ = d.span_stop_ <? (now_mom () + *unsmob_moment (s)).main_part_;
-         
-         tuplets_.push (d);
-       }
-      return true;
+      Tuplet_description d;
+      d.event_ = ev;
+
+      d.length_ = robust_scm2moment (d.event_->get_property ("length"),
+                                     Moment (0));
+      d.start_moment_ = now_mom ();
+      d.stop_moment_ = now_mom () + d.length_;
+
+      for (vsize i = 0; i < new_tuplets_.size (); i++)
+        {
+          /*
+            discard duplicates.
+          */
+          if (new_tuplets_[i].stop_moment_ == d.stop_moment_)
+            return;
+        }
+
+      new_tuplets_.push_back (d);
     }
-  return false;
+  else if (dir == STOP)
+    {
+      if (tuplets_.size ())
+        {
+          stopped_tuplets_.push_back (tuplets_.back ());
+          tuplets_.pop_back ();
+        }
+      else if (!to_boolean (get_property ("skipTypesetting")))
+        ev->origin ()->debug_output (_ ("No tuplet to end"));
+    }
+  else
+    ev->origin ()->programming_error ("direction tuplet-span-event_ invalid.");
 }
 
 void
 Tuplet_engraver::process_music ()
 {
-  for (int i= 0; i < tuplets_.size (); i++)
+  /*
+    This may happen if the end of a tuplet is part of a quoted voice.
+   */
+  Moment now = now_mom ();
+  for (vsize i = tuplets_.size (); i--;)
     {
-      if (tuplets_[i].spanner_)
-       continue;
-
-      Spanner* spanner = make_spanner ("TupletBracket",
-                                      tuplets_[i].music_->self_scm ());
-      tuplets_[i].spanner_ = spanner;
-
-      SCM proc = get_property ("tupletNumberFormatFunction");
-      if (ly_c_procedure_p (proc))
-       {
-         SCM t = scm_apply_0 (proc, scm_list_1 (tuplets_[i].music_->self_scm ()));
-         spanner->set_property ("text", t);
-       }
+      if (tuplets_[i].stop_moment_ == now)
+        {
+          stopped_tuplets_.push_back (tuplets_[i]);
+          tuplets_.erase (tuplets_.begin () + i);
+        }
+    }
+
+  for (vsize i = 0; i < stopped_tuplets_.size (); i++)
+    {
+      Spanner *bracket = stopped_tuplets_[i].bracket_;
+      Spanner *number = stopped_tuplets_[i].number_;
+      if (bracket)
+        {
+          if (stopped_tuplets_[i].full_length_)
+            {
+              Item *col
+                = unsmob<Item> (stopped_tuplets_[i].full_length_note_
+                               ? get_property ("currentMusicalColumn")
+                               : get_property ("currentCommandColumn"));
+
+              bracket->set_bound (RIGHT, col);
+              number->set_bound (RIGHT, col);
+            }
+          else if (!bracket->get_bound (RIGHT))
+            {
+              if (bracket->get_bound (LEFT))
+                {
+                  bracket->set_bound (RIGHT,
+                                      bracket->get_bound (LEFT));
+                  number->set_bound (RIGHT,
+                                     stopped_tuplets_[i].bracket_->get_bound (LEFT));
+                }
+              else
+                {
+                  warning ("omitting tuplet bracket with neither left nor right bound");
+                  continue;
+                }
+            }
+          // todo: scrap last_tuplets_, use stopped_tuplets_ only.
+          // clear stopped_tuplets_ at start_translation_timestep
+          last_tuplets_.push_back (bracket);
+          last_tuplets_.push_back (number);
+        }
+    }
+  stopped_tuplets_.clear ();
+
+  concat (tuplets_, new_tuplets_);
+  new_tuplets_.clear ();
+  for (vsize j = tuplets_.size (); j > 0; j--)
+    {
+      /* i goes from size-1 downto 0, inclusively */
+      vsize i = j - 1;
+
+      if (tuplets_[i].bracket_)
+        continue;
+
+      tuplets_[i].full_length_ = to_boolean (get_property ("tupletFullLength"));
+      tuplets_[i].full_length_note_
+        = to_boolean (get_property ("tupletFullLengthNote"));
+
+      tuplets_[i].bracket_ = make_spanner ("TupletBracket",
+                                           tuplets_[i].event_->self_scm ());
+      tuplets_[i].number_ = make_spanner ("TupletNumber",
+                                          tuplets_[i].event_->self_scm ());
+      tuplets_[i].number_->set_object ("bracket", tuplets_[i].bracket_->self_scm ());
+      tuplets_[i].number_->set_parent (tuplets_[i].bracket_, X_AXIS);
+      tuplets_[i].number_->set_parent (tuplets_[i].bracket_, Y_AXIS);
+      tuplets_[i].bracket_->set_object ("tuplet-number", tuplets_[i].number_->self_scm ());
+      tuplets_[i].stop_moment_.grace_part_ = 0;
+
+      if (i + 1 < tuplets_.size () && tuplets_[i + 1].bracket_)
+        Tuplet_bracket::add_tuplet_bracket (tuplets_[i].bracket_, tuplets_[i + 1].bracket_);
+
+      if (i > 0 && tuplets_[i - 1].bracket_)
+        Tuplet_bracket::add_tuplet_bracket (tuplets_[i - 1].bracket_, tuplets_[i].bracket_);
+
     }
 }
 
 void
-Tuplet_engraver::acknowledge_grob (Grob_info i)
+Tuplet_engraver::acknowledge_note_column (Grob_info inf)
 {
-  if (Note_column::has_interface (i.grob_))
-    {
-      for (int j =0; j < tuplets_.size (); j++)
-       if (tuplets_[j].spanner_) 
-         Tuplet_bracket::add_column (tuplets_[j].spanner_,
-                                     dynamic_cast<Item*> (i.grob_));
-    }
+  for (vsize j = 0; j < tuplets_.size (); j++)
+    if (tuplets_[j].bracket_)
+      {
+        Item *i = dynamic_cast<Item *> (inf.grob ());
+        Tuplet_bracket::add_column (tuplets_[j].bracket_, i);
+        add_bound_item (tuplets_[j].number_, i);
+      }
+}
+
+void
+Tuplet_engraver::acknowledge_script (Grob_info inf)
+{
+  for (vsize j = 0; j < tuplets_.size (); j++)
+    if (tuplets_[j].bracket_)
+      {
+        Item *i = dynamic_cast<Item *> (inf.grob ());
+        if (!i->internal_has_interface (ly_symbol2scm ("dynamic-interface")))
+          Tuplet_bracket::add_script (tuplets_[j].bracket_, i);
+      }
+}
+
+void
+Tuplet_engraver::acknowledge_finger (Grob_info inf)
+{
+  for (vsize j = 0; j < tuplets_.size (); j++)
+    if (tuplets_[j].bracket_)
+      {
+        Item *i = dynamic_cast<Item *> (inf.grob ());
+        Tuplet_bracket::add_script (tuplets_[j].bracket_, i);
+      }
+}
+
+void
+Tuplet_engraver::acknowledge_string_number (Grob_info inf)
+{
+  for (vsize j = 0; j < tuplets_.size (); j++)
+    if (tuplets_[j].bracket_)
+      {
+        Item *i = dynamic_cast<Item *> (inf.grob ());
+        Tuplet_bracket::add_script (tuplets_[j].bracket_, i);
+      }
 }
 
 void
 Tuplet_engraver::start_translation_timestep ()
 {
-  Moment now = now_mom ();
+  last_tuplets_.clear ();
+  /*
+    May seem superfluous, but necessary for skipTypesetting.
+   */
+  new_tuplets_.clear ();
+}
 
-  Moment tsd;
-  SCM s = get_property ("tupletSpannerDuration");
-  if (unsmob_moment (s))
-    tsd = unsmob_moment (s)->main_part_;
+void
+Tuplet_engraver::finalize ()
+{
+  if (to_boolean (get_property ("tupletFullLength")))
+    for (vsize i = 0; i < last_tuplets_.size (); i++)
+      {
+        Item *col = unsmob<Item> (get_property ("currentCommandColumn"));
+        last_tuplets_[i]->set_bound (RIGHT, col);
+      }
+}
 
-  for (int i = tuplets_.size (); i--;)
-    {
-      if (now.main_part_ >= tuplets_[i].span_stop_)
-       {
-         if (Spanner *sp = tuplets_[i].spanner_)
-           {
-             if (!sp->get_bound (RIGHT))
-               sp->set_bound (RIGHT, sp->get_bound (LEFT));
-             
-             tuplets_[i].spanner_ = 0;
-           }
-         
-         if (tsd.to_bool ())
-           tuplets_[i].span_stop_ += tsd.main_part_;
-       }
-
-      if (now.main_part_ >= tuplets_[i].stop_)
-       {
-         tuplets_.del (i);
-       }
-    }
+Tuplet_engraver::Tuplet_engraver (Context *c)
+  : Engraver (c)
+{
 }
 
-Tuplet_engraver::Tuplet_engraver ()
+void
+Tuplet_engraver::boot ()
 {
+  ADD_LISTENER (Tuplet_engraver, tuplet_span);
+  ADD_ACKNOWLEDGER (Tuplet_engraver, note_column);
+  ADD_ACKNOWLEDGER (Tuplet_engraver, script);
+  ADD_ACKNOWLEDGER (Tuplet_engraver, finger);
+  ADD_ACKNOWLEDGER (Tuplet_engraver, string_number);
 }
 
-ENTER_DESCRIPTION (Tuplet_engraver,
-/* descr */       "Catch Time_scaled_music and generate appropriate bracket  ",
-/* creats*/       "TupletBracket",
-/* accepts */     "time-scaled-music",
-/* acks  */      "note-column-interface",
-/* reads */       "tupletNumberFormatFunction tupletSpannerDuration",
-/* write */       "");
+ADD_TRANSLATOR (Tuplet_engraver,
+                /* doc */
+                "Catch tuplet events and generate appropriate bracket.",
+
+                /* create */
+                "TupletBracket "
+                "TupletNumber ",
+
+                /* read */
+                "tupletFullLength "
+                "tupletFullLengthNote ",
+
+                /* write */
+                ""
+               );