]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/chord-name-engraver.cc
Imported Upstream version 2.16.0
[lilypond.git] / lily / chord-name-engraver.cc
index 877d7c988c04c25f6fa3186175b8789a77e28131..eab4d94d075c52ef95f0ae09449d6d9d184585c5 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--2000 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 
-{
-public:
-  Chord_name_engraver ();
-  VIRTUAL_COPY_CONS (Translator);
+#include "translator.icc"
 
+class Chord_name_engraver : public Engraver
+{
+  TRANSLATOR_DECLARATIONS (Chord_name_engraver);
 protected:
-  virtual void do_pre_move_processing ();
-  virtual void acknowledge_element (Score_element_info i);
-  virtual void do_process_music ();
-  virtual bool do_try_music (Music* m);
-
+  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 create_chord_name ();
-  
-  Item* chord_name_p_;
-  Protected_scm pitches_;
-
-  Protected_scm chord_;
-  Protected_scm last_chord_;
+  Item *chord_name_;
+  vector<Stream_event *> notes_;
 
-  Protected_scm tonic_req_;
-  Protected_scm inversion_req_;
-  Protected_scm bass_req_;
+  SCM last_chord_;
+  Stream_event *rest_event_;
 };
 
-ADD_THIS_TRANSLATOR (Chord_name_engraver);
+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_p_ = 0;
-  pitches_ = SCM_EOL;
-  tonic_req_ = SCM_EOL;
-  inversion_req_ = SCM_EOL;
-  bass_req_ = SCM_EOL;
-  chord_ = SCM_EOL;
+  chord_name_ = 0;
   last_chord_ = SCM_EOL;
+  rest_event_ = 0;
 }
 
 void
-Chord_name_engraver::acknowledge_element (Score_element_info i)
+Chord_name_engraver::process_music ()
 {
-  if (Note_req* n = dynamic_cast<Note_req*> (i.req_l_))
-    pitches_ = gh_cons (n->get_mus_property ("pitch"), pitches_);
-}
+  SCM markup;
+  SCM bass = SCM_EOL;
+  SCM inversion = SCM_EOL;
+  SCM pitches = SCM_EOL;
 
-bool
-Chord_name_engraver::do_try_music (Music* m)
-{
-  if (Note_req* n = dynamic_cast<Note_req*> (m))
-    {
-      pitches_ = gh_cons (n->get_mus_property ("pitch"), pitches_);
-      return true;
-    }
-  if (Tonic_req* t = dynamic_cast<Tonic_req*> (m))
-    {
-      tonic_req_ = t->get_mus_property ("pitch");
-      return true;
-    }
-  if (Inversion_req* i = dynamic_cast<Inversion_req*> (m))
+  if (rest_event_)
     {
-      inversion_req_ = i->get_mus_property ("pitch");
-      return true;
+      SCM no_chord_markup = get_property ("noChordSymbol");
+      if (!Text_interface::is_markup (no_chord_markup))
+        return;
+      markup = no_chord_markup;
     }
-  if (Bass_req* b = dynamic_cast<Bass_req*> (m))
+  else
     {
-      bass_req_ = b->get_mus_property ("pitch");
-      return true;
+      if (!notes_.size ())
+        return;
+
+      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");
+      markup = scm_call_4 (name_proc, pitches, bass, inversion,
+                           context ()->self_scm ());
     }
-  return false;
+  /*
+    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);
+
+  last_chord_ = chord_as_scm;
 }
 
+IMPLEMENT_TRANSLATOR_LISTENER (Chord_name_engraver, note);
 void
-Chord_name_engraver::do_process_music ()
+Chord_name_engraver::listen_note (Stream_event *ev)
 {
-  if (!chord_name_p_ && pitches_ != SCM_EOL)
-    {
-      bool find_inversion_b = false;
-      SCM chord_inversion = get_property ("chordInversion");
-      if (gh_boolean_p (chord_inversion))
-       find_inversion_b = gh_scm2bool (chord_inversion);
-
-      chord_ = Chord::pitches_and_requests_to_chord (pitches_,
-                                                    tonic_req_,
-                                                    inversion_req_,
-                                                    bass_req_,
-                                                    find_inversion_b);
-      
-      create_chord_name ();
-      announce_element (chord_name_p_, 0);
-      SCM s = get_property ("drarnChords"); //FIXME!
-      if (to_boolean (s) && last_chord_ != SCM_EOL &&
-         gh_equal_p (chord_, last_chord_))
-       chord_name_p_->set_elt_property ("begin-of-line-visible", SCM_BOOL_T);
-    }
+  notes_.push_back (ev);
 }
 
+IMPLEMENT_TRANSLATOR_LISTENER (Chord_name_engraver, rest);
 void
-Chord_name_engraver::create_chord_name ()
+Chord_name_engraver::listen_rest (Stream_event *ev)
 {
-  chord_name_p_ = new Item (get_property ("ChordName"));
-
-  SCM pitches = gh_car (chord_);
-  SCM modifiers = gh_cdr (chord_);
-  SCM inversion = gh_car (modifiers);
-  SCM bass = gh_cdr (modifiers);
-  /* Hmm, maybe chord-name should use (pitches (inversion . base)) too? */
-  chord_name_p_->set_elt_property ("pitches", pitches);
-  chord_name_p_->set_elt_property ("inversion", inversion);
-  chord_name_p_->set_elt_property ("inversion", bass);
+  ASSIGN_EVENT_ONCE (rest_event_, ev);
 }
 
 void
-Chord_name_engraver::do_pre_move_processing ()
+Chord_name_engraver::stop_translation_timestep ()
 {
-  if (chord_name_p_)
-    {
-      typeset_element (chord_name_p_);
-    }
-  chord_name_p_ = 0;
-
-  pitches_ = SCM_EOL;
-  tonic_req_ = SCM_EOL;
-  inversion_req_ = SCM_EOL;
-  bass_req_ = SCM_EOL;
-  last_chord_ = chord_;
-  chord_ = SCM_EOL;
+  chord_name_ = 0;
+  notes_.clear ();
+  rest_event_ = 0;
 }
 
+/*
+  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 */
+                ""
+               );