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