X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Faccidental-engraver.cc;h=ce9a670f044a462a268f172a27fcbbec87036cd6;hb=cf598802e81eea3d5ced00bf98e48227da3f18a0;hp=14dd955cd3a18914530f1a594bb57a87e3119ae7;hpb=2fc177dc2401903f604f4520c7b59e1544046ed5;p=lilypond.git diff --git a/lily/accidental-engraver.cc b/lily/accidental-engraver.cc index 14dd955cd3..ce9a670f04 100644 --- a/lily/accidental-engraver.cc +++ b/lily/accidental-engraver.cc @@ -1,349 +1,623 @@ /* accidental-engraver.cc -- implement accidental_engraver - (c) 1997--2002 Han-Wen Nienhuys - Modified 2001 by Rune Zedeler + source file of the GNU LilyPond music typesetter + + (c) 1997--2007 Han-Wen Nienhuys + Modified 2001--2002 by Rune Zedeler */ -#include "musical-request.hh" -#include "command-request.hh" -#include "local-key-item.hh" +#include "accidental-placement.hh" +#include "arpeggio.hh" +#include "spanner.hh" +#include "context.hh" #include "item.hh" -#include "tie.hh" +#include "engraver.hh" +#include "international.hh" +#include "pitch.hh" +#include "protected-scm.hh" #include "rhythmic-head.hh" -#include "engraver-group-engraver.hh" - -#include "staff-symbol-referencer.hh" +#include "separation-item.hh" #include "side-position-interface.hh" -#include "engraver.hh" -#include "arpeggio.hh" +#include "stream-event.hh" +#include "tie.hh" #include "warn.hh" -/** +#include "translator.icc" +class Accidental_entry +{ +public: + bool done_; + Stream_event *melodic_; + Grob *accidental_; + Context *origin_; + Engraver *origin_engraver_; + Grob *head_; + bool tied_; + + Accidental_entry (); +}; - FIXME: should not compute vertical positioning of accidentals, but - get them from the noteheads +Accidental_entry::Accidental_entry () +{ + tied_ = false; + done_ = false; + melodic_ = 0; + accidental_ = 0; + origin_ = 0; + head_ = 0; +} - The algorithm for accidentals should be documented, and made - tweakable. +class Accidental_engraver : public Engraver +{ + int get_bar_number (); + void update_local_key_signature (SCM new_signature); + void create_accidental (Accidental_entry *entry, bool, bool); + Grob *make_standard_accidental (Stream_event *note, Grob *note_head, Engraver *trans, bool); + Grob *make_suggested_accidental (Stream_event *note, Grob *note_head, Engraver *trans); -*/ +protected: + TRANSLATOR_DECLARATIONS (Accidental_engraver); + void process_music (); + void acknowledge_tie (Grob_info); + void acknowledge_arpeggio (Grob_info); + void acknowledge_rhythmic_head (Grob_info); + void acknowledge_finger (Grob_info); + void acknowledge_note_column (Grob_info); -struct Accidental_engraver : Engraver { - Item *key_item_p_; -protected: - TRANSLATOR_DECLARATIONS(Accidental_engraver); - virtual void process_music (); - virtual void acknowledge_grob (Grob_info); - virtual void stop_translation_timestep (); - virtual void initialize (); - virtual void create_grobs (); + void stop_translation_timestep (); + void process_acknowledged (); + virtual void finalize (); -public: + virtual void derived_mark () const; - // todo -> property +public: SCM last_keysig_; - /* - Urgh. Since the accidentals depend on lots of variables, we have to - store all information before we can really create the accidentals. - */ - Link_array arpeggios_; - - Link_array mel_l_arr_; - Link_array head_l_arr_; - Link_array forced_l_arr_; - Link_array tie_l_arr_; + vector left_objects_; + vector right_objects_; + + Grob *accidental_placement_; + vector accidentals_; + vector ties_; + vector note_columns_; }; +/* + localKeySignature is changed at runtime, which means that references + in grobs should always store ly_deep_copy ()s of those. +*/ + Accidental_engraver::Accidental_engraver () { - key_item_p_ =0; + accidental_placement_ = 0; last_keysig_ = SCM_EOL; } void -Accidental_engraver::initialize () +Accidental_engraver::derived_mark () const { - last_keysig_ = get_property ("keySignature"); - daddy_trans_l_->set_property ("localKeySignature", last_keysig_); + scm_gc_mark (last_keysig_); } -/** calculates the number of accidentals on basis of the current local key sig - * (passed as argument). - * Returns number of accidentals (0, 1 or 2). - * Negative (-1 or -2) if accidental has changed. - **/ -static int -number_accidentals (SCM sig, Note_req * note_l, SCM curbarnum, SCM lazyness, - bool ignore_octave_b) +void +Accidental_engraver::update_local_key_signature (SCM new_sig) { - Pitch *pitch = unsmob_pitch (note_l->get_mus_property ("pitch")); - int n = pitch->notename_i_; - int o = pitch->octave_i_; - int a = pitch->alteration_i_; - int curbarnum_i = gh_scm2int(curbarnum); - int accbarnum_i = 0; - SCM prev; - if (ignore_octave_b) - prev = ly_assoc_cdr (gh_int2scm (n), sig); + last_keysig_ = new_sig; + set_context_property_on_children (context (), + ly_symbol2scm ("localKeySignature"), + new_sig); + + Context *trans = context ()->get_parent_context (); + + /* Reset parent contexts so that e.g. piano-accidentals won't remember old + cross-staff accidentals after key-sig-changes */ + + SCM val; + while (trans && trans->where_defined (ly_symbol2scm ("localKeySignature"), &val)==trans) + { + trans->set_property ("localKeySignature", ly_deep_copy (last_keysig_)); + trans = trans->get_parent_context (); + } +} + + +/** Calculate the number of accidentals on basis of the current local key + sig (passed as argument) + + * First check step+octave (taking into account barnumbers if necessary). + + * Then check the global signature (only step). + + Return number of accidentals (0, 1 or 2). */ + +static bool +recent_enough (int bar_number, SCM alteration_def, SCM laziness) +{ + if (scm_is_number (alteration_def) + || laziness == SCM_BOOL_T) + return true; + + return (bar_number <= scm_to_int (scm_cdr (alteration_def)) + scm_to_int (laziness)); +} + +static Rational +extract_alteration (SCM alteration_def) +{ + if (scm_is_number (alteration_def)) + return ly_scm2rational (alteration_def); + else if (scm_is_pair (alteration_def)) + return ly_scm2rational (scm_car (alteration_def)); + else if (alteration_def == SCM_BOOL_F) + return Rational (0); else - prev = gh_assoc (gh_cons (gh_int2scm (o), gh_int2scm (n)), sig); - /* should really be true unless prev==SCM_BOOL_F */ - if(gh_pair_p(prev) && gh_pair_p(ly_cdr(prev))) { - accbarnum_i = gh_scm2int(ly_cddr(prev)); - prev = gh_cons(ly_car(prev),ly_cadr(prev)); + assert (0); + return Rational (0); +} + +bool +is_tied (SCM alteration_def) +{ + SCM tied = ly_symbol2scm ("tied"); + return (alteration_def == tied + || (scm_is_pair (alteration_def) && scm_car (alteration_def) == tied)); +} + +struct Accidental_result +{ + bool need_acc; + bool need_restore; + + Accidental_result () { + need_restore = need_acc = false; } - /* If an accidental was not found or the accidental was too old */ - if (prev == SCM_BOOL_F || - (gh_number_p(lazyness) && curbarnum_i>accbarnum_i+gh_scm2int(lazyness))) - prev = gh_assoc (gh_int2scm (n), sig); - SCM prev_acc = (prev == SCM_BOOL_F) ? gh_int2scm (0) : ly_cdr (prev); - - int p = gh_number_p (prev_acc) ? gh_scm2int (prev_acc) : 0; - - int num; - if (a==p && !to_boolean (note_l->get_mus_property ("force-accidental")) && gh_number_p(prev_acc)) num=0; - else if ( (abs(a)get_property ("localKeySignature"); + + bool same_octave + = (ly_symbol2scm ("same-octave") == type); + bool any_octave + = (ly_symbol2scm ("any-octave") == type); + + if (same_octave || any_octave) + { + Accidental_result rule_result = check_pitch_against_signature + (localsig, pitch, bar_number, laziness, any_octave); + + result.need_acc |= rule_result.need_acc; + result.need_restore |= rule_result.need_restore; + } + else + warning (_f ("ignoring unknown accidental rule: %s", + ly_symbol2string (type).c_str ())); + } + + /* if symbol then it is a context name. Scan parent contexts to + find it. */ + else if (scm_is_symbol (rule)) + { + Context *dad = origin; + while (dad && !dad->is_alias (rule)) + dad = dad->get_parent_context (); + + if (dad) + origin = dad; + } + else + warning (_f ("pair or context-name expected for accidental rule, found %s", + ly_scm2string (rule).c_str ())); } - else warning(_f("Accidental typesetting must be pair: %s", - ly_scm2string(ly_car(accidentals_l)).ch_C())); - accidentals_l = ly_cdr(accidentals_l); - } - return diff ? -number : number; + + return result; +} + +int +Accidental_engraver::get_bar_number () +{ + SCM barnum = get_property ("internalBarNumber"); + SCM smp = get_property ("measurePosition"); + + int bn = robust_scm2int (barnum, 0); + + Moment mp = robust_scm2moment (smp, Moment (0)); + if (mp.main_part_ < Rational (0)) + bn--; + + return bn; } void -Accidental_engraver::create_grobs () +Accidental_engraver::process_acknowledged () { - if (!key_item_p_ && mel_l_arr_.size ()) + if (accidentals_.size () && !accidentals_.back ().done_) { - SCM localsig = get_property ("localKeySignature"); - SCM accidentals_l = get_property ("autoAccidentals"); - SCM cautionaries_l = get_property ("autoCautionaries"); - SCM barnum = get_property ("currentBarNumber"); + SCM accidental_rules = get_property ("autoAccidentals"); + SCM cautionary_rules = get_property ("autoCautionaries"); + int barnum = get_bar_number (); - bool extra_natural_b = get_property ("extraNatural")==SCM_BOOL_T; - for (int i=0; i < mel_l_arr_.size (); i++) + for (vsize i = 0; i < accidentals_.size (); i++) { - Grob * support_l = head_l_arr_[i]; - Note_req * note_l = mel_l_arr_[i]; + if (accidentals_[i].done_) + continue; + accidentals_[i].done_ = true; + + Stream_event *note = accidentals_[i].melodic_; + Context *origin = accidentals_[i].origin_; + + Pitch *pitch = unsmob_pitch (note->get_property ("pitch")); + if (!pitch) + continue; + + Accidental_result acc = check_pitch_against_rules (*pitch, origin, + accidental_rules, barnum); + Accidental_result caut = check_pitch_against_rules (*pitch, origin, + cautionary_rules, barnum); - int num = number_accidentals(localsig,note_l,accidentals_l,barnum); - int num_caut = number_accidentals(localsig,note_l,cautionaries_l,barnum); - bool cautionary = to_boolean (note_l->get_mus_property ("cautionary")); - if (abs(num_caut)>abs(num)) + bool cautionary = to_boolean (note->get_property ("cautionary")); + if (caut.score () > acc.score ()) { - num=num_caut; - cautionary=true; + acc.need_acc |= caut.need_acc; + acc.need_restore |= caut.need_restore; + + cautionary = true; } - - bool different=num<0; - num=abs(num); - /* see if there's a tie that "changes" the accidental */ - /* works because if there's a tie, the note to the left - is of the same pitch as the actual note */ + bool forced = to_boolean (note->get_property ("force-accidental")); + if (!acc.need_acc && forced) + acc.need_acc = true; + + /* Cannot look for ties: it's not guaranteed that they reach + us before the notes. */ + if (acc.need_acc + && !note->in_event_class ("trill-span-event")) + create_accidental (&accidentals_[i], acc.need_restore, cautionary); + + if (forced || cautionary) + accidentals_[i].accidental_->set_property ("forced", SCM_BOOL_T); + } + } +} + +void +Accidental_engraver::create_accidental (Accidental_entry *entry, + bool restore_natural, + bool cautionary) +{ + Stream_event *note = entry->melodic_; + Grob *support = entry->head_; + bool as_suggestion = to_boolean (entry->origin_->get_property ("suggestAccidentals")); + Grob *a = 0; + if (as_suggestion) + a = make_suggested_accidental (note, support, entry->origin_engraver_); + else + a = make_standard_accidental (note, support, entry->origin_engraver_, cautionary); + + if (restore_natural) + { + if (to_boolean (get_property ("extraNatural"))) + a->set_property ("restore-first", SCM_BOOL_T); + } + + entry->accidental_ = a; +} + +Grob * +Accidental_engraver::make_standard_accidental (Stream_event *note, + Grob *note_head, + Engraver *trans, + bool cautionary) +{ + (void)note; + + /* + We construct the accidentals at the originating Voice + level, so that we get the property settings for + Accidental from the respective Voice. + */ + Grob *a = 0; + if (cautionary) + a = trans->make_item ("AccidentalCautionary", note_head->self_scm ()); + else + a = trans->make_item ("Accidental", note_head->self_scm ()); + + /* + We add the accidentals to the support of the arpeggio, + so it is put left of the accidentals. + */ + for (vsize i = 0; i < left_objects_.size (); i++) + { + if (left_objects_[i]->get_property ("side-axis") == scm_from_int (X_AXIS)) + Side_position_interface::add_support (left_objects_[i], a); + } + + for (vsize i = 0; i < right_objects_.size (); i++) + Side_position_interface::add_support (a, right_objects_[i]); + a->set_parent (note_head, Y_AXIS); - Grob *tie_break_reminder = 0; - bool tie_changes = false; - for (int i=0; i < tie_l_arr_.size (); i++) - if (support_l == Tie::head (tie_l_arr_[i], RIGHT)) + if (!accidental_placement_) + accidental_placement_ = make_item ("AccidentalPlacement", + a->self_scm ()); + Accidental_placement::add_accidental (accidental_placement_, a); + + note_head->set_object ("accidental-grob", a->self_scm ()); + + return a; +} + +Grob * +Accidental_engraver::make_suggested_accidental (Stream_event *note, + Grob *note_head, + Engraver *trans) +{ + (void) note; + + Grob *a = trans->make_item ("AccidentalSuggestion", note_head->self_scm ()); + + Side_position_interface::add_support (a, note_head); + if (Grob *stem = unsmob_grob (a->get_object ("stem"))) + Side_position_interface::add_support (a, stem); + + a->set_parent (note_head, X_AXIS); + return a; +} + +void +Accidental_engraver::finalize () +{ + last_keysig_ = SCM_EOL; +} + +void +Accidental_engraver::stop_translation_timestep () +{ + for (vsize j = ties_.size (); j--;) + { + Grob *r = Tie::head (ties_[j], RIGHT); + for (vsize i = accidentals_.size (); i--;) + if (accidentals_[i].head_ == r) + { + if (Grob *g = accidentals_[i].accidental_) { - tie_changes = different; - /* Enable accidentals for broken tie - - We only want an accidental on a broken tie, - if the tie changes the accidental. - - Maybe check property noTieBreakForceAccidental? */ - if (different) - tie_break_reminder = tie_l_arr_[i]; - break; + g->set_object ("tie", ties_[j]->self_scm ()); + accidentals_[i].tied_ = true; } + ties_.erase (ties_.begin () + j); + break; + } + } - if (num) - { - if (!key_item_p_) - { - key_item_p_ = new Item (get_property ("Accidentals")); - Local_key_item::set_interface (key_item_p_); - - Staff_symbol_referencer::set_interface (key_item_p_); - SCM c0 = get_property ("centralCPosition"); - if (gh_number_p (c0)) - Staff_symbol_referencer::set_position (key_item_p_, gh_scm2int (c0)); - - announce_grob(key_item_p_, SCM_EOL); - } - - - Local_key_item::add_pitch (key_item_p_, *unsmob_pitch (note_l->get_mus_property ("pitch")), - cautionary, - num==2 && extra_natural_b, - tie_break_reminder); - Side_position_interface::add_support (key_item_p_,support_l); - - support_l->set_grob_property ("accidentals-grob", key_item_p_->self_scm ()); - } - - - /* - We should not record the accidental if it is the first - note and it is tied from the previous measure. - - Checking whether it is tied also works mostly, but will it - always do the correct thing? - */ - - Pitch *pitch = unsmob_pitch (note_l->get_mus_property ("pitch")); - int n = pitch->notename_i_; - int o = pitch->octave_i_; - int a = pitch->alteration_i_; - SCM on = gh_cons (gh_int2scm (o), gh_int2scm (n)); - if (tie_changes) + for (vsize i = accidentals_.size (); i--;) + { + int barnum = get_bar_number (); + + Stream_event *note = accidentals_[i].melodic_; + Context *origin = accidentals_[i].origin_; + + Pitch *pitch = unsmob_pitch (note->get_property ("pitch")); + if (!pitch) + continue; + + int n = pitch->get_notename (); + int o = pitch->get_octave (); + Rational a = pitch->get_alteration (); + SCM key = scm_cons (scm_from_int (o), scm_from_int (n)); + + SCM localsig = SCM_EOL; + while (origin + && origin->where_defined (ly_symbol2scm ("localKeySignature"), &localsig)) + { + bool change = false; + if (accidentals_[i].tied_) { /* Remember an alteration that is different both from that of the tied note and of the key signature. - */ - localsig = ly_assoc_front_x - (localsig, on, gh_cons(SCM_BOOL_T,barnum)); + */ + localsig = ly_assoc_prepend_x (localsig, key, scm_cons (ly_symbol2scm ("tied"), + scm_from_int (barnum))); + + change = true; } else { /* not really really correct if there are more than one noteheads with the same notename. - */ - localsig = ly_assoc_front_x - (localsig, on, gh_cons(gh_int2scm (a),barnum)); + */ + localsig = ly_assoc_prepend_x (localsig, key, + scm_cons (ly_rational2scm (a), + scm_from_int (barnum))); + change = true; } - } - - daddy_trans_l_->set_property ("localKeySignature", localsig); + + if (change) + origin->set_property ("localKeySignature", localsig); + + origin = origin->get_parent_context (); + } } - - - if (key_item_p_) + + if (accidental_placement_) + for (vsize i = 0; i < note_columns_.size (); i++) + Separation_item::add_conditional_item (note_columns_[i], accidental_placement_); + + accidental_placement_ = 0; + accidentals_.clear (); + left_objects_.clear (); + right_objects_.clear (); +} + +void +Accidental_engraver::acknowledge_rhythmic_head (Grob_info info) +{ + Stream_event *note = info.event_cause (); + if (note + && (note->in_event_class ("note-event") + || note->in_event_class ("trill-span-event"))) { /* - We add the accidentals to the support of the arpeggio, so it is put left of the - accidentals. - - */ - for (int i=0; i < arpeggios_.size (); i++) - Side_position_interface::add_support (arpeggios_[i], key_item_p_); - - arpeggios_.clear (); + string harmonics usually don't have accidentals. + */ + if (info.grob ()->get_property ("style") != ly_symbol2scm ("harmonic") + || to_boolean (get_property ("harmonicAccidentals"))) + { + Accidental_entry entry; + entry.head_ = info.grob (); + entry.origin_engraver_ = dynamic_cast (info.origin_translator ()); + entry.origin_ = entry.origin_engraver_->context (); + entry.melodic_ = note; + + accidentals_.push_back (entry); + } } } void -Accidental_engraver::finalize () +Accidental_engraver::acknowledge_tie (Grob_info info) { - + ties_.push_back (dynamic_cast (info.grob ())); } void -Accidental_engraver::stop_translation_timestep () +Accidental_engraver::acknowledge_note_column (Grob_info info) { - if (key_item_p_) - { - for (int i=0; i < head_l_arr_.size (); i++) - Side_position_interface::add_support (key_item_p_,head_l_arr_[i]); - - typeset_grob (key_item_p_); - key_item_p_ =0; - } - - - mel_l_arr_.clear (); - arpeggios_.clear (); - tie_l_arr_.clear (); - head_l_arr_.clear (); - forced_l_arr_.clear (); + note_columns_.push_back (info.grob ()); } void -Accidental_engraver::acknowledge_grob (Grob_info info) +Accidental_engraver::acknowledge_arpeggio (Grob_info info) { - Note_req * note_l = dynamic_cast (info.music_cause ()); + left_objects_.push_back (info.grob ()); +} - if (note_l && Rhythmic_head::has_interface (info.grob_l_)) - { - mel_l_arr_.push (note_l); - head_l_arr_.push (info.grob_l_); - } - else if (Tie::has_interface (info.grob_l_)) - { - tie_l_arr_.push (info.grob_l_); - } - else if (Arpeggio::has_interface (info.grob_l_)) - { - arpeggios_.push (info.grob_l_); - } - +void +Accidental_engraver::acknowledge_finger (Grob_info info) +{ + left_objects_.push_back (info.grob ()); } void Accidental_engraver::process_music () { -#if 0 - SCM smp = get_property ("measurePosition"); - Moment mp = (unsmob_moment (smp)) ? *unsmob_moment (smp) : Moment (0); -#endif - SCM sig = get_property ("keySignature"); - - /* Detect key sig changes. */ - if (last_keysig_ != sig) - { - daddy_trans_l_->set_property ("localKeySignature", ly_deep_copy (sig)); - last_keysig_ = sig; - } + if (last_keysig_ != sig) + update_local_key_signature (sig); } - - - - -ENTER_DESCRIPTION(Accidental_engraver, -/* descr */ "Make accidentals. Catches note heads, ties and notices key-change -events. Due to interaction with ties (which don't come together -with note heads), this needs to be in a context higher than Tie_engraver. FIXME", -/* creats*/ "Accidentals", -/* acks */ "rhythmic-head-interface tie-interface arpeggio-interface", -/* reads */ "localKeySignature extraNatural autoAccidentals autoCautionaries", -/* write */ "localKeySignature"); +ADD_ACKNOWLEDGER (Accidental_engraver, arpeggio); +ADD_ACKNOWLEDGER (Accidental_engraver, finger); +ADD_ACKNOWLEDGER (Accidental_engraver, rhythmic_head); +ADD_ACKNOWLEDGER (Accidental_engraver, tie); +ADD_ACKNOWLEDGER (Accidental_engraver, note_column); + +ADD_TRANSLATOR (Accidental_engraver, + /* doc */ + "Make accidentals." + " Catch note heads, ties and notices key-change events." + " This engraver usually lives at Staff level, but" + " reads the settings for Accidental at @code{Voice} level," + " so you can @code{\\override} them at @code{Voice}.", + + /* create */ + "Accidental " + "AccidentalCautionary " + "AccidentalSuggestion ", + + /* read */ + "autoAccidentals " + "autoCautionaries " + "internalBarNumber " + "extraNatural " + "harmonicAccidentals " + "localKeySignature ", + + /* write */ + "localKeySignature " + );