]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/chord-name-engraver.cc
Imported Upstream version 2.14.2
[lilypond.git] / lily / chord-name-engraver.cc
index 50ece53329022d8efb8ac5d4816f1282295e27e2..d0ced5a395f836e99fe57970185e26793b52612f 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--2011 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 "musical-pitch.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 ();
-
-  Array<Musical_pitch> pitch_arr_;
-  Item* chord_name_p_;
-  Chord* chord_p_;
-  Chord* last_chord_p_;
-  Tonic_req* tonic_req_;
-  Inversion_req* inversion_req_;
-  Bass_req* bass_req_;
+  Item *chord_name_;
+  vector<Stream_event*> notes_;
+  SCM last_chord_;
+  Stream_event *rest_event_;
 };
 
-ADD_THIS_TRANSLATOR (Chord_name_engraver);
-
-Chord_name_engraver::Chord_name_engraver ()
+void
+Chord_name_engraver::finalize ()
 {
-  chord_name_p_ = 0;
-  tonic_req_ = 0;
-  inversion_req_ = 0;
-  bass_req_ = 0;
-  chord_p_ = 0;
-  last_chord_p_ = 0;
 }
 
 void
-Chord_name_engraver::acknowledge_element (Score_element_info i)
+Chord_name_engraver::derived_mark () const
 {
-  if (Note_req* n = dynamic_cast<Note_req*> (i.req_l_))
-    pitch_arr_.push (* unsmob_pitch (n->get_mus_property ("pitch")));
+  scm_gc_mark (last_chord_);
 }
 
-bool
-Chord_name_engraver::do_try_music (Music* m)
+Chord_name_engraver::Chord_name_engraver ()
 {
-  if (Note_req* n = dynamic_cast<Note_req*> (m))
-    {
-      pitch_arr_.push (* unsmob_pitch (n->get_mus_property ("pitch")));
-      return true;
-    }
-  if (Tonic_req* t = dynamic_cast<Tonic_req*> (m))
-    {
-      tonic_req_ = t;
-      return true;
-    }
-  if (Inversion_req* i = dynamic_cast<Inversion_req*> (m))
-    {
-      inversion_req_ = i;
-      return true;
-    }
-  if (Bass_req* b = dynamic_cast<Bass_req*> (m))
-    {
-      bass_req_ = b;
-      return true;
-    }
-  return false;
+  chord_name_ = 0;
+  last_chord_ = SCM_EOL;
+  rest_event_ = 0;
 }
 
 void
-Chord_name_engraver::do_process_music ()
-{
-  if (chord_name_p_)
-    return;
+Chord_name_engraver::process_music ()
+{ 
+  SCM markup;
+  SCM bass = SCM_EOL;
+  SCM inversion = SCM_EOL;
+  SCM pitches = SCM_EOL;
+
+  if (rest_event_)
+    {
+      SCM no_chord_markup = get_property ("noChordSymbol");
+      if (!Text_interface::is_markup (no_chord_markup))
+        return;
+      markup = no_chord_markup;
+    }
+  else
+    {  
+      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 ());
+    }
+  /*
+    Ugh.
+  */
+  SCM chord_as_scm = scm_cons (pitches, scm_cons (bass, inversion));
 
-  if (!pitch_arr_.size ())
-    return;
+  chord_name_ = make_item ("ChordName", 
+      rest_event_ ? rest_event_->self_scm () : notes_[0]->self_scm ());
+  chord_name_->set_property ("text", markup);
 
-  bool find_inversion_b = false;
-  SCM chord_inversion = get_property ("chordInversion");
-  if (gh_boolean_p (chord_inversion))
-    find_inversion_b = gh_scm2bool (chord_inversion);
+  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);
 
-  chord_p_ = new Chord (to_chord (pitch_arr_,
-                                 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_p_ && !compare (chord_p_, last_chord_p_))
-    chord_name_p_->set_elt_property ("begin-of-line-visible", SCM_BOOL_T);
+  last_chord_ = chord_as_scm;
 }
 
+IMPLEMENT_TRANSLATOR_LISTENER (Chord_name_engraver, note);
 void
-Chord_name_engraver::create_chord_name ()
+Chord_name_engraver::listen_note (Stream_event *ev)
 {
-  assert (chord_p_);
-  chord_name_p_ = new Item (get_property ("ChordName"));
-  /*
-    Hmm, why not represent complete chord as list?
-    ((tonic third fifth) (inversion bass))
-  */
-  SCM plist = SCM_EOL;
-  for (int i= chord_p_->pitch_arr_.size (); i--; )
-    plist = gh_cons (chord_p_->pitch_arr_[i].smobbed_copy (), plist);
-  
-  chord_name_p_->set_elt_property ("pitches", plist);
-  if (chord_p_->inversion_b_)
-    chord_name_p_->set_elt_property ("inversion",
-                                    chord_p_->inversion_pitch_.smobbed_copy ());
-  if (chord_p_->bass_b_)
-    chord_name_p_->set_elt_property ("bass", chord_p_->bass_pitch_.smobbed_copy ());
+  notes_.push_back (ev);
 }
 
+IMPLEMENT_TRANSLATOR_LISTENER (Chord_name_engraver, rest);
 void
-Chord_name_engraver::do_pre_move_processing ()
+Chord_name_engraver::listen_rest (Stream_event *ev)
 {
-  if (chord_name_p_)
-    {
-      typeset_element (chord_name_p_);
-    }
-  pitch_arr_.clear ();
-  chord_name_p_ = 0;
-  tonic_req_ = 0;
-  inversion_req_ = 0;
-  bass_req_ = 0;
-  delete last_chord_p_;
-  last_chord_p_ = chord_p_;
-  chord_p_ = 0;
+  ASSIGN_EVENT_ONCE(rest_event_, ev);
+}
+  
+void
+Chord_name_engraver::stop_translation_timestep ()
+{
+  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 */
+               ""
+               );