/*
- 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--2015 Jan Nieuwenhuizen <janneke@gnu.org>
- (c) 1998--1999 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 "chord-name-engraver.hh"
#include "chord-name.hh"
-#include "musical-request.hh"
-#include "paper-def.hh"
-#include "lookup.hh"
-#include "paper-def.hh"
-#include "main.hh"
+#include "context.hh"
#include "dimensions.hh"
-#include "text-item.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"
-ADD_THIS_TRANSLATOR (Chord_name_engraver);
+#include "translator.icc"
-Chord_name_engraver::Chord_name_engraver ()
+class Chord_name_engraver : public Engraver
{
- chord_name_p_ = 0;
- tonic_req_ = 0;
- inversion_req_ = 0;
- bass_req_ = 0;
-}
+ TRANSLATOR_DECLARATIONS (Chord_name_engraver);
+protected:
+ void stop_translation_timestep ();
+ void process_music ();
+ virtual void finalize ();
+ void listen_note (Stream_event *);
+ void listen_rest (Stream_event *);
+private:
+ vector<Stream_event *> notes_;
+
+ Stream_event *rest_event_;
+};
void
-Chord_name_engraver::acknowledge_element (Score_element_info i)
+Chord_name_engraver::finalize ()
{
- if (Note_req* n = dynamic_cast<Note_req*> (i.req_l_))
- pitch_arr_.push (n->pitch_);
}
-bool
-Chord_name_engraver::do_try_music (Music* m)
+Chord_name_engraver::Chord_name_engraver (Context *c)
+ : Engraver (c)
{
- if (Note_req* n = dynamic_cast<Note_req*> (m))
- {
- pitch_arr_.push (n->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))
+ 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_)
{
- inversion_req_ = i;
- return true;
+ 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);
}
- if (Bass_req* b = dynamic_cast<Bass_req*> (m))
+ else
{
- bass_req_ = b;
- return true;
+ 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))
+ {
+ 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 (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");
+ }
+ }
+ }
+
+ 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 ());
+ 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);
+ }
+ chord_name->set_property ("text", markup);
+ }
}
- return false;
+
+ SCM chord_changes = get_property ("chordChanges");
+ 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);
+
+ context ()->set_property ("lastChord", markup);
}
void
-Chord_name_engraver::do_process_requests ()
+Chord_name_engraver::listen_note (Stream_event *ev)
{
- if (chord_name_p_)
- return;
- if (!pitch_arr_.size ())
- return;
+ notes_.push_back (ev);
+}
- bool find_inversion_b = false;
- SCM chord_inversion = get_property ("chordInversion", 0);
- if (gh_boolean_p (chord_inversion))
- find_inversion_b = gh_scm2bool (chord_inversion);
+void
+Chord_name_engraver::listen_rest (Stream_event *ev)
+{
+ ASSIGN_EVENT_ONCE (rest_event_, ev);
+}
- chord_name_p_ = new Chord_name;
- chord_name_p_->set (to_chord (pitch_arr_, tonic_req_, inversion_req_, bass_req_, find_inversion_b));
-
- announce_element (Score_element_info (chord_name_p_, 0));
+void
+Chord_name_engraver::stop_translation_timestep ()
+{
+ notes_.clear ();
+ rest_event_ = 0;
}
+/*
+ The READs description is not strictly accurate:
+ which properties are read depend on the chord naming function active.
+*/
void
-Chord_name_engraver::do_pre_move_processing ()
+Chord_name_engraver::boot ()
{
- 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;
+ 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.",
+
+ /* create */
+ "ChordName ",
+
+ /* read */
+ "chordChanges "
+ "chordNameExceptions "
+ "chordNameFunction "
+ "chordNoteNamer "
+ "chordRootNamer "
+ "chordNameExceptions "
+ "lastChord "
+ "majorSevenSymbol "
+ "noChordSymbol ",
+
+ /* write */
+ "lastChord "
+ );
projects / lilypond.git / blobdiff