2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1998--2014 Jan Nieuwenhuizen <janneke@gnu.org>
6 LilyPond is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 LilyPond is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
20 #include "chord-name.hh"
22 #include "dimensions.hh"
23 #include "engraver.hh"
24 #include "font-interface.hh"
26 #include "output-def.hh"
28 #include "protected-scm.hh"
29 #include "stream-event.hh"
30 #include "text-interface.hh"
33 #include "translator.icc"
35 class Chord_name_engraver : public Engraver
37 TRANSLATOR_DECLARATIONS (Chord_name_engraver);
39 void stop_translation_timestep ();
40 void process_music ();
41 virtual void finalize ();
42 DECLARE_TRANSLATOR_LISTENER (note);
43 DECLARE_TRANSLATOR_LISTENER (rest);
45 vector<Stream_event *> notes_;
47 Stream_event *rest_event_;
51 Chord_name_engraver::finalize ()
55 Chord_name_engraver::Chord_name_engraver ()
61 Chord_name_engraver::process_music ()
63 if (!rest_event_ && notes_.empty ())
68 SCM inversion = SCM_EOL;
69 SCM pitches = SCM_EOL;
72 // rest events present a hen-and-egg problem with regard to
73 // overriding the text property of the ChordName grob since we
74 // cannot create a ChordName grob, look at its text property and, if
75 // not set, use noChordSymbol to decide whether we should not have
76 // created the grob in the first place.
79 SCM no_chord_markup = get_property ("noChordSymbol");
80 if (!Text_interface::is_markup (no_chord_markup))
82 markup = no_chord_markup;
83 chord_name = make_item ("ChordName", rest_event_->self_scm ());
84 chord_name->set_property ("text", markup);
88 chord_name = make_item ("ChordName", notes_[0]->self_scm ());
89 // We cannot actually delay fetching the text property in case
90 // it is a callback since we need to compare the generated
91 // markups for the sake of chordChanges
92 markup = chord_name->get_property ("text");
93 if (!Text_interface::is_markup (markup))
95 Stream_event *inversion_event = 0;
96 for (vsize i = 0; i < notes_.size (); i++)
98 Stream_event *n = notes_[i];
99 SCM p = n->get_property ("pitch");
100 if (!unsmob_pitch (p))
103 if (n->get_property ("inversion") == SCM_BOOL_T)
108 else if (n->get_property ("bass") == SCM_BOOL_T)
111 pitches = scm_cons (p, pitches);
116 SCM oct = inversion_event->get_property ("octavation");
117 if (scm_is_number (oct))
119 Pitch *p = unsmob_pitch (inversion_event->get_property ("pitch"));
120 int octavation = scm_to_int (oct);
121 Pitch orig = p->transposed (Pitch (-octavation, 0, 0));
123 pitches = scm_cons (orig.smobbed_copy (), pitches);
126 programming_error ("inversion does not have original pitch");
129 pitches = scm_sort_list (pitches, Pitch::less_p_proc);
131 SCM name_proc = get_property ("chordNameFunction");
132 markup = scm_call_4 (name_proc, pitches, bass, inversion,
133 context ()->self_scm ());
134 if (!Text_interface::is_markup (markup))
136 // Ugh, we created a grob, now we better populate it.
137 // Use an empty string.
138 markup = scm_string (SCM_EOL);
140 chord_name->set_property ("text", markup);
144 SCM chord_changes = get_property ("chordChanges");
145 SCM last_chord = get_property ("lastChord");
146 if (to_boolean (chord_changes) && ly_is_equal (markup, last_chord))
147 chord_name->set_property ("begin-of-line-visible", SCM_BOOL_T);
149 context ()->set_property ("lastChord", markup);
152 IMPLEMENT_TRANSLATOR_LISTENER (Chord_name_engraver, note);
154 Chord_name_engraver::listen_note (Stream_event *ev)
156 notes_.push_back (ev);
159 IMPLEMENT_TRANSLATOR_LISTENER (Chord_name_engraver, rest);
161 Chord_name_engraver::listen_rest (Stream_event *ev)
163 ASSIGN_EVENT_ONCE (rest_event_, ev);
167 Chord_name_engraver::stop_translation_timestep ()
174 The READs description is not strictly accurate:
175 which properties are read depend on the chord naming function active.
177 ADD_TRANSLATOR (Chord_name_engraver,
179 "Catch note and rest events and generate the appropriate chordname.",
186 "chordNameExceptions "
190 "chordNameExceptions "