]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/chord-name-engraver.cc
Update d/copyright
[lilypond.git] / lily / chord-name-engraver.cc
index 79ad18fc2b4e5108a1b97f567274da28ccb2b238..26b4a607bb13bb39fbcd6954da896ab293161625 100644 (file)
 /*
-  chord-name-engraver.cc -- implement Chord_name_engraver
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 1998--2012 Jan Nieuwenhuizen <janneke@gnu.org>
 
-  (c) 1998--2002 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 "engraver.hh"
 #include "chord-name.hh"
-#include "chord.hh"
-#include "musical-request.hh"
-#include "paper-def.hh"
-#include "font-interface.hh"
-#include "paper-def.hh"
-#include "main.hh"
+#include "context.hh"
 #include "dimensions.hh"
+#include "engraver.hh"
+#include "font-interface.hh"
 #include "item.hh"
+#include "output-def.hh"
 #include "pitch.hh"
 #include "protected-scm.hh"
+#include "stream-event.hh"
+#include "text-interface.hh"
+#include "warn.hh"
 
-class Chord_name_engraver : public Engraver 
+#include "translator.icc"
+
+class Chord_name_engraver : public Engraver
 {
-  TRANSLATOR_DECLARATIONSChord_name_engraver);
+  TRANSLATOR_DECLARATIONS (Chord_name_engraver);
 protected:
-  virtual void stop_translation_timestep ();
-  virtual void process_music ();
-  virtual bool try_music (Music *);
-
+  void stop_translation_timestep ();
+  void process_music ();
+  virtual void finalize ();
+  virtual void derived_mark () const;
+  DECLARE_TRANSLATOR_LISTENER (note);
+  DECLARE_TRANSLATOR_LISTENER (rest);
 private:
-  void add_note (Music *);
-  
-  Item* chord_name_;
+  Item *chord_name_;
+  vector<Stream_event *> notes_;
 
-  Protected_scm chord_;
-  Protected_scm last_chord_;
+  SCM last_chord_;
+  Stream_event *rest_event_;
 };
 
+void
+Chord_name_engraver::finalize ()
+{
+}
 
+void
+Chord_name_engraver::derived_mark () const
+{
+  scm_gc_mark (last_chord_);
+}
 
 Chord_name_engraver::Chord_name_engraver ()
 {
   chord_name_ = 0;
-  chord_ = gh_cons (SCM_EOL, gh_cons (SCM_EOL, SCM_EOL));
-  last_chord_ = chord_;
+  last_chord_ = SCM_EOL;
+  rest_event_ = 0;
 }
 
 void
-Chord_name_engraver::add_note (Music * n)
+Chord_name_engraver::process_music ()
 {
-  SCM pitches = ly_car (chord_);
-  SCM modifiers = ly_cdr (chord_);
-  SCM inversion = modifiers == SCM_EOL ? SCM_EOL : ly_car (modifiers);
-  SCM bass = modifiers == SCM_EOL ? SCM_EOL : ly_cdr (modifiers);
-  
-  if (n->get_mus_property ("inversion") == SCM_BOOL_T)
-    inversion = n->get_mus_property ("pitch");
-  else if (n->get_mus_property ("bass") == SCM_BOOL_T)
-    bass = n->get_mus_property ("pitch");
+  if (!rest_event_ && !notes_.size ())
+   return;
+
+  chord_name_ = make_item ("ChordName",
+                           rest_event_ ? rest_event_->self_scm () : notes_[0]->self_scm ());
+
+  SCM maybe_markup = chord_name_->get_property_data ("text");
+
+  bool make_markup = !(Text_interface::is_markup (maybe_markup)
+                       || ly_is_procedure (maybe_markup));
+
+  SCM markup;
+
+  if (rest_event_ && !make_markup) { }
+  else if (rest_event_)
+    {
+      SCM no_chord_markup = get_property ("noChordSymbol");
+      if (!Text_interface::is_markup (no_chord_markup))
+        return;
+      markup = no_chord_markup;
+    }
   else
-    pitches = scm_sort_list (gh_cons (n->get_mus_property ("pitch"), pitches),
-                            Pitch::less_p_proc);
-  chord_ = gh_cons (pitches, gh_cons (inversion, bass));
+    {
+      SCM bass = SCM_EOL;
+      SCM inversion = SCM_EOL;
+      SCM pitches = SCM_EOL;
+
+      Stream_event *inversion_event = 0;
+      for (vsize i = 0; i < notes_.size (); i++)
+        {
+          Stream_event *n = notes_[i];
+          SCM p = n->get_property ("pitch");
+          if (!unsmob_pitch (p))
+            continue;
+
+          if (n->get_property ("inversion") == SCM_BOOL_T)
+            {
+              inversion_event = n;
+              inversion = p;
+            }
+          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_cons (orig.smobbed_copy (), pitches);
+            }
+          else
+            programming_error ("inversion does not have original pitch");
+        }
+
+      pitches = scm_sort_list (pitches, Pitch::less_p_proc);
+
+      SCM name_proc = get_property ("chordNameFunction");
+      if (make_markup)
+        markup = scm_call_4 (name_proc, pitches, bass, inversion,
+                             context ()->self_scm ());
+    }
+  /*
+    Ugh.
+  */
+  if (make_markup)
+    chord_name_->set_property ("text", markup);
+  else if (Text_interface::is_markup (maybe_markup))
+    markup = maybe_markup;
+
+  SCM chord_changes = get_property ("chordChanges");
+  if (to_boolean (chord_changes) && scm_is_pair (last_chord_)
+      && ly_is_equal (markup, last_chord_))
+    chord_name_->set_property ("begin-of-line-visible", SCM_BOOL_T);
+
+  last_chord_ = markup;
 }
 
