2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2010 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 item_
->set_property ("c0-position",
76 get_property ("middleCPosition"));
78 SCM last
= get_property ("lastKeySignature");
79 SCM key
= get_property ("keySignature");
80 bool extranatural
= to_boolean (get_property ("extraNatural"));
82 if ((to_boolean (get_property ("printKeyCancellation"))
84 && !scm_is_eq (last
, key
))
86 SCM restore
= SCM_EOL
;
88 for (SCM s
= last
; scm_is_pair (s
); s
= scm_cdr (s
))
90 SCM new_alter_pair
= scm_assoc (scm_caar (s
), key
);
91 Rational old_alter
= robust_scm2rational (scm_cdar (s
), 0);
92 if (new_alter_pair
== SCM_BOOL_F
94 && (ly_scm2rational (scm_cdr (new_alter_pair
)) - old_alter
)*old_alter
97 *tail
= scm_cons (scm_car (s
), *tail
);
98 tail
= SCM_CDRLOC (*tail
);
102 if (scm_is_pair (restore
))
104 cancellation_
= make_item ("KeyCancellation",
106 ? key_event_
->self_scm () : SCM_EOL
);
108 cancellation_
->set_property ("alteration-alist", scm_reverse (restore
));
109 cancellation_
->set_property ("c0-position",
110 get_property ("middleCPosition"));
114 item_
->set_property ("alteration-alist", scm_reverse (key
));
119 SCM visibility
= get_property ("explicitKeySignatureVisibility");
120 item_
->set_property ("break-visibility", visibility
);
124 IMPLEMENT_TRANSLATOR_LISTENER (Key_engraver
, key_change
);
126 Key_engraver::listen_key_change (Stream_event
*ev
)
128 /* do this only once, just to be on the safe side. */
129 if (ASSIGN_EVENT_ONCE (key_event_
, ev
))
130 read_event (key_event_
);
134 Key_engraver::acknowledge_clef (Grob_info
/* info */)
136 SCM c
= get_property ("createKeyOnClefChange");
142 Key_engraver::acknowledge_bar_line (Grob_info
/* info */)
144 if (scm_is_pair (get_property ("keySignature")))
149 Key_engraver::process_music ()
152 || get_property ("lastKeySignature") != get_property ("keySignature"))
157 Key_engraver::stop_translation_timestep ()
160 context ()->set_property ("lastKeySignature", get_property ("keySignature"));
166 Key_engraver::read_event (Stream_event
const *r
)
168 SCM p
= r
->get_property ("pitch-alist");
169 if (!scm_is_pair (p
))
174 SCM alist
= scm_list_copy (p
);
175 SCM order
= get_property ("keyAlterationOrder");
177 scm_is_pair (s
) && scm_is_pair (alist
); s
= scm_cdr (s
))
179 SCM head
= scm_member (scm_car (s
), alist
);
181 if (scm_is_pair (head
))
183 accs
= scm_cons (scm_car (head
), accs
);
184 alist
= scm_delete_x (scm_car (head
), alist
);
188 if (scm_is_pair (alist
))
191 for (SCM s
= alist
; scm_is_pair (s
); s
= scm_cdr (s
))
192 if (ly_scm2rational (scm_cdar (s
)))
195 accs
= scm_cons (scm_car (s
), accs
);
199 r
->origin ()->warning ("No ordering for key signature alterations");
202 context ()->set_property ("keySignature", scm_reverse (accs
));
203 context ()->set_property ("tonic",
204 r
->get_property ("tonic"));
208 Key_engraver::initialize ()
210 context ()->set_property ("keySignature", SCM_EOL
);
211 context ()->set_property ("lastKeySignature", SCM_EOL
);
214 context ()->set_property ("tonic", p
.smobbed_copy ());
217 ADD_ACKNOWLEDGER (Key_engraver
, clef
);
218 ADD_ACKNOWLEDGER (Key_engraver
, bar_line
);
220 ADD_TRANSLATOR (Key_engraver
,
222 "Engrave a key signature.",
229 "createKeyOnClefChange "
230 "explicitKeySignatureVisibility "
232 "keyAlterationOrder "
235 "printKeyCancellation ",