]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/chord-tremolo-engraver.cc
lilypond-manuals.css: edit color scheme and some spacing
[lilypond.git] / lily / chord-tremolo-engraver.cc
index d670feb130172f09bd157469b7ad8f505c36105e..9e48a1a4908d5a21bf0c0e59a9242483979f4dd3 100644 (file)
-/*   
-  new-chord-tremolo-engraver.cc --  implement Chord_tremolo_engraver
-  
-  source file of the GNU LilyPond music typesetter
-  
-  (c) 2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-  
- */
-
-#include "engraver.hh"
+/*
+  This file is part of LilyPond, the GNU music typesetter.
+
+  Copyright (C) 2000--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
+                 Erik Sandberg <mandolaerik@gmail.com>
+
+  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 "beam.hh"
+#include "engraver-group.hh"
+#include "international.hh"
+#include "item.hh"
+#include "math.h" // ceil
+#include "misc.hh"
 #include "repeated-music.hh"
-#include "stem.hh"
 #include "rhythmic-head.hh"
-#include "engraver-group-engraver.hh"
-#include "musical-request.hh"
+#include "spanner.hh"
+#include "stem-tremolo.hh"
+#include "stem.hh"
+#include "stream-event.hh"
 #include "warn.hh"
-#include "misc.hh"
-#include "note-head.hh"
+
+#include "translator.icc"
 
 /**
-  This acknowledges repeated music with "tremolo" style.  It typesets
-  a beam.
 
-  TODO:
+This acknowledges repeated music with "tremolo" style.  It typesets
+a beam.
 
-  - perhaps use engraver this to steer other engravers? That would
-  create dependencies between engravers, which is bad.
+TODO:
 
-  - create dots if appropriate.
+- perhaps use engraver this to steer other engravers? That would
+create dependencies between engravers, which is bad.
 
- */
+- create dots if appropriate.
 
+- create TremoloBeam iso Beam?
+*/
 class Chord_tremolo_engraver : public Engraver
 {
-  void typeset_beam ();
-public:
-  VIRTUAL_COPY_CONS(Translator);
-  Chord_tremolo_engraver();
+  TRANSLATOR_DECLARATIONS (Chord_tremolo_engraver);
 protected:
-  Repeated_music * repeat_;
+  Stream_event *repeat_;
 
-  /// moment (global time) where beam started.
-  Moment start_mom_;
-  Moment stop_mom_;
+  Spanner *beam_;
+  // Store the pointer to the previous stem, so we can create a beam if
+  // necessary and end the spanner
+  Grob *previous_stem_;
 
-  /// location  within measure where beam started.
-  Moment beam_start_location_;
-
-  int note_head_i_;
-  
-  Beam * beam_p_;
-  Beam * finished_beam_p_;
-  
 protected:
-  virtual void do_removal_processing();
-  virtual void do_process_music();
-  virtual bool do_try_music (Music*);
-  virtual void acknowledge_element (Score_element_info);
-  virtual void do_pre_move_processing();
-  virtual void do_post_move_processing();
+  virtual void finalize ();
+  void process_music ();
+  void listen_tremolo_span (Stream_event *);
+  void acknowledge_stem (Grob_info);
 };
 
-Chord_tremolo_engraver::Chord_tremolo_engraver()
+Chord_tremolo_engraver::Chord_tremolo_engraver (Context *c)
+  : Engraver (c)
 {
-  beam_p_  = finished_beam_p_ = 0;
-  repeat_ =0;
-  note_head_i_ = 0;
+  beam_ = 0;
+  repeat_ = 0;
+  previous_stem_ = 0;
 }
 
-bool
-Chord_tremolo_engraver::do_try_music (Music * m)
+void
+Chord_tremolo_engraver::listen_tremolo_span (Stream_event *ev)
 {
-  Repeated_music * rp = dynamic_cast<Repeated_music*> (m);
-  if (rp && rp->type_ == "tremolo" && !repeat_) 
+  Direction span_dir = to_dir (ev->get_property ("span-direction"));
+  if (span_dir == START)
     {
-      Moment l = rp->body_length_mom ();
-      repeat_ = rp;
-      start_mom_ = now_mom ();
-      stop_mom_ = start_mom_ + l;
-
-      // ugh. should generate dots, triplet beams.      
-      note_head_i_ = l.den () <? 4; 
-      return true;
+      ASSIGN_EVENT_ONCE (repeat_, ev);
     }
-  return false;
-}
-
-void
-Chord_tremolo_engraver::do_process_music ()
-{
-  if (repeat_ && !beam_p_)
+  else if (span_dir == STOP)
     {
-      beam_p_ = new Beam (get_property ("basicBeamProperties"));
-      beam_p_->set_elt_property ("chord-tremolo", SCM_BOOL_T);
-
-
-      SCM smp = get_property ("measurePosition");
-      Moment mp =  (unsmob_moment (smp)) ? *unsmob_moment (smp) : Moment (0);
-      beam_start_location_ = mp;
-      announce_element (Score_element_info (beam_p_, repeat_));
+      if (!repeat_)
+        ev->origin ()->warning (_ ("No tremolo to end"));
+      repeat_ = 0;
+      beam_ = 0;
+      previous_stem_ = 0;
     }
 }
 
-
 void
