2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
5 Modified 2001--2002 by Rune Zedeler <rz@daimi.au.dk>
7 LilyPond is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 LilyPond is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
21 #include "accidental-placement.hh"
22 #include "arpeggio.hh"
24 #include "duration.hh"
25 #include "engraver.hh"
26 #include "international.hh"
29 #include "protected-scm.hh"
30 #include "rhythmic-head.hh"
31 #include "separation-item.hh"
32 #include "side-position-interface.hh"
34 #include "stream-event.hh"
38 #include "translator.icc"
40 class Accidental_entry
44 Stream_event *melodic_;
47 Engraver *origin_engraver_;
54 Accidental_entry::Accidental_entry ()
65 class Accidental_engraver : public Engraver
67 void update_local_key_signature (SCM new_signature);
68 void create_accidental (Accidental_entry *entry, bool, bool);
69 Grob *make_standard_accidental (Stream_event *note, Grob *note_head, Engraver *trans, bool);
70 Grob *make_suggested_accidental (Stream_event *note, Grob *note_head, Engraver *trans);
73 TRANSLATOR_DECLARATIONS (Accidental_engraver);
74 void process_music ();
76 void acknowledge_end_tie (Grob_info);
77 void acknowledge_arpeggio (Grob_info);
78 void acknowledge_rhythmic_head (Grob_info);
79 void acknowledge_finger (Grob_info);
80 void acknowledge_note_column (Grob_info);
82 void stop_translation_timestep ();
83 void process_acknowledged ();
85 virtual void finalize ();
86 virtual void derived_mark () const;
91 vector<Grob *> left_objects_;
92 vector<Grob *> right_objects_;
94 Grob *accidental_placement_;
96 vector<Accidental_entry> accidentals_;
97 vector<Spanner *> ties_;
98 vector<Grob *> note_columns_;
102 localAlterations is changed at runtime, which means that references
103 in grobs should always store ly_deep_copy ()s of those.
106 Accidental_engraver::Accidental_engraver (Context *c)
109 accidental_placement_ = 0;
110 last_keysig_ = SCM_EOL;
114 Accidental_engraver::derived_mark () const
116 scm_gc_mark (last_keysig_);
120 Accidental_engraver::update_local_key_signature (SCM new_sig)
122 last_keysig_ = new_sig;
123 set_context_property_on_children (context (),
124 ly_symbol2scm ("localAlterations"),
127 Context *trans = context ()->get_parent_context ();
130 Reset parent contexts so that e.g. piano-accidentals won't remember old
131 cross-staff accidentals after key-sig-changes.
135 while (trans && trans->here_defined (ly_symbol2scm ("localAlterations"), &val))
137 trans->set_property ("localAlterations", ly_deep_copy (last_keysig_));
138 trans = trans->get_parent_context ();
142 struct Accidental_result
149 need_restore = need_acc = false;
152 Accidental_result (bool restore, bool acc)
154 need_restore = restore;
158 Accidental_result (SCM scm)
160 need_restore = to_boolean (scm_car (scm));
161 need_acc = to_boolean (scm_cdr (scm));
166 return need_acc ? 1 : 0
167 + need_restore ? 1 : 0;
173 check_pitch_against_rules (Pitch const &pitch, Context *origin,
174 SCM rules, int bar_number, SCM measurepos)
176 Accidental_result result;
177 SCM pitch_scm = pitch.smobbed_copy ();
178 SCM barnum_scm = scm_from_int (bar_number);
180 if (scm_is_pair (rules) && !scm_is_symbol (scm_car (rules)))
181 warning (_f ("accidental typesetting list must begin with context-name: %s",
182 ly_scm2string (scm_car (rules)).c_str ()));
184 for (; scm_is_pair (rules) && origin; rules = scm_cdr (rules))
186 SCM rule = scm_car (rules);
187 if (ly_is_procedure (rule))
189 SCM rule_result_scm = scm_call_4 (rule, origin->self_scm (),
190 pitch_scm, barnum_scm, measurepos);
191 Accidental_result rule_result (rule_result_scm);
193 result.need_acc |= rule_result.need_acc;
194 result.need_restore |= rule_result.need_restore;
198 If symbol then it is a context name. Scan parent contexts to
201 else if (scm_is_symbol (rule))
203 Context *dad = find_context_above (origin, rule);
208 warning (_f ("procedure or context-name expected for accidental rule, found %s",
209 print_scm_val (rule).c_str ()));
216 Accidental_engraver::process_acknowledged ()
218 if (accidentals_.size () && !accidentals_.back ().done_)
220 SCM accidental_rules = get_property ("autoAccidentals");
221 SCM cautionary_rules = get_property ("autoCautionaries");
222 SCM measure_position = get_property ("measurePosition");
223 int barnum = measure_number (context ());
225 for (vsize i = 0; i < accidentals_.size (); i++)
227 if (accidentals_[i].done_)
229 accidentals_[i].done_ = true;
231 Stream_event *note = accidentals_[i].melodic_;
232 Context *origin = accidentals_[i].origin_;
234 Pitch *pitch = unsmob<Pitch> (note->get_property ("pitch"));
238 Accidental_result acc = check_pitch_against_rules (*pitch, origin, accidental_rules,
239 barnum, measure_position);
240 Accidental_result caut = check_pitch_against_rules (*pitch, origin, cautionary_rules,
241 barnum, measure_position);
243 bool cautionary = to_boolean (note->get_property ("cautionary"));
244 if (caut.score () > acc.score ())
246 acc.need_acc |= caut.need_acc;
247 acc.need_restore |= caut.need_restore;
252 bool forced = to_boolean (note->get_property ("force-accidental"));
253 if (!acc.need_acc && forced)
257 Cannot look for ties: it's not guaranteed that they reach
260 if (!note->in_event_class ("trill-span-event"))
263 create_accidental (&accidentals_[i], acc.need_restore, cautionary);
265 if (forced || cautionary)
266 accidentals_[i].accidental_->set_property ("forced", SCM_BOOL_T);
273 Accidental_engraver::create_accidental (Accidental_entry *entry,
274 bool restore_natural,
277 Stream_event *note = entry->melodic_;
278 Grob *support = entry->head_;
279 bool as_suggestion = to_boolean (entry->origin_->get_property ("suggestAccidentals"));
282 a = make_suggested_accidental (note, support, entry->origin_engraver_);
284 a = make_standard_accidental (note, support, entry->origin_engraver_, cautionary);
288 if (to_boolean (get_property ("extraNatural")))
289 a->set_property ("restore-first", SCM_BOOL_T);
292 entry->accidental_ = a;
296 Accidental_engraver::make_standard_accidental (Stream_event * /* note */,
302 We construct the accidentals at the originating Voice
303 level, so that we get the property settings for
304 Accidental from the respective Voice.
308 a = trans->make_item ("AccidentalCautionary", note_head->self_scm ());
310 a = trans->make_item ("Accidental", note_head->self_scm ());
313 We add the accidentals to the support of the arpeggio,
314 so it is put left of the accidentals.
316 for (vsize i = 0; i < left_objects_.size (); i++)
318 if (ly_is_equal (left_objects_[i]->get_property ("side-axis"), scm_from_int (X_AXIS)))
319 Side_position_interface::add_support (left_objects_[i], a);
322 for (vsize i = 0; i < right_objects_.size (); i++)
323 Side_position_interface::add_support (a, right_objects_[i]);
325 a->set_parent (note_head, Y_AXIS);
327 if (!accidental_placement_)
328 accidental_placement_ = make_item ("AccidentalPlacement",
331 Accidental_placement::add_accidental
332 (accidental_placement_, a,
333 scm_is_eq (get_property ("accidentalGrouping"), ly_symbol2scm ("voice")),
336 note_head->set_object ("accidental-grob", a->self_scm ());
342 Accidental_engraver::make_suggested_accidental (Stream_event * /* note */,
346 Grob *a = trans->make_item ("AccidentalSuggestion", note_head->self_scm ());
348 Side_position_interface::add_support (a, note_head);
349 if (Grob *stem = unsmob<Grob> (a->get_object ("stem")))
350 Side_position_interface::add_support (a, stem);
352 a->set_parent (note_head, X_AXIS);
357 Accidental_engraver::finalize ()
359 last_keysig_ = SCM_EOL;
363 Accidental_engraver::stop_translation_timestep ()
365 for (vsize j = ties_.size (); j--;)
367 Grob *r = Tie::head (ties_[j], RIGHT);
368 Grob *l = Tie::head (ties_[j], LEFT);
371 // Don't mark accidentals as "tied" when the pitch is not
372 // actually the same. This is relevant for enharmonic ties.
373 Stream_event *le = unsmob<Stream_event> (l->get_property ("cause"));
374 Stream_event *re = unsmob<Stream_event> (r->get_property ("cause"));
376 && !ly_is_equal (le->get_property ("pitch"), re->get_property ("pitch")))
380 for (vsize i = accidentals_.size (); i--;)
381 if (accidentals_[i].head_ == r)
383 if (Grob *g = accidentals_[i].accidental_)
385 g->set_object ("tie", ties_[j]->self_scm ());
386 accidentals_[i].tied_ = true;
388 ties_.erase (ties_.begin () + j);
393 for (vsize i = accidentals_.size (); i--;)
395 Stream_event *note = accidentals_[i].melodic_;
396 Context *origin = accidentals_[i].origin_;
398 int barnum = measure_number (origin);
400 Pitch *pitch = unsmob<Pitch> (note->get_property ("pitch"));
404 int n = pitch->get_notename ();
405 int o = pitch->get_octave ();
406 Rational a = pitch->get_alteration ();
407 SCM key = scm_cons (scm_from_int (o), scm_from_int (n));
409 Moment end_mp = measure_position (context (),
410 unsmob<Duration> (note->get_property ("duration")));
411 SCM position = scm_cons (scm_from_int (barnum), end_mp.smobbed_copy ());
413 SCM localsig = SCM_EOL;
415 && origin->where_defined (ly_symbol2scm ("localAlterations"), &localsig))
418 if (accidentals_[i].tied_
419 && !(to_boolean (accidentals_[i].accidental_->get_property ("forced"))))
422 Remember an alteration that is different both from
423 that of the tied note and of the key signature.
425 localsig = ly_assoc_prepend_x (localsig, key, scm_cons (ly_symbol2scm ("tied"),
432 not really correct if there is more than one
433 note head with the same notename.
435 localsig = ly_assoc_prepend_x (localsig, key,
436 scm_cons (ly_rational2scm (a),
442 origin->set_property ("localAlterations", localsig);
444 origin = origin->get_parent_context ();
448 if (accidental_placement_)
449 for (vsize i = 0; i < note_columns_.size (); i++)
450 Separation_item::add_conditional_item (note_columns_[i], accidental_placement_);
452 accidental_placement_ = 0;
453 accidentals_.clear ();
454 note_columns_.clear ();
455 left_objects_.clear ();
456 right_objects_.clear ();
460 Accidental_engraver::acknowledge_rhythmic_head (Grob_info info)
462 Stream_event *note = info.event_cause ();
464 && (note->in_event_class ("note-event")
465 || note->in_event_class ("trill-span-event"))
466 // option to skip accidentals on string harmonics
467 && (to_boolean (get_property ("harmonicAccidentals"))
468 || !scm_is_eq (info.grob ()->get_property ("style"),
469 ly_symbol2scm ("harmonic")))
470 // ignore accidentals in non-printing voices like NullVoice
471 && !to_boolean (info.context ()->get_property ("nullAccidentals")))
473 Accidental_entry entry;
474 entry.head_ = info.grob ();
475 entry.origin_engraver_ = dynamic_cast<Engraver *> (info.origin_translator ());
476 entry.origin_ = entry.origin_engraver_->context ();
477 entry.melodic_ = note;
479 accidentals_.push_back (entry);
484 Accidental_engraver::acknowledge_end_tie (Grob_info info)
486 ties_.push_back (dynamic_cast<Spanner *> (info.grob ()));
490 Accidental_engraver::acknowledge_note_column (Grob_info info)
492 note_columns_.push_back (info.grob ());
496 Accidental_engraver::acknowledge_arpeggio (Grob_info info)
498 left_objects_.push_back (info.grob ());
502 Accidental_engraver::acknowledge_finger (Grob_info info)
504 left_objects_.push_back (info.grob ());
508 Accidental_engraver::process_music ()
510 SCM sig = get_property ("keyAlterations");
511 if (!scm_is_eq (last_keysig_, sig))
512 update_local_key_signature (sig);
517 Accidental_engraver::boot ()
519 ADD_ACKNOWLEDGER (Accidental_engraver, arpeggio);
520 ADD_ACKNOWLEDGER (Accidental_engraver, finger);
521 ADD_ACKNOWLEDGER (Accidental_engraver, rhythmic_head);
522 ADD_END_ACKNOWLEDGER (Accidental_engraver, tie);
523 ADD_ACKNOWLEDGER (Accidental_engraver, note_column);
526 ADD_TRANSLATOR (Accidental_engraver,
529 " Catch note heads, ties and notices key-change events."
530 " This engraver usually lives at Staff level, but"
531 " reads the settings for Accidental at @code{Voice} level,"
532 " so you can @code{\\override} them at @code{Voice}.",
536 "AccidentalCautionary "
537 "AccidentalPlacement "
538 "AccidentalSuggestion ",
545 "harmonicAccidentals "
546 "accidentalGrouping "