]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/metronome-engraver.cc
Break-alignable metronome marks: remove hardcoding of time signature.
[lilypond.git] / lily / metronome-engraver.cc
index 50eab8b60760a67015a5d45ff6ef27f11b0f69e7..a37a9475fb34e5329eb7e109d8ecaf0c13e760d1 100644 (file)
 /*
-  mark-engraver.cc -- implement Metronome_mark_engraver
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 1998--2010 Jan Nieuwenhuizen <janneke@gnu.org>
 
-  (c) 1998--2004 Jan Nieuwenhuizen <janneke@gnu.org>
+  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 <cctype>
+using namespace std;
+
+#include "engraver.hh"
 
-#include "note-column.hh"
-#include "bar-line.hh"
-#include "time-signature.hh"
-#include "engraver-group-engraver.hh"
 #include "context.hh"
+#include "duration.hh"
+#include "grob-array.hh"
+#include "item.hh"
+#include "stream-event.hh"
+#include "text-interface.hh"
+
+#include "translator.icc"
 
-/**
-  put stuff over or next to  bars.  Examples: bar numbers, marginal notes,
-  rehearsal marks.
- */
 class Metronome_mark_engraver : public Engraver
 {
 public:
   TRANSLATOR_DECLARATIONS (Metronome_mark_engraver);
+
 protected:
   Item *text_;
-  Grob *bar_line_;
-  Music *mark_ev_;
+  Grob *support_;
+
+  SCM last_duration_;
+  SCM last_count_;
+  SCM last_text_;
+
+  DECLARE_ACKNOWLEDGER (break_aligned);
   
-  void create_items (Music*);
 protected:
-  virtual void stop_translation_timestep ();
-  virtual bool try_music (Music *ev);
-  virtual void process_music ();
+  virtual void derived_mark () const;
+  void stop_translation_timestep ();
+  void process_music ();
 };
 
 Metronome_mark_engraver::Metronome_mark_engraver ()
 {
   text_ = 0;
-  mark_ev_ = 0;
+  support_ = 0;
+  last_duration_ = SCM_EOL;
+  last_count_ = SCM_EOL;
+  last_text_ = SCM_EOL;
 }
 
-void 
-Metronome_mark_engraver::stop_translation_timestep ()
+void
+Metronome_mark_engraver::derived_mark () const
 {
-  if (text_)
-    {
-      Grob*mc = unsmob_grob (get_property( "currentMusicalColumn"));
-      text_->set_parent (mc, X_AXIS);
-      text_->set_property ("side-support-elements" , get_property ("stavesFound"));
-      
-      text_ = 0;
-    }
-  mark_ev_ = 0;
+  scm_gc_mark (last_count_);
+  scm_gc_mark (last_duration_);
+  scm_gc_mark (last_text_);
 }
 
-
 void
-Metronome_mark_engraver::create_items (Music *rq)
+Metronome_mark_engraver::acknowledge_break_aligned (Grob_info inf)
 {
-  if (text_)
-    return;
-
-  text_ = make_item ("MetronomeMark", rq->self_scm () );
-
+  Grob *s = inf.grob ();
+  if (text_
+      && (s->get_property_data ("break-align-symbol")
+         == text_->get_property_data ("break-align-symbol")))
+    {
+      support_ = s;
+    }
 }
 
-
-bool
-Metronome_mark_engraver::try_music (Music* r)
+void
+Metronome_mark_engraver::stop_translation_timestep ()
 {
-  mark_ev_ = r;
-  return true;
+  if (text_)
+    {
+      if (!support_)
+       {
+         /*
+           Gardner Read "Music Notation", p.278
+
+           Align the metronome mark over the time signature (or the
+           first notational element of the measure if no time
+           signature is present in that measure).
+         */
+         Grob *mc = unsmob_grob (get_property ("currentMusicalColumn"));
+         text_->set_parent (mc, X_AXIS);
+       }
+      text_->set_object ("side-support-elements",
+                        grob_list_to_grob_array (get_property ("stavesFound")));
+      text_ = 0;
+      support_ = 0;
+    }
 }
 
 void
 Metronome_mark_engraver::process_music ()
 {
-  if (mark_ev_)
+  SCM count = get_property ("tempoUnitCount");
+  SCM duration = get_property ("tempoUnitDuration");
+  SCM text = get_property ("tempoText");
+
+  if ( ( (unsmob_duration (duration) && scm_is_number (count))
+        || Text_interface::is_markup (text) )
+      && !(ly_is_equal (count, last_count_)
+          && ly_is_equal (duration, last_duration_)
+          && ly_is_equal (text, last_text_)))
     {
-      create_items (mark_ev_);
+      text_ = make_item ("MetronomeMark", SCM_EOL);
 
       SCM proc = get_property ("metronomeMarkFormatter");
-      SCM result = scm_call_2 (proc, mark_ev_->self_scm (),
-                             context ()->self_scm ()); 
-      
+      SCM result = scm_call_4 (proc,
+                              text,
+                              duration,
+                              count,
+                              context ()->self_scm ());
+
       text_->set_property ("text", result);
     }
+
+  last_duration_ = duration;
+  last_count_ = count;
+  last_text_ = text;
 }
 
-ENTER_DESCRIPTION (Metronome_mark_engraver,
-/* descr */       "Engrave metro nome marking. This delegates the formatting work "
-                  "to the function in the metronomeMarkFormatter property. "
-                  "The mark is put over all staves. "
-                  "The staves are taken from the @code{stavesFound} property, "
-                  "which is maintained by @code{@ref{Staff_collecting_engraver}}. "
-       
-                  ,
-/* creats*/       "MetronomeMark",
-/* accepts */     "metronome-change-event",
-                  /* acks  */       "",
-/* reads */       "stavesFound metronomeMarkFormatter",
-/* write */       "");
+
+
+ADD_ACKNOWLEDGER (Metronome_mark_engraver, break_aligned);
+
+ADD_TRANSLATOR (Metronome_mark_engraver,
+               /* doc */
+               "Engrave metronome marking.  This delegates the formatting"
+               " work to the function in the @code{metronomeMarkFormatter}"
+               " property.  The mark is put over all staves.  The staves are"
+               " taken from the @code{stavesFound} property, which is"
+               " maintained by @ref{Staff_collecting_engraver}.",
+
+               /* create */
+               "MetronomeMark ",
+
+               /* read */
+               "stavesFound "
+               "metronomeMarkFormatter "
+               "tempoUnitDuration "
+               "tempoUnitCount "
+               "tempoText "
+               "tempoHideNote ",
+
+               /* write */
+               ""
+               );