X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fkey-engraver.cc;h=fd60570821e05dc37f875d0255942d82b63f7284;hb=3ea291c21ce16aeaf00b6a6f500bf0a3a9b790d9;hp=85419c2a1901bd7aa2217fae55f1bcbcbd60e389;hpb=e7d84e6728ecfdf74d8f214486a29c2aca199819;p=lilypond.git diff --git a/lily/key-engraver.cc b/lily/key-engraver.cc index 85419c2a19..fd60570821 100644 --- a/lily/key-engraver.cc +++ b/lily/key-engraver.cc @@ -1,216 +1,241 @@ /* - key-engraver.cc -- implement Key_engraver - - source file of the GNU LilyPond music typesetter - - (c) 1997--2000 Han-Wen Nienhuys - */ -// clean me up -#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 "timing-translator.hh" + This file is part of LilyPond, the GNU music typesetter. + + Copyright (C) 1997--2012 Han-Wen Nienhuys + + LilyPond is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + LilyPond is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with LilyPond. If not, see . +*/ + +#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 +{ + 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::finalize () { - item_p_ = 0; - do_post_move_processing (); } -bool -Key_engraver::key_changed_b () const +Key_engraver::Key_engraver () { - return keyreq_l_ ; + key_event_ = 0; + item_ = 0; + cancellation_ = 0; } void -Key_engraver::create_key (bool def) +Key_engraver::create_key (bool is_default) { - if (!item_p_) + if (!item_) { - item_p_ = new Key_item; - item_p_->property_alist_ = get_property ("basicKeyProperties"); - - - item_p_->set_elt_property ("c0-position", gh_int2scm (0)); - item_p_->set_elt_property ("old-accidentals", SCM_EOL); - item_p_->set_elt_property ("new-accidentals", SCM_EOL); - - Staff_symbol_referencer_interface st (item_p_); - st.set_interface (); - - if (key_.multi_octave_b_) - item_p_->set_elt_property ("multi-octave", gh_bool2scm (key_.multi_octave_b_)); - - announce_element (Score_element_info (item_p_,keyreq_l_)); - - - for (int i = 0; i < accidental_idx_arr_.size(); i++) - { - Musical_pitch m_l =accidental_idx_arr_[i]; - int a =m_l.accidental_i_; - if (key_.multi_octave_b_) - item_p_->add (m_l.steps (), a); - else - item_p_->add (m_l.notename_i_, a); - } - - for (int i = 0 ; i < old_accidental_idx_arr_.size(); i++) - { - Musical_pitch m_l =old_accidental_idx_arr_[i]; - int a =m_l.accidental_i_; - if (key_.multi_octave_b_) - item_p_->add_old (m_l.steps (), a); - else - item_p_->add_old (m_l.notename_i_, a); - } + item_ = make_item ("KeySignature", + key_event_ ? key_event_->self_scm () : SCM_EOL); + + /* Use middleCClefPosition rather than middleCPosition, because cue + * notes with a different clef will modify middleCPosition. The + * Key signature, however, should still be printed at the original + * position. */ + item_->set_property ("c0-position", + get_property ("middleCClefPosition")); + + SCM last = get_property ("lastKeySignature"); + SCM key = get_property ("keySignature"); + + if ((to_boolean (get_property ("printKeyCancellation")) + || key == SCM_EOL) + && !scm_is_eq (last, key)) + { + SCM restore = SCM_EOL; + 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 + || ((ly_scm2rational (scm_cdr (new_alter_pair)) - old_alter) * old_alter + < Rational (0))) + { + restore = scm_cons (scm_car (s), restore); + } + } + + 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", scm_reverse (key)); } - - if (!def) - item_p_->set_elt_property ("visibility-lambda", - scm_eval (ly_symbol2scm ("all-visible"))); - -} - - -bool -Key_engraver::do_try_music (Music * req_l) -{ - if (Key_change_req *kc = dynamic_cast (req_l)) + if (!is_default) { - if (keyreq_l_) - warning (_ ("FIXME: key change merge")); - keyreq_l_ = kc; - read_req (keyreq_l_); - return true; - } - return false; + SCM visibility = get_property ("explicitKeySignatureVisibility"); + item_->set_property ("break-visibility", visibility); + } } +IMPLEMENT_TRANSLATOR_LISTENER (Key_engraver, key_change); void -Key_engraver::acknowledge_element (Score_element_info info) +Key_engraver::listen_key_change (Stream_event *ev) { - if (dynamic_cast (info.req_l_)) - { - SCM c = get_property ("createKeyOnClefChange"); - if (to_boolean (c)) - { - create_key (false); - - } - } - else if (dynamic_cast (info.elem_l_) - && accidental_idx_arr_.size ()) - { - create_key (true); - } + /* 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::acknowledge_clef (Grob_info /* info */) +{ + SCM c = get_property ("createKeyOnClefChange"); + if (to_boolean (c)) + create_key (false); } void -Key_engraver::do_process_music () +Key_engraver::acknowledge_bar_line (Grob_info /* info */) { - if (keyreq_l_) - { - create_key (false); - } + if (scm_is_pair (get_property ("keySignature"))) + create_key (true); } void -Key_engraver::do_pre_move_processing () -{ - if (item_p_) - { - typeset_element (item_p_); - item_p_ = 0; - } +Key_engraver::process_music () +{ + if (key_event_ + || get_property ("lastKeySignature") != get_property ("keySignature")) + create_key (false); } +void +Key_engraver::stop_translation_timestep () +{ + item_ = 0; + context ()->set_property ("lastKeySignature", get_property ("keySignature")); + cancellation_ = 0; + key_event_ = 0; +} -/* - TODO. Use properties; and this is too hairy. - */ void -Key_engraver::read_req (Key_change_req const * r) +Key_engraver::read_event (Stream_event const *r) { - if (!r->key_) + SCM p = r->get_property ("pitch-alist"); + if (!scm_is_pair (p)) return; - - old_accidental_idx_arr_ = accidental_idx_arr_; - key_.clear (); - SCM prop = get_property ("keyOctaviation"); - key_.multi_octave_b_ = to_boolean (prop); - - accidental_idx_arr_.clear (); + SCM accs = SCM_EOL; - if (r->key_->ordinary_key_b_) + 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)) { - int no_of_acc = r->key_->ordinary_accidentals_i (); - - // Hmm, can't these be handled/constructed by Key_change_req? - if (no_of_acc < 0) - { - 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 ; - } - } + SCM head = scm_member (scm_car (s), alist); + + if (scm_is_pair (head)) + { + 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->key_->pitch_arr_.size (); i ++) - { - Musical_pitch m_l =r->key_->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 ("Incomplete keyAlterationOrder for key signature"); } + + context ()->set_property ("keySignature", scm_reverse_x (accs, SCM_EOL)); + context ()->set_property ("tonic", + r->get_property ("tonic")); } void -Key_engraver::do_post_move_processing () +Key_engraver::initialize () { - keyreq_l_ = 0; - old_accidental_idx_arr_.clear (); -} + context ()->set_property ("keySignature", SCM_EOL); + context ()->set_property ("lastKeySignature", SCM_EOL); -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 " + "middleCClefPosition ", + + /* write */ + "keySignature " + "lastKeySignature " + "tonic " + );