lily/key-engraver.cc

   1 /*
   2   key-engraver.cc -- implement Key_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9 #include "item.hh"
  10 #include "bar-line.hh"
  11 #include "staff-symbol-referencer.hh"
  12 #include "context.hh"
  13 #include "engraver.hh"
  14 #include "protected-scm.hh"
  15 #include "clef.hh"
  16 #include "pitch.hh"
  17
  18 /*
  19   TODO: The representation  of key sigs is all fucked.
  20 */
  21
  22 /**
  23    Make the key signature.
  24 */
  25 class Key_engraver : public Engraver
  26 {
  27   void create_key (bool);
  28   void read_ev (Music const *r);
  29
  30   Music *key_ev_;
  31   Item *item_;
  32   Item *cancellation_;
  33 public:
  34   TRANSLATOR_DECLARATIONS (Key_engraver);
  35
  36 protected:
  37   virtual void initialize ();
  38   virtual void finalize ();
  39   virtual bool try_music (Music *ev);
  40   PRECOMPUTED_VIRTUAL void stop_translation_timestep ();
  41   PRECOMPUTED_VIRTUAL void process_music ();
  42
  43   DECLARE_ACKNOWLEDGER(clef);
  44   DECLARE_ACKNOWLEDGER(bar_line);
  45
  46 };
  47
  48 void
  49 Key_engraver::finalize ()
  50 {
  51 }
  52
  53 Key_engraver::Key_engraver ()
  54 {
  55   key_ev_ = 0;
  56   item_ = 0;
  57   cancellation_ = 0;
  58 }
  59
  60 void
  61 Key_engraver::create_key (bool def)
  62 {
  63   if (!item_)
  64     {
  65       item_ = make_item ("KeySignature", key_ev_ ? key_ev_->self_scm () : SCM_EOL);
  66
  67       item_->set_property ("c0-position",
  68                            get_property ("middleCPosition"));
  69
  70       SCM last = get_property ("lastKeySignature");
  71       SCM key = get_property ("keySignature");
  72       if (to_boolean (get_property ("printKeyCancellation"))
  73           && !scm_is_eq (last, key))
  74         {
  75           cancellation_ = make_item ("KeyCancellation", key_ev_ ? key_ev_->self_scm () : SCM_EOL);
  76           cancellation_->set_property ("old-accidentals", last);
  77           cancellation_->set_property ("c0-position",
  78                                        get_property ("middleCPosition"));
  79         }
  80       item_->set_property ("new-accidentals", key);
  81     }
  82
  83   if (!def)
  84     {
  85       SCM vis = get_property ("explicitKeySignatureVisibility");
  86       if (ly_is_procedure (vis))
  87         item_->set_property ("break-visibility", vis);
  88     }
  89 }
  90
  91 bool
  92 Key_engraver::try_music (Music *ev)
  93 {
  94   if (ev->is_mus_type ("key-change-event"))
  95     {
  96       /* do this only once, just to be on the safe side.  */
  97       if (!key_ev_)
  98         {
  99           key_ev_ = ev;
 100           read_ev (key_ev_);
 101         }
 102       return true;
 103     }
 104   return false;
 105 }
 106
 107 void
 108 Key_engraver::acknowledge_clef (Grob_info info)
 109 {
 110   (void)info;
 111   SCM c = get_property ("createKeyOnClefChange");
 112   if (to_boolean (c))
 113     {
 114       create_key (false);
 115     }
 116 }
 117
 118 void
 119 Key_engraver::acknowledge_bar_line (Grob_info info)
 120 {
 121   (void)info;
 122   if (scm_is_pair (get_property ("keySignature")))
 123     {
 124       create_key (true);
 125     }
 126 }
 127
 128 void
 129 Key_engraver::process_music ()
 130 {
 131   if (key_ev_
 132       || get_property ("lastKeySignature") != get_property ("keySignature"))
 133     create_key (false);
 134 }
 135
 136 void
 137 Key_engraver::stop_translation_timestep ()
 138 {
 139   item_ = 0;
 140   context ()->set_property ("lastKeySignature", get_property ("keySignature"));
 141   cancellation_ = 0;
 142   key_ev_ = 0;
 143 }
 144
 145 void
 146 Key_engraver::read_ev (Music const *r)
 147 {
 148   SCM p = r->get_property ("pitch-alist");
 149   if (!scm_is_pair (p))
 150     return;
 151
 152   SCM n = scm_list_copy (p);
 153   SCM accs = SCM_EOL;
 154   for (SCM s = get_property ("keyAccidentalOrder");
 155        scm_is_pair (s); s = scm_cdr (s))
 156     {
 157       if (scm_is_pair (scm_member (scm_car (s), n)))
 158         {
 159           accs = scm_cons (scm_car (s), accs);
 160           n = scm_delete_x (scm_car (s), n);
 161         }
 162     }
 163
 164   for (SCM s = n; scm_is_pair (s); s = scm_cdr (s))
 165     if (scm_to_int (scm_cdar (s)))
 166       accs = scm_cons (scm_car (s), accs);
 167
 168   context ()->set_property ("keySignature", accs);
 169   context ()->set_property ("tonic",
 170                             r->get_property ("tonic"));
 171 }
 172
 173 void
 174 Key_engraver::initialize ()
 175 {
 176   context ()->set_property ("keySignature", SCM_EOL);
 177   context ()->set_property ("lastKeySignature", SCM_EOL);
 178
 179   Pitch p (0, 0, 0);
 180   context ()->set_property ("tonic", p.smobbed_copy ());
 181 }
 182
 183 #include "translator.icc"
 184
 185 ADD_ACKNOWLEDGER(Key_engraver,clef);
 186 ADD_ACKNOWLEDGER(Key_engraver,bar_line);
 187 ADD_TRANSLATOR (Key_engraver,
 188                 /* descr */ "",
 189                 /* creats*/ "KeySignature",
 190                 /* accepts */ "key-change-event",
 191                 /* reads */ "keySignature printKeyCancellation lastKeySignature explicitKeySignatureVisibility createKeyOnClefChange keyAccidentalOrder keySignature",
 192                 /* write */ "lastKeySignature tonic keySignature");