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 // clean me up
   9 #include "key-engraver.hh"
  10 #include "key-item.hh"
  11 #include "command-request.hh"
  12 #include "local-key-engraver.hh"
  13 #include "musical-request.hh"
  14 #include "local-key-item.hh"
  15 #include "bar.hh"
  16 #include "timing-translator.hh"
  17 #include "staff-symbol-referencer.hh"
  18
  19 Key_engraver::Key_engraver ()
  20 {
  21   item_p_ = 0;
  22   do_post_move_processing ();
  23 }
  24
  25 bool
  26 Key_engraver::key_changed_b () const
  27 {
  28   return keyreq_l_ ;
  29 }
  30
  31 void
  32 Key_engraver::create_key ()
  33 {
  34   if (!item_p_)
  35     {
  36       item_p_ = new Key_item;
  37       Staff_symbol_referencer_interface st (item_p_);
  38       st.set_interface ();
  39
  40
  41       item_p_->set_elt_property ("break-align-symbol", ly_symbol2scm ("Key_item"));
  42       item_p_->set_elt_property ("multi-octave",
  43                                  gh_bool2scm (key_.multi_octave_b_));
  44
  45       announce_element (Score_element_info (item_p_,keyreq_l_));
  46
  47
  48       for (int i = 0; i < accidental_idx_arr_.size(); i++)
  49         {
  50           Musical_pitch m_l =accidental_idx_arr_[i];
  51           int a =m_l.accidental_i_;
  52           if (key_.multi_octave_b_)
  53             item_p_->add (m_l.steps (), a);
  54           else
  55             item_p_->add (m_l.notename_i_, a);
  56         }
  57
  58       for (int i = 0 ; i < old_accidental_idx_arr_.size(); i++)
  59         {
  60           Musical_pitch m_l =old_accidental_idx_arr_[i];
  61           int a =m_l.accidental_i_;
  62           if (key_.multi_octave_b_)
  63             item_p_->add_old (m_l.steps  (), a);
  64           else
  65             item_p_->add_old (m_l.notename_i_, a);
  66         }
  67     }
  68 }
  69
  70
  71 bool
  72 Key_engraver::do_try_music (Music * req_l)
  73 {
  74   if (Key_change_req *kc = dynamic_cast <Key_change_req *> (req_l))
  75     {
  76       if (keyreq_l_)
  77         warning (_ ("FIXME: key change merge"));
  78       keyreq_l_ = kc;
  79       read_req (keyreq_l_);
  80       return true;
  81     }
  82   return  false;
  83 }
  84
  85 void
  86 Key_engraver::acknowledge_element (Score_element_info info)
  87 {
  88   if (dynamic_cast <Clef_change_req *> (info.req_l_))
  89     {
  90       SCM c =  get_property ("createKeyOnClefChange");
  91       if (to_boolean (c))
  92         create_key ();
  93     }
  94   else if (dynamic_cast<Bar *> (info.elem_l_)
  95            && accidental_idx_arr_.size ())
  96     {
  97       create_key ();
  98     }
  99
 100 }
 101
 102 void
 103 Key_engraver::do_process_music ()
 104 {
 105   if (keyreq_l_)
 106     {
 107       create_key ();
 108     }
 109 }
 110
 111 void
 112 Key_engraver::do_pre_move_processing ()
 113 {
 114   if (item_p_)
 115     {
 116       if (keyreq_l_)
 117         item_p_->set_elt_property ("visibility-lambda",
 118                                    scm_eval (ly_symbol2scm  ("all-visible")));
 119
 120       typeset_element (item_p_);
 121       item_p_ = 0;
 122     }
 123 }
 124
 125
 126 /*
 127   TODO.  Use properties; and this is too hairy.
 128  */
 129 void
 130 Key_engraver::read_req (Key_change_req const * r)
 131 {
 132   if (!r->key_)
 133     return;
 134
 135   old_accidental_idx_arr_ = accidental_idx_arr_;
 136   key_.clear ();
 137   SCM prop = get_property ("keyOctaviation");
 138
 139   key_.multi_octave_b_ = to_boolean (prop);
 140
 141   accidental_idx_arr_.clear ();
 142
 143   if (r->key_->ordinary_key_b_)
 144     {
 145       int no_of_acc = r->key_->ordinary_accidentals_i ();
 146
 147       // Hmm, can't these be handled/constructed by Key_change_req?
 148       if (no_of_acc < 0)
 149         {
 150           int accidental = 6 ; // First accidental: bes
 151           for ( ; no_of_acc < 0 ; no_of_acc++ )
 152             {
 153               Musical_pitch m;
 154               m.accidental_i_ = -1;
 155               m.notename_i_ = accidental;
 156               if (key_.multi_octave_b_)
 157                 key_.set (m);
 158               else
 159                 key_.set (m.notename_i_, m.accidental_i_);
 160               accidental_idx_arr_.push (m);
 161
 162               accidental = (accidental + 3) % 7 ;
 163             }
 164         }
 165       else
 166         {
 167           int accidental = 3 ; // First accidental: fis
 168           for ( ; no_of_acc > 0 ; no_of_acc-- )
 169             {
 170               Musical_pitch m;
 171               m.accidental_i_ = 1;
 172               m.notename_i_ = accidental;
 173               if (key_.multi_octave_b_)
 174                 key_.set (m);
 175               else
 176                 key_.set (m.notename_i_, m.accidental_i_);
 177               accidental_idx_arr_.push (m);
 178
 179               accidental = (accidental + 4) % 7 ;
 180             }
 181         }
 182     }
 183   else // Special key
 184     {
 185       for (int i = 0; i < r->key_->pitch_arr_.size (); i ++)
 186         {
 187           Musical_pitch m_l =r->key_->pitch_arr_[i];
 188           if (key_.multi_octave_b_)
 189             key_.set (m_l);
 190           else
 191             key_.set (m_l.notename_i_, m_l.accidental_i_);
 192
 193           accidental_idx_arr_.push (m_l);
 194         }
 195     }
 196 }
 197
 198 void
 199 Key_engraver::do_post_move_processing ()
 200 {
 201   keyreq_l_ = 0;
 202   old_accidental_idx_arr_.clear ();
 203 }
 204
 205 ADD_THIS_TRANSLATOR (Key_engraver);
 206