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   void listen_key_change (Stream_event *);
  50   void acknowledge_clef (Grob_info);
  51   void acknowledge_bar_line (Grob_info);
  52 };
  53
  54 void
  55 Key_engraver::finalize ()
  56 {
  57 }
  58
  59 Key_engraver::Key_engraver (Context *c)
  60   : Engraver (c)
  61 {
  62   key_event_ = 0;
  63   item_ = 0;
  64   cancellation_ = 0;
  65 }
  66
  67 void
  68 Key_engraver::create_key (bool is_default)
  69 {
  70   if (!item_)
  71     {
  72       item_ = make_item ("KeySignature",
  73                          key_event_ ? key_event_->self_scm () : SCM_EOL);
  74
  75       /* Use middleCClefPosition rather than middleCPosition, because cue
  76        * notes with a different clef will modify middleCPosition. The
  77        * Key signature, however, should still be printed at the original
  78        * position. */
  79       item_->set_property ("c0-position",
  80                            get_property ("middleCClefPosition"));
  81
  82       SCM last = get_property ("lastKeyAlterations");
  83       SCM key = get_property ("keyAlterations");
  84
  85       if ((to_boolean (get_property ("printKeyCancellation"))
  86            || scm_is_null (key))
  87           && !scm_is_eq (last, key))
  88         {
  89           SCM restore = SCM_EOL;
  90           for (SCM s = last; scm_is_pair (s); s = scm_cdr (s))
  91             {
  92               SCM new_alter_pair = scm_assoc (scm_caar (s), key);
  93               Rational old_alter = robust_scm2rational (scm_cdar (s), 0);
  94               if (scm_is_false (new_alter_pair)
  95                   || ((ly_scm2rational (scm_cdr (new_alter_pair)) - old_alter) * old_alter
  96                       < Rational (0)))
  97                 {
  98                   restore = scm_cons (scm_car (s), restore);
  99                 }
 100             }
 101
 102           if (scm_is_pair (restore))
 103             {
 104               cancellation_ = make_item ("KeyCancellation",
 105                                          key_event_
 106                                          ? key_event_->self_scm () : SCM_EOL);
 107
 108               cancellation_->set_property ("alteration-alist", restore);
 109               cancellation_->set_property ("c0-position",
 110                                            get_property ("middleCClefPosition"));
 111             }
 112         }
 113
 114       item_->set_property ("alteration-alist", scm_reverse (key));
 115     }
 116
 117   if (!is_default)
 118     {
 119       SCM visibility = get_property ("explicitKeySignatureVisibility");
 120       item_->set_property ("break-visibility", visibility);
 121       item_->set_property ("non-default", SCM_BOOL_T);
 122     }
 123 }
 124
 125 void
 126 Key_engraver::listen_key_change (Stream_event *ev)
 127 {
 128   /* do this only once, just to be on the safe side.  */
 129   if (ASSIGN_EVENT_ONCE (key_event_, ev))
 130     read_event (key_event_);
 131 }
 132
 133 void
 134 Key_engraver::acknowledge_clef (Grob_info /* info */)
 135 {
 136   SCM c = get_property ("createKeyOnClefChange");
 137   if (to_boolean (c))
 138     create_key (false);
 139 }
 140
 141 void
 142 Key_engraver::acknowledge_bar_line (Grob_info /* info */)
 143 {
 144   create_key (true);
 145 }
 146
 147 void
 148 Key_engraver::process_music ()
 149 {
 150   if (key_event_
 151       || get_property ("lastKeyAlterations") != get_property ("keyAlterations"))
 152     create_key (false);
 153 }
 154
 155 void
 156 Key_engraver::stop_translation_timestep ()
 157 {
 158   item_ = 0;
 159   context ()->set_property ("lastKeyAlterations", get_property ("keyAlterations"));
 160   cancellation_ = 0;
 161   key_event_ = 0;
 162 }
 163
 164 void
 165 Key_engraver::read_event (Stream_event const *r)
 166 {
 167   SCM p = r->get_property ("pitch-alist");
 168   if (!scm_is_pair (p))
 169     return;
 170
 171   SCM accs = SCM_EOL;
 172
 173   SCM alist = scm_list_copy (p);
 174   SCM order = get_property ("keyAlterationOrder");
 175   for (SCM s = order;
 176        scm_is_pair (s) && scm_is_pair (alist); s = scm_cdr (s))
 177     {
 178       SCM head = scm_member (scm_car (s), alist);
 179
 180       if (scm_is_pair (head))
 181         {
 182           accs = scm_cons (scm_car (head), accs);
 183           alist = scm_delete_x (scm_car (head), alist);
 184         }
 185     }
 186
 187   if (scm_is_pair (alist))
 188     {
 189       bool warn = false;
 190       for (SCM s = alist; scm_is_pair (s); s = scm_cdr (s))
 191         if (ly_scm2rational (scm_cdar (s)))
 192           {
 193             warn = true;
 194             accs = scm_cons (scm_car (s), accs);
 195           }
 196
 197       if (warn)
 198         r->origin ()->warning (_ ("Incomplete keyAlterationOrder for key signature"));
 199     }
 200
 201   context ()->set_property ("keyAlterations", scm_reverse_x (accs, SCM_EOL));
 202   context ()->set_property ("tonic",
 203                             r->get_property ("tonic"));
 204 }
 205
 206 void
 207 Key_engraver::initialize ()
 208 {
 209   context ()->set_property ("keyAlterations", SCM_EOL);
 210   context ()->set_property ("lastKeyAlterations", SCM_EOL);
 211
 212   Pitch p;
 213   context ()->set_property ("tonic", p.smobbed_copy ());
 214 }
 215
 216
 217 void
 218 Key_engraver::boot ()
 219 {
 220   ADD_LISTENER (Key_engraver, key_change);
 221   ADD_ACKNOWLEDGER (Key_engraver, clef);
 222   ADD_ACKNOWLEDGER (Key_engraver, bar_line);
 223 }
 224
 225 ADD_TRANSLATOR (Key_engraver,
 226                 /* doc */
 227                 "Engrave a key signature.",
 228
 229                 /* create */
 230                 "KeyCancellation "
 231                 "KeySignature ",
 232
 233                 /* read */
 234                 "createKeyOnClefChange "
 235                 "explicitKeySignatureVisibility "
 236                 "extraNatural "
 237                 "keyAlterationOrder "
 238                 "keyAlterations "
 239                 "lastKeyAlterations "
 240                 "printKeyCancellation "
 241                 "middleCClefPosition ",
 242
 243                 /* write */
 244                 "keyAlterations "
 245                 "lastKeyAlterations "
 246                 "tonic "
 247                );