]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/beam-engraver.cc
Issue 5167/6: Changes: show \markup xxx = ... \etc assignments
[lilypond.git] / lily / beam-engraver.cc
index 39ee8c6f3db538ef6e386fef25e697a68a49e516..f252eea5e2a1037c715ac72ef3aaf700bea8a0c0 100644 (file)
@@ -1,42 +1,60 @@
 /*
-  beam-engraver.cc -- implement Beam_engraver
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 1998--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 1998--2006 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 "beam.hh"
-#include "stem.hh"
-#include "warn.hh"
-#include "beaming.hh"
-#include "score-engraver.hh"
-#include "rest.hh"
+#include "beaming-pattern.hh"
+#include "context.hh"
+#include "directional-element-interface.hh"
 #include "drul-array.hh"
+#include "duration.hh"
+#include "engraver.hh"
+#include "international.hh"
 #include "item.hh"
+#include "rest.hh"
 #include "spanner.hh"
-#include "context.hh"
-#include "duration.hh"
+#include "stream-event.hh"
+#include "stem.hh"
+#include "unpure-pure-container.hh"
+#include "warn.hh"
 
 #include "translator.icc"
 
 class Beam_engraver : public Engraver
 {
 public:
-  DECLARE_ACKNOWLEDGER (stem);
-  DECLARE_ACKNOWLEDGER (rest);
+  void acknowledge_stem (Grob_info);
+  void acknowledge_rest (Grob_info);
+  void listen_beam (Stream_event *);
+
 protected:
-  Music *start_ev_;
+  Stream_event *start_ev_;
 
   Spanner *finished_beam_;
   Spanner *beam_;
-  Music *prev_start_ev_;
+  Stream_event *prev_start_ev_;
 
-  Music *now_stop_ev_;
+  Stream_event *stop_ev_;
 
-  Beaming_info_list *beam_info_;
-  Beaming_info_list *finished_beam_info_;
+  Direction forced_direction_;
+
+  Beaming_pattern *beam_info_;
+  Beaming_pattern *finished_beam_info_;
 
   /// location  within measure where beam started.
   Moment beam_start_location_;
@@ -44,8 +62,8 @@ protected:
   /// moment (global time) where beam started.
   Moment beam_start_mom_;
 
-  bool subdivide_beams_;
-  Moment beat_length_;
+  Beaming_options beaming_options_;
+  Beaming_options finished_beaming_options_;
 
   void typeset_beam ();
   void set_melisma (bool);
@@ -55,7 +73,6 @@ protected:
   void start_translation_timestep ();
   virtual void finalize ();
 
-  virtual bool try_music (Music *);
   void process_music ();
 
   virtual bool valid_start_point ();
@@ -83,35 +100,34 @@ Beam_engraver::valid_end_point ()
   return valid_start_point ();
 }
 
-Beam_engraver::Beam_engraver ()
+Beam_engraver::Beam_engraver (Context *c)
+  : Engraver (c)
 {
   beam_ = 0;
   finished_beam_ = 0;
   finished_beam_info_ = 0;
   beam_info_ = 0;
-  now_stop_ev_ = 0;
+  forced_direction_ = CENTER;
+  stop_ev_ = 0;
   start_ev_ = 0;
   prev_start_ev_ = 0;
 }
 
-bool
-Beam_engraver::try_music (Music *m)
+void
+Beam_engraver::listen_beam (Stream_event *ev)
 {
-  if (m->is_mus_type ("beam-event"))
+  Direction d = to_dir (ev->get_property ("span-direction"));
+
+  if (d == START && valid_start_point ())
     {
-      Direction d = to_dir (m->get_property ("span-direction"));
-      if (d == START && !valid_start_point ())
-       return false;
-      if (d == STOP && !valid_end_point ())
-       return false;
-
-      if (d == START)
-       start_ev_ = m;
-      else if (d == STOP)
-       now_stop_ev_ = m;
-      return true;
+      ASSIGN_EVENT_ONCE (start_ev_, ev);
+
+      Direction updown = to_dir (ev->get_property ("direction"));
+      if (updown)
+        forced_direction_ = updown;
     }
-  return false;
+  else if (d == STOP && valid_end_point ())
+    ASSIGN_EVENT_ONCE (stop_ev_, ev);
 }
 
 void
@@ -125,29 +141,35 @@ Beam_engraver::set_melisma (bool ml)
 void
 Beam_engraver::process_music ()
 {
-  if (beam_ && !to_boolean (get_property ("allowBeamBreak")))
-    get_score_engraver ()->forbid_breaks ();
-
   if (start_ev_)
     {
       if (beam_)
-       {
-         start_ev_->origin ()->warning (_ ("already have a beam"));
-         return;
-       }
+        {
+          start_ev_->origin ()->warning (_ ("already have a beam"));
+          return;
+        }
 
       set_melisma (true);
       prev_start_ev_ = start_ev_;
       beam_ = make_spanner ("Beam", start_ev_->self_scm ());
-      Moment mp (robust_scm2moment (get_property ("measurePosition"), Moment (0)));
+
+      Moment mp (robust_scm2moment (get_property ("measurePosition"),
+                                    Moment (0)));
 
       beam_start_location_ = mp;
       beam_start_mom_ = now_mom ();
 
-      beam_info_ = new Beaming_info_list;
-
+      beaming_options_.from_context (context ());
+      beam_info_ = new Beaming_pattern;
       /* urg, must copy to Auto_beam_engraver too */
     }
