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--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7   */
   8
   9 #include "key-item.hh"
  10 #include "command-request.hh"
  11 #include "musical-request.hh"
  12 #include "item.hh"
  13 #include "bar.hh"
  14 #include "timing-translator.hh"
  15 #include "staff-symbol-referencer.hh"
  16 #include "translator-group.hh"
  17 #include "engraver.hh"
  18 #include "pitch.hh"
  19 #include "protected-scm.hh"
  20 #include "clef.hh"
  21
  22 /**
  23   Make the key signature.
  24  */
  25 class Key_engraver : public Engraver
  26 {
  27   void create_key (bool);
  28   void read_req (Key_change_req const * r);
  29
  30 public:
  31   TRANSLATOR_DECLARATIONS(Key_engraver);
  32
  33   Key_change_req * keyreq_l_;
  34   Item * item_p_;
  35   Protected_scm old_accs_;      // ugh. -> property
  36
  37 protected:
  38   virtual void initialize ();
  39   virtual void finalize ();
  40   virtual bool try_music (Music *req_l);
  41   virtual void stop_translation_timestep ();
  42   virtual void start_translation_timestep ();
  43   virtual void create_grobs ();
  44   virtual void acknowledge_grob (Grob_info);
  45 };
  46
  47
  48 void
  49 Key_engraver::finalize ()
  50 {
  51   old_accs_ = SCM_EOL;          // unprotect can not  be called from dtor.
  52 }
  53
  54 Key_engraver::Key_engraver ()
  55 {
  56   keyreq_l_ = 0;
  57   item_p_ = 0;
  58 }
  59
  60 void
  61 Key_engraver::create_key (bool def)
  62 {
  63   if (!item_p_)
  64     {
  65       item_p_ = new Item (get_property ("KeySignature"));
  66
  67       item_p_->set_grob_property ("c0-position", gh_int2scm (0));
  68
  69       // todo: put this in basic props.
  70       item_p_->set_grob_property ("old-accidentals", old_accs_);
  71       item_p_->set_grob_property ("new-accidentals", get_property ("keySignature"));
  72
  73       Staff_symbol_referencer::set_interface (item_p_);
  74       Key_item::set_interface (item_p_);
  75
  76
  77       announce_grob (item_p_,keyreq_l_);
  78     }
  79
  80
  81   if (!def)
  82     {
  83       SCM vis = get_property ("explicitKeySignatureVisibility");
  84       if (gh_procedure_p (vis))
  85         item_p_->set_grob_property ("visibility-lambda",vis);
  86     }
  87 }
  88
  89
  90 bool
  91 Key_engraver::try_music (Music * req_l)
  92 {
  93   if (Key_change_req *kc = dynamic_cast <Key_change_req *> (req_l))
  94     {
  95       if (keyreq_l_ && !keyreq_l_->equal_b (kc))
  96         {
  97           kc->origin ()->warning (_ ("Conflicting key signatures found."));
  98           keyreq_l_->origin ()->warning (_ ("This was the other key definition."));
  99           return false;
 100         }
 101       keyreq_l_ = kc;
 102       read_req (keyreq_l_);
 103
 104       return true;
 105     }
 106   return  false;
 107 }
 108
 109 void
 110 Key_engraver::acknowledge_grob (Grob_info info)
 111 {
 112   if (Clef::has_interface (info.grob_l_))
 113     {
 114       SCM c =  get_property ("createKeyOnClefChange");
 115       if (to_boolean (c))
 116         {
 117           create_key (false);
 118         }
 119     }
 120   else if (Bar::has_interface (info.grob_l_)
 121            && gh_pair_p (get_property ("keySignature")))
 122     {
 123       create_key (true);
 124     }
 125
 126 }
 127
 128 void
 129 Key_engraver::create_grobs ()
 130 {
 131   if (keyreq_l_ || old_accs_ != get_property ("keySignature"))
 132     {
 133       create_key (false);
 134     }
 135 }
 136
 137 void
 138 Key_engraver::stop_translation_timestep ()
 139 {
 140   if (item_p_)
 141     {
 142       typeset_grob (item_p_);
 143       item_p_ = 0;
 144     }
 145 }
 146
 147 void
 148 Key_engraver::read_req (Key_change_req const * r)
 149 {
 150   SCM p = r->get_mus_property ("pitch-alist");
 151   if (!gh_pair_p (p))
 152     return;
 153
 154   SCM n = scm_list_copy (p);
 155   SCM accs = SCM_EOL;
 156   for (SCM s = get_property ("keyAccidentalOrder");
 157        gh_pair_p (s); s = ly_cdr (s))
 158     {
 159       if (gh_pair_p (scm_member (ly_car (s), n)))
 160         {
 161           accs = gh_cons (ly_car (s), accs);
 162           n = scm_delete_x (ly_car (s), n);
 163         }
 164     }
 165   for (SCM s = n ; gh_pair_p (s); s = ly_cdr (s))
 166     if (gh_scm2int (ly_cdar (s)))
 167       accs = gh_cons (ly_car (s), accs);
 168
 169   old_accs_ = get_property ("keySignature");
 170   daddy_trans_l_->set_property ("keySignature", accs);
 171 }
 172
 173 void
 174 Key_engraver::start_translation_timestep ()
 175 {
 176   keyreq_l_ = 0;
 177   old_accs_ = get_property ("keySignature");
 178 }
 179
 180 void
 181 Key_engraver::initialize ()
 182 {
 183   daddy_trans_l_->set_property ("keySignature", SCM_EOL);
 184   old_accs_ = SCM_EOL;
 185 }
 186
 187
 188
 189
 190 ENTER_DESCRIPTION(Key_engraver,
 191 /* descr */       "",
 192 /* creats*/       "KeySignature",
 193 /* acks  */       "bar-line-interface clef-interface",
 194 /* reads */       "keySignature explicitKeySignatureVisibility createKeyOnClefChange keyAccidentalOrder keySignature",
 195 /* write */       "");