source file of the GNU LilyPond music typesetter
- (c) 1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
- */
-
-#include "key-item.hh"
-#include "command-request.hh"
-#include "musical-request.hh"
-#include "local-key-item.hh"
-#include "bar.hh"
-#include "timing-translator.hh"
-#include "staff-symbol-referencer.hh"
-#include "translator-group.hh"
+ (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
+*/
+
+#include "bar-line.hh"
+#include "clef.hh"
+#include "context.hh"
#include "engraver.hh"
-#include "musical-pitch.hh"
+#include "item.hh"
+#include "pitch.hh"
#include "protected-scm.hh"
-#include "clef.hh"
+#include "staff-symbol-referencer.hh"
+#include "stream-event.hh"
+
+#include "translator.icc"
-/**
- Make the key signature.
- */
-class Key_engraver : public Engraver {
- void create_key(bool);
- void read_req (Key_change_req const * r);
+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:
- Key_engraver();
-
- VIRTUAL_COPY_CONS(Translator);
+ TRANSLATOR_DECLARATIONS (Key_engraver);
- Key_change_req * keyreq_l_;
- Item * item_p_;
- Protected_scm old_accs_; // ugh. -> property
-
protected:
- virtual void do_creation_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);
+ 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 ()
+{
+}
Key_engraver::Key_engraver ()
{
- keyreq_l_ = 0;
- item_p_ = 0;
+ key_event_ = 0;
+ item_ = 0;
+ cancellation_ = 0;
}
-void
-Key_engraver::create_key (bool def)
+
+SCM
+make_qt_key (SCM rat_key)
{
- if (!item_p_)
+ SCM qt_key = SCM_EOL;
+ SCM *tail = &qt_key;
+
+ for (SCM s = rat_key; scm_is_pair (s); s = scm_cdr (s))
{
- item_p_ = new Item ( get_property ("basicKeyProperties"));
+ *tail = scm_cons (scm_cons (scm_caar (s),
+ scm_from_int (Rational (4)* ly_scm2rational (scm_cdar (s)))),
+ SCM_EOL);
+ tail = SCM_CDRLOC (*tail);
+ }
- item_p_->set_elt_property ("c0-position", gh_int2scm (0));
+ return qt_key;
+}
- // 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"));
+void
+Key_engraver::create_key (bool is_default)
+{
+ if (!item_)
+ {
+ item_ = make_item ("KeySignature",
+ key_event_ ? key_event_->self_scm () : SCM_EOL);
- Staff_symbol_referencer::set_interface (item_p_);
+ item_->set_property ("c0-position",
+ get_property ("middleCPosition"));
- 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_));
- }
+ SCM last = get_property ("lastKeySignature");
+ SCM key = get_property ("keySignature");
+ bool extranatural = to_boolean(get_property("extraNatural"));
- if (!def)
- item_p_->set_elt_property ("visibility-lambda",
- scm_eval (ly_symbol2scm ("all-visible")));
+ 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);
+ Rational old_alter = ly_scm2rational (scm_cdar (s));
+ if (new_alter_pair == SCM_BOOL_F
+ || extranatural
+ && (ly_scm2rational (scm_cdr (new_alter_pair)) - old_alter)*old_alter < Rational (0))
+ {
+ *tail = scm_cons (scm_car (s), *tail);
+ tail = SCM_CDRLOC (*tail);
+ }
+ }
+
+ if (scm_is_pair (restore))
+ {
+ cancellation_ = make_item ("KeyCancellation",
+ key_event_
+ ? key_event_->self_scm () : SCM_EOL);
+
+ cancellation_->set_property ("alteration-alist", make_qt_key (restore));
+ cancellation_->set_property ("c0-position",
+ get_property ("middleCPosition"));
+ }
+ }
-}
+ item_->set_property ("alteration-alist", make_qt_key (key));
+ }
-bool
-Key_engraver::do_try_music (Music * req_l)
-{
- if (Key_change_req *kc = dynamic_cast <Key_change_req *> (req_l))
+ 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 (Clef::has_interface (info.elem_l_))
- {
- SCM c = get_property ("createKeyOnClefChange");
- if (to_boolean (c))
- {
- create_key (false);
- }
- }
- else if (Bar::has_interface (info.elem_l_)
- && gh_pair_p (get_property ("keySignature")))
- {
- 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_ || old_accs_ != get_property ("keySignature"))
- {
- 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::read_req (Key_change_req const * r)
+Key_engraver::stop_translation_timestep ()
{
- if (r->pitch_alist_ == SCM_UNDEFINED)
+ item_ = 0;
+ context ()->set_property ("lastKeySignature", get_property ("keySignature"));
+ cancellation_ = 0;
+ key_event_ = 0;
+}
+
+void
+Key_engraver::read_event (Stream_event const *r)
+{
+ SCM p = r->get_property ("pitch-alist");
+ if (!scm_is_pair (p))
return;
- SCM n = scm_list_copy (r->pitch_alist_);
SCM accs = SCM_EOL;
- for (SCM s = get_property ("keyAccidentalOrder");
- gh_pair_p (s); s = gh_cdr (s))
+
+ SCM alist = scm_list_copy (p);
+ SCM order = get_property ("keyAlterationOrder");
+ for (SCM s = order;
+ scm_is_pair (s) && scm_is_pair (alist); s = scm_cdr (s))
{
- if (gh_pair_p (scm_member (gh_car (s), n)))
+ SCM head = scm_member (scm_car (s), alist);
+
+ if (scm_is_pair (head))
{
- accs = gh_cons (gh_car (s), accs);
- n = scm_delete_x (gh_car (s), n);
+ accs = scm_cons (scm_car (head), accs);
+ alist = scm_delete_x (scm_car (head), alist);
}
}
- 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);
+ if (scm_is_pair (alist))
+ {
+ bool warn = false;
+ for (SCM s = alist; scm_is_pair (s); s = scm_cdr (s))
+ if (ly_scm2rational (scm_cdar (s)))
+ {
+ warn = true;
+ accs = scm_cons (scm_car (s), accs);
+ }
+
+ if (warn)
+ r->origin ()->warning ("No ordering for key signature alterations");
+ }
+
+ 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_ = get_property ("keySignature");
-}
+ context ()->set_property ("keySignature", SCM_EOL);
+ context ()->set_property ("lastKeySignature", SCM_EOL);
-void
-Key_engraver::do_creation_processing ()
-{
- daddy_trans_l_->set_property ("keySignature", SCM_EOL);
- old_accs_ = SCM_EOL;
+ Pitch p (0, 0, 0);
+ context ()->set_property ("tonic", p.smobbed_copy ());
}
-
-ADD_THIS_TRANSLATOR (Key_engraver);
-
+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 ")