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.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   Item * item_p_;
  36   Protected_scm old_accs_;      // ugh. -> property
  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 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::set_interface (item_p_);
  68
  69       SCM prop = get_property ("keyOctaviation");
  70       bool multi = to_boolean (prop);
  71
  72       if (multi)
  73         item_p_->set_elt_property ("multi-octave", gh_bool2scm (multi));
  74
  75       announce_element (Score_element_info (item_p_,keyreq_l_));
  76     }
  77
  78   if (!def)
  79     item_p_->set_elt_property ("visibility-lambda",
  80                                scm_eval (ly_symbol2scm  ("all-visible")));
  81
  82 }
  83
  84
  85 bool
  86 Key_engraver::do_try_music (Music * req_l)
  87 {
  88   if (Key_change_req *kc = dynamic_cast <Key_change_req *> (req_l))
  89     {
  90       if (keyreq_l_)
  91         warning (_ ("FIXME: key change merge"));
  92       keyreq_l_ = kc;
  93       read_req (keyreq_l_);
  94       return true;
  95     }
  96   return  false;
  97 }
  98
  99 void
 100 Key_engraver::acknowledge_element (Score_element_info info)
 101 {
 102   if (Clef::has_interface (info.elem_l_))
 103     {
 104       SCM c =  get_property ("createKeyOnClefChange");
 105       if (to_boolean (c))
 106         {
 107           create_key (false);
 108         }
 109     }
 110   else if (Bar::has_interface (info.elem_l_)
 111            && gh_pair_p (get_property ("keySignature")))
 112     {
 113       create_key (true);
 114     }
 115
 116 }
 117
 118 void
 119 Key_engraver::do_process_music ()
 120 {
 121   if (keyreq_l_ || old_accs_ != get_property ("keySignature"))
 122     {
 123       create_key (false);
 124     }
 125 }
 126
 127 void
 128 Key_engraver::do_pre_move_processing ()
 129 {
 130   if (item_p_)
 131     {
 132       typeset_element (item_p_);
 133       item_p_ = 0;
 134     }
 135 }
 136
 137 void
 138 Key_engraver::read_req (Key_change_req const * r)
 139 {
 140   if (r->pitch_alist_ == SCM_UNDEFINED)
 141     return;
 142
 143   SCM n = scm_list_copy (r->pitch_alist_);
 144   SCM accs = SCM_EOL;
 145   for (SCM s = get_property ("keyAccidentalOrder");
 146        gh_pair_p (s); s = gh_cdr (s))
 147     {
 148       if (gh_pair_p (scm_member (gh_car (s), n)))
 149         {
 150           accs = gh_cons (gh_car (s), accs);
 151           n = scm_delete_x (gh_car (s), n);
 152         }
 153     }
 154   for (SCM s = n ; gh_pair_p (s); s = gh_cdr (s))
 155     if (gh_scm2int (gh_cdar (s)))
 156       accs = gh_cons (gh_car (s), accs);
 157
 158   old_accs_ = get_property ("keySignature");
 159   daddy_trans_l_->set_property ("keySignature", accs);
 160 }
 161
 162 void
 163 Key_engraver::do_post_move_processing ()
 164 {
 165   keyreq_l_ = 0;
 166   old_accs_ = get_property ("keySignature");
 167 }
 168
 169 void
 170 Key_engraver::do_creation_processing ()
 171 {
 172   daddy_trans_l_->set_property ("keySignature", SCM_EOL);
 173   old_accs_ = SCM_EOL;
 174 }
 175
 176
 177 ADD_THIS_TRANSLATOR (Key_engraver);
 178