/*
- 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--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
-{
-
- TRANSLATOR_DECLARATIONS( Chord_name_engraver);
+#include "translator.icc"
+class Chord_name_engraver : public Engraver
+{
+ TRANSLATOR_DECLARATIONS (Chord_name_engraver);
protected:
- virtual void stop_translation_timestep ();
- virtual void acknowledge_grob (Grob_info i);
- virtual void create_grobs ();
- virtual bool try_music (Music *);
-
+ void stop_translation_timestep ();
+ void process_music ();
+ virtual void finalize ();
+ void listen_note (Stream_event *);
+ void listen_rest (Stream_event *);
private:
- void add_note (Note_req *);
-
- Item* chord_name_p_;
+ vector<Stream_event *> notes_;
- Protected_scm chord_;
- Protected_scm last_chord_;
+ Stream_event *rest_event_;
};
-
-
-Chord_name_engraver::Chord_name_engraver ()
+void
+Chord_name_engraver::finalize ()
{
- chord_name_p_ = 0;
- chord_ = gh_cons (SCM_EOL, gh_cons (SCM_EOL, SCM_EOL));
- last_chord_ = chord_;
}
-void
-Chord_name_engraver::add_note (Note_req* n)
+Chord_name_engraver::Chord_name_engraver (Context *c)
+ : Engraver (c)
{
- 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");
- 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));
+ rest_event_ = 0;
}
-bool
-Chord_name_engraver::try_music (Music* m)
+void
+Chord_name_engraver::process_music ()
{
- if (Note_req* n = dynamic_cast<Note_req*> (m))
+ 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
{
- add_note (n);
- 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::acknowledge_grob (Grob_info i)
+Chord_name_engraver::listen_note (Stream_event *ev)
{
- if (Note_req* n = dynamic_cast<Note_req*> (i.music_cause ()))
- add_note (n);
+ notes_.push_back (ev);
}
void
-Chord_name_engraver::create_grobs ()
+Chord_name_engraver::listen_rest (Stream_event *ev)
{
- if (!chord_name_p_ && ly_car (chord_) != SCM_EOL)
- {
- chord_name_p_ = new Item (get_property ("ChordName"));
- chord_name_p_->set_grob_property ("chord", chord_);
- announce_grob(chord_name_p_, 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_p_->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_p_)
- {
- typeset_grob (chord_name_p_);
- }
- chord_name_p_ = 0;
+ notes_.clear ();
+ rest_event_ = 0;
+}
- if (ly_car (chord_) != SCM_EOL)
- last_chord_ = chord_;
- chord_ = gh_cons (SCM_EOL, gh_cons (SCM_EOL, SCM_EOL));
+/*
+ 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);
}
-ENTER_DESCRIPTION(Chord_name_engraver,
-/* descr */ "Catch Note_req's, Tonic_reqs, Inversion_reqs, Bass_req
-and generate the appropriate chordname.",
-/* creats*/ "ChordName",
-/* acks */ "grob-interface",
-/* reads */ "chordChanges",
-/* write */ "");
+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