source file of the GNU LilyPond music typesetter
- (c) 1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
*/
-#include "key-engraver.hh"
-#include "key-item.hh"
-#include "command-request.hh"
-#include "local-key-engraver.hh"
-#include "musical-request.hh"
-#include "local-key-item.hh"
-#include "bar.hh"
-#include "time-description.hh"
+
+
+#include "event.hh"
+#include "item.hh"
+#include "bar-line.hh"
+#include "staff-symbol-referencer.hh"
+#include "translator-group.hh"
+#include "engraver.hh"
+#include "pitch.hh"
+#include "protected-scm.hh"
+#include "clef.hh"
+
+/*
+ TODO: The representation of key sigs is all fucked.
+ */
+
+/**
+ Make the key signature.
+ */
+class Key_engraver : public Engraver
+{
+ void create_key (bool);
+ void read_ev (Key_change_ev const * r);
+ Key_change_ev * key_ev_;
+ Item * item_;
+
+public:
+ TRANSLATOR_DECLARATIONS(Key_engraver);
+
+protected:
+ virtual void initialize ();
+ virtual void finalize ();
+ virtual bool try_music (Music *ev);
+ virtual void stop_translation_timestep ();
+ virtual void start_translation_timestep ();
+ virtual void process_music ();
+ virtual void acknowledge_grob (Grob_info);
+};
+
+
+void
+Key_engraver::finalize ()
+{
+}
+
Key_engraver::Key_engraver ()
{
- kit_p_ = 0;
- do_post_move_processing ();
+ key_ev_ = 0;
+ item_ = 0;
}
+
void
-Key_engraver::create_key ()
+Key_engraver::create_key (bool def)
{
- if (!kit_p_)
+ if (!item_)
{
- kit_p_ = new Key_item;
- kit_p_->break_priority_i_ = -1; // ugh
- kit_p_->multi_octave_b_ = key_.multi_octave_b_;
- announce_element (Score_element_info (kit_p_,keyreq_l_));
+ item_ = make_item ("KeySignature");
+
+ item_->set_grob_property ("c0-position",
+ get_property ("centralCPosition"));
+ // todo: put this in basic props.
+ item_->set_grob_property ("old-accidentals", get_property ("lastKeySignature"));
+ item_->set_grob_property ("new-accidentals", get_property ("keySignature"));
- for (int i = 0; i < accidental_idx_arr_.size(); i++)
- {
- Musical_pitch m_l =accidental_idx_arr_[i];
- int a =m_l.accidental_i_;
- if (key_.multi_octave_b_)
- kit_p_->add (m_l.steps (), a);
- else
- kit_p_->add (m_l.notename_i_, a);
- }
+ announce_grob(item_, key_ev_ ? key_ev_->self_scm() : SCM_EOL);
+ }
- for (int i = 0 ; i< old_accidental_idx_arr_.size(); i++)
- {
- Musical_pitch m_l =old_accidental_idx_arr_[i];
- int a =m_l.accidental_i_;
- if (key_.multi_octave_b_)
- kit_p_->add_old (m_l.steps (), a);
- else
- kit_p_->add_old (m_l.notename_i_, a);
- }
+ if (!def)
+ {
+ SCM vis = get_property ("explicitKeySignatureVisibility");
+ if (gh_procedure_p (vis))
+ item_->set_grob_property ("break-visibility",vis);
}
}
bool
-Key_engraver::do_try_music (Music * req_l)
+Key_engraver::try_music (Music * ev)
{
- if (Key_change_req *kc = dynamic_cast <Key_change_req *> (req_l))
+ // if (Key_change_ev *kc = dynamic_cast <Key_change_ev *> (ev))
+ if (ev->is_mus_type ("key-change-event"))
{
- if (keyreq_l_)
- warning ("Fixme: key change merge.");
- keyreq_l_ = kc;
- read_req (keyreq_l_);
+ if (!key_ev_)
+ {
+ /*
+ do this only once, just to be on the safe side.
+ */
+ key_ev_ = dynamic_cast<Key_change_ev*> (ev); // UGH.
+ read_ev (key_ev_);
+ }
+
return true;
}
return false;
}
+
void
-Key_engraver::acknowledge_element (Score_element_info info)
+Key_engraver::acknowledge_grob (Grob_info info)
{
- if (dynamic_cast <Clef_change_req *> (info.req_l_))
+ if (Clef::has_interface (info.grob_))
{
- int i= get_property ("createKeyOnClefChange", 0).length_i ();
- if (i)
- create_key ();
+ SCM c = get_property ("createKeyOnClefChange");
+ if (to_boolean (c))
+ {
+ create_key (false);
+ }
}
- else if (dynamic_cast<Bar *> (info.elem_l_)
- && accidental_idx_arr_.size ())
+ else if (Bar_line::has_interface (info.grob_)
+ && gh_pair_p (get_property ("keySignature")))
{
- if (!keyreq_l_)
- default_key_b_ = true;
- create_key ();
+ create_key (true);
}
-
}
+
void
-Key_engraver::do_process_requests ()
+Key_engraver::process_music ()
{
- if (keyreq_l_)
- {
- create_key ();
- }
+ if (key_ev_ ||
+ get_property ("lastKeySignature") != get_property ("keySignature"))
+ create_key (false);
}
+
void
-Key_engraver::do_pre_move_processing ()
-{
- if (kit_p_)
+Key_engraver::stop_translation_timestep ()
+{
+ if (item_)
{
- kit_p_->default_b_ = default_key_b_;
- typeset_element (kit_p_);
- kit_p_ = 0;
+ typeset_grob (item_);
+ item_ = 0;
}
}
-/*
- TODO Slightly hairy.
- */
void
-Key_engraver::read_req (Key_change_req const * r)
+Key_engraver::read_ev (Key_change_ev const * r)
{
- old_accidental_idx_arr_ = accidental_idx_arr_;
- key_.clear ();
- Scalar prop = get_property ("keyoctaviation", 0);
- if (prop.length_i () > 0)
+ SCM p = r->get_mus_property ("pitch-alist");
+ if (!gh_pair_p (p))
+ return;
+
+ SCM n = scm_list_copy (p);
+ SCM accs = SCM_EOL;
+ for (SCM s = get_property ("keyAccidentalOrder");
+ gh_pair_p (s); s = ly_cdr (s))
{
- key_.multi_octave_b_ = ! prop.to_bool ();
+ if (gh_pair_p (scm_member (ly_car (s), n)))
+ {
+ accs = gh_cons (ly_car (s), accs);
+ n = scm_delete_x (ly_car (s), n);
+ }
}
- accidental_idx_arr_.clear ();
+ for (SCM s = n ; gh_pair_p (s); s = ly_cdr (s))
+ if (gh_scm2int (ly_cdar (s)))
+ accs = gh_cons (ly_car (s), accs);
- if (r->ordinary_key_b_)
- {
- int p;
- if (r->pitch_arr_.size () < 1)
- {
- r->warning (_ ("No key name: assuming `C'"));
- p = 0;
- }
- else
- {
- p = r->pitch_arr_[0].semitone_pitch ();
- p += r->modality_i_;
- }
- /* Solve the equation 7*no_of_acc mod 12 = p, -6 <= no_of_acc <= 5 */
- int no_of_acc = (7*p) % 12;
- no_of_acc = (no_of_acc + 18) % 12 -6;
+ daddy_trans_->set_property ("keySignature", accs);
+ daddy_trans_->set_property ("tonic" ,
+ r->get_mus_property ("tonic"));
+}
- /* Correct from flats to sharps or vice versa */
- if (no_of_acc * r->pitch_arr_[0].accidental_i_ < 0)
- no_of_acc += 12 * sign (r->pitch_arr_[0].accidental_i_);
- if (no_of_acc < 0)
- {
- int accidental = 6 ; // First accidental: bes
- for ( ; no_of_acc < 0 ; no_of_acc++ )
- {
- Musical_pitch m;
- m.accidental_i_ = -1;
- m.notename_i_ = accidental;
- if (key_.multi_octave_b_)
- key_.set (m);
- else
- key_.set (m.notename_i_, m.accidental_i_);
- accidental_idx_arr_.push (m);
-
- accidental = (accidental + 3) % 7 ;
- }
- }
- else
- {
- int accidental = 3 ; // First accidental: fis
- for ( ; no_of_acc > 0 ; no_of_acc-- )
- {
- Musical_pitch m;
- m.accidental_i_ = 1;
- m.notename_i_ = accidental;
- if (key_.multi_octave_b_)
- key_.set (m);
- else
- key_.set (m.notename_i_, m.accidental_i_);
- accidental_idx_arr_.push (m);
-
- accidental = (accidental + 4) % 7 ;
- }
- }
- }
- else // Special key
- {
- for (int i = 0; i < r->pitch_arr_.size (); i ++)
- {
- Musical_pitch m_l =r->pitch_arr_[i];
- if (key_.multi_octave_b_)
- key_.set (m_l);
- else
- key_.set (m_l.notename_i_, m_l.accidental_i_);
-
- accidental_idx_arr_.push (m_l);
- }
- }
+void
+Key_engraver::start_translation_timestep ()
+{
+ key_ev_ = 0;
+ daddy_trans_->set_property ("lastKeySignature", get_property ("keySignature"));
}
+
void
-Key_engraver::do_post_move_processing ()
+Key_engraver::initialize ()
{
- keyreq_l_ = 0;
- default_key_b_ = false;
- old_accidental_idx_arr_.clear ();
-}
+ daddy_trans_->set_property ("keySignature", SCM_EOL);
+ daddy_trans_->set_property ("lastKeySignature", SCM_EOL);
+ Pitch p(0,0,0);
+ daddy_trans_->set_property ("tonic", p.smobbed_copy ());
+}
-ADD_THIS_TRANSLATOR (Key_engraver);
+ENTER_DESCRIPTION(Key_engraver,
+/* descr */ "",
+/* creats*/ "KeySignature",
+/* accepts */ "key-change-event",
+/* acks */ "bar-line-interface clef-interface",
+/* reads */ "keySignature lastKeySignature explicitKeySignatureVisibility createKeyOnClefChange keyAccidentalOrder keySignature",
+/* write */ "lastKeySignature tonic keySignature");