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 (bool def)
  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   if (!def)
  71       item_p_->set_elt_property ("visibility-lambda",
  72                                  scm_eval (ly_symbol2scm  ("all-visible")));
  73
  74 }
  75
  76
  77 bool
  78 Key_engraver::do_try_music (Music * req_l)
  79 {
  80   if (Key_change_req *kc = dynamic_cast <Key_change_req *> (req_l))
  81     {
  82       if (keyreq_l_)
  83         warning (_ ("FIXME: key change merge"));
  84       keyreq_l_ = kc;
  85       read_req (keyreq_l_);
  86       return true;
  87     }
  88   return  false;
  89 }
  90
  91 void
  92 Key_engraver::acknowledge_element (Score_element_info info)
  93 {
  94   if (dynamic_cast <Clef_change_req *> (info.req_l_))
  95     {
  96       SCM c =  get_property ("createKeyOnClefChange");
  97       if (to_boolean (c))
  98         {
  99           create_key (false);
 100
 101         }
 102     }
 103   else if (dynamic_cast<Bar *> (info.elem_l_)
 104            && accidental_idx_arr_.size ())
 105     {
 106       create_key (true);
 107     }
 108
 109 }
 110
 111 void
 112 Key_engraver::do_process_music ()
 113 {
 114   if (keyreq_l_)
 115     {
 116       create_key (false);
 117     }
 118 }
 119
 120 void
 121 Key_engraver::do_pre_move_processing ()
 122 {
 123   if (item_p_)
 124     {
 125       typeset_element (item_p_);
 126       item_p_ = 0;
 127     }
 128 }
 129
 130
 131 /*
 132   TODO.  Use properties; and this is too hairy.
 133  */
 134 void
 135 Key_engraver::read_req (Key_change_req const * r)
 136 {
 137   if (!r->key_)
 138     return;
 139
 140   old_accidental_idx_arr_ = accidental_idx_arr_;
 141   key_.clear ();
 142   SCM prop = get_property ("keyOctaviation");
 143
 144   key_.multi_octave_b_ = to_boolean (prop);
 145
 146   accidental_idx_arr_.clear ();
 147
 148   if (r->key_->ordinary_key_b_)
 149     {
 150       int no_of_acc = r->key_->ordinary_accidentals_i ();
 151
 152       // Hmm, can't these be handled/constructed by Key_change_req?
 153       if (no_of_acc < 0)
 154         {
 155           int accidental = 6 ; // First accidental: bes
 156           for ( ; no_of_acc < 0 ; no_of_acc++ )
 157             {
 158               Musical_pitch m;
 159               m.accidental_i_ = -1;
 160               m.notename_i_ = accidental;
 161               if (key_.multi_octave_b_)
 162                 key_.set (m);
 163               else
 164                 key_.set (m.notename_i_, m.accidental_i_);
 165               accidental_idx_arr_.push (m);
 166
 167               accidental = (accidental + 3) % 7 ;
 168             }
 169         }
 170       else
 171         {
 172           int accidental = 3 ; // First accidental: fis
 173           for ( ; no_of_acc > 0 ; no_of_acc-- )
 174             {
 175               Musical_pitch m;
 176               m.accidental_i_ = 1;
 177               m.notename_i_ = accidental;
 178               if (key_.multi_octave_b_)
 179                 key_.set (m);
 180               else
 181                 key_.set (m.notename_i_, m.accidental_i_);
 182               accidental_idx_arr_.push (m);
 183
 184               accidental = (accidental + 4) % 7 ;
 185             }
 186         }
 187     }
 188   else // Special key
 189     {
 190       for (int i = 0; i < r->key_->pitch_arr_.size (); i ++)
 191         {
 192           Musical_pitch m_l =r->key_->pitch_arr_[i];
 193           if (key_.multi_octave_b_)
 194             key_.set (m_l);
 195           else
 196             key_.set (m_l.notename_i_, m_l.accidental_i_);
 197
 198           accidental_idx_arr_.push (m_l);
 199         }
 200     }
 201 }
 202
 203 void
 204 Key_engraver::do_post_move_processing ()
 205 {
 206   keyreq_l_ = 0;
 207   old_accidental_idx_arr_.clear ();
 208 }
 209
 210 ADD_THIS_TRANSLATOR (Key_engraver);
 211