-bool
-Chord_name_engraver::try_music (Music* m)
+IMPLEMENT_TRANSLATOR_LISTENER (Chord_name_engraver, note);
+void
+Chord_name_engraver::listen_note (Stream_event *ev)
 {
-  /*
-    hmm. Should check? 
-   */
-  if (m->is_mus_type ("note-event"))
-    {
-      add_note (m);
-      return true;
-    }
-  return false;
+  notes_.push_back (ev);
 }
 
+IMPLEMENT_TRANSLATOR_LISTENER (Chord_name_engraver, rest);
 void
-Chord_name_engraver::process_music ()
+Chord_name_engraver::listen_rest (Stream_event *ev)
 {
-  if (ly_car (chord_) != SCM_EOL)
-    {
-      chord_name_ = new Item (get_property ("ChordName"));
-      chord_name_->set_grob_property ("chord", chord_);
-      announce_grob(chord_name_, SCM_EOL);
-      SCM s = get_property ("chordChanges");
-      if (to_boolean (s) && ly_car (last_chord_) != SCM_EOL
-                 && gh_equal_p (chord_, last_chord_))
-       chord_name_->set_grob_property ("begin-of-line-visible", SCM_BOOL_T);
-    }
+  ASSIGN_EVENT_ONCE (rest_event_, ev);
 }
 
 void
 Chord_name_engraver::stop_translation_timestep ()
 {
-  if (chord_name_)
-    {
-      typeset_grob (chord_name_);
-    }
   chord_name_ = 0;
-
-  if (ly_car (chord_) != SCM_EOL)
-    last_chord_ = chord_;
-  chord_ = gh_cons (SCM_EOL, gh_cons (SCM_EOL, SCM_EOL));
+  notes_.clear ();
+  rest_event_ = 0;
 }
 
-ENTER_DESCRIPTION(Chord_name_engraver,
-/* descr */       "Catch note-events, Tonic_reqs, Inversion_reqs, Bass_req
-and generate the appropriate chordname.",
-/* creats*/       "ChordName",
-/* accepts */     "note-event busy-playing-event",
-/* acks  */      "",
-/* reads */       "chordChanges",
-/* write */       "");
+/*
+  The READs description is not strictly accurate:
+  which properties are read depend on the chord naming function active.
+*/
+ADD_TRANSLATOR (Chord_name_engraver,
+                /* doc */
+                "Catch note and rest events and generate the appropriate chordname.",
+
+                /* create */
+                "ChordName ",
+
+                /* read */
+                "chordChanges "
+                "chordNameExceptions "
+                "chordNameFunction "
+                "chordNoteNamer "
+                "chordRootNamer "
+                "chordNameExceptions "
+                "majorSevenSymbol "
+                "noChordSymbol ",
+
+                /* write */
+                ""
+               );