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