/*
- key-engraver.cc -- implement Key_engraver
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
+ Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
- (c) 1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
- */
+ LilyPond is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
-#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"
+ LilyPond is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
-Key_engraver::Key_engraver ()
+ You should have received a copy of the GNU General Public License
+ along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#include "clef.hh"
+#include "context.hh"
+#include "engraver.hh"
+#include "international.hh"
+#include "item.hh"
+#include "pitch.hh"
+#include "protected-scm.hh"
+#include "staff-symbol-referencer.hh"
+#include "stream-event.hh"
+
+#include "translator.icc"
+
+class Key_engraver : public Engraver
{
- kit_p_ = 0;
- do_post_move_processing ();
-}
+ 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 ();
+
+ void listen_key_change (Stream_event *);
+ void acknowledge_clef (Grob_info);
+ void acknowledge_bar_line (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
- kit_p_->multi_octave_b_ = key_.multi_octave_b_;
- announce_element (Score_element_info (kit_p_,keyreq_l_));
-
-
- 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);
- }
-
- 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);
- }
- }
-}
-
+}
-bool
-Key_engraver::do_try_music (Music * req_l)
+Key_engraver::Key_engraver (Context *c)
+ : Engraver (c)
{
- 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;
+ key_event_ = 0;
+ item_ = 0;
+ cancellation_ = 0;
}
void
-Key_engraver::acknowledge_element (Score_element_info info)
+Key_engraver::create_key (bool is_default)
{
- if (dynamic_cast <Clef_change_req *> (info.req_l_))
+ if (!item_)
{
- int i= get_property ("createKeyOnClefChange", 0).length_i ();
- if (i)
- create_key ();
+ item_ = make_item ("KeySignature",
+ key_event_ ? key_event_->self_scm () : SCM_EOL);
+
+ /* Use middleCClefPosition rather than middleCPosition, because cue
+ * notes with a different clef will modify middleCPosition. The
+ * Key signature, however, should still be printed at the original
+ * position. */
+ item_->set_property ("c0-position",
+ get_property ("middleCClefPosition"));
+
+ SCM last = get_property ("lastKeyAlterations");
+ SCM key = get_property ("keyAlterations");
+
+ if ((to_boolean (get_property ("printKeyCancellation"))
+ || scm_is_null (key))
+ && !scm_is_eq (last, key))
+ {
+ SCM restore = SCM_EOL;
+ 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 = robust_scm2rational (scm_cdar (s), 0);
+ if (scm_is_false (new_alter_pair)
+ || ((ly_scm2rational (scm_cdr (new_alter_pair)) - old_alter) * old_alter
+ < Rational (0)))
+ {
+ restore = scm_cons (scm_car (s), restore);
+ }
+ }
+
+ 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 ("middleCClefPosition"));
+ }
+ }
+
+ item_->set_property ("alteration-alist", scm_reverse (key));
}
- else if (dynamic_cast<Bar *> (info.elem_l_)
- && accidental_idx_arr_.size ())
+
+ if (!is_default)
{
- if (!keyreq_l_)
- default_key_b_ = true;
- create_key ();
+ SCM visibility = get_property ("explicitKeySignatureVisibility");
+ item_->set_property ("break-visibility", visibility);
+ item_->set_property ("non-default", SCM_BOOL_T);
}
+}
+void
+Key_engraver::listen_key_change (Stream_event *ev)
+{
+ /* 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::do_process_requests ()
+Key_engraver::acknowledge_clef (Grob_info /* info */)
{
- if (keyreq_l_)
- {
- create_key ();
- }
+ SCM c = get_property ("createKeyOnClefChange");
+ if (to_boolean (c))
+ create_key (false);
}
void
-Key_engraver::do_pre_move_processing ()
-{
- if (kit_p_)
- {
- kit_p_->default_b_ = default_key_b_;
- typeset_element (kit_p_);
- kit_p_ = 0;
- }
+Key_engraver::acknowledge_bar_line (Grob_info /* info */)
+{
+ create_key (true);
}
+void
+Key_engraver::process_music ()
+{
+ if (key_event_
+ || !scm_is_eq (get_property ("lastKeyAlterations"),
+ get_property ("keyAlterations")))
+ create_key (false);
+}
-/*
- TODO Slightly hairy.
- */
void
-Key_engraver::read_req (Key_change_req const * r)
+Key_engraver::stop_translation_timestep ()
{
- old_accidental_idx_arr_ = accidental_idx_arr_;
- key_.clear ();
- Scalar prop = get_property ("keyoctaviation", 0);
- if (prop.length_i () > 0)
- {
- key_.multi_octave_b_ = ! prop.to_bool ();
- }
-
- accidental_idx_arr_.clear ();
+ item_ = 0;
+ context ()->set_property ("lastKeyAlterations", get_property ("keyAlterations"));
+ 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;
- if (r->ordinary_key_b_)
+ SCM accs = SCM_EOL;
+
+ 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))
{
- int p;
- if (r->pitch_arr_.size () < 1)
+ SCM head = scm_member (scm_car (s), alist);
+
+ if (scm_is_pair (head))
{
- 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;
-
- /* 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 ;
- }
- }
+ accs = scm_cons (scm_car (head), accs);
+ alist = scm_delete_x (scm_car (head), alist);
+ }
}
- else // Special key
+
+ if (scm_is_pair (alist))
{
- 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);
- }
+ 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 (_ ("Incomplete keyAlterationOrder for key signature"));
}
+
+ context ()->set_property ("keyAlterations", scm_reverse_x (accs, SCM_EOL));
+ context ()->set_property ("tonic",
+ r->get_property ("tonic"));
}
void
-Key_engraver::do_post_move_processing ()
+Key_engraver::initialize ()
{
- keyreq_l_ = 0;
- default_key_b_ = false;
- old_accidental_idx_arr_.clear ();
-}
+ context ()->set_property ("keyAlterations", SCM_EOL);
+ context ()->set_property ("lastKeyAlterations", SCM_EOL);
+ Pitch p;
+ context ()->set_property ("tonic", p.smobbed_copy ());
+}
-ADD_THIS_TRANSLATOR (Key_engraver);
+void
+Key_engraver::boot ()
+{
+ ADD_LISTENER (Key_engraver, key_change);
+ ADD_ACKNOWLEDGER (Key_engraver, clef);
+ ADD_ACKNOWLEDGER (Key_engraver, bar_line);
+}
+ADD_TRANSLATOR (Key_engraver,
+ /* doc */
+ "Engrave a key signature.",
+
+ /* create */
+ "KeyCancellation "
+ "KeySignature ",
+
+ /* read */
+ "createKeyOnClefChange "
+ "explicitKeySignatureVisibility "
+ "extraNatural "
+ "keyAlterationOrder "
+ "keyAlterations "
+ "lastKeyAlterations "
+ "printKeyCancellation "
+ "middleCClefPosition ",
+
+ /* write */
+ "keyAlterations "
+ "lastKeyAlterations "
+ "tonic "
+ );
projects / lilypond.git / blobdiff