]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/key-engraver.cc
Fix some bugs in the dynamic engraver and PostScript backend
[lilypond.git] / lily / key-engraver.cc
index 85419c2a1901bd7aa2217fae55f1bcbcbd60e389..b0a87988a4809908419b5d4906a555cc5aa7ce53 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-  */
-// clean me up 
-#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"
+  (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
+*/
+
+#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"
 
-Key_engraver::Key_engraver ()
+#include "translator.icc"
+
+/*
+  TODO: The representation  of key sigs is all fucked.
+*/
+
+/**
+   Make the key signature.
+*/
+class Key_engraver : public Engraver
+{
+  void create_key (bool);
+  void read_event (Music const *r);
+
+  Music *key_event_;
+  Item *item_;
+  Item *cancellation_;
+public:
+  TRANSLATOR_DECLARATIONS (Key_engraver);
+
+protected:
+  virtual void initialize ();
+  virtual void finalize ();
+  virtual bool try_music (Music *event);
+  void stop_translation_timestep ();
+  void process_music ();
+
+  DECLARE_ACKNOWLEDGER (clef);
+  DECLARE_ACKNOWLEDGER (bar_line);
+};
+
+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_event_ = 0;
+  item_ = 0;
+  cancellation_ = 0;
 }
 
 void
-Key_engraver::create_key (bool def)
+Key_engraver::create_key (bool is_default)
 {
-  if (!item_p_) 
+  if (!item_)
     {
-      item_p_ = new Key_item;
-      item_p_->property_alist_ = get_property ("basicKeyProperties");
-
-      
-      item_p_->set_elt_property ("c0-position", gh_int2scm (0));
-      item_p_->set_elt_property ("old-accidentals", SCM_EOL);
-      item_p_->set_elt_property ("new-accidentals", SCM_EOL);
-
-      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_));
-      
-      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);
-       }
-
-      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);
-       }
-    }
+      item_ = make_item ("KeySignature",
+                        key_event_ ? key_event_->self_scm () : SCM_EOL);
 
+      item_->set_property ("c0-position",
+                          get_property ("middleCPosition"));
 
-  if (!def)
-    item_p_->set_elt_property ("visibility-lambda",
-                              scm_eval (ly_symbol2scm  ("all-visible")));
+      SCM last = get_property ("lastKeySignature");
+      SCM key = get_property ("keySignature");
 
-}      
+      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))
+           {
+             if (scm_assoc (scm_caar (s), key) == SCM_BOOL_F)
+               {
+                 *tail = scm_acons (scm_caar (s),
+                                    scm_from_int (0), *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", restore);
+             cancellation_->set_property ("c0-position",
+                                          get_property ("middleCPosition"));
+           }
+       }
+      item_->set_property ("alteration-alist", 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);
+    }
 }
 
-void
-Key_engraver::acknowledge_element (Score_element_info info)
+bool
+Key_engraver::try_music (Music *event)
 {
-  if (dynamic_cast <Clef_change_req *> (info.req_l_)) 
+  if (event->is_mus_type ("key-change-event"))
     {
-      SCM c =  get_property ("createKeyOnClefChange");
-      if (to_boolean (c))
+      /* do this only once, just to be on the safe side.  */
+      if (!key_event_)
        {
-         create_key (false);
-      
+         key_event_ = event;
+         read_event (key_event_);
        }
+      return true;
     }
-  else if (dynamic_cast<Bar *> (info.elem_l_)
-          && accidental_idx_arr_.size ()) 
-    {
-      create_key (true);
-    }
+  return false;
+}
 
+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_) 
-    {
-      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::stop_translation_timestep ()
+{
+  item_ = 0;
+  context ()->set_property ("lastKeySignature", get_property ("keySignature"));
+  cancellation_ = 0;
+  key_event_ = 0;
+}
 
-/*
-  TODO.  Use properties; and this is too hairy.
- */
 void
-Key_engraver::read_req (Key_change_req const * r)
+Key_engraver::read_event (Music const *r)
 {
-  if (!r->key_)
+  SCM p = r->get_property ("pitch-alist");
+  if (!scm_is_pair (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_) 
+  SCM n = scm_list_copy (p);
+  SCM accs = SCM_EOL;
+  for (SCM s = get_property ("keyAlterationOrder");
+       scm_is_pair (s); s = scm_cdr (s))
     {
-      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) 
+      if (scm_is_pair (scm_member (scm_car (s), n)))
        {
-         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->key_->pitch_arr_.size (); i ++) 
-       {
-         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 = scm_cons (scm_car (s), accs);
+         n = scm_delete_x (scm_car (s), n);
        }
     }
+
+  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);
+
+  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_accidental_idx_arr_.clear ();
-}
+  context ()->set_property ("keySignature", SCM_EOL);
+  context ()->set_property ("lastKeySignature", SCM_EOL);
 
-ADD_THIS_TRANSLATOR (Key_engraver);
+  Pitch p (0, 0, 0);
+  context ()->set_property ("tonic", p.smobbed_copy ());
+}
 
+ADD_ACKNOWLEDGER (Key_engraver, clef);
+ADD_ACKNOWLEDGER (Key_engraver, bar_line);
+
+ADD_TRANSLATOR (Key_engraver,
+               /* doc */ "",
+               /* create */ "KeySignature",
+               /* accept */ "key-change-event",
+               
+               /* read */
+               "createKeyOnClefChange "
+               "explicitKeySignatureVisibility "
+               "keyAlterationOrder "
+               "keySignature "
+               "keySignature "
+               "lastKeySignature "
+               "printKeyCancellation "
+               ,
+               
+               /* write */
+               "keySignature "
+               "lastKeySignature "
+               "tonic ")