2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
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 "bar-line.hh"
23 #include "engraver.hh"
26 #include "protected-scm.hh"
27 #include "staff-symbol-referencer.hh"
28 #include "stream-event.hh"
30 #include "translator.icc"
32 class Key_engraver : public Engraver
34 void create_key (bool);
35 void read_event (Stream_event const *r);
37 Stream_event *key_event_;
41 TRANSLATOR_DECLARATIONS (Key_engraver);
44 virtual void initialize ();
45 virtual void finalize ();
46 void stop_translation_timestep ();
47 void process_music ();
49 DECLARE_TRANSLATOR_LISTENER (key_change);
50 DECLARE_ACKNOWLEDGER (clef);
51 DECLARE_ACKNOWLEDGER (bar_line);
55 Key_engraver::finalize ()
59 Key_engraver::Key_engraver ()
68 Key_engraver::create_key (bool is_default)
72 item_ = make_item ("KeySignature",
73 key_event_ ? key_event_->self_scm () : SCM_EOL);
75 /* Use middleCClefPosition rather than middleCPosition, because cue
76 * notes with a different clef will modify middleCPosition. The
77 * Key signature, however, should still be printed at the original
79 item_->set_property ("c0-position",
80 get_property ("middleCClefPosition"));
82 SCM last = get_property ("lastKeySignature");
83 SCM key = get_property ("keySignature");
85 if ((to_boolean (get_property ("printKeyCancellation"))
87 && !scm_is_eq (last, key))
89 SCM restore = SCM_EOL;
91 for (SCM s = last; scm_is_pair (s); s = scm_cdr (s))
93 SCM new_alter_pair = scm_assoc (scm_caar (s), key);
94 Rational old_alter = robust_scm2rational (scm_cdar (s), 0);
95 if (new_alter_pair == SCM_BOOL_F
96 || ((ly_scm2rational (scm_cdr (new_alter_pair)) - old_alter) * old_alter
99 *tail = scm_cons (scm_car (s), *tail);
100 tail = SCM_CDRLOC (*tail);
104 if (scm_is_pair (restore))
106 cancellation_ = make_item ("KeyCancellation",
108 ? key_event_->self_scm () : SCM_EOL);
110 cancellation_->set_property ("alteration-alist", scm_reverse (restore));
111 cancellation_->set_property ("c0-position",
112 get_property ("middleCPosition"));
116 item_->set_property ("alteration-alist", scm_reverse (key));
121 SCM visibility = get_property ("explicitKeySignatureVisibility");
122 item_->set_property ("break-visibility", visibility);
126 IMPLEMENT_TRANSLATOR_LISTENER (Key_engraver, key_change);
128 Key_engraver::listen_key_change (Stream_event *ev)
130 /* do this only once, just to be on the safe side. */
131 if (ASSIGN_EVENT_ONCE (key_event_, ev))
132 read_event (key_event_);
136 Key_engraver::acknowledge_clef (Grob_info /* info */)
138 SCM c = get_property ("createKeyOnClefChange");
144 Key_engraver::acknowledge_bar_line (Grob_info /* info */)
146 if (scm_is_pair (get_property ("keySignature")))
151 Key_engraver::process_music ()
154 || get_property ("lastKeySignature") != get_property ("keySignature"))
159 Key_engraver::stop_translation_timestep ()
162 context ()->set_property ("lastKeySignature", get_property ("keySignature"));
168 Key_engraver::read_event (Stream_event const *r)
170 SCM p = r->get_property ("pitch-alist");
171 if (!scm_is_pair (p))
176 SCM alist = scm_list_copy (p);
177 SCM order = get_property ("keyAlterationOrder");
179 scm_is_pair (s) && scm_is_pair (alist); s = scm_cdr (s))
181 SCM head = scm_member (scm_car (s), alist);
183 if (scm_is_pair (head))
185 accs = scm_cons (scm_car (head), accs);
186 alist = scm_delete_x (scm_car (head), alist);
190 if (scm_is_pair (alist))
193 for (SCM s = alist; scm_is_pair (s); s = scm_cdr (s))
194 if (ly_scm2rational (scm_cdar (s)))
197 accs = scm_cons (scm_car (s), accs);
201 r->origin ()->warning ("Incomplete keyAlterationOrder for key signature");
204 context ()->set_property ("keySignature", scm_reverse (accs));
205 context ()->set_property ("tonic",
206 r->get_property ("tonic"));
210 Key_engraver::initialize ()
212 context ()->set_property ("keySignature", SCM_EOL);
213 context ()->set_property ("lastKeySignature", SCM_EOL);
216 context ()->set_property ("tonic", p.smobbed_copy ());
219 ADD_ACKNOWLEDGER (Key_engraver, clef);
220 ADD_ACKNOWLEDGER (Key_engraver, bar_line);
222 ADD_TRANSLATOR (Key_engraver,
224 "Engrave a key signature.",
231 "createKeyOnClefChange "
232 "explicitKeySignatureVisibility "
234 "keyAlterationOrder "
237 "printKeyCancellation "
238 "middleCClefPosition ",