/*
- local-key-engraver.cc -- implement accidental_engraver
+ accidental-engraver.cc -- implement accidental_engraver
- (c) 1997--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ source file of the GNU LilyPond music typesetter
+
+ (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ Modified 2001--2002 by Rune Zedeler <rz@daimi.au.dk>
*/
-#include "musical-request.hh"
-#include "command-request.hh"
-#include "local-key-item.hh"
-#include "item.hh"
-#include "tie.hh"
+#include "accidental-placement.hh"
+#include "arpeggio.hh"
+#include "context.hh"
+#include "engraver.hh"
+#include "protected-scm.hh"
#include "rhythmic-head.hh"
-#include "timing-translator.hh"
-#include "engraver-group-engraver.hh"
-
-#include "staff-symbol-referencer.hh"
#include "side-position-interface.hh"
-#include "engraver.hh"
-#include "arpeggio.hh"
-
-/**
-
-
- FIXME: should not compute vertical positioning of accidentals, but
- get them from the noteheads
+#include "tie.hh"
+#include "warn.hh"
- The algorithm for accidentals should be documented, and made
- tweakable.
+class Accidental_entry
+{
+public:
+ bool done_;
+ Music *melodic_;
+ Grob *accidental_;
+ Context *origin_;
+ Engraver *origin_trans_;
+ Grob *head_;
+ bool tied_;
+
+ Accidental_entry ();
+};
-*/
+Accidental_entry::Accidental_entry ()
+{
+ tied_ = false;
+ done_ = false;
+ melodic_ = 0;
+ accidental_ = 0;
+ origin_ = 0;
+ head_ = 0;
+}
+class Accidental_engraver : public Engraver
+{
+public:
+ int get_bar_number ();
+ void update_local_key_signature ();
-struct Accidental_engraver : Engraver {
- Item *key_item_p_;
protected:
- TRANSLATOR_DECLARATIONS(Accidental_engraver);
+ TRANSLATOR_DECLARATIONS (Accidental_engraver);
virtual void process_music ();
virtual void acknowledge_grob (Grob_info);
virtual void stop_translation_timestep ();
virtual void initialize ();
- virtual void create_grobs ();
+ virtual void process_acknowledged_grobs ();
virtual void finalize ();
-public:
- // todo -> property
- 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.
- */
- Link_array<Grob> arpeggios_;
+ virtual void derived_mark () const;
+public:
+ SCM last_keysig_; // ugh.
- Link_array<Note_req> mel_l_arr_;
- Link_array<Grob> support_l_arr_;
- Link_array<Item> forced_l_arr_;
- Link_array<Grob> tie_l_arr_;
+ /* Urgh. Since the accidentals depend on lots of variables, we have
+ to store all information before we can really create the
+ accidentals. */
+ Link_array<Grob> left_objects_;
+ Link_array<Grob> right_objects_;
+ Grob *accidental_placement_;
+
+ Array<Accidental_entry> accidentals_;
+ Link_array<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.
+ */
+
+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 ()
{
- key_item_p_ =0;
+ accidental_placement_ = 0;
last_keysig_ = SCM_EOL;
}
void
-Accidental_engraver::initialize ()
+Accidental_engraver::derived_mark () const
{
- last_keysig_ = get_property ("keySignature");
- daddy_trans_l_->set_property ("localKeySignature", last_keysig_);
+ scm_gc_mark (last_keysig_);
}
void
-Accidental_engraver::create_grobs ()
+Accidental_engraver::update_local_key_signature ()
{
- if (!key_item_p_ && mel_l_arr_.size ())
+ last_keysig_ = get_property ("keySignature");
+ set_property_on_children (context (), "localKeySignature", last_keysig_);
+
+ Context *trans = context ()->get_parent_context ();
+
+ /* Huh. Don't understand what this is good for. --hwn. */
+ while (trans && trans->where_defined (ly_symbol2scm ("localKeySignature")))
{
- SCM localsig = get_property ("localKeySignature");
-
- for (int i=0; i < mel_l_arr_.size (); i++)
- {
- Grob * support_l = support_l_arr_[i];
- Note_req * note_l = mel_l_arr_[i];
+ trans->set_property ("localKeySignature", ly_deep_copy (last_keysig_));
+ trans = trans->get_parent_context ();
+ }
+}
- int n = unsmob_pitch (note_l->get_mus_property ("pitch"))->notename_i_;
- int o = unsmob_pitch (note_l->get_mus_property ("pitch"))->octave_i () ;
- int a = unsmob_pitch (note_l->get_mus_property ("pitch"))->alteration_i_;
-
- /* 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 */
-
- SCM prev = scm_assoc (gh_cons (gh_int2scm (o), gh_int2scm (n)), localsig);
- if (prev == SCM_BOOL_F)
- prev = scm_assoc (gh_int2scm (n), localsig);
- SCM prev_acc = (prev == SCM_BOOL_F) ? gh_int2scm (0) : ly_cdr (prev);
- bool different = !gh_equal_p (prev_acc , gh_int2scm (a));
- int p = gh_number_p (prev_acc) ? gh_scm2int (prev_acc) : 0;
-
- Grob *tie_break_reminder = 0;
- bool tie_changes = false;
- for (int i=0; i < tie_l_arr_.size (); i++)
- if (support_l == Tie::head (tie_l_arr_[i], 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_l_arr_[i];
- break;
- }
+void
+Accidental_engraver::initialize ()
+{
+ update_local_key_signature ();
+}
- /* When do we want accidentals:
-
- 1. when property force-accidental is set, and not
- tie_changes
- 2. when different and not tie-changes
- 3. maybe when at end of a tie: we must later see if
- we're after a line break */
- if (( (to_boolean (note_l->get_mus_property ("force-accidental"))
- || different)
- && !tie_changes)
- || tie_break_reminder)
- {
- if (!key_item_p_)
- {
- key_item_p_ = new Item (get_property ("Accidentals"));
- Local_key_item::set_interface (key_item_p_);
-
-
- Staff_symbol_referencer::set_interface (key_item_p_);
- SCM c0 = get_property ("centralCPosition");
- if (gh_number_p (c0))
- Staff_symbol_referencer::set_position (key_item_p_, gh_scm2int (c0));
-
- announce_grob (key_item_p_, 0);
- }
-
- bool extra_natural =
- sign (p) * (p - a) == 1
- && abs (p) == 2;
-
- Local_key_item::add_pitch (key_item_p_, *unsmob_pitch (note_l->get_mus_property ("pitch")),
- to_boolean (note_l->get_mus_property ("cautionary")),
- extra_natural,
- tie_break_reminder);
- Side_position_interface::add_support (key_item_p_,support_l);
- }
-
- /*
- We should not record the accidental if it is the first
- note and it is tied from the previous measure.
+/** 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). */
- Checking whether it is tied also works mostly, but will it
- always do the correct thing?
+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));
+}
- */
- bool forget = to_boolean (get_property ("forgetAccidentals"));
- if (tie_changes)
- {
- /*
- Remember an alteration that is different both from
- that of the tied note and of the key signature.
+static int
+extract_alteration (SCM alteration_def)
+{
+ 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
+ assert (0);
+ return 0;
+}
- */
- localsig = scm_assoc_set_x (localsig, gh_cons (gh_int2scm (o),
- gh_int2scm (n)),
- SCM_BOOL_T);
+bool
+is_tied (SCM alteration_def)
+{
+ return (alteration_def == SCM_BOOL_T)
+ || (scm_is_pair (alteration_def) && scm_car (alteration_def) == SCM_BOOL_T);
+}
- }
- else if (!forget)
- {
- /*
- not really really correct if there are more than one
- noteheads with the same notename.
- */
- localsig = scm_assoc_set_x (localsig, gh_cons (gh_int2scm (o),
- gh_int2scm (n)),
- gh_int2scm (a));
+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 previous_alteration = SCM_BOOL_F;
+ 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);
+ }
-
- daddy_trans_l_->set_property ("localKeySignature", localsig);
+
+ if (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;
}
+ int num = 1;
+ if (is_tied (previous_alteration))
+ {
+ num = 1;
+ *different = 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);
+ }
+ return num;
+}
+
+static int
+number_accidentals (bool *different,
+ Pitch *pitch, Context *origin,
+ SCM accidentals, int bar_number)
+{
+ int number = 0;
- if (key_item_p_)
+ *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
+ SCM rule = scm_car (accidentals);
+ 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);
+
+ if (same_octave_b || any_octave_b)
+ {
+ 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 ("ignoring unknown accidental: %s",
+ ly_symbol2string (type).to_str0 ()));
+ }
+
+
/*
- Hmm. Which one has to be on the left?
+ 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 ()));
+ }
+
+ 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;
+}
- On which left, code or paper?
+void
+Accidental_engraver::process_acknowledged_grobs ()
+{
+ if (accidentals_.size () && !accidentals_.top ().done_)
+ {
+ 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 < accidentals_.size (); i++)
+ {
+ 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;
+
+ 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;
+ }
+
+ if (num == 0 && to_boolean (note->get_property ("force-accidental")))
+ num = 1;
+
+
+ /*
+ 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 (accidentals_[i].origin_trans_,
+ ly_symbol2scm ("Accidental"),
+ note->self_scm (),
+ "Accidental"
+ );
+ 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 ());
- (Arpeggios are engraved left of accidentals, of course.)
- */
- for (int i=0; i < arpeggios_.size (); i++)
- Side_position_interface::add_support (arpeggios_[i], key_item_p_);
+ a->set_property ("accidentals", accs);
+ accidentals_[i].accidental_ = a;
- arpeggios_.clear ();
+ /*
+ 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]);
+ }
+ }
}
}
void
Accidental_engraver::finalize ()
{
-
+ last_keysig_ = SCM_EOL;
}
void
Accidental_engraver::stop_translation_timestep ()
{
- if (key_item_p_)
+ for (int j = ties_.size (); j--;)
{
- for (int i=0; i < support_l_arr_.size (); i++)
- Side_position_interface::add_support (key_item_p_,support_l_arr_[i]);
-
- typeset_grob (key_item_p_);
- key_item_p_ =0;
+ 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--;)
+ {
+ 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")))
+ {
+ /*
+ 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;
+ }
- mel_l_arr_.clear ();
- arpeggios_.clear ();
- tie_l_arr_.clear ();
- support_l_arr_.clear ();
- forced_l_arr_.clear ();
+ if (change)
+ origin->set_property ("localKeySignature", localsig);
+
+ origin = origin->get_parent_context ();
+ }
+ }
+
+ 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 <Note_req *> (info.req_l_);
+ Music *note = info.music_cause ();
- if (note_l && Rhythmic_head::has_interface (info.grob_l_))
- {
- mel_l_arr_.push (note_l);
- support_l_arr_.push (info.grob_l_);
- }
- else if (Tie::has_interface (info.grob_l_))
+ if (note
+ && note->is_mus_type ("note-event")
+ && Rhythmic_head::has_interface (info.grob_))
{
- tie_l_arr_.push (info.grob_l_);
- }
- else if (Arpeggio::has_interface (info.grob_l_))
- {
- arpeggios_.push (info.grob_l_);
+ if (to_boolean ( get_property ("harmonicAccidentals"))
+ || !ly_c_equal_p (info.grob_->get_property ("style"),
+ ly_symbol2scm ("harmonic")))
+ {
+
+ Accidental_entry entry ;
+ entry.head_ = info.grob_;
+ entry.origin_trans_ = dynamic_cast<Engraver*> (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<Spanner*> (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_);
}
-/*
- ugh. repeated deep_copy generates lots of garbage.
- */
void
Accidental_engraver::process_music ()
{
- SCM smp = get_property ("measurePosition");
- Moment mp = (unsmob_moment (smp)) ? *unsmob_moment (smp) : Moment (0);
-
SCM sig = get_property ("keySignature");
-
- /*
- Detect key sig changes. If we haven't found any, check if at start
- of measure, and set localKeySignature anyhow. */
- if (last_keysig_ != sig)
- {
- daddy_trans_l_->set_property ("localKeySignature", ly_deep_copy (sig));
- last_keysig_ = sig;
- }
- else if (!mp.to_bool () )
- {
- if (!to_boolean (get_property ("noResetKey")))
- daddy_trans_l_->set_property ("localKeySignature", ly_deep_copy (sig));
- }
+ /* Detect key sig changes.
+ Update all parents and children. */
+ if (last_keysig_ != sig)
+ update_local_key_signature ();
}
-
-
-
-
-ENTER_DESCRIPTION(Accidental_engraver,
-/* descr */ "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. FIXME",
-/* creats*/ "Accidentals",
-/* acks */ "rhythmic-head-interface tie-interface arpeggio-interface",
-/* reads */ "localKeySignature forgetAccidentals noResetKey",
-/* write */ "");
+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"
+ );