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--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7   */
   8
   9
  10 #include "key-item.hh"
  11 #include "command-request.hh"
  12 #include "musical-request.hh"
  13 #include "local-key-item.hh"
  14 #include "bar.hh"
  15 #include "timing-translator.hh"
  16 #include "staff-symbol-referencer.hh"
  17 #include "translator-group.hh"
  18 #include "engraver.hh"
  19 #include "musical-pitch.hh"
  20 #include "protected-scm.hh"
  21 #include "clef-item.hh"
  22
  23 /**
  24   Make the key signature.
  25  */
  26 class Key_engraver : public Engraver {
  27   void create_key(bool);
  28   void read_req (Key_change_req const * r);
  29
  30 public:
  31   Key_engraver();
  32
  33   VIRTUAL_COPY_CONS(Translator);
  34
  35   Key_change_req * keyreq_l_;
  36   Key_item * item_p_;
  37   Protected_scm old_accs_;
  38
  39 protected:
  40   virtual void do_creation_processing();
  41   virtual bool do_try_music (Music *req_l);
  42   virtual void do_process_music();
  43   virtual void do_pre_move_processing();
  44   virtual void do_post_move_processing();
  45   virtual void acknowledge_element (Score_element_info);
  46 };
  47
  48
  49 Key_engraver::Key_engraver ()
  50 {
  51   keyreq_l_ = 0;
  52   item_p_ = 0;
  53 }
  54
  55 void
  56 Key_engraver::create_key (bool def)
  57 {
  58   if (!item_p_)
  59     {
  60       item_p_ = new Key_item ( get_property ("basicKeyProperties"));
  61
  62       item_p_->set_elt_property ("c0-position", gh_int2scm (0));
  63
  64       // todo: put this in basic props.
  65       item_p_->set_elt_property ("old-accidentals", old_accs_);
  66       item_p_->set_elt_property ("new-accidentals", get_property ("keySignature"));
  67
  68       Staff_symbol_referencer_interface st (item_p_);
  69       st.set_interface ();
  70
  71       SCM prop = get_property ("keyOctaviation");
  72       bool multi = to_boolean (prop);
  73
  74       if (multi)
  75         item_p_->set_elt_property ("multi-octave", gh_bool2scm (multi));
  76
  77       announce_element (Score_element_info (item_p_,keyreq_l_));
  78     }
  79
  80   if (!def)
  81     item_p_->set_elt_property ("visibility-lambda",
  82                                scm_eval (ly_symbol2scm  ("all-visible")));
  83
  84 }
  85
  86
  87 bool
  88 Key_engraver::do_try_music (Music * req_l)
  89 {
  90   if (Key_change_req *kc = dynamic_cast <Key_change_req *> (req_l))
  91     {
  92       if (keyreq_l_)
  93         warning (_ ("FIXME: key change merge"));
  94       keyreq_l_ = kc;
  95       read_req (keyreq_l_);
  96       return true;
  97     }
  98   return  false;
  99 }
 100
 101 void
 102 Key_engraver::acknowledge_element (Score_element_info info)
 103 {
 104   if (dynamic_cast <Clef_item *> (info.elem_l_))
 105     {
 106       SCM c =  get_property ("createKeyOnClefChange");
 107       if (to_boolean (c))
 108         {
 109           create_key (false);
 110         }
 111     }
 112   else if (dynamic_cast<Bar *> (info.elem_l_)
 113            && gh_pair_p (get_property ("keySignature")))
 114     {
 115       create_key (true);
 116     }
 117
 118 }
 119
 120 void
 121 Key_engraver::do_process_music ()
 122 {
 123   if (keyreq_l_ || old_accs_ != get_property ("keySignature"))
 124     {
 125       create_key (false);
 126     }
 127 }
 128
 129 void
 130 Key_engraver::do_pre_move_processing ()
 131 {
 132   if (item_p_)
 133     {
 134       typeset_element (item_p_);
 135       item_p_ = 0;
 136     }
 137 }
 138
 139 void
 140 Key_engraver::read_req (Key_change_req const * r)
 141 {
 142   if (!r->key_)
 143     return;
 144
 145   SCM n = scm_list_copy (r->key_->pitch_alist_);
 146   SCM accs = SCM_EOL;
 147   for (SCM s = get_property ("keyAccidentalOrder");
 148        gh_pair_p (s); s = gh_cdr (s))
 149     {
 150       if (gh_pair_p (scm_member (gh_car (s), n)))
 151         {
 152           accs = gh_cons (gh_car (s), accs);
 153           n = scm_delete_x (gh_car (s), n);
 154         }
 155     }
 156   for (SCM s = n ; gh_pair_p (s); s = gh_cdr (s))
 157     if (gh_scm2int (gh_cdar (s)))
 158       accs = gh_cons (gh_car (s), accs);
 159
 160   old_accs_ = get_property ("keySignature");
 161   daddy_trans_l_->set_property ("keySignature", accs);
 162 }
 163
 164 void
 165 Key_engraver::do_post_move_processing ()
 166 {
 167   keyreq_l_ = 0;
 168   old_accs_ = get_property ("keySignature");
 169 }
 170
 171 void
 172 Key_engraver::do_creation_processing ()
 173 {
 174   daddy_trans_l_->set_property ("keySignature", SCM_EOL);
 175   old_accs_ = SCM_EOL;
 176 }
 177
 178
 179 ADD_THIS_TRANSLATOR (Key_engraver);
 180