X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fkey-engraver.cc;h=11234556fd058961112b96b1a9b947eed478f7da;hb=refs%2Fheads%2Fbugs%2F572290;hp=bb66802d8604f6045f07449fe4ea758a8ef9e52f;hpb=9efbad2d9487a05b04423e7e9f062968e8f8eaf4;p=lilypond.git diff --git a/lily/key-engraver.cc b/lily/key-engraver.cc index bb66802d86..11234556fd 100644 --- a/lily/key-engraver.cc +++ b/lily/key-engraver.cc @@ -1,191 +1,230 @@ /* - key-reg.cc -- implement Key_engraver + key-engraver.cc -- implement Key_engraver source file of the GNU LilyPond music typesetter - (c) 1997--1998 Han-Wen Nienhuys + (c) 1997--2009 Han-Wen Nienhuys +*/ - */ -#include "key-engraver.hh" -#include "key-item.hh" -#include "command-request.hh" -#include "local-key-engraver.hh" -#include "musical-request.hh" -#include "local-key-item.hh" -#include "bar.hh" -#include "time-description.hh" +#include "bar-line.hh" +#include "clef.hh" +#include "context.hh" +#include "engraver.hh" +#include "item.hh" +#include "pitch.hh" +#include "protected-scm.hh" +#include "staff-symbol-referencer.hh" +#include "stream-event.hh" -Key_engraver::Key_engraver () +#include "translator.icc" + +class Key_engraver : public Engraver { - kit_p_ = 0; - do_post_move_processing (); -} + void create_key (bool); + void read_event (Stream_event const *r); + + Stream_event *key_event_; + Item *item_; + Item *cancellation_; +public: + TRANSLATOR_DECLARATIONS (Key_engraver); + +protected: + virtual void initialize (); + virtual void finalize (); + void stop_translation_timestep (); + void process_music (); + + DECLARE_TRANSLATOR_LISTENER (key_change); + DECLARE_ACKNOWLEDGER (clef); + DECLARE_ACKNOWLEDGER (bar_line); +}; void -Key_engraver::create_key () +Key_engraver::finalize () { - if (!kit_p_) - { - kit_p_ = new Key_item; - kit_p_->break_priority_i_ = -1; // ugh - announce_element (Score_element_info (kit_p_,keyreq_l_)); - kit_p_->set (key_.multi_octave_b_, accidental_idx_arr_, old_accidental_idx_arr_); - } } -bool -Key_engraver::do_try_request (Request * req_l) +Key_engraver::Key_engraver () { - Command_req* creq_l= dynamic_cast (req_l); - if (!creq_l|| !dynamic_cast (creq_l)) - return false; - - if (keyreq_l_) - return false; // TODO - keyreq_l_ = dynamic_cast (creq_l); - read_req (keyreq_l_); - return true; + key_event_ = 0; + item_ = 0; + cancellation_ = 0; } + void -Key_engraver::acknowledge_element (Score_element_info info) +Key_engraver::create_key (bool is_default) { - Command_req * r_l = dynamic_cast (info.req_l_) ; - - if (r_l && dynamic_cast (r_l)) + if (!item_) { - int i= get_property ("createKeyOnClefChange").length_i (); - if (i) - create_key (); + item_ = make_item ("KeySignature", + key_event_ ? key_event_->self_scm () : SCM_EOL); + + item_->set_property ("c0-position", + get_property ("middleCPosition")); + + SCM last = get_property ("lastKeySignature"); + SCM key = get_property ("keySignature"); + bool extranatural = to_boolean (get_property ("extraNatural")); + + if ((to_boolean (get_property ("printKeyCancellation")) + || key == SCM_EOL) + && !scm_is_eq (last, key)) + { + SCM restore = SCM_EOL; + SCM *tail = &restore; + for (SCM s = last; scm_is_pair (s); s = scm_cdr (s)) + { + SCM new_alter_pair = scm_assoc (scm_caar (s), key); + Rational old_alter = robust_scm2rational (scm_cdar (s), 0); + if (new_alter_pair == SCM_BOOL_F + || (extranatural + && (ly_scm2rational (scm_cdr (new_alter_pair)) - old_alter)*old_alter + < Rational (0))) + { + *tail = scm_cons (scm_car (s), *tail); + tail = SCM_CDRLOC (*tail); + } + } + + if (scm_is_pair (restore)) + { + cancellation_ = make_item ("KeyCancellation", + key_event_ + ? key_event_->self_scm () : SCM_EOL); + + cancellation_->set_property ("alteration-alist", restore); + cancellation_->set_property ("c0-position", + get_property ("middleCPosition")); + } + } + + item_->set_property ("alteration-alist", key); } - else if (info.elem_l_->is_type_b (Bar::static_name ()) - && accidental_idx_arr_.size ()) + + if (!is_default) { - if (!keyreq_l_) - default_key_b_ = true; - create_key (); + SCM visibility = get_property ("explicitKeySignatureVisibility"); + item_->set_property ("break-visibility", visibility); } +} +IMPLEMENT_TRANSLATOR_LISTENER (Key_engraver, key_change); +void +Key_engraver::listen_key_change (Stream_event *ev) +{ + /* do this only once, just to be on the safe side. */ + if (ASSIGN_EVENT_ONCE (key_event_, ev)) + read_event (key_event_); } void -Key_engraver::do_process_requests () +Key_engraver::acknowledge_clef (Grob_info /* info */) { - if (keyreq_l_) - { - create_key (); - } + SCM c = get_property ("createKeyOnClefChange"); + if (to_boolean (c)) + create_key (false); } void -Key_engraver::do_pre_move_processing () -{ - if (kit_p_) - { - kit_p_->default_b_ = default_key_b_; - typeset_element (kit_p_); - kit_p_ = 0; - } +Key_engraver::acknowledge_bar_line (Grob_info /* info */) +{ + if (scm_is_pair (get_property ("keySignature"))) + create_key (true); } +void +Key_engraver::process_music () +{ + if (key_event_ + || get_property ("lastKeySignature") != get_property ("keySignature")) + create_key (false); +} -/* - TODO Slightly hairy. - */ void -Key_engraver::read_req (Key_change_req const * r) +Key_engraver::stop_translation_timestep () { - old_accidental_idx_arr_ = accidental_idx_arr_; - key_.clear (); - Scalar prop = get_property ("keyoctaviation"); - if (prop.length_i () > 0) - { - key_.multi_octave_b_ = ! prop.to_bool (); - } - - accidental_idx_arr_.clear (); + item_ = 0; + context ()->set_property ("lastKeySignature", get_property ("keySignature")); + cancellation_ = 0; + key_event_ = 0; +} - if (r->ordinary_key_b_) - { - int p; - if (r->pitch_arr_.size () < 1) - { - r->warning (_ ("No key name: assuming `C'")); - p = 0; - } - else - { - p = r->pitch_arr_[0].semitone_pitch (); - if (r->minor_b ()) - p += 3; - } - /* Solve the equation 7*no_of_acc mod 12 = p, -6 <= no_of_acc <= 5 */ - int no_of_acc = (7*p) % 12; - no_of_acc = (no_of_acc + 18) % 12 -6; +void +Key_engraver::read_event (Stream_event const *r) +{ + SCM p = r->get_property ("pitch-alist"); + if (!scm_is_pair (p)) + return; - /* Correct from flats to sharps or vice versa */ - if (no_of_acc * r->pitch_arr_[0].accidental_i_ < 0) - no_of_acc += 12 * sign (r->pitch_arr_[0].accidental_i_); + SCM accs = SCM_EOL; - if (no_of_acc < 0) + SCM alist = scm_list_copy (p); + SCM order = get_property ("keyAlterationOrder"); + for (SCM s = order; + scm_is_pair (s) && scm_is_pair (alist); s = scm_cdr (s)) + { + SCM head = scm_member (scm_car (s), alist); + + if (scm_is_pair (head)) { - int accidental = 6 ; // First accidental: bes - for ( ; no_of_acc < 0 ; no_of_acc++ ) - { - Musical_pitch m; - m.accidental_i_ = -1; - m.notename_i_ = accidental; - if (key_.multi_octave_b_) - key_.set (m); - else - key_.set (m.notename_i_, m.accidental_i_); - accidental_idx_arr_.push (m); - - accidental = (accidental + 3) % 7 ; - } - } - else - { - int accidental = 3 ; // First accidental: fis - for ( ; no_of_acc > 0 ; no_of_acc-- ) - { - Musical_pitch m; - m.accidental_i_ = 1; - m.notename_i_ = accidental; - if (key_.multi_octave_b_) - key_.set (m); - else - key_.set (m.notename_i_, m.accidental_i_); - accidental_idx_arr_.push (m); - - accidental = (accidental + 4) % 7 ; - } + accs = scm_cons (scm_car (head), accs); + alist = scm_delete_x (scm_car (head), alist); } } - else // Special key + + if (scm_is_pair (alist)) { - for (int i = 0; i < r->pitch_arr_.size (); i ++) - { - Musical_pitch m_l =r->pitch_arr_[i]; - if (key_.multi_octave_b_) - key_.set (m_l); - else - key_.set (m_l.notename_i_, m_l.accidental_i_); - - accidental_idx_arr_.push (m_l); - } + bool warn = false; + for (SCM s = alist; scm_is_pair (s); s = scm_cdr (s)) + if (ly_scm2rational (scm_cdar (s))) + { + warn = true; + accs = scm_cons (scm_car (s), accs); + } + + if (warn) + r->origin ()->warning ("No ordering for key signature alterations"); } + + context ()->set_property ("keySignature", accs); + context ()->set_property ("tonic", + r->get_property ("tonic")); } void -Key_engraver::do_post_move_processing () +Key_engraver::initialize () { - keyreq_l_ = 0; - default_key_b_ = false; - old_accidental_idx_arr_.clear (); -} - + context ()->set_property ("keySignature", SCM_EOL); + context ()->set_property ("lastKeySignature", SCM_EOL); -IMPLEMENT_IS_TYPE_B1 (Key_engraver,Engraver); -ADD_THIS_TRANSLATOR (Key_engraver); + Pitch p (0, 0, 0); + context ()->set_property ("tonic", p.smobbed_copy ()); +} +ADD_ACKNOWLEDGER (Key_engraver, clef); +ADD_ACKNOWLEDGER (Key_engraver, bar_line); + +ADD_TRANSLATOR (Key_engraver, + /* doc */ + "Engrave a key signature.", + + /* create */ + "KeyCancellation " + "KeySignature ", + + /* read */ + "createKeyOnClefChange " + "explicitKeySignatureVisibility " + "extraNatural " + "keyAlterationOrder " + "keySignature " + "lastKeySignature " + "printKeyCancellation ", + + /* write */ + "keySignature " + "lastKeySignature " + "tonic " + );