source file of the GNU LilyPond music typesetter
- (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
+ (c) 1997--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
Modified 2001--2002 by Rune Zedeler <rz@daimi.au.dk>
*/
#include "accidental-placement.hh"
#include "arpeggio.hh"
+#include "spanner.hh"
#include "context.hh"
+#include "item.hh"
#include "engraver.hh"
#include "international.hh"
-#include "music.hh"
#include "pitch.hh"
#include "protected-scm.hh"
#include "rhythmic-head.hh"
#include "side-position-interface.hh"
+#include "stream-event.hh"
#include "tie.hh"
#include "warn.hh"
{
public:
bool done_;
- Music *melodic_;
+ Stream_event *melodic_;
Grob *accidental_;
Context *origin_;
Engraver *origin_engraver_;
class Accidental_engraver : public Engraver
{
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 (Music *note, Grob *note_head, Engraver *trans);
- Grob *make_suggested_accidental (Music *note, Grob *note_head, Engraver *trans);
+ 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 acknowledge_finger (Grob_info);
void stop_translation_timestep ();
- virtual void initialize ();
void process_acknowledged ();
+
virtual void finalize ();
virtual void derived_mark () const;
public:
- SCM last_keysig_; // ugh.
+ 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.
- */
- std::vector<Grob*> left_objects_;
- std::vector<Grob*> right_objects_;
+ vector<Grob*> left_objects_;
+ vector<Grob*> right_objects_;
Grob *accidental_placement_;
-
std::vector<Accidental_entry> accidentals_;
- std::vector<Spanner*> ties_;
+ vector<Accidental_entry> accidentals_;
+ vector<Spanner*> 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.
*/
}
void
-Accidental_engraver::update_local_key_signature ()
+Accidental_engraver::update_local_key_signature (SCM new_sig)
{
- last_keysig_ = get_property ("keySignature");
+ last_keysig_ = new_sig;
set_context_property_on_children (context (),
ly_symbol2scm ("localKeySignature"),
- last_keysig_);
+ new_sig);
Context *trans = context ()->get_parent_context ();
- /* Huh. Don't understand what this is good for. --hwn. */
+ /* 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))
+ 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)
return (bar_number <= scm_to_int (scm_cdr (alteration_def)) + scm_to_int (laziness));
}
-static int
+static Rational
extract_alteration (SCM alteration_def)
{
if (scm_is_number (alteration_def))
- return scm_to_int (alteration_def);
+ return ly_scm2rational (alteration_def);
else if (scm_is_pair (alteration_def))
- return scm_to_int (scm_car (alteration_def));
+ return ly_scm2rational (scm_car (alteration_def));
else if (alteration_def == SCM_BOOL_F)
- return 0;
+ return Rational (0);
else
assert (0);
- return 0;
+ return Rational (0);
}
bool
is_tied (SCM alteration_def)
{
- return (alteration_def == SCM_BOOL_T)
- || (scm_is_pair (alteration_def) && scm_car (alteration_def) == SCM_BOOL_T);
+ SCM tied = ly_symbol2scm ("tied");
+ return (alteration_def == tied
+ || (scm_is_pair (alteration_def) && scm_car (alteration_def) == tied));
}
-static int
-number_accidentals_from_sig (bool *different, SCM sig, Pitch *pitch,
- int bar_number, SCM laziness, bool ignore_octave)
+struct Accidental_result
+{
+ bool need_acc;
+ bool need_restore;
+
+ Accidental_result () {
+ need_restore = need_acc = false;
+ }
+
+ 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)
{
- int n = pitch->get_notename ();
- int o = pitch->get_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)), sig, SCM_BOOL_F);
- SCM from_key_signature = ly_assoc_get (scm_from_int (n), sig, SCM_BOOL_F);
+ 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 = sig; scm_is_pair (s); s = scm_cdr (s))
+ 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);
+ {
+ from_other_octaves = scm_cdr (entry);
+ break;
+ }
}
- if (from_same_octave != SCM_BOOL_F
+ 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
else if (from_key_signature != SCM_BOOL_F)
previous_alteration = from_key_signature;
- int num = 1;
if (is_tied (previous_alteration))
{
- num = 1;
- *different = true;
+ result.need_acc = true;
}
else
{
- int prev = extract_alteration (previous_alteration);
- int alter = pitch->get_alteration ();
-
- if (alter == prev)
- num = 0;
- else if ((abs (alter) < abs (prev)
- || prev * alter < 0) && alter != 0)
- num = 2;
- *different = (alter != prev);
+ 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 num;
+
+ return result;
}
-static int
-number_accidentals (bool *different,
- Pitch *pitch, Context *origin,
- SCM accidentals, int bar_number)
+static
+Accidental_result
+check_pitch_against_rules (Pitch const &pitch, Context *origin,
+ SCM rules, int bar_number)
{
- int number = 0;
-
- *different = false;
- if (scm_is_pair (accidentals) && !scm_is_symbol (scm_car (accidentals)))
+ Accidental_result result;
+ 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 (accidentals)).c_str ()));
+ ly_scm2string (scm_car (rules)).c_str ()));
- for (; scm_is_pair (accidentals) && origin;
- accidentals = scm_cdr (accidentals))
+ for (; scm_is_pair (rules) && origin;
+ rules = scm_cdr (rules))
{
- // If pair then it is a new accidentals typesetting rule to be checked
- SCM rule = scm_car (accidentals);
+ SCM rule = scm_car (rules);
if (scm_is_pair (rule))
{
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);
+ bool same_octave
+ = (ly_symbol2scm ("same-octave") == type);
+ bool any_octave
+ = (ly_symbol2scm ("any-octave") == type);
- if (same_octave_b || any_octave_b)
+ if (same_octave || any_octave)
{
- 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);
+ 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",
+ warning (_f ("ignoring unknown accidental rule: %s",
ly_symbol2string (type).c_str ()));
}
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);
{
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 ();
for (vsize i = 0; i < accidentals_.size (); i++)
continue;
accidentals_[i].done_ = true;
- Music *note = accidentals_[i].melodic_;
+ 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;
/* Cannot look for ties: it's not guaranteed that they reach
us before the notes. */
- if (num)
- create_accidental (&accidentals_[i], num > 1, cautionary);
+ 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);
}
}
}
bool restore_natural,
bool cautionary)
{
- Music *note = entry->melodic_;
+ Stream_event *note = entry->melodic_;
Grob *support = entry->head_;
- Pitch *pitch = unsmob_pitch (note->get_property ("pitch"));
-
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_);
+ a = make_standard_accidental (note, support, entry->origin_engraver_, cautionary);
- SCM accs = scm_cons (scm_from_int (pitch->get_alteration ()),
- SCM_EOL);
if (restore_natural)
{
if (to_boolean (get_property ("extraNatural")))
- accs = scm_cons (scm_from_int (0), accs);
+ a->set_property ("restore-first", SCM_BOOL_T);
}
- /* TODO: add cautionary option in accidental. */
- if (cautionary)
- a->set_property ("cautionary", SCM_BOOL_T);
-
- a->set_property ("accidentals", accs);
entry->accidental_ = a;
}
Grob *
-Accidental_engraver::make_standard_accidental (Music *note,
- Grob *support,
- Engraver *trans)
+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
- = make_grob_from_properties (trans,
- ly_symbol2scm ("Accidental"),
- note->self_scm (),
- "Accidental");
+ 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++)
- Side_position_interface::add_support (left_objects_[i], a);
+ {
+ 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 (support, Y_AXIS);
+ 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);
- support->set_object ("accidental-grob", a->self_scm ());
-
+ note_head->set_object ("accidental-grob", a->self_scm ());
+
return a;
}
Grob *
-Accidental_engraver::make_suggested_accidental (Music *note,
- Grob *note_head, Engraver *trans)
+Accidental_engraver::make_suggested_accidental (Stream_event *note,
+ Grob *note_head,
+ Engraver *trans)
{
+ (void) note;
- Grob *a
- = make_grob_from_properties (trans,
- ly_symbol2scm ("AccidentalSuggestion"),
- note->self_scm (),
- "AccidentalSuggestion");
+ 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")))
{
int barnum = get_bar_number ();
- Music *note = accidentals_[i].melodic_;
+ Stream_event *note = accidentals_[i].melodic_;
Context *origin = accidentals_[i].origin_;
Pitch *pitch = unsmob_pitch (note->get_property ("pitch"));
int n = pitch->get_notename ();
int o = pitch->get_octave ();
- int a = pitch->get_alteration ();
+ Rational a = pitch->get_alteration ();
SCM key = scm_cons (scm_from_int (o), scm_from_int (n));
SCM localsig = SCM_EOL;
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_from_int (barnum)));
+ localsig = ly_assoc_prepend_x (localsig, key, scm_cons (ly_symbol2scm ("tied"),
+ scm_from_int (barnum)));
change = true;
}
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_from_int (a),
+ localsig = ly_assoc_prepend_x (localsig, key,
+ scm_cons (ly_rational2scm (a),
scm_from_int (barnum)));
change = true;
}
void
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"))
+ && (note->in_event_class ("note-event")
+ || note->in_event_class ("trill-span-event")))
{
/*
- std::string harmonics usually don't have accidentals.
+ string harmonics usually don't have accidentals.
*/
- if (to_boolean (get_property ("harmonicAccidentals"))
- || !ly_is_equal (info.grob ()->get_property ("style"),
- ly_symbol2scm ("harmonic")))
+ if (info.grob ()->get_property ("style") != ly_symbol2scm ("harmonic")
+ || to_boolean (get_property ("harmonicAccidentals")))
{
Accidental_entry entry;
entry.head_ = info.grob ();
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);
}
ADD_ACKNOWLEDGER (Accidental_engraver, arpeggio);
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}. ",
- "Accidental AccidentalSuggestion",
- "",
+ /* grobs */
+ "Accidental "
+ "AccidentalCautionary "
+ "AccidentalSuggestion ",
+ /* props */
"autoAccidentals "
"autoCautionaries "
+ "internalBarNumber "
"extraNatural "
"harmonicAccidentals "
- "localKeySignature",
- "localKeySignature");
+ "localKeySignature ",
+ "localKeySignature "
+ );
projects / lilypond.git / blobdiff