+
+  typeset_beam ();
+  if (stop_ev_ && beam_)
+    {
+      announce_end_grob (beam_, stop_ev_->self_scm ());
+
+    }
 }
 
 void
@@ -155,12 +177,26 @@ Beam_engraver::typeset_beam ()
 {
   if (finished_beam_)
     {
-      finished_beam_info_->beamify (beat_length_, subdivide_beams_);
+      Grob *stem = finished_beam_->get_bound (RIGHT);
+      if (!stem)
+        {
+          stem = finished_beam_->get_bound (LEFT);
+          if (stem)
+            finished_beam_->set_bound (RIGHT, stem);
+        }
+
+      if (stem && forced_direction_)
+        set_grob_direction (stem, forced_direction_);
+
+      forced_direction_ = CENTER;
+      finished_beam_info_->beamify (finished_beaming_options_);
+
       Beam::set_beaming (finished_beam_, finished_beam_info_);
 
       delete finished_beam_info_;
       finished_beam_info_ = 0;
       finished_beam_ = 0;
+
     }
 }
 
@@ -170,24 +206,19 @@ Beam_engraver::start_translation_timestep ()
   start_ev_ = 0;
 
   if (beam_)
-    {
-      set_melisma (true);
-
-      subdivide_beams_ = to_boolean (get_property ("subdivideBeams"));
-      beat_length_ = robust_scm2moment (get_property ("beatLength"), Moment (1, 4));
-    }
+    set_melisma (true);
 }
 
 void
 Beam_engraver::stop_translation_timestep ()
 {
-  typeset_beam ();
-  if (now_stop_ev_)
+  if (stop_ev_)
     {
       finished_beam_ = beam_;
       finished_beam_info_ = beam_info_;
+      finished_beaming_options_ = beaming_options_;
 
-      now_stop_ev_ = 0;
+      stop_ev_ = 0;
       beam_ = 0;
       beam_info_ = 0;
       typeset_beam ();
@@ -204,8 +235,8 @@ Beam_engraver::finalize ()
       prev_start_ev_->origin ()->warning (_ ("unterminated beam"));
 
       /*
-       we don't typeset it, (we used to, but it was commented
-       out. Reason unknown) */
+        we don't typeset it, (we used to, but it was commented
+        out. Reason unknown) */
       beam_->suicide ();
       delete beam_info_;
     }
@@ -214,86 +245,113 @@ Beam_engraver::finalize ()
 void
 Beam_engraver::acknowledge_rest (Grob_info info)
 {
-  if (beam_)
-    {
-      chain_offset_callback (info.grob(),
-                            Beam::rest_collision_callback_proc, Y_AXIS);
-    }
+  if (beam_
+      && !scm_is_number (info.grob ()->get_property_data ("staff-position")))
+    chain_offset_callback (info.grob (),
+                           Unpure_pure_container::make_smob
+                             (Beam::rest_collision_callback_proc,
+                              Beam::pure_rest_collision_callback_proc),
+                           Y_AXIS);
 }
 
