/*
local-key-engraver.cc -- implement Local_key_engraver
- (c) 1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1997--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
*/
#include "musical-request.hh"
#include "rhythmic-head.hh"
#include "timing-translator.hh"
#include "engraver-group-engraver.hh"
-#include "grace-align-item.hh"
+
#include "staff-symbol-referencer.hh"
#include "side-position-interface.hh"
#include "engraver.hh"
-
+#include "arpeggio.hh"
/**
- 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).
+
FIXME: should not compute vertical positioning of accidentals, but
get them from the noteheads
+ The algorithm for accidentals should be documented, and made
+ tweakable.
+
*/
struct Local_key_engraver : Engraver {
Item *key_item_p_;
protected:
- VIRTUAL_COPY_CONS(Translator);
- virtual void do_process_music();
- virtual void acknowledge_element (Score_element_info);
- virtual void do_pre_move_processing();
- virtual void do_creation_processing ();
- virtual void process_acknowledged ();
- virtual void do_removal_processing ();
+ TRANSLATOR_DECLARATIONS(Local_key_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 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_;
Link_array<Note_req> mel_l_arr_;
- Link_array<Score_element> support_l_arr_;
+ Link_array<Grob> support_l_arr_;
Link_array<Item> forced_l_arr_;
- Link_array<Score_element> tied_l_arr_;
- Local_key_engraver();
+ Link_array<Grob> tie_l_arr_;
- Item * grace_align_l_;
};
-Local_key_engraver::Local_key_engraver()
+Local_key_engraver::Local_key_engraver ()
{
key_item_p_ =0;
- grace_align_l_ =0;
last_keysig_ = SCM_EOL;
}
void
-Local_key_engraver::do_creation_processing ()
+Local_key_engraver::initialize ()
{
last_keysig_ = get_property ("keySignature");
daddy_trans_l_->set_property ("localKeySignature", last_keysig_);
}
void
-Local_key_engraver::process_acknowledged ()
+Local_key_engraver::create_grobs ()
{
- if (!key_item_p_ && mel_l_arr_.size())
+ if (!key_item_p_ && mel_l_arr_.size ())
{
SCM localsig = get_property ("localKeySignature");
- SCM f = get_property ("forgetAccidentals");
- bool forget = to_boolean (f);
- for (int i=0; i < mel_l_arr_.size(); i++)
+ for (int i=0; i < mel_l_arr_.size (); i++)
{
- Score_element * support_l = support_l_arr_[i];
+ Grob * support_l = support_l_arr_[i];
Note_req * note_l = mel_l_arr_[i];
- int n = note_l->pitch_.notename_i_;
- int o = note_l->pitch_.octave_i_;
- int a = note_l->pitch_.accidental_i_;
+ 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
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);
- int prev_acc = (prev == SCM_BOOL_F) ? 0 : gh_scm2int (gh_cdr (prev));
- bool different = prev_acc != a;
-
- bool tie_changes = tied_l_arr_.find_l (support_l) && different;
- if (!forget
- && (note_l->forceacc_b_ || different)
- && !tie_changes)
+ 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;
+ }
+
+ /* 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 ("basicLocalKeyProperties"));
+ key_item_p_ = new Item (get_property ("Accidentals"));
Local_key_item::set_interface (key_item_p_);
- Side_position::set_axis (key_item_p_, X_AXIS);
- Side_position::set_direction (key_item_p_, LEFT);
+
+
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_element (key_item_p_, 0);
+ announce_grob (key_item_p_, 0);
}
bool extra_natural =
- sign (prev_acc) * (prev_acc - a) == 1
- && abs(prev_acc) == 2;
-
- Local_key_item::add_pitch (key_item_p_, note_l->pitch_,
- note_l->cautionary_b_,
- extra_natural);
- Side_position::add_support (key_item_p_,support_l);
+ 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);
}
/*
always do the correct thing?
*/
- if (!forget && !tie_changes)
+ 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.
+
+ */
+ localsig = scm_assoc_set_x (localsig, gh_cons (gh_int2scm (o),
+ gh_int2scm (n)),
+ SCM_BOOL_T);
+
+ }
+ else if (!forget)
{
/*
not really really correct if there are more than one
daddy_trans_l_->set_property ("localKeySignature", localsig);
}
- if (key_item_p_ && grace_align_l_)
+
+ if (key_item_p_)
{
- Side_position::add_support (grace_align_l_,key_item_p_);
- grace_align_l_ =0;
+ /*
+ Hmm. Which one has to be on the left?
+
+ On which left, code or paper?
+
+ (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_);
+
+ arpeggios_.clear ();
}
-
}
void
-Local_key_engraver::do_removal_processing ()
+Local_key_engraver::finalize ()
{
- // TODO: if grace ? signal accidentals to Local_key_engraver the
+
}
void
-Local_key_engraver::do_pre_move_processing()
+Local_key_engraver::stop_translation_timestep ()
{
if (key_item_p_)
{
- for (int i=0; i < support_l_arr_.size(); i++)
- Side_position::add_support (key_item_p_,support_l_arr_[i]);
+ for (int i=0; i < support_l_arr_.size (); i++)
+ Side_position_interface::add_support (key_item_p_,support_l_arr_[i]);
- typeset_element (key_item_p_);
+ typeset_grob (key_item_p_);
key_item_p_ =0;
}
- grace_align_l_ = 0;
- mel_l_arr_.clear();
- tied_l_arr_.clear();
- support_l_arr_.clear();
- forced_l_arr_.clear();
+
+ mel_l_arr_.clear ();
+ arpeggios_.clear ();
+ tie_l_arr_.clear ();
+ support_l_arr_.clear ();
+ forced_l_arr_.clear ();
}
void
-Local_key_engraver::acknowledge_element (Score_element_info info)
+Local_key_engraver::acknowledge_grob (Grob_info info)
{
- SCM wg= get_property ("weAreGraceContext");
-
- bool selfgr = gh_boolean_p (wg) &&gh_scm2bool (wg);
- bool he_gr = to_boolean (info.elem_l_->get_elt_property ("grace"));
-
- Item * item = dynamic_cast<Item*> (info.elem_l_);
- if (he_gr && !selfgr && item && Grace_align_item::has_interface (item))
- {
- grace_align_l_ = item;
- }
- if (he_gr != selfgr)
- return;
-
Note_req * note_l = dynamic_cast <Note_req *> (info.req_l_);
- if (note_l && Rhythmic_head::has_interface (info.elem_l_))
+ if (note_l && Rhythmic_head::has_interface (info.grob_l_))
{
mel_l_arr_.push (note_l);
- support_l_arr_.push (info.elem_l_);
+ support_l_arr_.push (info.grob_l_);
}
- else if (Tie::has_interface (info.elem_l_))
+ else if (Tie::has_interface (info.grob_l_))
{
- tied_l_arr_.push (Tie::head (info.elem_l_, RIGHT));
+ tie_l_arr_.push (info.grob_l_);
}
+ else if (Arpeggio::has_interface (info.grob_l_))
+ {
+ arpeggios_.push (info.grob_l_);
+ }
+
}
/*
ugh. repeated deep_copy generates lots of garbage.
*/
void
-Local_key_engraver::do_process_music()
+Local_key_engraver::process_music ()
{
SCM smp = get_property ("measurePosition");
- Moment mp = (unsmob_moment (smp)) ? *unsmob_moment (smp) : Moment (0);
+ Moment mp = (unsmob_moment (smp)) ? *unsmob_moment (smp) : Moment (0);
SCM sig = get_property ("keySignature");
daddy_trans_l_->set_property ("localKeySignature", ly_deep_copy (sig));
last_keysig_ = sig;
}
- else if (!mp)
+ else if (!mp.to_bool () )
{
if (!to_boolean (get_property ("noResetKey")))
daddy_trans_l_->set_property ("localKeySignature", ly_deep_copy (sig));
-ADD_THIS_TRANSLATOR(Local_key_engraver);
+
+ENTER_DESCRIPTION(Local_key_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 */ "");