-Chord_tremolo_engraver::do_removal_processing ()
+Chord_tremolo_engraver::process_music ()
 {
-  typeset_beam ();
-  if (beam_p_)
+  if (repeat_ && !beam_)
     {
-      repeat_->warning (_ ("unterminated chord tremolo"));
-      finished_beam_p_ = beam_p_;
-      typeset_beam ();
+      beam_ = make_spanner ("Beam", repeat_->self_scm ());
     }
 }
 
 void
-Chord_tremolo_engraver::typeset_beam ()
+Chord_tremolo_engraver::finalize ()
 {
-  if (finished_beam_p_)
+  if (beam_)
     {
-      typeset_element (finished_beam_p_);
-      finished_beam_p_ = 0;
+      repeat_->origin ()->warning (_ ("unterminated chord tremolo"));
+      announce_end_grob (beam_, SCM_EOL);
+      beam_->suicide ();
     }
 }
 
-
 void
-Chord_tremolo_engraver::acknowledge_element (Score_element_info info)
+Chord_tremolo_engraver::acknowledge_stem (Grob_info info)
 {
-  if (beam_p_)
+  if (beam_)
     {
-      if (Stem::has_interface (info.elem_l_))
-       {
-         Score_element * s = info.elem_l_;
-         int f = Stem::flag_i (s);
-         f = (f > 2) ? f - 2 : 1;
-         Stem::set_beaming (s, f, LEFT);
-         Stem::set_beaming (s, f, RIGHT);
-         
-         /*
-           URG: this sets the direction of the Stem s.
-           It's amazing Mike:
-           
-             Stem:: type_i () ->first_head ()->get_direction () ->
-                     Directional_element_interface (me).set (d);
-
-
-             don't understand this comment.
-                     --hwn.
-          */
-         SCM d = s->get_elt_property ("direction");
-         if (Stem::type_i (s ) != 1)
-           {
-             int gap_i =Stem::flag_i (s ) - ((Stem::type_i (s ) >? 2) - 2);
-             beam_p_->set_elt_property ("beam-gap", gh_int2scm(gap_i));
-           }
-         s->set_elt_property ("direction", d);
-
-         if (Rhythmic_req* r = dynamic_cast <Rhythmic_req *> (info.req_l_))
-           {
-             beam_p_->add_stem (s);
-             Moment stem_location = now_mom () -
-               start_mom_ + beam_start_location_;
-           }
-         else
-           {
-             String s = _ ("stem must have Rhythmic structure");
-             if (info.req_l_)
-               info.req_l_->warning (s);
-             else
-               ::warning (s);
-           }
-       }
-      if (Note_head::has_interface (info.elem_l_))
-       {
-         info.elem_l_->set_elt_property ("duration-log", gh_int2scm (intlog2 (note_head_i_)));
-       }
+      int tremolo_type = robust_scm2int (repeat_->get_property ("tremolo-type"), 1);
+      int flags = max (0, intlog2 (tremolo_type) - 2);
+      int repeat_count = robust_scm2int (repeat_->get_property ("repeat-count"), 1);
+      int gap_count = min (flags, intlog2 (repeat_count) + 1);
+
+      Grob *s = info.grob ();
+      if (previous_stem_)
+        {
+          // FIXME: We know that the beam has ended only in listen_tremolo_span
+          //        but then it is too late for Spanner_break_forbid_engraver
+          //        to allow a line break... So, as a nasty hack, announce the
+          //        spanner's end after each note except the first. The only
+          //        "drawback" is that for multi-note tremolos a break would
+          //        theoretically be allowed after the second note (but since
+          //        that note is typically not at a barline, I don't think
+          //        anyone will ever notice!)
+          announce_end_grob (beam_, previous_stem_->self_scm ());
+          // Create the whole beam between previous and current note
+          Stem::set_beaming (previous_stem_, flags, RIGHT);
+          Stem::set_beaming (s, flags, LEFT);
+        }
+
+      if (Stem::duration_log (s) != 1)
+        beam_->set_property ("gap-count", scm_from_int (gap_count));
+
+      if (info.ultimate_event_cause ()->in_event_class ("rhythmic-event"))
+        Beam::add_stem (beam_, s);
+      else
+        {
+          string s = _ ("stem must have Rhythmic structure");
+          if (info.event_cause ())
+            info.event_cause ()->origin ()->warning (s);
+          else
+            ::warning (s);
+        }
+      // Store current grob, so we can possibly end the spanner here (and
+      // reset the beam direction to RIGHT)
+      previous_stem_ = s;
     }
 }
 
-
 void
-Chord_tremolo_engraver::do_post_move_processing ()
+Chord_tremolo_engraver::boot ()
 {
-  if (beam_p_ && stop_mom_ == now_mom ())
-    {
-      finished_beam_p_ = beam_p_;
-
-      repeat_ = 0;
-      beam_p_ = 0;
-    }
+  ADD_LISTENER (Chord_tremolo_engraver, tremolo_span);
+  ADD_ACKNOWLEDGER (Chord_tremolo_engraver, stem);
 }
 
+ADD_TRANSLATOR (Chord_tremolo_engraver,
+                /* doc */
+                "Generate beams for tremolo repeats.",
 
-void
-Chord_tremolo_engraver::do_pre_move_processing ()
-{
-  typeset_beam ();
-}
+                /* create */
+                "Beam ",
 
-ADD_THIS_TRANSLATOR(Chord_tremolo_engraver);
+                /* read */
+                "",
 
+                /* write */
+                ""
+               );