/*
accidental-engraver.cc -- implement accidental_engraver
- (c) 1997--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
- Modified 2001 by Rune Zedeler <rz@daimi.au.dk>
+ (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 "event.hh"
+#include "spanner.hh"
#include "item.hh"
#include "tie.hh"
#include "rhythmic-head.hh"
#include "engraver-group-engraver.hh"
-
-#include "staff-symbol-referencer.hh"
+#include "accidental-placement.hh"
#include "side-position-interface.hh"
#include "engraver.hh"
#include "arpeggio.hh"
#include "warn.hh"
+#include "context.hh"
+#include "protected-scm.hh"
+
+
+struct Accidental_entry {
+ bool done_;
+ Music * melodic_;
+ Grob * accidental_;
+ Context *origin_;
+ Grob* head_;
+ bool tied_;
+ Accidental_entry ();
+};
-/**
-
-
- FIXME: should not compute vertical positioning of accidentals, but
- get them from the noteheads
-
- The algorithm for accidentals should be documented, and made
- tweakable.
-
-*/
-
+Accidental_entry::Accidental_entry ()
+{
+ tied_ = false;
+ done_ = false;
+ melodic_ =0;
+ accidental_ = 0;
+ origin_ = 0;
+ head_ = 0;
+}
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_;
+ Protected_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_;
-
- Link_array<Note_req> mel_l_arr_;
- Link_array<Grob> head_l_arr_;
- Link_array<Item> forced_l_arr_;
- Link_array<Grob> tie_l_arr_;
+ */
+ Link_array<Grob> left_objects_;
+ Link_array<Grob> right_objects_;
+
+ Grob * accidental_placement_;
+
+ Array<Accidental_entry> accidentals_;
+ Link_array<Spanner> ties_;
+ SCM get_bar_num ();
};
+static void
+set_property_on_children (Context * trans, const char * sym, SCM val)
+{
+ trans->set_property (sym, val);
+ for (SCM p = trans->context_list_; gh_pair_p (p); p = ly_cdr (p))
+ {
+ Context *trg = unsmob_context (ly_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;
}
Accidental_engraver::initialize ()
{
last_keysig_ = get_property ("keySignature");
- daddy_trans_l_->set_property ("localKeySignature", last_keysig_);
+
+ Context * trans_ = daddy_context_;
+ while (trans_)
+ {
+ trans_ -> set_property ("localKeySignature",
+ ly_deep_copy (last_keysig_));
+ trans_ = trans_->daddy_context_;
+ }
+ set_property_on_children (daddy_context_,"localKeySignature", last_keysig_);
}
-/** 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.
- **/
+/*
+
+ calculates the number of accidentals on basis of the current local key
+ sig (passed as argument)
+
+ Returns number of accidentals (0, 1 or 2).
+
+*/
static int
-number_accidentals (SCM sig, Note_req * note_l, SCM curbarnum, SCM lazyness,
- bool ignore_octave_b)
+number_accidentals_from_sig (bool *different,
+ SCM sig, Pitch *pitch, SCM curbarnum, SCM lazyness,
+ bool ignore_octave)
{
- Pitch *pitch = unsmob_pitch (note_l->get_mus_property ("pitch"));
- int n = pitch->notename_i_;
- int o = pitch->octave_i_;
- int a = pitch->alteration_i_;
- int curbarnum_i = gh_scm2int(curbarnum);
+ int n = pitch->get_notename ();
+ int o = pitch->get_octave ();
+ int a = pitch->get_alteration ();
+ 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 (ignore_octave)
+ prev = ly_assoc_cdr (scm_int2num (n), sig);
else
- prev = gh_assoc (gh_cons (gh_int2scm (o), gh_int2scm (n)), sig);
- /* 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));
- }
+ prev = scm_assoc (gh_cons (scm_int2num (o), scm_int2num (n)), sig);
+
+ /* 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);
- SCM prev_acc = (prev == SCM_BOOL_F) ? gh_int2scm (0) : ly_cdr (prev);
+ (gh_number_p (lazyness) && curbarnum_i > accbarnum_i + gh_scm2int (lazyness)))
+ prev = scm_assoc (scm_int2num (n), sig);
+
+
+ SCM prev_acc = (prev == SCM_BOOL_F) ? scm_int2num (0) : ly_cdr (prev);
int p = gh_number_p (prev_acc) ? gh_scm2int (prev_acc) : 0;
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)<abs(p) || p*a<0) && a!=0 ) num=2;
- else num=1;
-
- return a==p ? num : -num;
+ if (a == p && gh_number_p (prev_acc))
+ num = 0;
+ else if ( (abs (a)<abs (p) || p*a<0) && a != 0 )
+ num = 2;
+ else
+ num = 1;
+
+ *different = (a != p);
+ return num;
}
static int
-number_accidentals (SCM localsig, Note_req * note_l, SCM accidentals_l,
- SCM curbarnum) {
- int number=0;
- int diff=0;
- while(gh_pair_p(accidentals_l)) {
- if(gh_pair_p(ly_car(accidentals_l))) {
- SCM type = gh_caar(accidentals_l);
- SCM lazyness = gh_cdar(accidentals_l);
- bool measure_same_octave_b =
- gh_eq_p(ly_symbol2scm("measure-same-octave"),type);
- bool measure_any_octave_b =
- gh_eq_p(ly_symbol2scm("measure-any-octave"),type);
- if(measure_same_octave_b || measure_any_octave_b) {
- int n = number_accidentals
- (localsig,note_l,curbarnum,lazyness,measure_any_octave_b);
- diff |= n<0;
- number = max(number,abs(n));
- }
- else warning(_f("unknown accidental typesetting: %s",
- ly_symbol2string(type).ch_C()));
+number_accidentals (bool *different,
+ Pitch *pitch, Context * origin,
+ SCM accidentals, SCM curbarnum)
+{
+ int number = 0;
+
+ *different = 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)).to_str0 ()));
+
+ for (; gh_pair_p (accidentals) && origin; accidentals = gh_cdr (accidentals))
+ {
+ // If pair then it is a new accidentals typesetting rule to be checked
+ SCM rule = gh_car (accidentals);
+ if (gh_pair_p (rule))
+ {
+ SCM type = gh_car (rule);
+ SCM lazyness = gh_cdr (rule);
+ SCM localsig = origin->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);
+
+ if (same_octave_b || any_octave_b)
+ {
+ bool d = false;
+ int n = number_accidentals_from_sig
+ (&d, localsig, pitch, curbarnum, lazyness, any_octave_b);
+ *different = *different || d;
+ number = max (number, n);
+ }
+ else
+ warning (_f ("unknown accidental typesetting: %s. Ignored",
+ ly_symbol2string (type).to_str0 ()));
+ }
+
+
+ /*
+ if symbol then it is a context name. Scan parent contexts to find it.
+ */
+ else if (gh_symbol_p (rule))
+ {
+ Context * dad = origin;
+ while (dad && !dad->is_alias (rule))
+ dad = dad->daddy_context_;
+
+ if (dad)
+ origin = dad;
+ }
+ else warning (_f ("Accidental rule must be pair or context-name; Found %s",
+ ly_scm2string (rule).to_str0 ()));
}
- else warning(_f("Accidental typesetting must be pair: %s",
- ly_scm2string(ly_car(accidentals_l)).ch_C()));
- accidentals_l = ly_cdr(accidentals_l);
- }
- return diff ? -number : number;
+
+ return number;
+}
+
+SCM
+Accidental_engraver::get_bar_num ()
+{
+ SCM barnum = get_property ("currentBarNumber");
+ SCM smp = get_property ("measurePosition");
+
+ Moment mp = (unsmob_moment (smp)) ? *unsmob_moment (smp) : Moment (0);
+ if (mp.main_part_ < Rational (0)
+ && gh_number_p (barnum))
+ barnum = scm_int2num (gh_scm2int (barnum) - 1);
+
+ return barnum ;
}
void
-Accidental_engraver::create_grobs ()
+Accidental_engraver::process_acknowledged_grobs ()
{
- if (!key_item_p_ && mel_l_arr_.size ())
+ if (accidentals_.size () && !accidentals_.top ().done_)
{
- SCM localsig = get_property ("localKeySignature");
- SCM accidentals_l = get_property ("autoAccidentals");
- SCM cautionaries_l = get_property ("autoCautionaries");
- SCM barnum = get_property ("currentBarNumber");
-
- bool extra_natural_b = get_property ("extraNatural")==SCM_BOOL_T;
- for (int i=0; i < mel_l_arr_.size (); i++)
+ SCM accidentals = get_property ("autoAccidentals");
+ SCM cautionaries = get_property ("autoCautionaries");
+ SCM barnum = get_bar_num ();
+
+ bool extra_natural_b = get_property ("extraNatural") == SCM_BOOL_T;
+ for (int i = 0; i < accidentals_.size (); i++)
{
- Grob * support_l = head_l_arr_[i];
- Note_req * note_l = mel_l_arr_[i];
-
- int num = number_accidentals(localsig,note_l,accidentals_l,barnum);
- int num_caut = number_accidentals(localsig,note_l,cautionaries_l,barnum);
- bool cautionary = to_boolean (note_l->get_mus_property ("cautionary"));
- if (abs(num_caut)>abs(num))
+ 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;
- cautionary=true;
+ num = num_caut;
+ different = different_caut;
+ cautionary = true;
}
+
+ if (num == 0 && to_boolean (note->get_property ("force-accidental")))
+ num = 1;
- 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 */
+ /*
+ 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 (origin,
+ ly_symbol2scm ("Accidental"));
+ a->set_parent (support, Y_AXIS);
+ if (!accidental_placement_)
+ {
+ accidental_placement_ = make_item ("AccidentalPlacement");
+ announce_grob (accidental_placement_, a->self_scm ());
+ }
+
+ Accidental_placement::add_accidental (accidental_placement_, a);
+ announce_grob (a, SCM_EOL);
- 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
+
+ SCM accs = gh_cons (scm_int2num (pitch->get_alteration ()), SCM_EOL);
+ if (num == 2 && extra_natural_b)
+ accs = gh_cons (scm_int2num (0), accs);
- 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;
- }
+ /* TODO:
- if (num)
- {
- if (!key_item_p_)
+ add cautionary option in accidental.
+ */
+
+ if (cautionary)
{
- 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);
+ a->set_property ("cautionary", SCM_BOOL_T);
}
-
- Local_key_item::add_pitch (key_item_p_, *unsmob_pitch (note_l->get_mus_property ("pitch")),
- cautionary,
- num==2 && extra_natural_b,
- tie_break_reminder);
- Side_position_interface::add_support (key_item_p_,support_l);
- support_l->set_grob_property ("accidentals", key_item_p_->self_scm ());
+ support->set_property ("accidental-grob", a->self_scm ());
+
+ a->set_property ("accidentals", accs);
+ accidentals_[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 < 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]);
}
-
+ }
+ }
+}
- /*
- We should not record the accidental if it is the first
- note and it is tied from the previous measure.
- Checking whether it is tied also works mostly, but will it
- always do the correct thing?
- */
-
- Pitch *pitch = unsmob_pitch (note_l->get_mus_property ("pitch"));
- int n = pitch->notename_i_;
- int o = pitch->octave_i_;
- int a = pitch->alteration_i_;
- SCM on = gh_cons (gh_int2scm (o), gh_int2scm (n));
- if (tie_changes)
+
+
+void
+Accidental_engraver::finalize ()
+{
+ last_keysig_ = SCM_EOL;
+}
+
+void
+Accidental_engraver::stop_translation_timestep ()
+{
+ 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--;)
+ {
+ SCM barnum = get_bar_num ();
+
+ 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 on_s = gh_cons (scm_int2num (o), scm_int2num (n));
+
+ while (origin)
+ {
+ /*
+ 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, on, gh_cons(SCM_BOOL_T,barnum));
+ (localsig, on_s, gh_cons (SCM_BOOL_T, 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, on, gh_cons(gh_int2scm (a),barnum));
+ (localsig, on_s, gh_cons (scm_int2num (a), barnum));
+
+ change = true;
}
- }
-
- daddy_trans_l_->set_property ("localKeySignature", localsig);
+
+ if (change)
+ origin->set_property ("localKeySignature", localsig);
+ origin = origin->daddy_context_;
+ }
}
-
- if (key_item_p_)
+ for (int i = 0; i < accidentals_.size (); i++)
{
- /*
- 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], key_item_p_);
-
- arpeggios_.clear ();
+ if (Grob *a = accidentals_[i].accidental_)
+ typeset_grob (a);
}
-}
-void
-Accidental_engraver::finalize ()
-{
+ if (accidental_placement_)
+ typeset_grob (accidental_placement_);
+ accidental_placement_ = 0;
+
+ accidentals_.clear ();
+ left_objects_.clear ();
+ right_objects_.clear ();
}
void
-Accidental_engraver::stop_translation_timestep ()
+Accidental_engraver::acknowledge_grob (Grob_info info)
{
- if (key_item_p_)
+ Music * note = info.music_cause ();
+
+ if (note
+ && note->is_mus_type ("note-event")
+ && Rhythmic_head::has_interface (info.grob_)
+#if 0
+ /*
+ todo: make tunable.
+ */
+ && !gh_equal_p (info.grob_->get_property ("style"),
+ ly_symbol2scm ("harmonic"))
+#endif
+ )
{
- for (int i=0; i < head_l_arr_.size (); i++)
- Side_position_interface::add_support (key_item_p_,head_l_arr_[i]);
+ Accidental_entry entry ;
+ entry.head_ = info.grob_;
+ entry.origin_ = info.origin_trans_->daddy_context_;
+ entry.melodic_ = note;
- typeset_grob (key_item_p_);
- key_item_p_ =0;
+ accidentals_.push (entry);
}
-
-
- mel_l_arr_.clear ();
- arpeggios_.clear ();
- tie_l_arr_.clear ();
- head_l_arr_.clear ();
- forced_l_arr_.clear ();
-}
-
-void
-Accidental_engraver::acknowledge_grob (Grob_info info)
-{
- Note_req * note_l = dynamic_cast <Note_req *> (info.music_cause ());
-
- if (note_l && Rhythmic_head::has_interface (info.grob_l_))
+ else if (Tie::has_interface (info.grob_))
{
- mel_l_arr_.push (note_l);
- head_l_arr_.push (info.grob_l_);
+ ties_.push (dynamic_cast<Spanner*> (info.grob_));
}
- else if (Tie::has_interface (info.grob_l_))
+ else if (Arpeggio::has_interface (info.grob_))
{
- tie_l_arr_.push (info.grob_l_);
+ left_objects_.push (info.grob_);
}
- else if (Arpeggio::has_interface (info.grob_l_))
+ else if (info.grob_->internal_has_interface (ly_symbol2scm ("finger-interface")))
{
- arpeggios_.push (info.grob_l_);
+ 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 (last_keysig_ != sig)
+ /* Detect key sig changes.
+ Update all parents and children
+ */
+ if (last_keysig_ != sig)
{
- daddy_trans_l_->set_property ("localKeySignature", ly_deep_copy (sig));
+ Context * trans_ = daddy_context_;
+ while (trans_)
+ {
+ trans_ -> set_property ("localKeySignature", ly_deep_copy (sig));
+ trans_ = trans_->daddy_context_;
+ }
+ set_property_on_children (daddy_context_,"localKeySignature", sig);
+
last_keysig_ = sig;
}
}
-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 extraNatural autoAccidentals autoCautionaries",
-/* write */ "localKeySignature");
+ENTER_DESCRIPTION (Accidental_engraver,
+ "Make accidentals. Catches 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",
+ "",
+ "finger-interface rhythmic-head-interface tie-interface arpeggio-interface",
+ "localKeySignature extraNatural autoAccidentals autoCautionaries",
+ "localKeySignature");