X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Faccidental-engraver.cc;h=351ab2045a035df90825c9ce8edd99c973b05d8f;hb=033879e52460a019a63eccf67514d4a58853f67e;hp=31e0998c9e00e1cb7611c6c9f9260caa7be46e93;hpb=334fe0d65dbcbb1cd69df39ca8bb8e422cf9d784;p=lilypond.git diff --git a/lily/accidental-engraver.cc b/lily/accidental-engraver.cc index 31e0998c9e..351ab2045a 100644 --- a/lily/accidental-engraver.cc +++ b/lily/accidental-engraver.cc @@ -3,32 +3,35 @@ source file of the GNU LilyPond music typesetter - (c) 1997--2004 Han-Wen Nienhuys + (c) 1997--2007 Han-Wen Nienhuys Modified 2001--2002 by Rune Zedeler */ #include "accidental-placement.hh" #include "arpeggio.hh" +#include "spanner.hh" #include "context.hh" -#include "engraver-group-engraver.hh" -#include "engraver.hh" -#include "event.hh" #include "item.hh" +#include "engraver.hh" +#include "international.hh" +#include "pitch.hh" #include "protected-scm.hh" #include "rhythmic-head.hh" #include "side-position-interface.hh" -#include "spanner.hh" +#include "stream-event.hh" #include "tie.hh" #include "warn.hh" +#include "translator.icc" class Accidental_entry { public: bool done_; - Music *melodic_; + Stream_event *melodic_; Grob *accidental_; Context *origin_; + Engraver *origin_engraver_; Grob *head_; bool tied_; @@ -47,54 +50,44 @@ Accidental_entry::Accidental_entry () class Accidental_engraver : public Engraver { -public: int get_bar_number (); - void update_local_key_signature (); + 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); - virtual void process_music (); - virtual void acknowledge_grob (Grob_info); - virtual void stop_translation_timestep (); - virtual void initialize (); - virtual void process_acknowledged_grobs (); + 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 stop_translation_timestep (); + void process_acknowledged (); + virtual void finalize (); + virtual void derived_mark () const; public: - Protected_scm last_keysig_; // ugh. - - /* Urgh. Since the accidentals depend on lots of variables, we have - to store all information before we can really create the - accidentals. */ - Link_array left_objects_; - Link_array right_objects_; + SCM last_keysig_; + + vector left_objects_; + vector right_objects_; Grob *accidental_placement_; - Array accidentals_; - Link_array ties_; + vector accidentals_; + vector ties_; }; - /* - TODO: - - ugh, it is not clear what properties are mutable and which - aren't. eg. localKeySignature is changed at runtime, which means - that references in grobs should always store ly_deep_copy ()s of - those. - */ + localKeySignature is changed at runtime, which means that references + in grobs should always store ly_deep_copy ()s of those. +*/ -static void -set_property_on_children (Context *trans, char const *sym, SCM val) -{ - trans->set_property (sym, ly_deep_copy (val)); - for (SCM p = trans->children_contexts (); ly_c_pair_p (p); p = ly_cdr (p)) - { - Context *trg = unsmob_context (ly_car (p)); - set_property_on_children (trg, sym, ly_deep_copy (val)); - } -} Accidental_engraver::Accidental_engraver () { @@ -103,257 +96,355 @@ Accidental_engraver::Accidental_engraver () } void -Accidental_engraver::update_local_key_signature () +Accidental_engraver::derived_mark () const +{ + scm_gc_mark (last_keysig_); +} + +void +Accidental_engraver::update_local_key_signature (SCM new_sig) { - last_keysig_ = get_property ("keySignature"); - set_property_on_children (context (), "localKeySignature", last_keysig_); + last_keysig_ = new_sig; + set_context_property_on_children (context (), + ly_symbol2scm ("localKeySignature"), + new_sig); Context *trans = context ()->get_parent_context (); - /* Huh. Don't understand what this is good for. --hwn. */ - while (trans && trans->where_defined (ly_symbol2scm ("localKeySignature"))) + /* 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 (); } } -void -Accidental_engraver::initialize () -{ - update_local_key_signature (); -} - /** 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 int -number_accidentals_from_sig (bool *different, SCM sig, Pitch *pitch, - int curbarnum, SCM laziness, bool ignore_octave) + +static bool +recent_enough (int bar_number, SCM alteration_def, SCM laziness) { - int n = pitch->get_notename (); - int o = pitch->get_octave (); - int a = pitch->get_alteration (); + if (scm_is_number (alteration_def) + || laziness == SCM_BOOL_T) + return true; - SCM prev_alt = SCM_BOOL_F; + return (bar_number <= scm_to_int (scm_cdr (alteration_def)) + scm_to_int (laziness)); +} - if (!ignore_octave) - { - SCM prev_local - = scm_assoc (scm_cons (scm_int2num (o), scm_int2num (n)), sig); +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 + assert (0); + return Rational (0); +} - if (ly_c_pair_p (prev_local)) - { - if (ly_c_pair_p (ly_cdr (prev_local)) - && ly_c_number_p (laziness)) - { - int barnum = ly_scm2int (ly_cddr (prev_local)); +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)); +} - prev_local = scm_cons (ly_car (prev_local), ly_cadr (prev_local)); - if (curbarnum <= barnum + ly_scm2int (laziness)) - prev_alt = prev_local; - } - } - } +struct Accidental_result +{ + bool need_acc; + bool need_restore; + + Accidental_result () { + need_restore = need_acc = false; + } - if (prev_alt == SCM_BOOL_F) - prev_alt = scm_assoc (scm_int2num (n), sig); + int score () const { + return need_acc ? 1 : 0 + + need_restore ? 1 : 0; + } +}; + +Accidental_result +check_pitch_against_signature (SCM key_signature, Pitch const &pitch, + int bar_number, SCM laziness, bool ignore_octave) +{ + Accidental_result result; + int n = pitch.get_notename (); + int o = pitch.get_octave (); + + SCM previous_alteration = SCM_BOOL_F; - prev_alt = (prev_alt == SCM_BOOL_F) ? scm_int2num (0) : ly_cdr (prev_alt); - - /* UGH. prev_acc can be #t in case of ties. What is this for? */ - int p = ly_c_number_p (prev_alt) ? ly_scm2int (prev_alt) : 0; + SCM from_same_octave = ly_assoc_get (scm_cons (scm_from_int (o), + scm_from_int (n)), key_signature, SCM_BOOL_F); + SCM from_key_signature = ly_assoc_get (scm_from_int (n), key_signature, SCM_BOOL_F); + SCM from_other_octaves = SCM_BOOL_F; + for (SCM s = key_signature; scm_is_pair (s); s = scm_cdr (s)) + { + SCM entry = scm_car (s); + if (scm_is_pair (scm_car (entry)) + && scm_cdar (entry) == scm_from_int (n)) + { + from_other_octaves = scm_cdr (entry); + break; + } + } - int num; - if (a == p && ly_c_number_p (prev_alt)) - num = 0; - else if ( (abs (a)get_property ("localKeySignature"); - - bool same_octave_b = - ly_c_eq_p (ly_symbol2scm ("same-octave"), type); - bool any_octave_b = - ly_c_eq_p (ly_symbol2scm ("any-octave"), type); - if (same_octave_b || any_octave_b) + bool same_octave + = (ly_symbol2scm ("same-octave") == type); + bool any_octave + = (ly_symbol2scm ("any-octave") == type); + + if (same_octave || any_octave) { - bool d = false; - int n = number_accidentals_from_sig - (&d, localsig, pitch, curbarnum, laziness, any_octave_b); - *different = *different || d; - number = max (number, n); + 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: %s", - ly_symbol2string (type).to_str0 ())); + 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 (ly_c_symbol_p (rule)) + /* 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 ("Accidental rule must be pair or context-name; Found %s", - ly_scm2string (rule).to_str0 ())); + else + warning (_f ("pair or context-name expected for accidental rule, found %s", + ly_scm2string (rule).c_str ())); } - return number; + return result; } int Accidental_engraver::get_bar_number () { - SCM barnum = get_property ("currentBarNumber"); + SCM barnum = get_property ("internalBarNumber"); SCM smp = get_property ("measurePosition"); int bn = robust_scm2int (barnum, 0); - - Moment mp = (unsmob_moment (smp)) ? *unsmob_moment (smp) : Moment (0); + + Moment mp = robust_scm2moment (smp, Moment (0)); if (mp.main_part_ < Rational (0)) bn--; - + return bn; } void -Accidental_engraver::process_acknowledged_grobs () +Accidental_engraver::process_acknowledged () { - if (accidentals_.size () && !accidentals_.top ().done_) + if (accidentals_.size () && !accidentals_.back ().done_) { - SCM accidentals = get_property ("autoAccidentals"); - SCM cautionaries = get_property ("autoCautionaries"); + 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 < accidentals_.size (); i++) + + for (vsize i = 0; i < accidentals_.size (); i++) { - if (accidentals_[i].done_ ) + if (accidentals_[i].done_) continue; - accidentals_[i].done_ = true; - Grob *support = accidentals_[i].head_; - Music *note = accidentals_[i].melodic_; + 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; - bool different = false; - bool different_caut = false; - - int num = number_accidentals (&different, - pitch, origin, - accidentals, barnum); - int num_caut = number_accidentals (&different_caut, - pitch, origin, - cautionaries, barnum); + Accidental_result acc = check_pitch_against_rules (*pitch, origin, + accidental_rules, barnum); + Accidental_result caut = check_pitch_against_rules (*pitch, origin, + cautionary_rules, barnum); bool cautionary = to_boolean (note->get_property ("cautionary")); - - if (num_caut > num) + if (caut.score () > acc.score ()) { - num = num_caut; - different = different_caut; + acc.need_acc |= caut.need_acc; + acc.need_restore |= caut.need_restore; + cautionary = true; } - if (num == 0 && to_boolean (note->get_property ("force-accidental"))) - num = 1; - + bool forced = to_boolean (note->get_property ("force-accidental")); + if (!acc.need_acc && forced) + acc.need_acc = true; - /* - Can not look for ties: it's not guaranteed that they reach - us before the notes - */ - - if (num) - { - /* - We construct the accidentals at the originating Voice - level, so that we get the property settings for - Accidental from the respective Voice. - */ - Grob *a - = make_item_from_properties (origin->implementation (), - ly_symbol2scm ("Accidental"), - note->self_scm ()); - a->set_parent (support, Y_AXIS); - - if (!accidental_placement_) - accidental_placement_ = make_item ("AccidentalPlacement", - a->self_scm ()); - Accidental_placement::add_accidental (accidental_placement_, a); - SCM accs = scm_cons (scm_int2num (pitch->get_alteration ()), - SCM_EOL); - if (num == 2 && extra_natural_b) - accs = scm_cons (scm_int2num (0), accs); - - /* TODO: add cautionary option in accidental. */ - - if (cautionary) - a->set_property ("cautionary", SCM_BOOL_T); - - support->set_property ("accidental-grob", a->self_scm ()); - - a->set_property ("accidentals", accs); - accidentals_[i].accidental_ = a; + /* 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); - /* - We add the accidentals to the support of the arpeggio, - so it is put left of the accidentals. - */ - for (int i = 0; i < left_objects_.size (); i++) - Side_position_interface::add_support (left_objects_[i], a); - for (int i = 0; i < right_objects_.size (); i++) - Side_position_interface::add_support (a, right_objects_[i]); - } + 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); + + 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 () { @@ -363,28 +454,28 @@ Accidental_engraver::finalize () void Accidental_engraver::stop_translation_timestep () { - for (int j = ties_.size (); j--;) + for (vsize j = ties_.size (); j--;) { Grob *r = Tie::head (ties_[j], RIGHT); - for (int i = accidentals_.size (); i--;) + for (vsize i = accidentals_.size (); i--;) if (accidentals_[i].head_ == r) { if (Grob *g = accidentals_[i].accidental_) { - g->set_property ("tie", ties_[j]->self_scm ()); + g->set_object ("tie", ties_[j]->self_scm ()); accidentals_[i].tied_ = true; } - ties_.del (j); + ties_.erase (ties_.begin () + j); break; } } - for (int i = accidentals_.size (); i--;) + for (vsize i = accidentals_.size (); i--;) { int barnum = get_bar_number (); - Music *note = accidentals_[i].melodic_; - Context * origin = accidentals_[i].origin_; + Stream_event *note = accidentals_[i].melodic_; + Context *origin = accidentals_[i].origin_; Pitch *pitch = unsmob_pitch (note->get_property ("pitch")); if (!pitch) @@ -392,16 +483,13 @@ Accidental_engraver::stop_translation_timestep () int n = pitch->get_notename (); int o = pitch->get_octave (); - int a = pitch->get_alteration (); - SCM key = scm_cons (scm_int2num (o), scm_int2num (n)); + 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"))) + && origin->where_defined (ly_symbol2scm ("localKeySignature"), &localsig)) { - /* - huh? we set props all the way to the top? - */ - SCM localsig = origin->get_property ("localKeySignature"); bool change = false; if (accidentals_[i].tied_) { @@ -409,8 +497,8 @@ Accidental_engraver::stop_translation_timestep () Remember an alteration that is different both from that of the tied note and of the key signature. */ - localsig = ly_assoc_front_x - (localsig, key, scm_cons (SCM_BOOL_T, scm_int2num (barnum))); + localsig = ly_assoc_prepend_x (localsig, key, scm_cons (ly_symbol2scm ("tied"), + scm_from_int (barnum))); change = true; } @@ -420,9 +508,9 @@ Accidental_engraver::stop_translation_timestep () not really really correct if there are more than one noteheads with the same notename. */ - localsig = ly_assoc_front_x (localsig, key, - scm_cons (scm_int2num (a), - scm_int2num (barnum))); + localsig = ly_assoc_prepend_x (localsig, key, + scm_cons (ly_rational2scm (a), + scm_from_int (barnum))); change = true; } @@ -440,67 +528,80 @@ Accidental_engraver::stop_translation_timestep () } void -Accidental_engraver::acknowledge_grob (Grob_info info) +Accidental_engraver::acknowledge_rhythmic_head (Grob_info info) { - Music *note = info.music_cause (); - + Stream_event *note = info.event_cause (); if (note - && note->is_mus_type ("note-event") - && Rhythmic_head::has_interface (info.grob_)) + && (note->in_event_class ("note-event") + || note->in_event_class ("trill-span-event"))) { - if (to_boolean ( get_property ("harmonicAccidentals")) - || !ly_c_equal_p (info.grob_->get_property ("style"), - ly_symbol2scm ("harmonic"))) + /* + 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_ = info.origin_trans_->context (); + 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 (entry); + accidentals_.push_back (entry); } } - else if (Tie::has_interface (info.grob_)) - ties_.push (dynamic_cast (info.grob_)); - else if (Arpeggio::has_interface (info.grob_)) - left_objects_.push (info.grob_); - else if (info.grob_ - ->internal_has_interface (ly_symbol2scm ("finger-interface"))) - left_objects_.push (info.grob_); +} + +void +Accidental_engraver::acknowledge_tie (Grob_info info) +{ + ties_.push_back (dynamic_cast (info.grob ())); +} + +void +Accidental_engraver::acknowledge_arpeggio (Grob_info info) +{ + left_objects_.push_back (info.grob ()); +} + +void +Accidental_engraver::acknowledge_finger (Grob_info info) +{ + left_objects_.push_back (info.grob ()); } void Accidental_engraver::process_music () { SCM sig = get_property ("keySignature"); - /* Detect key sig changes. - Update all parents and children. */ if (last_keysig_ != sig) - update_local_key_signature (); + update_local_key_signature (sig); } -ENTER_DESCRIPTION (Accidental_engraver, - "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}. " - , - "Accidental" - , - "" - , - "arpeggio-interface " - "finger-interface " - "rhythmic-head-interface " - "tie-interface " - , - "autoAccidentals " - "autoCautionaries " - "extraNatural " - "harmonicAccidentals " - "localKeySignature" - , - "localKeySignature" - ); +ADD_ACKNOWLEDGER (Accidental_engraver, arpeggio); +ADD_ACKNOWLEDGER (Accidental_engraver, finger); +ADD_ACKNOWLEDGER (Accidental_engraver, rhythmic_head); +ADD_ACKNOWLEDGER (Accidental_engraver, tie); + +ADD_TRANSLATOR (Accidental_engraver, + + "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}. ", + + /* grobs */ + "Accidental " + "AccidentalCautionary " + "AccidentalSuggestion ", + + /* props */ + "autoAccidentals " + "autoCautionaries " + "internalBarNumber " + "extraNatural " + "harmonicAccidentals " + "localKeySignature ", + "localKeySignature " + );