2 key-engraver.cc -- implement Key_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
10 #include "bar-line.hh"
11 #include "staff-symbol-referencer.hh"
13 #include "engraver.hh"
14 #include "protected-scm.hh"
18 TODO: The representation of key sigs is all fucked.
22 Make the key signature.
24 class Key_engraver : public Engraver
26 void create_key (bool);
27 void read_ev (Music const *r);
33 TRANSLATOR_DECLARATIONS (Key_engraver);
36 virtual void initialize ();
37 virtual void finalize ();
38 virtual bool try_music (Music *ev);
39 virtual void stop_translation_timestep ();
40 virtual void start_translation_timestep ();
41 virtual void process_music ();
42 virtual void acknowledge_grob (Grob_info);
46 Key_engraver::finalize ()
50 Key_engraver::Key_engraver ()
58 Key_engraver::create_key (bool def)
62 item_ = make_item ("KeySignature", key_ev_ ? key_ev_->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 if (to_boolean (get_property ("printKeyCancellation"))
70 && !scm_is_eq (last, key))
72 cancellation_ = make_item ("KeyCancellation", key_ev_ ? key_ev_->self_scm () : SCM_EOL);
73 cancellation_->set_property ("old-accidentals", last);
74 cancellation_->set_property ("c0-position",
75 get_property ("middleCPosition"));
78 item_->set_property ("new-accidentals", key);
83 SCM vis = get_property ("explicitKeySignatureVisibility");
84 if (ly_c_procedure_p (vis))
85 item_->set_property ("break-visibility", vis);
90 Key_engraver::try_music (Music *ev)
92 if (ev->is_mus_type ("key-change-event"))
94 /* do this only once, just to be on the safe side. */
106 Key_engraver::acknowledge_grob (Grob_info info)
108 if (Clef::has_interface (info.grob_))
110 SCM c = get_property ("createKeyOnClefChange");
116 else if (Bar_line::has_interface (info.grob_)
117 && scm_is_pair (get_property ("keySignature")))
124 Key_engraver::process_music ()
127 || get_property ("lastKeySignature") != get_property ("keySignature"))
132 Key_engraver::stop_translation_timestep ()
135 context ()->set_property ("lastKeySignature", get_property ("keySignature"));
140 Key_engraver::read_ev (Music const *r)
142 SCM p = r->get_property ("pitch-alist");
143 if (!scm_is_pair (p))
146 SCM n = scm_list_copy (p);
148 for (SCM s = get_property ("keyAccidentalOrder");
149 scm_is_pair (s); s = scm_cdr (s))
151 if (scm_is_pair (scm_member (scm_car (s), n)))
153 accs = scm_cons (scm_car (s), accs);
154 n = scm_delete_x (scm_car (s), n);
158 for (SCM s = n; scm_is_pair (s); s = scm_cdr (s))
159 if (scm_to_int (scm_cdar (s)))
160 accs = scm_cons (scm_car (s), accs);
162 context ()->set_property ("keySignature", accs);
163 context ()->set_property ("tonic",
164 r->get_property ("tonic"));
168 Key_engraver::start_translation_timestep ()
174 Key_engraver::initialize ()
176 context ()->set_property ("keySignature", SCM_EOL);
177 context ()->set_property ("lastKeySignature", SCM_EOL);
180 context ()->set_property ("tonic", p.smobbed_copy ());
184 ADD_TRANSLATOR (Key_engraver,
186 /* creats*/ "KeySignature",
187 /* accepts */ "key-change-event",
188 /* acks */ "bar-line-interface clef-interface",
189 /* reads */ "keySignature printKeyCancellation lastKeySignature explicitKeySignatureVisibility createKeyOnClefChange keyAccidentalOrder keySignature",
190 /* write */ "lastKeySignature tonic keySignature");