]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/key-engraver.cc
2003 -> 2004
[lilypond.git] / lily / key-engraver.cc
index da00f7204069ef2ddb13373df76d2700f3503029..061e1544779e093ea184afc9f024fd28b60896f3 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2004 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"
+
+
+#include "event.hh"
+#include "item.hh"
+#include "bar-line.hh"
 #include "staff-symbol-referencer.hh"
+#include "translator-group.hh"
+#include "engraver.hh"
+#include "pitch.hh"
+#include "protected-scm.hh"
+#include "clef.hh"
 
 /*
-  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_ev (Key_change_ev const * r);
+  Key_change_ev * key_ev_;
+  Item * item_;
+
+public:
+  TRANSLATOR_DECLARATIONS(Key_engraver);
+
+protected:
+  virtual void initialize ();
+  virtual void finalize ();
+  virtual bool try_music (Music *ev);
+  virtual void stop_translation_timestep ();
+  virtual void start_translation_timestep ();
+  virtual void process_music ();
+  virtual void acknowledge_grob (Grob_info);
+};
+
+
+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_ev_ = 0;
+  item_ = 0;
 }
 
+
 void
 Key_engraver::create_key (bool def)
 {
-  if (!item_p_
+  if (!item_) 
     {
-      item_p_ = new Key_item ( get_property ("basicKeyProperties"));
-      
-      item_p_->set_elt_property ("c0-position", gh_int2scm (0));
+      item_ = make_item ("KeySignature");
 
+      item_->set_grob_property ("c0-position",
+                               get_property ("centralCPosition"));
+      
       // todo: put this in basic props.
-      item_p_->set_elt_property ("old-accidentals", old_accs_);
-      item_p_->set_elt_property ("new-accidentals", new_accs_);
+      item_->set_grob_property ("old-accidentals", get_property ("lastKeySignature"));
+      item_->set_grob_property ("new-accidentals", get_property ("keySignature"));
 
-      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_));
+      announce_grob(item_, key_ev_ ? key_ev_->self_scm() : SCM_EOL);
     }
 
   if (!def)
-    item_p_->set_elt_property ("visibility-lambda",
-                              scm_eval (ly_symbol2scm  ("all-visible")));
-
+    {
+      SCM vis = get_property ("explicitKeySignatureVisibility"); 
+      if (gh_procedure_p (vis))
+       item_->set_grob_property ("break-visibility",vis);
+    }
 }      
 
 
 bool
-Key_engraver::do_try_music (Music * req_l)
+Key_engraver::try_music (Music * ev)
 {
-  if (Key_change_req *kc = dynamic_cast <Key_change_req *> (req_l))
+  //  if (Key_change_ev *kc = dynamic_cast <Key_change_ev *> (ev))
+  if (ev->is_mus_type ("key-change-event"))
     {
-      if (keyreq_l_)
-       warning (_ ("FIXME: key change merge"));
-      keyreq_l_ = kc;
-      read_req (keyreq_l_);
+      if (!key_ev_)
+       {
+         /*
+           do this only once, just to be on the safe side.
+           */      
+         key_ev_ = dynamic_cast<Key_change_ev*> (ev); // UGH.
+         read_ev (key_ev_);
+       }
+      
       return true;
     }   
   return  false;
 }
 
+
 void
-Key_engraver::acknowledge_element (Score_element_info info)
+Key_engraver::acknowledge_grob (Grob_info info)
 {
-  if (dynamic_cast <Clef_change_req *> (info.req_l_)) 
+  if (Clef::has_interface (info.grob_))
     {
       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_))
+  else if (Bar_line::has_interface (info.grob_)
+          && gh_pair_p (get_property ("keySignature")))
     {
       create_key (true);
     }
-
 }
 
+
 void
-Key_engraver::do_process_music ()
+Key_engraver::process_music ()
 {
-  if (keyreq_l_) 
-    {
-      create_key (false);
-    }
+  if (key_ev_ ||
+      get_property ("lastKeySignature") != get_property ("keySignature"))
+    create_key (false);
 }
 
+
 void
-Key_engraver::do_pre_move_processing ()
-{ 
-  if (item_p_
+Key_engraver::stop_translation_timestep ()
+{
+  if (item_) 
     {
-      typeset_element (item_p_);
-      item_p_ = 0;
+      typeset_grob (item_);
+      item_ = 0;
     }
 }
 
 
-/*
-  TODO.  Use properties; and this is too hairy.
- */
 void
-Key_engraver::read_req (Key_change_req const * r)
+Key_engraver::read_ev (Key_change_ev const * r)
 {
-  if (!r->key_)
+  SCM p = r->get_mus_property ("pitch-alist");
+  if (!gh_pair_p (p))
     return;
-  
-  key_.clear ();
-  SCM prop = get_property ("keyOctaviation");
-  bool multi = to_boolean (prop);
-
-  SCM n = SCM_EOL;
 
-  if (r->key_->ordinary_key_b_) 
-    {
-      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) 
-       {
-         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
+  SCM n = scm_list_copy (p);
+  SCM accs = SCM_EOL;
+  for (SCM s = get_property ("keyAccidentalOrder");
+       gh_pair_p (s); s = ly_cdr (s))
     {
-      for (int i = 0; i < r->key_->pitch_arr_.size (); i ++) 
+      if (gh_pair_p (scm_member (ly_car (s), n)))
        {
-         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 = gh_cons (ly_car (s), accs);
+         n = scm_delete_x (ly_car (s), n);
        }
     }
-
-  old_accs_ = new_accs_;
-  new_accs_ = n;
   
+  for (SCM s = n ; gh_pair_p (s); s = ly_cdr (s))
+    if (gh_scm2int (ly_cdar (s)))
+      accs = gh_cons (ly_car (s), accs);
+
+  daddy_trans_->set_property ("keySignature", accs);
+  daddy_trans_->set_property ("tonic" ,
+                             r->get_mus_property ("tonic"));
 }
 
+
 void
-Key_engraver::do_post_move_processing ()
+Key_engraver::start_translation_timestep ()
 {
-  keyreq_l_ = 0;
-  old_accs_ = SCM_EOL;
+  key_ev_ = 0;
+  daddy_trans_->set_property ("lastKeySignature", get_property ("keySignature"));
+}
+
+
+void
+Key_engraver::initialize ()
+{
+  daddy_trans_->set_property ("keySignature", SCM_EOL);
+  daddy_trans_->set_property ("lastKeySignature", SCM_EOL);
+
+  Pitch p(0,0,0);
+  daddy_trans_->set_property ("tonic", p.smobbed_copy ());
+
 }
 
-ADD_THIS_TRANSLATOR (Key_engraver);
 
+ENTER_DESCRIPTION(Key_engraver,
+/* descr */       "",
+/* creats*/       "KeySignature",
+/* accepts */     "key-change-event",
+/* acks  */      "bar-line-interface clef-interface",
+/* reads */       "keySignature lastKeySignature explicitKeySignatureVisibility createKeyOnClefChange keyAccidentalOrder keySignature",
+/* write */       "lastKeySignature tonic keySignature");