]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/key-engraver.cc
release: 1.5.14
[lilypond.git] / lily / key-engraver.cc
index 250fb169eaeaecce877cfc764ffb14f290b5bfa8..445d1972656af812639fa4b9f9237191aa22811b 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c)  1997--2001 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 "item.hh"
 #include "bar.hh"
 #include "timing-translator.hh"
 #include "staff-symbol-referencer.hh"
-
-/*
-  this is a large mess. Please clean this to use Basic properties and
-  Scheme data structs.
+#include "translator-group.hh"
+#include "engraver.hh"
+#include "pitch.hh"
+#include "protected-scm.hh"
+#include "clef.hh"
+
+/**
+  Make the key signature.
  */
+class Key_engraver : public Engraver
+{
+  void create_key (bool);
+  void read_req (Key_change_req const * r);
+  Key_change_req * keyreq_l_;
+  Item * item_p_;
 
-Key_engraver::Key_engraver ()
+public:
+  TRANSLATOR_DECLARATIONS(Key_engraver);
+
+protected:
+  virtual void initialize ();
+  virtual void finalize ();
+  virtual bool try_music (Music *req_l);
+  virtual void stop_translation_timestep ();
+  virtual void start_translation_timestep ();
+  virtual void create_grobs ();
+  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_ ;
+  keyreq_l_ = 0;
+  item_p_ = 0;
 }
 
+
 void
 Key_engraver::create_key (bool def)
 {
   if (!item_p_) 
     {
-      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", SCM_EOL);
-      item_p_->set_elt_property ("new-accidentals", SCM_EOL);
+      item_p_ = new Item (get_property ("KeySignature"));
 
-      Staff_symbol_referencer_interface st (item_p_);
-      st.set_interface ();
-      
-      if (key_.multi_octave_b_)
-       item_p_->set_elt_property ("multi-octave", gh_bool2scm (key_.multi_octave_b_));
+      item_p_->set_grob_property ("c0-position",
+                                 get_property ("centralCPosition"));
       
-      announce_element (Score_element_info (item_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_)
-           item_p_->add (m_l.steps (), a);
-         else
-           item_p_->add (m_l.notename_i_, a);
-       }
+      // todo: put this in basic props.
+      item_p_->set_grob_property ("old-accidentals", get_property ("lastKeySignature"));
+      item_p_->set_grob_property ("new-accidentals", get_property ("keySignature"));
 
-      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_)
-           item_p_->add_old (m_l.steps  (), a);
-         else
-           item_p_->add_old (m_l.notename_i_, a);
-       }
+      Staff_symbol_referencer::set_interface (item_p_);
+      Key_item::set_interface (item_p_);
+      announce_grob (item_p_,keyreq_l_);
     }
 
-
   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_p_->set_grob_property ("visibility-lambda",vis);
+    }
 }      
 
 
 bool
-Key_engraver::do_try_music (Music * req_l)
+Key_engraver::try_music (Music * req_l)
 {
   if (Key_change_req *kc = dynamic_cast <Key_change_req *> (req_l))
     {
-      if (keyreq_l_)
-       warning (_ ("FIXME: key change merge"));
+      if (keyreq_l_ && !keyreq_l_->equal_b (kc))
+       {
+         kc->origin ()->warning (_ ("Conflicting key signatures found."));
+         keyreq_l_->origin ()->warning (_ ("This was the other key definition."));       
+         return false;
+       }
       keyreq_l_ = kc;
       read_req (keyreq_l_);
+
       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_l_))
     {
       SCM c =  get_property ("createKeyOnClefChange");
       if (to_boolean (c))
        {
          create_key (false);
-      
        }
     }
-  else if (dynamic_cast<Bar *> (info.elem_l_)
-          && accidental_idx_arr_.size ()) 
+  else if (Bar::has_interface (info.grob_l_)
+          && gh_pair_p (get_property ("keySignature")))
     {
       create_key (true);
     }
-
 }
 
+
 void
-Key_engraver::do_process_music ()
+Key_engraver::create_grobs ()
 {
-  if (keyreq_l_) 
-    {
-      create_key (false);
-    }
+  if (keyreq_l_ ||
+      get_property ("lastKeySignature") != get_property ("keySignature"))
+    create_key (false);
 }
 
+
 void
-Key_engraver::do_pre_move_processing ()
-{ 
+Key_engraver::stop_translation_timestep ()
+{
   if (item_p_) 
     {
-      typeset_element (item_p_);
+      typeset_grob (item_p_);
       item_p_ = 0;
     }
 }
 
 
-/*
-  TODO.  Use properties; and this is too hairy.
- */
 void
 Key_engraver::read_req (Key_change_req const * r)
 {
-  if (!r->key_)
+  SCM p = r->get_mus_property ("pitch-alist");
+  if (!gh_pair_p (p))
     return;
-  
-  old_accidental_idx_arr_ = accidental_idx_arr_;
-  key_.clear ();
-  SCM prop = get_property ("keyOctaviation");
-
-  key_.multi_octave_b_ = to_boolean (prop);
-  
-  accidental_idx_arr_.clear ();
-
-  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 (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
+  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 (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);
+         accs = gh_cons (ly_car (s), accs);
+         n = scm_delete_x (ly_car (s), 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_l_->set_property ("lastKeySignature",
+                               get_property ("keySignature"));
+  daddy_trans_l_->set_property ("keySignature", accs);
 }
 
+
 void
-Key_engraver::do_post_move_processing ()
+Key_engraver::start_translation_timestep ()
 {
   keyreq_l_ = 0;
-  old_accidental_idx_arr_.clear ();
+  daddy_trans_l_->set_property ("lastKeySignature", get_property ("keySignature"));
+}
+
+
+void
+Key_engraver::initialize ()
+{
+  daddy_trans_l_->set_property ("keySignature", SCM_EOL);
+  daddy_trans_l_->set_property ("lastKeySignature", SCM_EOL);
 }
 
-ADD_THIS_TRANSLATOR (Key_engraver);
 
+ENTER_DESCRIPTION(Key_engraver,
+/* descr */       "",
+/* creats*/       "KeySignature",
+/* acks  */       "bar-line-interface clef-interface",
+/* reads */       "keySignature lastKeySignature explicitKeySignatureVisibility createKeyOnClefChange keyAccidentalOrder keySignature",
+/* write */       "lastKeySignature");