X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Faccidental-engraver.cc;h=cb33a4545b047577d093cee46d30f8182fddc13f;hb=9e781b7dc83b60a543ce218aa1a5f139f74c760f;hp=457fd734c4ce87442e83403718b67a2ca94174f5;hpb=62f221b6b3861ff055dc0384ec3c48cc665688cd;p=lilypond.git diff --git a/lily/accidental-engraver.cc b/lily/accidental-engraver.cc index 457fd734c4..cb33a4545b 100644 --- a/lily/accidental-engraver.cc +++ b/lily/accidental-engraver.cc @@ -1,10 +1,21 @@ /* - accidental-engraver.cc -- implement Accidental_engraver + This file is part of LilyPond, the GNU music typesetter. - source file of the GNU LilyPond music typesetter - - (c) 1997--2008 Han-Wen Nienhuys + Copyright (C) 1997--2014 Han-Wen Nienhuys Modified 2001--2002 by Rune Zedeler + + 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 "accidental-placement.hh" @@ -47,6 +58,7 @@ Accidental_entry::Accidental_entry () melodic_ = 0; accidental_ = 0; origin_ = 0; + origin_engraver_ = 0; head_ = 0; } @@ -61,7 +73,7 @@ protected: TRANSLATOR_DECLARATIONS (Accidental_engraver); void process_music (); - void acknowledge_tie (Grob_info); + void acknowledge_end_tie (Grob_info); void acknowledge_arpeggio (Grob_info); void acknowledge_rhythmic_head (Grob_info); void acknowledge_finger (Grob_info); @@ -69,21 +81,21 @@ protected: void stop_translation_timestep (); void process_acknowledged (); - + virtual void finalize (); virtual void derived_mark () const; public: SCM last_keysig_; - vector left_objects_; - vector right_objects_; + vector left_objects_; + vector right_objects_; Grob *accidental_placement_; vector accidentals_; - vector ties_; - vector note_columns_; + vector ties_; + vector note_columns_; }; /* @@ -91,7 +103,6 @@ public: in grobs should always store ly_deep_copy ()s of those. */ - Accidental_engraver::Accidental_engraver () { accidental_placement_ = 0; @@ -109,64 +120,24 @@ Accidental_engraver::update_local_key_signature (SCM new_sig) { last_keysig_ = new_sig; set_context_property_on_children (context (), - ly_symbol2scm ("localKeySignature"), - new_sig); + 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 */ + /* + 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) + 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_cadr (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 - 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; @@ -192,103 +163,14 @@ struct Accidental_result int score () const { return need_acc ? 1 : 0 - + need_restore ? 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; - - 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; - } - } - - if (!ignore_octave - && from_same_octave != SCM_BOOL_F - && recent_enough (bar_number, from_same_octave, laziness)) - previous_alteration = from_same_octave; - else if (ignore_octave - && from_other_octaves != SCM_BOOL_F - && recent_enough (bar_number, from_other_octaves, laziness)) - previous_alteration = from_other_octaves; - else if (from_key_signature != SCM_BOOL_F) - previous_alteration = from_key_signature; - - if (is_tied (previous_alteration)) - { - result.need_acc = true; - } - else - { - Rational prev = extract_alteration (previous_alteration); - Rational alter = pitch.get_alteration (); - - if (alter != prev) - { - result.need_acc = true; - if (alter.sign () - && (alter.abs () < prev.abs () - || (prev * alter).sign () < 0)) - result.need_restore = true; - } - } - - return result; -} - -// TODO: consider moving check_pitch_against_signature to SCM (in which case -// we can delete this function). -LY_DEFINE (ly_find_accidentals_simple, "ly:find-accidentals-simple", 5, 0, 0, - (SCM keysig, SCM pitch_scm, SCM barnum, SCM laziness, SCM octaveness ), - "Checks the need for an accidental and a @q{restore} accidental against a" - " key signature. The @var{laziness} is the number of bars for which reminder" - " accidentals are used (ie. if @var{laziness} is zero, we only cancel accidentals" - " in the same bar; if @var{laziness} is three, we cancel accidentals up to three" - " bars after they first appear. @var{octaveness} is either" - " @code{'same-octave} or @code{'any-octave} and it specifies whether" - " accidentals should be canceled in different octaves.") -{ - LY_ASSERT_TYPE (unsmob_pitch, pitch_scm, 2); - LY_ASSERT_TYPE (scm_is_integer, barnum, 3); - LY_ASSERT_TYPE (ly_is_symbol, octaveness, 5); - - bool symbol_ok = octaveness == ly_symbol2scm ("any-octave") || - octaveness == ly_symbol2scm ("same-octave"); - - SCM_ASSERT_TYPE (symbol_ok, octaveness, SCM_ARG5, __FUNCTION__, "'any-octave or 'same-octave"); - - Pitch *pitch = unsmob_pitch (pitch_scm); - - int bar_number = scm_to_int (barnum); - bool ignore_octave = ly_symbol2scm ("any-octave") == octaveness; - Accidental_result result = check_pitch_against_signature (keysig, *pitch, bar_number, - laziness, ignore_octave); - - return scm_cons (scm_from_bool (result.need_restore), scm_from_bool (result.need_acc)); -} - static Accidental_result check_pitch_against_rules (Pitch const &pitch, Context *origin, - SCM rules, int bar_number, SCM measurepos) + SCM rules, int bar_number, SCM measurepos) { Accidental_result result; SCM pitch_scm = pitch.smobbed_copy (); @@ -296,37 +178,37 @@ check_pitch_against_rules (Pitch const &pitch, Context *origin, if (scm_is_pair (rules) && !scm_is_symbol (scm_car (rules))) warning (_f ("accidental typesetting list must begin with context-name: %s", - ly_scm2string (scm_car (rules)).c_str ())); + ly_scm2string (scm_car (rules)).c_str ())); - for (; scm_is_pair (rules) && origin; - rules = scm_cdr (rules)) + for (; scm_is_pair (rules) && origin; rules = scm_cdr (rules)) { SCM rule = scm_car (rules); if (ly_is_procedure (rule)) - { - SCM rule_result_scm = scm_call_4 (rule, origin->self_scm (), - pitch_scm, barnum_scm, measurepos); - - Accidental_result rule_result (rule_result_scm); + { + SCM rule_result_scm = scm_call_4 (rule, origin->self_scm (), + pitch_scm, barnum_scm, measurepos); + Accidental_result rule_result (rule_result_scm); - result.need_acc |= rule_result.need_acc; - result.need_restore |= rule_result.need_restore; - } + result.need_acc |= rule_result.need_acc; + result.need_restore |= rule_result.need_restore; + } - /* if symbol then it is a context name. Scan parent contexts to - find it. */ + /* + 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; - } + { + Context *dad = origin; + while (dad && !dad->is_alias (rule)) + dad = dad->get_parent_context (); + + if (dad) + origin = dad; + } else - warning (_f ("procedure or context-name expected for accidental rule, found %s", - print_scm_val (rule).c_str ())); + warning (_f ("procedure or context-name expected for accidental rule, found %s", + print_scm_val (rule).c_str ())); } return result; @@ -340,57 +222,59 @@ Accidental_engraver::process_acknowledged () SCM accidental_rules = get_property ("autoAccidentals"); SCM cautionary_rules = get_property ("autoCautionaries"); SCM measure_position = get_property ("measurePosition"); - int barnum = measure_number (context()); + int barnum = measure_number (context ()); for (vsize i = 0; i < accidentals_.size (); 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, measure_position); - Accidental_result caut = check_pitch_against_rules (*pitch, origin, cautionary_rules, - barnum, measure_position); - - bool cautionary = to_boolean (note->get_property ("cautionary")); - if (caut.score () > acc.score ()) - { - acc.need_acc |= caut.need_acc; - acc.need_restore |= caut.need_restore; - - cautionary = true; - } - - 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 (!note->in_event_class ("trill-span-event")) - { - if (acc.need_acc) - create_accidental (&accidentals_[i], acc.need_restore, cautionary); - - if (forced || cautionary) - accidentals_[i].accidental_->set_property ("forced", SCM_BOOL_T); - } - } + { + 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, measure_position); + Accidental_result caut = check_pitch_against_rules (*pitch, origin, cautionary_rules, + barnum, measure_position); + + bool cautionary = to_boolean (note->get_property ("cautionary")); + if (caut.score () > acc.score ()) + { + acc.need_acc |= caut.need_acc; + acc.need_restore |= caut.need_restore; + + cautionary = true; + } + + 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 (!note->in_event_class ("trill-span-event")) + { + if (acc.need_acc) + 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) + bool restore_natural, + bool cautionary) { Stream_event *note = entry->melodic_; Grob *support = entry->head_; @@ -404,20 +288,18 @@ Accidental_engraver::create_accidental (Accidental_entry *entry, if (restore_natural) { if (to_boolean (get_property ("extraNatural"))) - a->set_property ("restore-first", SCM_BOOL_T); + 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) +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 @@ -436,7 +318,7 @@ Accidental_engraver::make_standard_accidental (Stream_event *note, 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); + Side_position_interface::add_support (left_objects_[i], a); } for (vsize i = 0; i < right_objects_.size (); i++) @@ -446,21 +328,23 @@ Accidental_engraver::make_standard_accidental (Stream_event *note, if (!accidental_placement_) accidental_placement_ = make_item ("AccidentalPlacement", - a->self_scm ()); - Accidental_placement::add_accidental (accidental_placement_, a); + a->self_scm ()); + + Accidental_placement::add_accidental + (accidental_placement_, a, + get_property ("accidentalGrouping") == ly_symbol2scm ("voice"), + (long) trans); 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) +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); @@ -484,20 +368,20 @@ Accidental_engraver::stop_translation_timestep () { Grob *r = Tie::head (ties_[j], RIGHT); for (vsize i = accidentals_.size (); i--;) - if (accidentals_[i].head_ == r) - { - if (Grob *g = accidentals_[i].accidental_) - { - g->set_object ("tie", ties_[j]->self_scm ()); - accidentals_[i].tied_ = true; - } - ties_.erase (ties_.begin () + j); - break; - } + if (accidentals_[i].head_ == r) + { + if (Grob *g = accidentals_[i].accidental_) + { + g->set_object ("tie", ties_[j]->self_scm ()); + accidentals_[i].tied_ = true; + } + ties_.erase (ties_.begin () + j); + break; + } } for (vsize i = accidentals_.size (); i--;) - { + { Stream_event *note = accidentals_[i].melodic_; Context *origin = accidentals_[i].origin_; @@ -505,7 +389,7 @@ Accidental_engraver::stop_translation_timestep () Pitch *pitch = unsmob_pitch (note->get_property ("pitch")); if (!pitch) - continue; + continue; int n = pitch->get_notename (); int o = pitch->get_octave (); @@ -513,43 +397,42 @@ Accidental_engraver::stop_translation_timestep () SCM key = scm_cons (scm_from_int (o), scm_from_int (n)); Moment end_mp = measure_position (context (), - unsmob_duration (note->get_property ("duration"))); + unsmob_duration (note->get_property ("duration"))); SCM position = scm_cons (scm_from_int (barnum), end_mp.smobbed_copy ()); SCM localsig = SCM_EOL; while (origin - && origin->where_defined (ly_symbol2scm ("localKeySignature"), &localsig)) - { - bool change = false; - if (accidentals_[i].tied_ - && !(to_boolean (accidentals_[i].accidental_->get_property ("forced")))) - { - /* - Remember an alteration that is different both from - that of the tied note and of the key signature. - */ - localsig = ly_assoc_prepend_x (localsig, key,scm_cons (ly_symbol2scm ("tied"), - position)); - - change = true; - } - else - { - /* - not really really correct if there are more than one - noteheads with the same notename. - */ - localsig = ly_assoc_prepend_x (localsig, key, - scm_cons (ly_rational2scm (a), - position)); - change = true; - } - - if (change) - origin->set_property ("localKeySignature", localsig); - - origin = origin->get_parent_context (); - } + && origin->where_defined (ly_symbol2scm ("localKeySignature"), &localsig)) + { + bool change = false; + if (accidentals_[i].tied_ + && !(to_boolean (accidentals_[i].accidental_->get_property ("forced")))) + { + /* + Remember an alteration that is different both from + that of the tied note and of the key signature. + */ + localsig = ly_assoc_prepend_x (localsig, key, scm_cons (ly_symbol2scm ("tied"), + position)); + change = true; + } + else + { + /* + not really correct if there is more than one + note head with the same notename. + */ + localsig = ly_assoc_prepend_x (localsig, key, + scm_cons (ly_rational2scm (a), + position)); + change = true; + } + + if (change) + origin->set_property ("localKeySignature", localsig); + + origin = origin->get_parent_context (); + } } if (accidental_placement_) @@ -558,6 +441,7 @@ Accidental_engraver::stop_translation_timestep () accidental_placement_ = 0; accidentals_.clear (); + note_columns_.clear (); left_objects_.clear (); right_objects_.clear (); } @@ -568,27 +452,27 @@ 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"))) + || note->in_event_class ("trill-span-event"))) { /* - string harmonics usually don't have accidentals. + 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); - } + || 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::acknowledge_tie (Grob_info info) +Accidental_engraver::acknowledge_end_tie (Grob_info info) { ties_.push_back (dynamic_cast (info.grob ())); } @@ -622,32 +506,33 @@ Accidental_engraver::process_music () ADD_ACKNOWLEDGER (Accidental_engraver, arpeggio); ADD_ACKNOWLEDGER (Accidental_engraver, finger); ADD_ACKNOWLEDGER (Accidental_engraver, rhythmic_head); -ADD_ACKNOWLEDGER (Accidental_engraver, tie); +ADD_END_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 " - "AccidentalPlacement " - "AccidentalSuggestion ", - - /* read */ - "autoAccidentals " - "autoCautionaries " - "internalBarNumber " - "extraNatural " - "harmonicAccidentals " - "keySignature " - "localKeySignature ", - - /* write */ - "localKeySignature " - ); + /* 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 " + "AccidentalPlacement " + "AccidentalSuggestion ", + + /* read */ + "autoAccidentals " + "autoCautionaries " + "internalBarNumber " + "extraNatural " + "harmonicAccidentals " + "accidentalGrouping " + "keySignature " + "localKeySignature ", + + /* write */ + "localKeySignature " + );