2 key-engraver.cc -- implement Key_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2009 Han-Wen Nienhuys <hanwen@xs4all.nl>
12 #include "engraver.hh"
15 #include "protected-scm.hh"
16 #include "staff-symbol-referencer.hh"
17 #include "stream-event.hh"
19 #include "translator.icc"
21 class Key_engraver
: public Engraver
23 void create_key (bool);
24 void read_event (Stream_event
const *r
);
26 Stream_event
*key_event_
;
30 TRANSLATOR_DECLARATIONS (Key_engraver
);
33 virtual void initialize ();
34 virtual void finalize ();
35 void stop_translation_timestep ();
36 void process_music ();
38 DECLARE_TRANSLATOR_LISTENER (key_change
);
39 DECLARE_ACKNOWLEDGER (clef
);
40 DECLARE_ACKNOWLEDGER (bar_line
);
44 Key_engraver::finalize ()
48 Key_engraver::Key_engraver ()
57 Key_engraver::create_key (bool is_default
)
61 item_
= make_item ("KeySignature",
62 key_event_
? key_event_
->self_scm () : SCM_EOL
);
64 item_
->set_property ("c0-position",
65 get_property ("middleCPosition"));
67 SCM last
= get_property ("lastKeySignature");
68 SCM key
= get_property ("keySignature");
69 bool extranatural
= to_boolean (get_property ("extraNatural"));
71 if ((to_boolean (get_property ("printKeyCancellation"))
73 && !scm_is_eq (last
, key
))
75 SCM restore
= SCM_EOL
;
77 for (SCM s
= last
; scm_is_pair (s
); s
= scm_cdr (s
))
79 SCM new_alter_pair
= scm_assoc (scm_caar (s
), key
);
80 Rational old_alter
= robust_scm2rational (scm_cdar (s
), 0);
81 if (new_alter_pair
== SCM_BOOL_F
83 && (ly_scm2rational (scm_cdr (new_alter_pair
)) - old_alter
)*old_alter
86 *tail
= scm_cons (scm_car (s
), *tail
);
87 tail
= SCM_CDRLOC (*tail
);
91 if (scm_is_pair (restore
))
93 cancellation_
= make_item ("KeyCancellation",
95 ? key_event_
->self_scm () : SCM_EOL
);
97 cancellation_
->set_property ("alteration-alist", scm_reverse (restore
));
98 cancellation_
->set_property ("c0-position",
99 get_property ("middleCPosition"));
103 item_
->set_property ("alteration-alist", scm_reverse (key
));
108 SCM visibility
= get_property ("explicitKeySignatureVisibility");
109 item_
->set_property ("break-visibility", visibility
);
113 IMPLEMENT_TRANSLATOR_LISTENER (Key_engraver
, key_change
);
115 Key_engraver::listen_key_change (Stream_event
*ev
)
117 /* do this only once, just to be on the safe side. */
118 if (ASSIGN_EVENT_ONCE (key_event_
, ev
))
119 read_event (key_event_
);
123 Key_engraver::acknowledge_clef (Grob_info
/* info */)
125 SCM c
= get_property ("createKeyOnClefChange");
131 Key_engraver::acknowledge_bar_line (Grob_info
/* info */)
133 if (scm_is_pair (get_property ("keySignature")))
138 Key_engraver::process_music ()
141 || get_property ("lastKeySignature") != get_property ("keySignature"))
146 Key_engraver::stop_translation_timestep ()
149 context ()->set_property ("lastKeySignature", get_property ("keySignature"));
155 Key_engraver::read_event (Stream_event
const *r
)
157 SCM p
= r
->get_property ("pitch-alist");
158 if (!scm_is_pair (p
))
163 SCM alist
= scm_list_copy (p
);
164 SCM order
= get_property ("keyAlterationOrder");
166 scm_is_pair (s
) && scm_is_pair (alist
); s
= scm_cdr (s
))
168 SCM head
= scm_member (scm_car (s
), alist
);
170 if (scm_is_pair (head
))
172 accs
= scm_cons (scm_car (head
), accs
);
173 alist
= scm_delete_x (scm_car (head
), alist
);
177 if (scm_is_pair (alist
))
180 for (SCM s
= alist
; scm_is_pair (s
); s
= scm_cdr (s
))
181 if (ly_scm2rational (scm_cdar (s
)))
184 accs
= scm_cons (scm_car (s
), accs
);
188 r
->origin ()->warning ("No ordering for key signature alterations");
191 context ()->set_property ("keySignature", scm_reverse (accs
));
192 context ()->set_property ("tonic",
193 r
->get_property ("tonic"));
197 Key_engraver::initialize ()
199 context ()->set_property ("keySignature", SCM_EOL
);
200 context ()->set_property ("lastKeySignature", SCM_EOL
);
203 context ()->set_property ("tonic", p
.smobbed_copy ());
206 ADD_ACKNOWLEDGER (Key_engraver
, clef
);
207 ADD_ACKNOWLEDGER (Key_engraver
, bar_line
);
209 ADD_TRANSLATOR (Key_engraver
,
211 "Engrave a key signature.",
218 "createKeyOnClefChange "
219 "explicitKeySignatureVisibility "
221 "keyAlterationOrder "
224 "printKeyCancellation ",