-
-
 void
 Beam_engraver::acknowledge_stem (Grob_info info)
 {
   if (!beam_)
     return;
-  
+
   Moment now = now_mom ();
   if (!valid_start_point ())
     return;
 
+  // It's suboptimal that we don't support callbacks returning ##f,
+  // but this makes beams have no effect on "stems" reliably in
+  // TabStaff when \tabFullNotation is switched off: the real stencil
+  // callback for beams is called quite late in the process, and we
+  // don't want to trigger it early.
+  if (scm_is_false (beam_->get_property_data ("stencil")))
+    return;
+
   Item *stem = dynamic_cast<Item *> (info.grob ());
   if (Stem::get_beam (stem))
     return;
 
-  
-  
-  Music *m = info.ultimate_music_cause ();
-  if (!m->is_mus_type ("rhythmic-event"))
+  Stream_event *ev = info.ultimate_event_cause ();
+  if (!ev->in_event_class ("rhythmic-event"))
     {
-      String s = _ ("stem must have Rhythmic structure");
-      if (info.music_cause ())
-       info.music_cause ()->origin ()->warning (s);
-      else
-       ::warning (s);
-
+      info.grob ()->warning (_ ("stem must have Rhythmic structure"));
       return;
     }
 
   last_stem_added_at_ = now;
-  int durlog = unsmob_duration (m->get_property ("duration"))->duration_log ();
+
+  Duration *stem_duration = unsmob<Duration> (ev->get_property ("duration"));
+  int durlog = stem_duration->duration_log ();
+  //int durlog = unsmob<Duration> (ev->get_property ("duration"))->duration_log ();
   if (durlog <= 2)
     {
-      m->origin ()->warning (_ ("stem doesn't fit in beam"));
+      ev->origin ()->warning (_ ("stem does not fit in beam"));
       prev_start_ev_->origin ()->warning (_ ("beam was started here"));
       /*
-       don't return, since
+        don't return, since
 
-       [r4 c8] can just as well be modern notation.
+        [r4 c8] can just as well be modern notation.
       */
     }
 
-  stem->set_property ("duration-log",
-                     scm_from_int (durlog));
+  if (forced_direction_)
+    set_grob_direction (stem, forced_direction_);
+
+  stem->set_property ("duration-log", scm_from_int (durlog));
   Moment stem_location = now - beam_start_mom_ + beam_start_location_;
   beam_info_->add_stem (stem_location,
-                       max (durlog- 2, 0));
+                        max (durlog - 2, 0),
+                        Stem::is_invisible (stem),
+                        stem_duration->factor (),
+                        (to_boolean (stem->get_property ("tuplet-start"))));
   Beam::add_stem (beam_, stem);
 }
 
-ADD_ACKNOWLEDGER (Beam_engraver, stem);
-ADD_ACKNOWLEDGER (Beam_engraver, rest);
+
+void
+Beam_engraver::boot ()
+{
+  ADD_LISTENER (Beam_engraver, beam);
+  ADD_ACKNOWLEDGER (Beam_engraver, stem);
+  ADD_ACKNOWLEDGER (Beam_engraver, rest);
+}
 
 ADD_TRANSLATOR (Beam_engraver,
-               /* doc */ "Handles Beam events by engraving Beams.    If omitted, then notes will be "
-               "printed with flags instead of beams.",
-               /* create */ "Beam",
-               /* accept */ "beam-event",
-               /* read */ "beamMelismaBusy beatLength subdivideBeams",
-               /* write */ "");
+                /* doc */
+                "Handle @code{Beam} events by engraving beams.  If omitted,"
+                " then notes are printed with flags instead of beams.",
+
+                /* create */
+                "Beam ",
+
+                /* read */
+                "baseMoment "
+                "beamMelismaBusy "
+                "beatStructure "
+                "subdivideBeams ",
+
+                /* write */
+                "forbidBreak"
+               );
 
 class Grace_beam_engraver : public Beam_engraver
 {
 public:
   TRANSLATOR_DECLARATIONS (Grace_beam_engraver);
+  TRANSLATOR_INHERIT (Beam_engraver);
 
 protected:
   virtual bool valid_start_point ();
   virtual bool valid_end_point ();
 };
 
-Grace_beam_engraver::Grace_beam_engraver ()
+Grace_beam_engraver::Grace_beam_engraver (Context *c)
+  : Beam_engraver (c)
 {
 }
 
@@ -311,14 +369,30 @@ Grace_beam_engraver::valid_end_point ()
   return beam_ && valid_start_point ();
 }
 
-ADD_ACKNOWLEDGER (Grace_beam_engraver, stem);
-ADD_ACKNOWLEDGER (Grace_beam_engraver, rest);
+void
+Grace_beam_engraver::boot ()
+{
+  ADD_LISTENER (Grace_beam_engraver, beam);
+  ADD_ACKNOWLEDGER (Grace_beam_engraver, stem);
+  ADD_ACKNOWLEDGER (Grace_beam_engraver, rest);
+}
+
 ADD_TRANSLATOR (Grace_beam_engraver,
-               /* doc */ "Handles Beam events by engraving Beams.  If omitted, then notes will "
-               "be printed with flags instead of beams. Only engraves beams when we "
-               " are at grace points in time. ",
-               /* create */ "Beam",
-               /* accept */ "beam-event",
-               /* read */ "beamMelismaBusy beatLength allowBeamBreak subdivideBeams",
-               /* write */ "");
+                /* doc */
+                "Handle @code{Beam} events by engraving beams.  If omitted,"
+                " then notes are printed with flags instead of beams.  Only"
+                " engraves beams when we are at grace points in time.",
+
+                /* create */
+                "Beam ",
+
+                /* read */
+                "baseMoment "
+                "beamMelismaBusy "
+                "beatStructure "
+                "subdivideBeams ",
+
+                /* write */
+                ""
+               );