lily/key-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include "clef.hh"
  21 #include "context.hh"
  22 #include "engraver.hh"
  23 #include "international.hh"
  24 #include "item.hh"
  25 #include "pitch.hh"
  26 #include "protected-scm.hh"
  27 #include "staff-symbol-referencer.hh"
  28 #include "stream-event.hh"
  29
  30 #include "translator.icc"
  31
  32 class Key_engraver : public Engraver
  33 {
  34   void create_key (bool);
  35   void read_event (Stream_event const *r);
  36
  37   Stream_event *key_event_;
  38   Item *item_;
  39   Item *cancellation_;
  40 public:
  41   TRANSLATOR_DECLARATIONS (Key_engraver);
  42
  43 protected:
  44   virtual void initialize ();
  45   virtual void finalize ();
  46   void stop_translation_timestep ();
  47   void process_music ();
  48
  49   DECLARE_TRANSLATOR_LISTENER (key_change);
  50   DECLARE_ACKNOWLEDGER (clef);
  51   DECLARE_ACKNOWLEDGER (bar_line);
  52 };
  53
  54 void
  55 Key_engraver::finalize ()
  56 {
  57 }
  58
  59 Key_engraver::Key_engraver ()
  60 {
  61   key_event_ = 0;
  62   item_ = 0;
  63   cancellation_ = 0;
  64 }
  65
  66 void
  67 Key_engraver::create_key (bool is_default)
  68 {
  69   if (!item_)
  70     {
  71       item_ = make_item ("KeySignature",
  72                          key_event_ ? key_event_->self_scm () : SCM_EOL);
  73
  74       /* Use middleCClefPosition rather than middleCPosition, because cue
  75        * notes with a different clef will modify middleCPosition. The
  76        * Key signature, however, should still be printed at the original
  77        * position. */
  78       item_->set_property ("c0-position",
  79                            get_property ("middleCClefPosition"));
  80
  81       SCM last = get_property ("lastKeyAlterations");
  82       SCM key = get_property ("keyAlterations");
  83
  84       if ((to_boolean (get_property ("printKeyCancellation"))
  85            || scm_is_null (key))
  86           && !scm_is_eq (last, key))
  87         {
  88           SCM restore = SCM_EOL;
  89           for (SCM s = last; scm_is_pair (s); s = scm_cdr (s))
  90             {
  91               SCM new_alter_pair = scm_assoc (scm_caar (s), key);
  92               Rational old_alter = robust_scm2rational (scm_cdar (s), 0);
  93               if (scm_is_false (new_alter_pair)
  94                   || ((ly_scm2rational (scm_cdr (new_alter_pair)) - old_alter) * old_alter
  95                       < Rational (0)))
  96                 {
  97                   restore = scm_cons (scm_car (s), restore);
  98                 }
  99             }
 100
 101           if (scm_is_pair (restore))
 102             {
 103               cancellation_ = make_item ("KeyCancellation",
 104                                          key_event_
 105                                          ? key_event_->self_scm () : SCM_EOL);
 106
 107               cancellation_->set_property ("alteration-alist", restore);
 108               cancellation_->set_property ("c0-position",
 109                                            get_property ("middleCClefPosition"));
 110             }
 111         }
 112
 113       item_->set_property ("alteration-alist", scm_reverse (key));
 114     }
 115
 116   if (!is_default)
 117     {
 118       SCM visibility = get_property ("explicitKeySignatureVisibility");
 119       item_->set_property ("break-visibility", visibility);
 120     }
 121 }
 122
 123 IMPLEMENT_TRANSLATOR_LISTENER (Key_engraver, key_change);
 124 void
 125 Key_engraver::listen_key_change (Stream_event *ev)
 126 {
 127   /* do this only once, just to be on the safe side.  */
 128   if (ASSIGN_EVENT_ONCE (key_event_, ev))
 129     read_event (key_event_);
 130 }
 131
 132 void
 133 Key_engraver::acknowledge_clef (Grob_info /* info */)
 134 {
 135   SCM c = get_property ("createKeyOnClefChange");
 136   if (to_boolean (c))
 137     create_key (false);
 138 }
 139
 140 void
 141 Key_engraver::acknowledge_bar_line (Grob_info /* info */)
 142 {
 143   create_key (true);
 144 }
 145
 146 void
 147 Key_engraver::process_music ()
 148 {
 149   if (key_event_
 150       || get_property ("lastKeyAlterations") != get_property ("keyAlterations"))
 151     create_key (false);
 152 }
 153
 154 void
 155 Key_engraver::stop_translation_timestep ()
 156 {
 157   item_ = 0;
 158   context ()->set_property ("lastKeyAlterations", get_property ("keyAlterations"));
 159   cancellation_ = 0;
 160   key_event_ = 0;
 161 }
 162
 163 void
 164 Key_engraver::read_event (Stream_event const *r)
 165 {
 166   SCM p = r->get_property ("pitch-alist");
 167   if (!scm_is_pair (p))
 168     return;
 169
 170   SCM accs = SCM_EOL;
 171
 172   SCM alist = scm_list_copy (p);
 173   SCM order = get_property ("keyAlterationOrder");
 174   for (SCM s = order;
 175        scm_is_pair (s) && scm_is_pair (alist); s = scm_cdr (s))
 176     {
 177       SCM head = scm_member (scm_car (s), alist);
 178
 179       if (scm_is_pair (head))
 180         {
 181           accs = scm_cons (scm_car (head), accs);
 182           alist = scm_delete_x (scm_car (head), alist);
 183         }
 184     }
 185
 186   if (scm_is_pair (alist))
 187     {
 188       bool warn = false;
 189       for (SCM s = alist; scm_is_pair (s); s = scm_cdr (s))
 190         if (ly_scm2rational (scm_cdar (s)))
 191           {
 192             warn = true;
 193             accs = scm_cons (scm_car (s), accs);
 194           }
 195
 196       if (warn)
 197         r->origin ()->warning (_ ("Incomplete keyAlterationOrder for key signature"));
 198     }
 199
 200   context ()->set_property ("keyAlterations", scm_reverse_x (accs, SCM_EOL));
 201   context ()->set_property ("tonic",
 202                             r->get_property ("tonic"));
 203 }
 204
 205 void
 206 Key_engraver::initialize ()
 207 {
 208   context ()->set_property ("keyAlterations", SCM_EOL);
 209   context ()->set_property ("lastKeyAlterations", SCM_EOL);
 210
 211   Pitch p;
 212   context ()->set_property ("tonic", p.smobbed_copy ());
 213 }
 214
 215 ADD_ACKNOWLEDGER (Key_engraver, clef);
 216 ADD_ACKNOWLEDGER (Key_engraver, bar_line);
 217
 218 ADD_TRANSLATOR (Key_engraver,
 219                 /* doc */
 220                 "Engrave a key signature.",
 221
 222                 /* create */
 223                 "KeyCancellation "
 224                 "KeySignature ",
 225
 226                 /* read */
 227                 "createKeyOnClefChange "
 228                 "explicitKeySignatureVisibility "
 229                 "extraNatural "
 230                 "keyAlterationOrder "
 231                 "keyAlterations "
 232                 "lastKeyAlterations "
 233                 "printKeyCancellation "
 234                 "middleCClefPosition ",
 235
 236                 /* write */
 237                 "keyAlterations "
 238                 "lastKeyAlterations "
 239                 "tonic "
 240                );