]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/key-engraver.cc
Run `make grand-replace'.
[lilypond.git] / lily / key-engraver.cc
index fdb59dc4927c061a9d6cc7a867fdfb49018076be..7997d11c33adb98e655d189691f211afd9714d0d 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-  */
+  (c) 1997--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
+*/
 
-
-
-#include "event.hh"
-#include "item.hh"
 #include "bar-line.hh"
-#include "staff-symbol-referencer.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"
 
-/*
-  TODO: The representation  of key sigs is all fucked.
- */
+#include "translator.icc"
 
-/**
-  Make the key signature.
- */
 class Key_engraver : public Engraver
 {
   void create_key (bool);
-  void read_ev (Music const * r);
-  Music * key_ev_;
-  Item * item_;
+  void read_event (Stream_event const *r);
 
+  Stream_event *key_event_;
+  Item *item_;
+  Item *cancellation_;
 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 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 ()
 {
-  key_ev_ = 0;
+  key_event_ = 0;
   item_ = 0;
+  cancellation_ = 0;
 }
 
 
 void
-Key_engraver::create_key (bool def)
+Key_engraver::create_key (bool is_default)
 {
-  if (!item_) 
+  if (!item_)
     {
-      item_ = make_item ("KeySignature", key_ev_ ? key_ev_->self_scm () : SCM_EOL);
+      item_ = make_item ("KeySignature",
+                        key_event_ ? key_event_->self_scm () : SCM_EOL);
 
       item_->set_property ("c0-position",
                           get_property ("middleCPosition"));
-      
-      if (to_boolean (get_property ("printKeyCancellation")))
-       item_->set_property ("old-accidentals", get_property ("lastKeySignature"));
-      item_->set_property ("new-accidentals", get_property ("keySignature"));
 
+      SCM last = get_property ("lastKeySignature");
+      SCM key = get_property ("keySignature");
+      bool extranatural = to_boolean (get_property ("extraNatural"));
+
+      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))
+           {
+             SCM new_alter_pair = scm_assoc (scm_caar (s), key);
+             Rational old_alter = robust_scm2rational (scm_cdar (s), 0);
+             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", restore);
+             cancellation_->set_property ("c0-position",
+                                          get_property ("middleCPosition"));
+           }
+       }
+
+      item_->set_property ("alteration-alist", key);
     }
 
-  if (!def)
+  if (!is_default)
     {
-      SCM vis = get_property ("explicitKeySignatureVisibility"); 
-      if (ly_c_procedure_p (vis))
-       item_->set_property ("break-visibility",vis);
+      SCM visibility = get_property ("explicitKeySignatureVisibility");
+      item_->set_property ("break-visibility", visibility);
     }
-}      
-
+}
 
-bool
-Key_engraver::try_music (Music * ev)
+IMPLEMENT_TRANSLATOR_LISTENER (Key_engraver, key_change);
+void
+Key_engraver::listen_key_change (Stream_event *ev)
 {
-  if (ev->is_mus_type ("key-change-event"))
-    {
-      if (!key_ev_)
-       {
-         /*
-           do this only once, just to be on the safe side.
-           */      
-         key_ev_ = ev;
-         read_ev (key_ev_);
-       }
-      
-      return true;
-    }   
-  return  false;
+  /* 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::acknowledge_grob (Grob_info info)
+Key_engraver::acknowledge_clef (Grob_info info)
 {
-  if (Clef::has_interface (info.grob_))
-    {
-      SCM c =  get_property ("createKeyOnClefChange");
-      if (to_boolean (c))
-       {
-         create_key (false);
-       }
-    }
-  else if (Bar_line::has_interface (info.grob_)
-          && ly_c_pair_p (get_property ("keySignature")))
-    {
-      create_key (true);
-    }
+  (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::process_music ()
 {
-  if (key_ev_ ||
-      get_property ("lastKeySignature") != get_property ("keySignature"))
+  if (key_event_
+      || get_property ("lastKeySignature") != get_property ("keySignature"))
     create_key (false);
 }
 
-
 void
 Key_engraver::stop_translation_timestep ()
 {
-  if (item_) 
-    {
-      typeset_grob (item_);
-      item_ = 0;
-    }
+  item_ = 0;
+  context ()->set_property ("lastKeySignature", get_property ("keySignature"));
+  cancellation_ = 0;
+  key_event_ = 0;
 }
 
-
 void
-Key_engraver::read_ev (Music const * r)
+Key_engraver::read_event (Stream_event const *r)
 {
   SCM p = r->get_property ("pitch-alist");
-  if (!ly_c_pair_p (p))
+  if (!scm_is_pair (p))
     return;
 
-  SCM n = scm_list_copy (p);
   SCM accs = SCM_EOL;
-  for (SCM s = get_property ("keyAccidentalOrder");
-       ly_c_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 (ly_c_pair_p (scm_member (ly_car (s), n)))
+      SCM head = scm_member (scm_car (s), alist);
+      
+      if (scm_is_pair (head))
        {
-         accs = scm_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 ; ly_c_pair_p (s); s = ly_cdr (s))
-    if (ly_scm2int (ly_cdar (s)))
-      accs = scm_cons (ly_car (s), accs);
 
+  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::start_translation_timestep ()
-{
-  key_ev_ = 0;
-  context ()->set_property ("lastKeySignature", get_property ("keySignature"));
+  context ()->set_property ("tonic",
+                           r->get_property ("tonic"));
 }
 
-
 void
 Key_engraver::initialize ()
 {
   context ()->set_property ("keySignature", SCM_EOL);
   context ()->set_property ("lastKeySignature", SCM_EOL);
 
-  Pitch p (0,0,0);
+  Pitch p (0, 0, 0);
   context ()->set_property ("tonic", p.smobbed_copy ());
-
 }
 
-
-ENTER_DESCRIPTION (Key_engraver,
-/* descr */       "",
-/* creats*/       "KeySignature",
-/* accepts */     "key-change-event",
-/* acks  */      "bar-line-interface clef-interface",
-/* reads */       "keySignature printKeyCancellation lastKeySignature explicitKeySignatureVisibility createKeyOnClefChange keyAccidentalOrder keySignature",
-/* write */       "lastKeySignature tonic keySignature");
+ADD_ACKNOWLEDGER (Key_engraver, clef);
+ADD_ACKNOWLEDGER (Key_engraver, bar_line);
+
+ADD_TRANSLATOR (Key_engraver,
+               /* doc */
+               "Engrave a key signature.",
+
+               /* create */
+               "KeySignature ",
+               
+               /* read */
+               "createKeyOnClefChange "
+               "explicitKeySignatureVisibility "
+               "extraNatural "
+               "keyAlterationOrder "
+               "keySignature "
+               "lastKeySignature "
+               "printKeyCancellation ",
+               
+               /* write */
+               "keySignature "
+               "lastKeySignature "
+               "tonic "
+               );