]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/key-engraver.cc
* lily/include/translator.hh (class Translator): remove
[lilypond.git] / lily / key-engraver.cc
index e2152e224545fcd89d368dbc6397e044c925d1da..450b2c50e505fd60f8a45e0ed610fd39ec72974b 100644 (file)
 /*
-  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--2005 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"
+#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"
+#include "pitch.hh"
+
+/*
+  TODO: The representation  of key sigs is all fucked.
+*/
+
+/**
+   Make the key signature.
+*/
+class Key_engraver : public Engraver
+{
+  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);
+  void stop_translation_timestep ();
+  void process_music ();
+
+  DECLARE_ACKNOWLEDGER(clef);
+  DECLARE_ACKNOWLEDGER(bar_line);
+  
+};
+
+void
+Key_engraver::finalize ()
+{
+}
 
 Key_engraver::Key_engraver ()
 {
-  kit_p_ = 0;
-  do_post_move_processing ();
+  key_ev_ = 0;
+  item_ = 0;
+  cancellation_ = 0;
 }
 
 void
-Key_engraver::create_key ()
+Key_engraver::create_key (bool def)
 {
-  if (!kit_p_) 
+  if (!item_)
     {
-      kit_p_ = new Key_item;
-      kit_p_->break_priority_i_ = -1; // ugh
-      announce_element (Score_element_info (kit_p_,keyreq_l_));
-      kit_p_->set (key_.multi_octave_b_, accidental_idx_arr_, old_accidental_idx_arr_);
+      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);
+    }
+
+  if (!def)
+    {
+      SCM vis = get_property ("explicitKeySignatureVisibility");
+      if (ly_is_procedure (vis))
+       item_->set_property ("break-visibility", vis);
     }
 }
 
 bool
-Key_engraver::do_try_request (Request * req_l)
+Key_engraver::try_music (Music *ev)
 {
-  if (Key_change_req *kc = dynamic_cast <Key_change_req *> (req_l))
+  if (ev->is_mus_type ("key-change-event"))
     {
-      if (keyreq_l_)
-       warning ("Fixme: key change merge.");
-      keyreq_l_ = kc;
-      read_req (keyreq_l_);
+      /* 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;
+    }
+  return false;
 }
 
 void
-Key_engraver::acknowledge_element (Score_element_info info)
+Key_engraver::acknowledge_clef (Grob_info info)
 {
-  if (dynamic_cast <Clef_change_req *> (info.req_l_)) 
-    {
-      int i= get_property ("createKeyOnClefChange").length_i ();
-      if (i)
-       create_key ();
-    }
-  else if (dynamic_cast<Bar *> (info.elem_l_)
-          && accidental_idx_arr_.size ()) 
+  (void)info;
+  SCM c = get_property ("createKeyOnClefChange");
+  if (to_boolean (c))
     {
-      if (!keyreq_l_)
-       default_key_b_ = true;
-      create_key ();
+      create_key (false);
     }
-
 }
 
 void
-Key_engraver::do_process_requests ()
+Key_engraver::acknowledge_bar_line (Grob_info info)
 {
-  if (keyreq_l_) 
+  (void)info;
+  if (scm_is_pair (get_property ("keySignature")))
     {
-      create_key ();
+      create_key (true);
     }
 }
 
 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::process_music ()
+{
+  if (key_ev_
+      || get_property ("lastKeySignature") != get_property ("keySignature"))
+    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");
-  if (prop.length_i () > 0)
-    {
-      key_.multi_octave_b_ = ! prop.to_bool ();
-    }
-  
-  accidental_idx_arr_.clear ();
+  item_ = 0;
+  context ()->set_property ("lastKeySignature", get_property ("keySignature"));
+  cancellation_ = 0;
+  key_ev_ = 0;
+}
 
-  if (r->ordinary_key_b_) 
+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))
     {
-      int p;
-      if (r->pitch_arr_.size () < 1) 
-        {
-         r->warning (_ ("No key name: assuming `C'"));
-         p = 0;
-       }
-      else
+      if (scm_is_pair (scm_member (scm_car (s), n)))
        {
-         p = r->pitch_arr_[0].semitone_pitch ();
-         p += r->modality_i_;
+         accs = scm_cons (scm_car (s), accs);
+         n = scm_delete_x (scm_car (s), n);
        }
-      /* 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_);
+  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);
 
-      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);
-       }
-    }
+  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;
-  default_key_b_ = false;
-  old_accidental_idx_arr_.clear ();
-}
+  context ()->set_property ("keySignature", SCM_EOL);
+  context ()->set_property ("lastKeySignature", SCM_EOL);
 
+  Pitch p (0, 0, 0);
+  context ()->set_property ("tonic", p.smobbed_copy ());
+}
 
-IMPLEMENT_IS_TYPE_B1 (Key_engraver,Engraver);
-ADD_THIS_TRANSLATOR (Key_engraver);
+#include "translator.icc"
 
+ADD_ACKNOWLEDGER(Key_engraver,clef);
+ADD_ACKNOWLEDGER(Key_engraver,bar_line);
+ADD_TRANSLATOR (Key_engraver,
+               /* descr */ "",
+               /* creats*/ "KeySignature",
+               /* accepts */ "key-change-event",
+               /* reads */ "keySignature printKeyCancellation lastKeySignature explicitKeySignatureVisibility createKeyOnClefChange keyAccidentalOrder keySignature",
+               /* write */ "lastKeySignature tonic keySignature");