/*
- 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--2000 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 "item.hh"
#include "bar.hh"
-#include "time-description.hh"
+#include "timing-translator.hh"
+#include "staff-symbol-referencer.hh"
+#include "translator-group.hh"
+#include "engraver.hh"
+#include "musical-pitch.hh"
+#include "protected-scm.hh"
+#include "clef.hh"
+
+/**
+ Make the key signature.
+ */
+class Key_engraver : public Engraver
+{
+ void create_key(bool);
+ void read_req (Key_change_req const * r);
+
+public:
+ Key_engraver();
+
+ VIRTUAL_COPY_CONS(Translator);
+
+ Key_change_req * keyreq_l_;
+ Item * item_p_;
+ Protected_scm old_accs_; // ugh. -> property
+
+protected:
+ virtual void do_creation_processing();
+ virtual void do_removal_processing ();
+ virtual bool do_try_music (Music *req_l);
+ virtual void do_process_music();
+ virtual void do_pre_move_processing();
+ virtual void do_post_move_processing();
+ virtual void acknowledge_element (Score_element_info);
+};
+
+
+void
+Key_engraver::do_removal_processing ()
+{
+ old_accs_ = SCM_EOL; // unprotect can not be called from dtor.
+}
Key_engraver::Key_engraver ()
{
- kit_p_ = 0;
- do_post_move_processing ();
+ keyreq_l_ = 0;
+ item_p_ = 0;
}
void
-Key_engraver::create_key ()
+Key_engraver::create_key (bool def)
{
- if (!kit_p_)
+ if (!item_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);
+ item_p_ = new Item ( get_property ("basicKeyProperties"));
+
+ item_p_->set_elt_property ("c0-position", gh_int2scm (0));
+
+ // todo: put this in basic props.
+ item_p_->set_elt_property ("old-accidentals", old_accs_);
+ item_p_->set_elt_property ("new-accidentals", get_property ("keySignature"));
+
+ Staff_symbol_referencer::set_interface (item_p_);
+ Key_item::set_interface (item_p_);
+
+ SCM prop = get_property ("keyOctaviation");
+ bool multi = to_boolean (prop);
+
+ if (multi)
+ item_p_->set_elt_property ("multi-octave", gh_bool2scm (multi));
+
+ announce_element (item_p_,keyreq_l_);
}
-}
+
+
+ if (!def)
+ {
+ SCM vis = get_property ("explicitKeySignatureVisibility");
+ if (gh_procedure_p (vis))
+ item_p_->set_elt_property ("visibility-lambda",vis);
+ }
+}
+
bool
-Key_engraver::do_try_request (Request * req_l)
+Key_engraver::do_try_music (Music * req_l)
{
- 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;
+ if (Key_change_req *kc = dynamic_cast <Key_change_req *> (req_l))
+ {
+ if (keyreq_l_)
+ warning (_ ("FIXME: key change merge"));
+ keyreq_l_ = kc;
+ read_req (keyreq_l_);
+ return true;
+ }
+ return false;
}
void
Key_engraver::acknowledge_element (Score_element_info info)
{
- Command_req * r_l = info.req_l_->access_Command_req () ;
- if (r_l && r_l->access_Clef_change_req ())
+ if (Clef::has_interface (info.elem_l_))
{
- create_key ();
+ SCM c = get_property ("createKeyOnClefChange");
+ if (to_boolean (c))
+ {
+ create_key (false);
+ }
}
- else if (info.elem_l_->is_type_b (Bar::static_name ())
- && accidental_idx_arr_.size ())
+ else if (Bar::has_interface (info.elem_l_)
+ && 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::do_process_music ()
{
- if (keyreq_l_)
+ if (keyreq_l_ || old_accs_ != get_property ("keySignature"))
{
- create_key ();
+ create_key (false);
}
}
void
Key_engraver::do_pre_move_processing ()
{
- if (kit_p_)
+ if (item_p_)
{
- kit_p_->default_b_ = default_key_b_;
- typeset_element (kit_p_);
- kit_p_ = 0;
+ typeset_element (item_p_);
+ item_p_ = 0;
}
}
-
-/*
- TODO Slightly hairy.
- */
void
Key_engraver::read_req (Key_change_req const * r)
{
- 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 (r->ordinary_key_b_)
+ SCM p = r->get_mus_property ("pitch-alist");
+ if (p == SCM_UNDEFINED)
+ return;
+
+ SCM n = scm_list_copy (p);
+ SCM accs = SCM_EOL;
+ for (SCM s = get_property ("keyAccidentalOrder");
+ gh_pair_p (s); s = gh_cdr (s))
{
- int p;
- if (r->pitch_arr_.size () < 1)
- {
- r->warning (_ ("No key name: assuming `C'"));
- p = 0;
- }
- else
+ if (gh_pair_p (scm_member (gh_car (s), n)))
{
- 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_);
-
- 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);
+ accs = gh_cons (gh_car (s), accs);
+ n = scm_delete_x (gh_car (s), n);
}
}
+ for (SCM s = n ; gh_pair_p (s); s = gh_cdr (s))
+ if (gh_scm2int (gh_cdar (s)))
+ accs = gh_cons (gh_car (s), accs);
+
+ old_accs_ = get_property ("keySignature");
+ daddy_trans_l_->set_property ("keySignature", accs);
}
void
Key_engraver::do_post_move_processing ()
{
keyreq_l_ = 0;
- default_key_b_ = false;
- old_accidental_idx_arr_.clear ();
+ old_accs_ = get_property ("keySignature");
+}
+
+void
+Key_engraver::do_creation_processing ()
+{
+ daddy_trans_l_->set_property ("keySignature", SCM_EOL);
+ old_accs_ = SCM_EOL;
}
-IMPLEMENT_IS_TYPE_B1 (Key_engraver,Engraver);
ADD_THIS_TRANSLATOR (Key_engraver);