]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/chord-name-engraver.cc
Web-ja: update introduction
[lilypond.git] / lily / chord-name-engraver.cc
index e2281400d01007ac9f14173a51dad0f9c9515b4b..3d989ccfb14de07ee33cf981f0e5e67ed338a3cb 100644 (file)
@@ -1,7 +1,7 @@
 /*
   This file is part of LilyPond, the GNU music typesetter.
 
-  Copyright (C) 1998--2011 Jan Nieuwenhuizen <janneke@gnu.org>
+  Copyright (C) 1998--2015 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
@@ -39,14 +39,11 @@ protected:
   void stop_translation_timestep ();
   void process_music ();
   virtual void finalize ();
-  virtual void derived_mark () const;
-  DECLARE_TRANSLATOR_LISTENER (note);
-  DECLARE_TRANSLATOR_LISTENER (rest);
+  void listen_note (Stream_event *);
+  void listen_rest (Stream_event *);
 private:
-  Item *chord_name_;
   vector<Stream_event *> notes_;
 
-  SCM last_chord_;
   Stream_event *rest_event_;
 };
 
@@ -55,104 +52,104 @@ Chord_name_engraver::finalize ()
 {
 }
 
-void
-Chord_name_engraver::derived_mark () const
+Chord_name_engraver::Chord_name_engraver (Context *c)
+  : Engraver (c)
 {
-  scm_gc_mark (last_chord_);
-}
-
-Chord_name_engraver::Chord_name_engraver ()
-{
-  chord_name_ = 0;
-  last_chord_ = SCM_EOL;
   rest_event_ = 0;
 }
 
 void
 Chord_name_engraver::process_music ()
 {
+  if (!rest_event_ && notes_.empty ())
+    return;
+
   SCM markup;
   SCM bass = SCM_EOL;
   SCM inversion = SCM_EOL;
   SCM pitches = SCM_EOL;
+  Item *chord_name = 0;
 
+  // rest events present a hen-and-egg problem with regard to
+  // overriding the text property of the ChordName grob since we
+  // cannot create a ChordName grob, look at its text property and, if
+  // not set, use noChordSymbol to decide whether we should not have
+  // created the grob in the first place.
   if (rest_event_)
     {
       SCM no_chord_markup = get_property ("noChordSymbol");
       if (!Text_interface::is_markup (no_chord_markup))
         return;
       markup = no_chord_markup;
+      chord_name = make_item ("ChordName", rest_event_->self_scm ());
+      chord_name->set_property ("text", markup);
     }
   else
     {
-      if (!notes_.size ())
-        return;
-
-      Stream_event *inversion_event = 0;
-      for (vsize i = 0; i < notes_.size (); i++)
+      chord_name = make_item ("ChordName", notes_[0]->self_scm ());
+      // We cannot actually delay fetching the text property in case
+      // it is a callback since we need to compare the generated
+      // markups for the sake of chordChanges
+      markup = chord_name->get_property ("text");
+      if (!Text_interface::is_markup (markup))
         {
-          Stream_event *n = notes_[i];
-          SCM p = n->get_property ("pitch");
-          if (!unsmob_pitch (p))
-            continue;
-
-          if (n->get_property ("inversion") == SCM_BOOL_T)
+          for (vsize i = 0; i < notes_.size (); i++)
             {
-              inversion_event = n;
-              inversion = p;
+              Stream_event *n = notes_[i];
+              SCM p = n->get_property ("pitch");
+              if (!unsmob<Pitch> (p))
+                continue;
+
+              if (to_boolean (n->get_property ("bass")))
+                bass = p;
+              else
+                {
+                  SCM oct = n->get_property ("octavation");
+                  if (scm_is_number (oct))
+                    {
+                      Pitch orig = unsmob<Pitch> (p)->transposed (Pitch (-scm_to_int (oct), 0));
+                      pitches = scm_cons (orig.smobbed_copy (), pitches);
+                    }
+                  else
+                    pitches = scm_cons (p, pitches);
+                  if (to_boolean (n->get_property ("inversion")))
+                    {
+                      inversion = p;
+                      if (!scm_is_number (oct))
+                        programming_error ("inversion does not have original pitch");
+                    }
+                }
             }
-          else if (n->get_property ("bass") == SCM_BOOL_T)
-            bass = p;
-          else
-            pitches = scm_cons (p, pitches);
-        }
 
-      if (inversion_event)
-        {
-          SCM oct = inversion_event->get_property ("octavation");
-          if (scm_is_number (oct))
-            {
-              Pitch *p = unsmob_pitch (inversion_event->get_property ("pitch"));
-              int octavation = scm_to_int (oct);
-              Pitch orig = p->transposed (Pitch (-octavation, 0, 0));
+          pitches = scm_sort_list (pitches, Pitch::less_p_proc);
 
-              pitches = scm_cons (orig.smobbed_copy (), pitches);
+          SCM name_proc = get_property ("chordNameFunction");
+          markup = scm_call_4 (name_proc, pitches, bass, inversion,
+                               context ()->self_scm ());
+          if (!Text_interface::is_markup (markup))
+            {
+              // Ugh, we created a grob, now we better populate it.
+              // Use an empty string.
+              markup = scm_string (SCM_EOL);
             }
-          else
-            programming_error ("inversion does not have original pitch");
+          chord_name->set_property ("text", markup);
         }
-
-      pitches = scm_sort_list (pitches, Pitch::less_p_proc);
-
-      SCM name_proc = get_property ("chordNameFunction");
-      markup = scm_call_4 (name_proc, pitches, bass, inversion,
-                           context ()->self_scm ());
     }
-  /*
-    Ugh.
-  */
-  SCM chord_as_scm = scm_cons (pitches, scm_cons (bass, inversion));
-
-  chord_name_ = make_item ("ChordName",
-                           rest_event_ ? rest_event_->self_scm () : notes_[0]->self_scm ());
-  chord_name_->set_property ("text", markup);
 
   SCM chord_changes = get_property ("chordChanges");
