/*
- key-reg.cc -- implement Key_engraver
+ key-engraver.cc -- implement Key_engraver
source file of the GNU LilyPond music typesetter
- (c) 1997--1998 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"
-Key_engraver::Key_engraver ()
+#include "item.hh"
+#include "bar-line.hh"
+#include "staff-symbol-referencer.hh"
+#include "context.hh"
+#include "engraver.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
{
- kit_p_ = 0;
- do_post_move_processing ();
-}
+ void create_key (bool);
+ void read_ev (Music const * r);
+
+ Music *key_ev_;
+ Item *item_;
+ Item *cancellation_;
+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::create_key ()
+Key_engraver::finalize ()
{
- if (!kit_p_)
- {
- kit_p_ = new Key_item;
- kit_p_->break_priority_i_ = -1; // ugh
- announce_element (Score_element_info (kit_p_,keyreq_l_));
- kit_p_->read (*this);
- }
}
-bool
-Key_engraver::do_try_request (Request * req_l)
+
+Key_engraver::Key_engraver ()
{
- Command_req* creq_l= req_l->access_Command_req ();
- if (!creq_l|| !creq_l->access_Key_change_req ())
- return false;
-
- if (keyreq_l_)
- return false; // TODO
- keyreq_l_ = creq_l->access_Key_change_req ();
- read_req (keyreq_l_);
- return true;
+ key_ev_ = 0;
+ item_ = 0;
+ cancellation_ = 0;
}
+
void
-Key_engraver::acknowledge_element (Score_element_info info)
+Key_engraver::create_key (bool def)
{
- Command_req * r_l = info.req_l_->access_Command_req () ;
- if (r_l && r_l->access_Clef_change_req ())
+ if (!item_)
{
- create_key ();
+ item_ = make_item ("KeySignature", key_ev_ ? key_ev_->self_scm () : SCM_EOL);
+
+ item_->set_property ("c0-position",
+ get_property ("middleCPosition"));
+
+ SCM last = get_property ("lastKeySignature");
+ SCM key = get_property ("keySignature");
+ if (to_boolean (get_property ("printKeyCancellation"))
+ && !scm_is_eq (last, key))
+ {
+ cancellation_ = make_item ("KeyCancellation", key_ev_ ? key_ev_->self_scm () : SCM_EOL);
+ cancellation_->set_property ("old-accidentals",last);
+ cancellation_->set_property ("c0-position",
+ get_property ("middleCPosition"));
+
+ }
+ item_->set_property ("new-accidentals", key);
}
- else if (info.elem_l_->is_type_b (Bar::static_name ())
- && accidental_idx_arr_.size ())
+
+ if (!def)
{
- if (!keyreq_l_)
- default_key_b_ = true;
- create_key ();
+ SCM vis = get_property ("explicitKeySignatureVisibility");
+ if (ly_c_procedure_p (vis))
+ item_->set_property ("break-visibility",vis);
}
+}
-}
-void
-Key_engraver::do_process_requests ()
+bool
+Key_engraver::try_music (Music * ev)
{
- if (keyreq_l_)
+ if (ev->is_mus_type ("key-change-event"))
{
- create_key ();
- }
+ /* do this only once, just to be on the safe side. */
+ if (!key_ev_)
+ {
+ key_ev_ = ev;
+ read_ev (key_ev_);
+ }
+ return true;
+ }
+ return false;
}
+
void
-Key_engraver::do_pre_move_processing ()
-{
- if (kit_p_)
+Key_engraver::acknowledge_grob (Grob_info info)
+{
+ if (Clef::has_interface (info.grob_))
{
- kit_p_->default_b_ = default_key_b_;
- typeset_element (kit_p_);
- kit_p_ = 0;
+ SCM c = get_property ("createKeyOnClefChange");
+ if (to_boolean (c))
+ {
+ create_key (false);
+ }
+ }
+ else if (Bar_line::has_interface (info.grob_)
+ && scm_is_pair (get_property ("keySignature")))
+ {
+ create_key (true);
}
}
-/*
- TODO Slightly hairy.
- */
void
-Key_engraver::read_req (Key_change_req const * r)
+Key_engraver::process_music ()
{
- old_accidental_idx_arr_ = accidental_idx_arr_;
- key_.clear ();
- Scalar prop = get_property ("keyoctaviation");
- if (prop.length_i () > 0)
- {
- key_.multi_octave_b_ = ! prop.to_bool ();
- }
-
- accidental_idx_arr_.clear ();
+ if (key_ev_ ||
+ get_property ("lastKeySignature") != get_property ("keySignature"))
+ create_key (false);
+}
- 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 ();
- if (r->minor_b ())
- p += 3;
- }
- /* 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;
- /* 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_);
+void
+Key_engraver::stop_translation_timestep ()
+{
+ item_ = 0;
+ context ()->set_property ("lastKeySignature", get_property ("keySignature"));
+ cancellation_ = 0;
+}
- 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
+
+void
+Key_engraver::read_ev (Music const * r)
+{
+ SCM p = r->get_property ("pitch-alist");
+ if (!scm_is_pair (p))
+ return;
+
+ SCM n = scm_list_copy (p);
+ SCM accs = SCM_EOL;
+ for (SCM s = get_property ("keyAccidentalOrder");
+ scm_is_pair (s); s = scm_cdr (s))
{
- for (int i = 0; i < r->pitch_arr_.size (); i ++)
+ if (scm_is_pair (scm_member (scm_car (s), n)))
{
- 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);
+ accs = scm_cons (scm_car (s), accs);
+ n = scm_delete_x (scm_car (s), n);
}
}
+
+ for (SCM s = n ; scm_is_pair (s); s = scm_cdr (s))
+ if (scm_to_int (scm_cdar (s)))
+ accs = scm_cons (scm_car (s), accs);
+
+ context ()->set_property ("keySignature", accs);
+ context ()->set_property ("tonic" ,
+ r->get_property ("tonic"));
}
+
void
-Key_engraver::do_post_move_processing ()
+Key_engraver::start_translation_timestep ()
{
- keyreq_l_ = 0;
- default_key_b_ = false;
- old_accidental_idx_arr_.clear ();
+ key_ev_ = 0;
}
-IMPLEMENT_IS_TYPE_B1 (Key_engraver,Engraver);
-ADD_THIS_TRANSLATOR (Key_engraver);
+void
+Key_engraver::initialize ()
+{
+ context ()->set_property ("keySignature", SCM_EOL);
+ context ()->set_property ("lastKeySignature", SCM_EOL);
+
+ Pitch p (0,0,0);
+ context ()->set_property ("tonic", p.smobbed_copy ());
+
+}
+
+ADD_TRANSLATOR (Key_engraver,
+/* descr */ "",
+/* creats*/ "KeySignature",
+/* accepts */ "key-change-event",
+/* acks */ "bar-line-interface clef-interface",
+/* reads */ "keySignature printKeyCancellation lastKeySignature explicitKeySignatureVisibility createKeyOnClefChange keyAccidentalOrder keySignature",
+/* write */ "lastKeySignature tonic keySignature");