2 key-engraver.cc -- implement Key_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
10 #include "command-request.hh"
11 #include "musical-request.hh"
13 #include "bar-line.hh"
14 #include "staff-symbol-referencer.hh"
15 #include "translator-group.hh"
16 #include "engraver.hh"
18 #include "protected-scm.hh"
22 Make the key signature.
24 class Key_engraver : public Engraver
26 void create_key (bool);
27 void read_req (Key_change_req const * r);
28 Key_change_req * keyreq_;
32 TRANSLATOR_DECLARATIONS(Key_engraver);
35 virtual void initialize ();
36 virtual void finalize ();
37 virtual bool try_music (Music *req);
38 virtual void stop_translation_timestep ();
39 virtual void start_translation_timestep ();
40 virtual void process_music ();
41 virtual void acknowledge_grob (Grob_info);
46 Key_engraver::finalize ()
51 Key_engraver::Key_engraver ()
59 Key_engraver::create_key (bool def)
63 item_ = new Item (get_property ("KeySignature"));
65 item_->set_grob_property ("c0-position",
66 get_property ("centralCPosition"));
68 // todo: put this in basic props.
69 item_->set_grob_property ("old-accidentals", get_property ("lastKeySignature"));
70 item_->set_grob_property ("new-accidentals", get_property ("keySignature"));
72 announce_grob(item_, keyreq_ ? keyreq_->self_scm() : SCM_EOL);
77 SCM vis = get_property ("explicitKeySignatureVisibility");
78 if (gh_procedure_p (vis))
79 item_->set_grob_property ("break-visibility",vis);
85 Key_engraver::try_music (Music * req)
87 if (Key_change_req *kc = dynamic_cast <Key_change_req *> (req))
89 if (keyreq_ && !keyreq_->equal_b (kc))
91 kc->origin ()->warning (_ ("Conflicting key signatures found."));
92 keyreq_->origin ()->warning (_ ("This was the other key definition."));
99 do this only once, just to be on the safe side.
112 Key_engraver::acknowledge_grob (Grob_info info)
114 if (Clef::has_interface (info.grob_))
116 SCM c = get_property ("createKeyOnClefChange");
122 else if (Bar_line::has_interface (info.grob_)
123 && gh_pair_p (get_property ("keySignature")))
131 Key_engraver::process_music ()
134 get_property ("lastKeySignature") != get_property ("keySignature"))
140 Key_engraver::stop_translation_timestep ()
144 typeset_grob (item_);
151 Key_engraver::read_req (Key_change_req const * r)
153 SCM p = r->get_mus_property ("pitch-alist");
157 SCM n = scm_list_copy (p);
159 for (SCM s = get_property ("keyAccidentalOrder");
160 gh_pair_p (s); s = ly_cdr (s))
162 if (gh_pair_p (scm_member (ly_car (s), n)))
164 accs = gh_cons (ly_car (s), accs);
165 n = scm_delete_x (ly_car (s), n);
169 for (SCM s = n ; gh_pair_p (s); s = ly_cdr (s))
170 if (gh_scm2int (ly_cdar (s)))
171 accs = gh_cons (ly_car (s), accs);
174 daddy_trans_->set_property ("lastKeySignature",
175 get_property ("keySignature"));
178 daddy_trans_->set_property ("keySignature", accs);
183 Key_engraver::start_translation_timestep ()
186 daddy_trans_->set_property ("lastKeySignature", get_property ("keySignature"));
191 Key_engraver::initialize ()
193 daddy_trans_->set_property ("keySignature", SCM_EOL);
194 daddy_trans_->set_property ("lastKeySignature", SCM_EOL);
198 ENTER_DESCRIPTION(Key_engraver,
200 /* creats*/ "KeySignature",
201 /* accepts */ "key-change-event",
202 /* acks */ "bar-line-interface clef-interface",
203 /* reads */ "keySignature lastKeySignature explicitKeySignatureVisibility createKeyOnClefChange keyAccidentalOrder keySignature",
204 /* write */ "lastKeySignature");