source file of the GNU LilyPond music typesetter
- (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 "bar.hh"
-#include "timing-translator.hh"
+ (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
+*/
+
+#include "bar-line.hh"
+#include "clef.hh"
+#include "context.hh"
+#include "engraver.hh"
+#include "item.hh"
+#include "pitch.hh"
+#include "protected-scm.hh"
#include "staff-symbol-referencer.hh"
+#include "stream-event.hh"
+
+#include "translator.icc"
/*
- this is a large mess. Please clean this to use Basic properties and
- Scheme data structs.
- */
+ TODO: The representation of key sigs is all fucked.
+*/
-Key_engraver::Key_engraver ()
+/**
+ Make the key signature.
+*/
+class Key_engraver : public Engraver
+{
+ void create_key (bool);
+ void read_event (Stream_event const *r);
+
+ Stream_event *key_event_;
+ Item *item_;
+ Item *cancellation_;
+public:
+ TRANSLATOR_DECLARATIONS (Key_engraver);
+
+protected:
+ virtual void initialize ();
+ virtual void finalize ();
+ void stop_translation_timestep ();
+ void process_music ();
+
+ DECLARE_TRANSLATOR_LISTENER (key_change);
+ DECLARE_ACKNOWLEDGER (clef);
+ DECLARE_ACKNOWLEDGER (bar_line);
+};
+
+void
+Key_engraver::finalize ()
{
- item_p_ = 0;
- do_post_move_processing ();
}
-bool
-Key_engraver::key_changed_b () const
+Key_engraver::Key_engraver ()
{
- return keyreq_l_ ;
+ key_event_ = 0;
+ item_ = 0;
+ cancellation_ = 0;
}
void
-Key_engraver::create_key (bool def)
+Key_engraver::create_key (bool is_default)
{
- if (!item_p_)
+ if (!item_)
{
- item_p_ = new Key_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", new_accs_);
-
- Staff_symbol_referencer_interface st (item_p_);
- st.set_interface ();
-
- SCM prop = get_property ("keyOctaviation");
- bool multi = to_boolean (prop);
-
- if (multi)
- item_p_->set_elt_property ("multi-octave", gh_bool2scm (multi));
-
- announce_element (Score_element_info (item_p_,keyreq_l_));
- }
+ item_ = make_item ("KeySignature",
+ key_event_ ? key_event_->self_scm () : SCM_EOL);
- if (!def)
- item_p_->set_elt_property ("visibility-lambda",
- scm_eval (ly_symbol2scm ("all-visible")));
+ item_->set_property ("c0-position",
+ get_property ("middleCPosition"));
-}
+ SCM last = get_property ("lastKeySignature");
+ SCM key = get_property ("keySignature");
+ bool extranatural = to_boolean(get_property("extraNatural"));
+ if ((to_boolean (get_property ("printKeyCancellation"))
+ || key == SCM_EOL)
+ && !scm_is_eq (last, key))
+ {
+ SCM restore = SCM_EOL;
+ SCM *tail = &restore;
+ for (SCM s = last; scm_is_pair (s); s = scm_cdr (s))
+ {
+ SCM new_alter_pair = scm_assoc (scm_caar (s), key);
+ int old_alter = scm_to_int (scm_cdar (s));
+ if (new_alter_pair == SCM_BOOL_F
+ || extranatural
+ && (scm_to_int(scm_cdr(new_alter_pair))-old_alter)*old_alter < 0)
+ {
+ *tail = scm_cons (scm_car (s), *tail);
+ tail = SCM_CDRLOC (*tail);
+ }
+ }
-bool
-Key_engraver::do_try_music (Music * req_l)
-{
- if (Key_change_req *kc = dynamic_cast <Key_change_req *> (req_l))
+ if (scm_is_pair (restore))
+ {
+ cancellation_ = make_item ("KeyCancellation",
+ key_event_
+ ? key_event_->self_scm () : SCM_EOL);
+
+ cancellation_->set_property ("alteration-alist", restore);
+ cancellation_->set_property ("c0-position",
+ get_property ("middleCPosition"));
+ }
+ }
+ item_->set_property ("alteration-alist", key);
+ }
+
+ if (!is_default)
{
- if (keyreq_l_)
- warning (_ ("FIXME: key change merge"));
- keyreq_l_ = kc;
- read_req (keyreq_l_);
- return true;
- }
- return false;
+ SCM visibility = get_property ("explicitKeySignatureVisibility");
+ item_->set_property ("break-visibility", visibility);
+ if (cancellation_)
+ cancellation_->set_property ("break-visibility", visibility);
+ }
}
+IMPLEMENT_TRANSLATOR_LISTENER (Key_engraver, key_change);
void
-Key_engraver::acknowledge_element (Score_element_info info)
+Key_engraver::listen_key_change (Stream_event *ev)
{
- if (dynamic_cast <Clef_change_req *> (info.req_l_))
- {
- SCM c = get_property ("createKeyOnClefChange");
- if (to_boolean (c))
- {
- create_key (false);
-
- }
- }
- else if (dynamic_cast<Bar *> (info.elem_l_)
- && gh_pair_p (new_accs_))
- {
- create_key (true);
- }
+ /* do this only once, just to be on the safe side. */
+ if (ASSIGN_EVENT_ONCE (key_event_, ev))
+ read_event (key_event_);
+}
+void
+Key_engraver::acknowledge_clef (Grob_info info)
+{
+ (void)info;
+ SCM c = get_property ("createKeyOnClefChange");
+ if (to_boolean (c))
+ create_key (false);
}
void
-Key_engraver::do_process_music ()
+Key_engraver::acknowledge_bar_line (Grob_info info)
{
- if (keyreq_l_)
- {
- create_key (false);
- }
+ (void)info;
+ if (scm_is_pair (get_property ("keySignature")))
+ create_key (true);
}
void
-Key_engraver::do_pre_move_processing ()
-{
- if (item_p_)
- {
- typeset_element (item_p_);
- item_p_ = 0;
- }
+Key_engraver::process_music ()
+{
+ if (key_event_
+ || get_property ("lastKeySignature") != get_property ("keySignature"))
+ create_key (false);
}
+void
+Key_engraver::stop_translation_timestep ()
+{
+ item_ = 0;
+ context ()->set_property ("lastKeySignature", get_property ("keySignature"));
+ cancellation_ = 0;
+ key_event_ = 0;
+}
-/*
- TODO. Use properties; and this is too hairy.
- */
void
-Key_engraver::read_req (Key_change_req const * r)
+Key_engraver::read_event (Stream_event const *r)
{
- if (!r->key_)
+ SCM p = r->get_property ("pitch-alist");
+ if (!scm_is_pair (p))
return;
-
- key_.clear ();
- SCM prop = get_property ("keyOctaviation");
- bool multi = to_boolean (prop);
- SCM n = SCM_EOL;
-
- if (r->key_->ordinary_key_b_)
+ SCM n = scm_list_copy (p);
+ SCM accs = SCM_EOL;
+ for (SCM s = get_property ("keyAlterationOrder");
+ scm_is_pair (s); s = scm_cdr (s))
{
- int no_of_acc = r->key_->ordinary_accidentals_i ();
-
- // Hmm, can't these be handled/constructed by Key_change_req?
- if (no_of_acc < 0)
+ if (scm_is_pair (scm_member (scm_car (s), n)))
{
- 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 (multi)
- key_.set (m.octave_i_, m.notename_i_, m.accidental_i_);
- else
- key_.set (m.notename_i_, m.accidental_i_);
-
- SCM pair = gh_cons (gh_int2scm (m.notename_i_),
- gh_int2scm (m.accidental_i_));
- n = gh_cons (pair, n) ;
- 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 (multi)
- key_.set (m.octave_i_, m.notename_i_, m.accidental_i_);
- else
- key_.set (m.notename_i_, m.accidental_i_);
-
- SCM pair = gh_cons (gh_int2scm (m.notename_i_),
- gh_int2scm (m.accidental_i_));
- n = gh_cons (pair, n);
-
- accidental = (accidental + 4) % 7 ;
- }
- }
- }
- else // Special key
- {
- for (int i = 0; i < r->key_->pitch_arr_.size (); i ++)
- {
- Musical_pitch m_l =r->key_->pitch_arr_[i];
- if (multi)
- key_.set (m_l.octave_i_, m_l.notename_i_, m_l.accidental_i_);
- else
- key_.set (m_l.notename_i_, m_l.accidental_i_);
-
- SCM pair = gh_cons (gh_int2scm (m_l.notename_i_),
- gh_int2scm (m_l.accidental_i_));
- n = gh_cons (pair, n);
+ accs = scm_cons (scm_car (s), accs);
+ n = scm_delete_x (scm_car (s), n);
}
}
- old_accs_ = new_accs_;
- new_accs_ = 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::initialize ()
{
- keyreq_l_ = 0;
- old_accs_ = SCM_EOL;
-}
+ context ()->set_property ("keySignature", SCM_EOL);
+ context ()->set_property ("lastKeySignature", SCM_EOL);
-ADD_THIS_TRANSLATOR (Key_engraver);
+ Pitch p (0, 0, 0);
+ context ()->set_property ("tonic", p.smobbed_copy ());
+}
+ADD_ACKNOWLEDGER (Key_engraver, clef);
+ADD_ACKNOWLEDGER (Key_engraver, bar_line);
+
+ADD_TRANSLATOR (Key_engraver,
+ /* doc */ "",
+ /* create */ "KeySignature",
+
+ /* read */
+ "createKeyOnClefChange "
+ "explicitKeySignatureVisibility "
+ "extraNatural "
+ "keyAlterationOrder "
+ "keySignature "
+ "keySignature "
+ "lastKeySignature "
+ "printKeyCancellation "
+ ,
+
+ /* write */
+ "keySignature "
+ "lastKeySignature "
+ "tonic ")