-  if (to_boolean (chord_changes) && scm_is_pair (last_chord_)
-      && ly_is_equal (chord_as_scm, last_chord_))
-    chord_name_->set_property ("begin-of-line-visible", SCM_BOOL_T);
+  SCM last_chord = get_property ("lastChord");
+  if (to_boolean (chord_changes) && ly_is_equal (markup, last_chord))
+    chord_name->set_property ("begin-of-line-visible", SCM_BOOL_T);
 
-  last_chord_ = chord_as_scm;
+  context ()->set_property ("lastChord", markup);
 }
 
-IMPLEMENT_TRANSLATOR_LISTENER (Chord_name_engraver, note);
 void
 Chord_name_engraver::listen_note (Stream_event *ev)
 {
   notes_.push_back (ev);
 }
 
-IMPLEMENT_TRANSLATOR_LISTENER (Chord_name_engraver, rest);
 void
 Chord_name_engraver::listen_rest (Stream_event *ev)
 {
@@ -162,7 +159,6 @@ Chord_name_engraver::listen_rest (Stream_event *ev)
 void
 Chord_name_engraver::stop_translation_timestep ()
 {
-  chord_name_ = 0;
   notes_.clear ();
   rest_event_ = 0;
 }
@@ -171,6 +167,13 @@ Chord_name_engraver::stop_translation_timestep ()
   The READs description is not strictly accurate:
   which properties are read depend on the chord naming function active.
 */
+void
+Chord_name_engraver::boot ()
+{
+  ADD_LISTENER (Chord_name_engraver, note);
+  ADD_LISTENER (Chord_name_engraver, rest);
+}
+
 ADD_TRANSLATOR (Chord_name_engraver,
                 /* doc */
                 "Catch note and rest events and generate the appropriate chordname.",
@@ -185,9 +188,10 @@ ADD_TRANSLATOR (Chord_name_engraver,
                 "chordNoteNamer "
                 "chordRootNamer "
                 "chordNameExceptions "
+                "lastChord "
                 "majorSevenSymbol "
                 "noChordSymbol ",
 
                 /* write */
-                ""
+                "lastChord "
                );