]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/key-engraver.cc
Merge branch 'master' of git://git.sv.gnu.org/lilypond
[lilypond.git] / lily / key-engraver.cc
index d0345c0040b81e16e98cdf6e79cadb1ffbbcb466..8bd0d1305fc89936907e4246b6a9c3b5878ec4db 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-  */
+  (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
+*/
 
-
-#include "command-request.hh"
-#include "musical-request.hh"
-#include "item.hh"
 #include "bar-line.hh"
-#include "staff-symbol-referencer.hh"
-#include "translator-group.hh"
+#include "clef.hh"
+#include "context.hh"
 #include "engraver.hh"
+#include "item.hh"
 #include "pitch.hh"
 #include "protected-scm.hh"
-#include "clef.hh"
+#include "staff-symbol-referencer.hh"
+#include "stream-event.hh"
+
+#include "translator.icc"
 
-/**
-  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_;
+  void read_event (Stream_event const *r);
 
+  Stream_event *key_event_;
+  Item *item_;
+  Item *cancellation_;
 public:
-  TRANSLATOR_DECLARATIONS(Key_engraver);
+  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 stop_translation_timestep ();
+  void process_music ();
 
+  DECLARE_TRANSLATOR_LISTENER (key_change);
+  DECLARE_ACKNOWLEDGER (clef);
+  DECLARE_ACKNOWLEDGER (bar_line);
+};
 
 void
 Key_engraver::finalize ()
 {
 }
 
-
 Key_engraver::Key_engraver ()
 {
-  keyreq_l_ = 0;
-  item_p_ = 0;
+  key_event_ = 0;
+  item_ = 0;
+  cancellation_ = 0;
 }
 
 
-void
-Key_engraver::create_key (bool def)
+SCM
+make_qt_key (SCM rat_key)
 {
-  if (!item_p_) 
-    {
-      item_p_ = new Item (get_property ("KeySignature"));
-
-      item_p_->set_grob_property ("c0-position",
-                                 get_property ("centralCPosition"));
+  SCM qt_key = SCM_EOL;
+  SCM *tail = &qt_key;
       
-      // 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"));
-
-      announce_grob(item_p_, keyreq_l_ ? keyreq_l_->self_scm() : SCM_EOL);
-    }
-
-  if (!def)
+  for (SCM s = rat_key; scm_is_pair (s); s = scm_cdr (s))
     {
-      SCM vis = get_property ("explicitKeySignatureVisibility"); 
-      if (gh_procedure_p (vis))
-       item_p_->set_grob_property ("visibility-lambda",vis);
+      *tail = scm_cons (scm_cons (scm_caar (s),
+                                 scm_from_int (Rational (4)* ly_scm2rational (scm_cdar (s)))),
+                       SCM_EOL);
+      tail =  SCM_CDRLOC (*tail);
     }
-}      
 
+  return qt_key;
+}
 
-bool
-Key_engraver::try_music (Music * req_l)
+void
+Key_engraver::create_key (bool is_default)
 {
-  if (Key_change_req *kc = dynamic_cast <Key_change_req *> (req_l))
+  if (!item_)
     {
-      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_);
+      item_ = make_item ("KeySignature",
+                        key_event_ ? key_event_->self_scm () : SCM_EOL);
 
-      return true;
-    }   
-  return  false;
-}
+      item_->set_property ("c0-position",
+                          get_property ("middleCPosition"));
 
+      SCM last = get_property ("lastKeySignature");
+      SCM key = get_property ("keySignature");
+      bool extranatural = to_boolean(get_property("extraNatural"));
 
-void
-Key_engraver::acknowledge_grob (Grob_info info)
-{
-  if (Clef::has_interface (info.grob_l_))
-    {
-      SCM c =  get_property ("createKeyOnClefChange");
-      if (to_boolean (c))
+      if ((to_boolean (get_property ("printKeyCancellation"))
+          || key == SCM_EOL)
+         && !scm_is_eq (last, key))
        {
-         create_key (false);
+         SCM restore = SCM_EOL;
+         SCM *tail = &restore;
+         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 = ly_scm2rational (scm_cdar (s));
+             if (new_alter_pair == SCM_BOOL_F
+                 || extranatural
+                 && (ly_scm2rational (scm_cdr (new_alter_pair)) - old_alter)*old_alter < Rational (0))
+               {
+                 *tail = scm_cons (scm_car (s), *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", make_qt_key (restore));
+             cancellation_->set_property ("c0-position",
+                                          get_property ("middleCPosition"));
+           }
        }
+
+
+      item_->set_property ("alteration-alist", make_qt_key (key));
     }
-  else if (Bar_line::has_interface (info.grob_l_)
-          && gh_pair_p (get_property ("keySignature")))
+
+  if (!is_default)
     {
-      create_key (true);
+      SCM visibility = get_property ("explicitKeySignatureVisibility");
+      item_->set_property ("break-visibility", visibility);
+      if (cancellation_)
+       cancellation_->set_property ("break-visibility", visibility);
     }
 }
 
+IMPLEMENT_TRANSLATOR_LISTENER (Key_engraver, key_change);
+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::create_grobs ()
+Key_engraver::acknowledge_clef (Grob_info info)
 {
-  if (keyreq_l_ ||
-      get_property ("lastKeySignature") != get_property ("keySignature"))
+  (void)info;
+  SCM c = get_property ("createKeyOnClefChange");
+  if (to_boolean (c))
     create_key (false);
 }
 
+void
+Key_engraver::acknowledge_bar_line (Grob_info info)
+{
+  (void)info;
+  if (scm_is_pair (get_property ("keySignature")))
+    create_key (true);
+}
 
 void
-Key_engraver::stop_translation_timestep ()
+Key_engraver::process_music ()
 {
-  if (item_p_) 
-    {
-      typeset_grob (item_p_);
-      item_p_ = 0;
-    }
+  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;
+}
 
 void
-Key_engraver::read_req (Key_change_req const * r)
+Key_engraver::read_event (Stream_event const *r)
 {
-  SCM p = r->get_mus_property ("pitch-alist");
-  if (!gh_pair_p (p))
+  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");
-       gh_pair_p (s); s = ly_cdr (s))
+
+  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))
     {
-      if (gh_pair_p (scm_member (ly_car (s), n)))
+      SCM head = scm_member (scm_car (s), alist);
+      
+      if (scm_is_pair (head))
        {
-         accs = gh_cons (ly_car (s), accs);
-         n = scm_delete_x (ly_car (s), n);
+         accs = scm_cons (scm_car (head), accs);
+         alist = scm_delete_x (scm_car (head), alist);
        }
     }
-  
-  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::start_translation_timestep ()
-{
-  keyreq_l_ = 0;
-  daddy_trans_l_->set_property ("lastKeySignature", get_property ("keySignature"));
+  if (scm_is_pair (alist))
+    {
+      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 ("No ordering for key signature alterations");      
+    }
+  
+  context ()->set_property ("keySignature", accs);
+  context ()->set_property ("tonic",
+                           r->get_property ("tonic"));
 }
 
-
 void
 Key_engraver::initialize ()
 {
-  daddy_trans_l_->set_property ("keySignature", SCM_EOL);
-  daddy_trans_l_->set_property ("lastKeySignature", SCM_EOL);
-}
+  context ()->set_property ("keySignature", SCM_EOL);
+  context ()->set_property ("lastKeySignature", SCM_EOL);
 
+  Pitch p (0, 0, 0);
+  context ()->set_property ("tonic", p.smobbed_copy ());
+}
 
-ENTER_DESCRIPTION(Key_engraver,
-/* descr */       "",
-/* creats*/       "KeySignature",
-/* acks  */       "bar-line-interface clef-interface",
-/* reads */       "keySignature lastKeySignature explicitKeySignatureVisibility createKeyOnClefChange keyAccidentalOrder keySignature",
-/* write */       "lastKeySignature");
+ADD_ACKNOWLEDGER (Key_engraver, clef);
+ADD_ACKNOWLEDGER (Key_engraver, bar_line);
+
+ADD_TRANSLATOR (Key_engraver,
+               /* doc */ "",
+               /* create */ "KeySignature",
+               
+               /* read */
+               "createKeyOnClefChange "
+               "explicitKeySignatureVisibility "
+               "extraNatural "
+               "keyAlterationOrder "
+               "keySignature "
+               "keySignature "
+               "lastKeySignature "
+               "printKeyCancellation "
+               ,
+               
+               /* write */
+               "keySignature "
+               "lastKeySignature "
+               "tonic ")