X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Faccidental-engraver.cc;h=1dc9395057210b9f637126568053fe6c45492a41;hb=39a23d0f6910fd0359655518ce05ad0f6bc5f73f;hp=5ed5ef9e43a9230bfe9f72ef52372c3ee399ab85;hpb=a0b072ed070ca6abb36a11e015073b117103e35d;p=lilypond.git diff --git a/lily/accidental-engraver.cc b/lily/accidental-engraver.cc index 5ed5ef9e43..1dc9395057 100644 --- a/lily/accidental-engraver.cc +++ b/lily/accidental-engraver.cc @@ -1,54 +1,52 @@ /* accidental-engraver.cc -- implement accidental_engraver - (c) 1997--2002 Han-Wen Nienhuys - Modified 2001-2002 by Rune Zedeler + source file of the GNU LilyPond music typesetter + + (c) 1997--2005 Han-Wen Nienhuys + Modified 2001--2002 by Rune Zedeler */ -#include "musical-request.hh" -#include "command-request.hh" -#include "item.hh" -#include "tie.hh" -#include "rhythmic-head.hh" -#include "engraver-group-engraver.hh" #include "accidental-placement.hh" -#include "side-position-interface.hh" -#include "engraver.hh" #include "arpeggio.hh" +#include "context.hh" +#include "engraver.hh" +#include "protected-scm.hh" +#include "rhythmic-head.hh" +#include "side-position-interface.hh" +#include "tie.hh" #include "warn.hh" -#include "translator-group.hh" - -/** - - -FIXME: should not compute vertical positioning of accidentals, but -get them from the noteheads - -The algorithm for accidentals should be documented, and made -tweakable. - -*/ - -struct Accidental_entry { +class Accidental_entry +{ +public: bool done_; - Note_req * melodic_; - Grob * accidental_; - Translator_group *origin_; - Grob* head_; - Accidental_entry(); + Music *melodic_; + Grob *accidental_; + Context *origin_; + Engraver *origin_trans_; + Grob *head_; + bool tied_; + + Accidental_entry (); }; -Accidental_entry::Accidental_entry() +Accidental_entry::Accidental_entry () { + tied_ = false; done_ = false; - melodic_ =0; + melodic_ = 0; accidental_ = 0; origin_ = 0; head_ = 0; } -struct Accidental_engraver : Engraver { +class Accidental_engraver : public Engraver +{ +public: + int get_bar_number (); + void update_local_key_signature (); + protected: TRANSLATOR_DECLARATIONS (Accidental_engraver); virtual void process_music (); @@ -57,35 +55,42 @@ protected: virtual void initialize (); virtual void process_acknowledged_grobs (); virtual void finalize (); -public: - /* - TODO -> property. - - This is not a property, and it is not protected. This poses a - very small risk of the value being GC'd from under us. - */ - SCM last_keysig_; + virtual void derived_mark () const; +public: + 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 arpeggios_; + /* 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_; - Grob * accidental_placement_; - + Grob *accidental_placement_; - /* - The next - */ - Array accidental_arr_; - - Link_array tie_arr_; + Array accidentals_; + Link_array 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. +*/ +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 (); scm_is_pair (p); p = scm_cdr (p)) + { + Context *trg = unsmob_context (scm_car (p)); + set_property_on_children (trg, sym, ly_deep_copy (val)); + } +} Accidental_engraver::Accidental_engraver () { @@ -94,294 +99,293 @@ Accidental_engraver::Accidental_engraver () } void -Accidental_engraver::initialize () +Accidental_engraver::derived_mark () const +{ + scm_gc_mark (last_keysig_); +} + +void +Accidental_engraver::update_local_key_signature () { last_keysig_ = get_property ("keySignature"); + set_property_on_children (context (), "localKeySignature", last_keysig_); + + Context *trans = context ()->get_parent_context (); - Translator_group * trans_ = daddy_trans_l_; - while (trans_) + /* Huh. Don't understand what this is good for. --hwn. */ + while (trans && trans->where_defined (ly_symbol2scm ("localKeySignature"))) { - trans_ -> set_property ("localKeySignature", ly_deep_copy (last_keysig_)); - trans_ = trans_->daddy_trans_l_; + trans->set_property ("localKeySignature", ly_deep_copy (last_keysig_)); + trans = trans->get_parent_context (); } - daddy_trans_l_->set_children_property ("localKeySignature", last_keysig_); } -/* +void +Accidental_engraver::initialize () +{ + update_local_key_signature (); +} -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. +/** 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 int -number_accidentals (SCM sig, Note_req * note_l, Pitch *pitch, SCM curbarnum, SCM lazyness, - bool ignore_octave_b) +extract_alteration (SCM alteration_def) { - 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); + if (scm_is_number (alteration_def)) + return scm_to_int (alteration_def); + else if (scm_is_pair (alteration_def)) + return scm_to_int (scm_car (alteration_def)); + else if (alteration_def == SCM_BOOL_F) + return 0; else - prev = gh_assoc (gh_cons (gh_int2scm (o), gh_int2scm (n)), sig); + assert (0); + return 0; +} - /* 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)); - } - - /* 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); +bool +is_tied (SCM alteration_def) +{ + return (alteration_def == SCM_BOOL_T) + || (scm_is_pair (alteration_def) && scm_car (alteration_def) == SCM_BOOL_T); +} +static int +number_accidentals_from_sig (bool *different, SCM sig, Pitch *pitch, + int bar_number, SCM laziness, bool ignore_octave) +{ + int n = pitch->get_notename (); + int o = pitch->get_octave (); - SCM prev_acc = (prev == SCM_BOOL_F) ? gh_int2scm (0) : ly_cdr (prev); + SCM previous_alteration = SCM_BOOL_F; - int p = gh_number_p (prev_acc) ? gh_scm2int (prev_acc) : 0; + SCM from_same_octave = ly_assoc_get (scm_cons (scm_int2num (o), + scm_int2num (n)), sig, SCM_BOOL_F); + SCM from_key_signature = ly_assoc_get (scm_int2num (n), sig, SCM_BOOL_F); + SCM from_other_octaves = SCM_BOOL_F; + for (SCM s = sig; scm_is_pair (s); s = scm_cdr (s)) + { + SCM entry = scm_car (s); + if (scm_is_pair (scm_car (entry)) + && scm_cdar (entry) == scm_int2num (n)) + from_other_octaves = scm_cdr (entry); + } - 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_alteration (); + + if (alter == prev) + num = 0; + else if ((abs (alter) < abs (prev) || prev * alter < 0) && alter != 0) + num = 2; + *different = (alter != prev); + } + return num; } static int -number_accidentals (Note_req * note_l, Pitch *pitch, Translator_group * origin_l, - SCM accidentals, SCM curbarnum) +number_accidentals (bool *different, + Pitch *pitch, Context *origin, + SCM accidentals, int bar_number) { int number = 0; - bool diff = false; - if (gh_pair_p (accidentals) && !gh_symbol_p (ly_car (accidentals))) - warning (_f ("Accidental typesetting list must begin with context-name: %s", - ly_scm2string (ly_car (accidentals)).ch_C ())); - - while (gh_pair_p (accidentals) && origin_l) + *different = false; + if (scm_is_pair (accidentals) && !scm_is_symbol (scm_car (accidentals))) + warning (_f ("accidental typesetting list must begin with context-name: %s", + ly_scm2string (scm_car (accidentals)).to_str0 ())); + + for (; scm_is_pair (accidentals) && origin; + accidentals = scm_cdr (accidentals)) { // If pair then it is a new accidentals typesetting rule to be checked - if (gh_pair_p (ly_car (accidentals))) + SCM rule = scm_car (accidentals); + if (scm_is_pair (rule)) { - SCM type = gh_caar (accidentals); - SCM lazyness = gh_cdar (accidentals); - SCM localsig = origin_l->get_property ("localKeySignature"); - - bool same_octave_b = - gh_eq_p (ly_symbol2scm ("same-octave"), type); - bool any_octave_b = - gh_eq_p (ly_symbol2scm ("any-octave"), type); + SCM type = scm_car (rule); + SCM laziness = scm_cdr (rule); + SCM localsig = origin->get_property ("localKeySignature"); + + bool same_octave_b + = scm_is_eq (ly_symbol2scm ("same-octave"), type); + bool any_octave_b + = scm_is_eq (ly_symbol2scm ("any-octave"), type); if (same_octave_b || any_octave_b) { - int n = number_accidentals - (localsig, note_l, pitch, curbarnum, lazyness, any_octave_b); - diff = diff || (n < 0); - number = max (number, abs (n)); + bool d = false; + int n = number_accidentals_from_sig + (&d, localsig, pitch, bar_number, laziness, any_octave_b); + *different = *different || d; + number = max (number, n); } else - warning (_f ("unknown accidental typesetting: %s. Ignored", - ly_symbol2string (type).ch_C ())); + warning (_f ("ignoring unknown accidental: %s", + ly_symbol2string (type).to_str0 ())); } - - /* - if symbol then it is a context name. Scan parent contexts to find it. - */ - else if (gh_symbol_p (ly_car (accidentals))) + /* if symbol then it is a context name. Scan parent contexts to + find it. */ + else if (scm_is_symbol (rule)) { - String context = ly_symbol2string (ly_car (accidentals)); - - while (origin_l && !origin_l->is_alias_b (context)) - origin_l = origin_l->daddy_trans_l_; - - if (!origin_l) - warning (_f ("Symbol is not a parent context: %s. Ignored", - context.ch_C ())); + Context *dad = origin; + while (dad && !dad->is_alias (rule)) + dad = dad->get_parent_context (); + + if (dad) + origin = dad; } - else warning (_f ("Accidental typesetting must be pair or context-name: %s", - ly_scm2string (ly_car (accidentals)).ch_C ())); - - accidentals = ly_cdr (accidentals); + else + warning (_f ("pair or context-name expected for accidental rule, found %s", + ly_scm2string (rule).to_str0 ())); } - return diff ? -number : number; + + return number; +} + +int +Accidental_engraver::get_bar_number () +{ + SCM barnum = get_property ("currentBarNumber"); + 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::process_acknowledged_grobs () { - if (accidental_arr_.size () && !accidental_arr_.top().done_) + if (accidentals_.size () && !accidentals_.top ().done_) { - //SCM localsig = get_property ("localKeySignature"); - SCM accidentals = get_property ("autoAccidentals"); - SCM cautionaries = get_property ("autoCautionaries"); - SCM barnum = get_property ("currentBarNumber"); + SCM accidentals = get_property ("autoAccidentals"); + SCM cautionaries = get_property ("autoCautionaries"); + int barnum = get_bar_number (); bool extra_natural_b = get_property ("extraNatural") == SCM_BOOL_T; - for (int i = 0; i < accidental_arr_.size (); i++) + for (int i = 0; i < accidentals_.size (); i++) { - if (accidental_arr_[i].done_ ) + if (accidentals_[i].done_) + continue; + accidentals_[i].done_ = true; + Grob *support = accidentals_[i].head_; + Music *note = accidentals_[i].melodic_; + Context *origin = accidentals_[i].origin_; + + Pitch *pitch = unsmob_pitch (note->get_property ("pitch")); + if (!pitch) continue; - accidental_arr_[i].done_ = true; - Grob * support_l = accidental_arr_[i].head_; - Note_req * note_l = accidental_arr_[i].melodic_; - Translator_group * origin_l = accidental_arr_[i].origin_; - - Pitch * pitch = unsmob_pitch (note_l->get_mus_property ("pitch")); - int num = number_accidentals (note_l, pitch, origin_l, accidentals, barnum); - int num_caut = number_accidentals (note_l, pitch, origin_l, cautionaries, barnum); - bool cautionary = to_boolean (note_l->get_mus_property ("cautionary")); - - if (abs (num_caut) > abs (num)) + + 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); + + bool cautionary = to_boolean (note->get_property ("cautionary")); + + if (num_caut > num) { num = num_caut; + different = different_caut; 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 */ - - Grob *tie_break_reminder = 0; - bool tie_changes = false; - for (int j = 0; j < tie_arr_.size (); j++) - if (support_l == Tie::head (tie_arr_[j], RIGHT)) - { - 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_arr_[j]; - break; - } + if (num == 0 && to_boolean (note->get_property ("force-accidental"))) + num = 1; + /* Cannot look for ties: it's not guaranteed that they reach + us before the notes. */ if (num) { - Grob * a = new Item (get_property ("Accidental")); - a->set_parent (support_l, Y_AXIS); + /* + 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 (accidentals_[i].origin_trans_, + ly_symbol2scm ("Accidental"), + note->self_scm (), + "Accidental"); + a->set_parent (support, Y_AXIS); if (!accidental_placement_) - { - accidental_placement_ = new Item (get_property ("AccidentalPlacement")); - announce_grob (accidental_placement_, a->self_scm()); - } - + accidental_placement_ = make_item ("AccidentalPlacement", + a->self_scm ()); Accidental_placement::add_accidental (accidental_placement_, a); - announce_grob (a, SCM_EOL); - - - SCM accs = gh_cons (gh_int2scm (pitch->alteration_i_), SCM_EOL); + SCM accs = scm_cons (scm_int2num (pitch->get_alteration ()), + SCM_EOL); if (num == 2 && extra_natural_b) - accs = gh_cons (gh_int2scm (0), accs); - - /* TODO: + accs = scm_cons (scm_int2num (0), accs); - add cautionary option in accidental. - */ + /* TODO: add cautionary option in accidental. */ if (cautionary) - { - a->set_grob_property ("cautionary", SCM_BOOL_T); - } - - if (tie_break_reminder) - { - // TODO. - a->set_grob_property ("tie", tie_break_reminder->self_scm()); - } - - - support_l->set_grob_property ("accidental-grob", a->self_scm ()); - - a->set_grob_property ("accidentals", accs); - accidental_arr_[i].accidental_ = a; - /* - 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], a); - } - - - /* - We should not record the accidental if it is the first - note and it is tied from the previous measure. + a->set_property ("cautionary", SCM_BOOL_T); - Checking whether it is tied also works mostly, but will it - always do the correct thing? - */ - + support->set_property ("accidental-grob", a->self_scm ()); - int n = pitch->notename_i_; - int o = pitch->octave_i_; - int a = pitch->alteration_i_; - SCM on_s = gh_cons (gh_int2scm (o), gh_int2scm (n)); + a->set_property ("accidentals", accs); + accidentals_[i].accidental_ = a; - /* - TODO: Speed this up! - - Perhaps only check translators mentioned in the auto-accidentals? - -rz - - TODO: profile this. - - I'd be surprised if the impact of this would be - measurable. Anyway, it seems localsig doesn't change - every time-step, but a set_property() is done every - time. We could save on that, probably. - - --hwn. - - - */ - - while (origin_l) - { - SCM localsig = origin_l->get_property ("localKeySignature"); - if (tie_changes) - { - /* - 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_s, gh_cons (SCM_BOOL_T, barnum)); - } - else - { - /* - not really really correct if there are more than one - noteheads with the same notename. - */ - localsig = ly_assoc_front_x - (localsig, on_s, gh_cons (gh_int2scm (a), barnum)); - } - origin_l->set_property ("localKeySignature", localsig); - origin_l = origin_l->daddy_trans_l_; + /* + 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]); } } } @@ -390,87 +394,145 @@ Accidental_engraver::process_acknowledged_grobs () void Accidental_engraver::finalize () { - + last_keysig_ = SCM_EOL; } void Accidental_engraver::stop_translation_timestep () { - for (int i = 0; i < accidental_arr_.size(); i++) + for (int j = ties_.size (); j--;) + { + Grob *r = Tie::head (ties_[j], RIGHT); + for (int i = accidentals_.size (); i--;) + if (accidentals_[i].head_ == r) + { + if (Grob *g = accidentals_[i].accidental_) + { + g->set_property ("tie", ties_[j]->self_scm ()); + accidentals_[i].tied_ = true; + } + ties_.del (j); + break; + } + } + + for (int i = accidentals_.size (); i--;) { - Grob *a = accidental_arr_[i].accidental_; - if (a) + int barnum = get_bar_number (); + + Music *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 (); + int a = pitch->get_alteration (); + SCM key = scm_cons (scm_int2num (o), scm_int2num (n)); + + while (origin + && origin->where_defined (ly_symbol2scm ("localKeySignature"))) { - typeset_grob (a); + /* + huh? we set props all the way to the top? + */ + SCM localsig = origin->get_property ("localKeySignature"); + 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, key, scm_cons (SCM_BOOL_T, scm_int2num (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, key, + scm_cons (scm_int2num (a), + scm_int2num (barnum))); + change = true; + } + + if (change) + origin->set_property ("localKeySignature", localsig); + + origin = origin->get_parent_context (); } } - if (accidental_placement_) - typeset_grob(accidental_placement_); - accidental_placement_ = 00; - - accidental_arr_.clear(); - arpeggios_.clear (); - tie_arr_.clear (); + accidental_placement_ = 0; + accidentals_.clear (); + left_objects_.clear (); + right_objects_.clear (); } void Accidental_engraver::acknowledge_grob (Grob_info info) { - Note_req * note_l = dynamic_cast (info.music_cause ()); + Music *note = info.music_cause (); - if (note_l && Rhythmic_head::has_interface (info.grob_l_)) + if (note + && note->is_mus_type ("note-event") + && Rhythmic_head::has_interface (info.grob_)) { - Accidental_entry entry ; - entry.head_ = info.grob_l_; - entry.origin_ = info.origin_trans_l_->daddy_trans_l_; - entry.melodic_ = note_l; + if (to_boolean (get_property ("harmonicAccidentals")) + || !ly_c_equal_p (info.grob_->get_property ("style"), + ly_symbol2scm ("harmonic"))) + { - accidental_arr_.push (entry); - } - else if (Tie::has_interface (info.grob_l_)) - { - tie_arr_.push (info.grob_l_); - } - else if (Arpeggio::has_interface (info.grob_l_)) - { - arpeggios_.push (info.grob_l_); + Accidental_entry entry; + entry.head_ = info.grob_; + entry.origin_trans_ = dynamic_cast (info.origin_trans_); + entry.origin_ = info.origin_trans_->context (); + entry.melodic_ = note; + + accidentals_.push (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::process_music () { SCM sig = get_property ("keySignature"); - /* Detect key sig changes. - Update all parents and children - */ + Update all parents and children. */ if (last_keysig_ != sig) - { - Translator_group * trans_ = daddy_trans_l_; - while (trans_) - { - trans_ -> set_property ("localKeySignature", ly_deep_copy (sig)); - trans_ = trans_->daddy_trans_l_; - } - daddy_trans_l_->set_children_property ("localKeySignature", sig); - - last_keysig_ = sig; - } + update_local_key_signature (); } - - - - -ENTER_DESCRIPTION (Accidental_engraver, -"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.", - - "Accidental", - "rhythmic-head-interface tie-interface arpeggio-interface", - "localKeySignature extraNatural autoAccidentals autoCautionaries", - "localKeySignature"); +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}. ", + "Accidental", + "", + "arpeggio-interface " + "finger-interface " + "rhythmic-head-interface " + "tie-interface ", + "autoAccidentals " + "autoCautionaries " + "extraNatural " + "harmonicAccidentals " + "localKeySignature", + "localKeySignature");