lily/key-engraver.cc

   1 /*
   2   key-reg.cc -- implement Key_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c)  1997--1998 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7
   8   */
   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 "time-description.hh"
  17
  18 Key_engraver::Key_engraver ()
  19 {
  20   kit_p_ = 0;
  21   do_post_move_processing ();
  22 }
  23
  24 void
  25 Key_engraver::create_key ()
  26 {
  27   if (!kit_p_)
  28     {
  29       kit_p_ = new Key_item;
  30       kit_p_->break_priority_i_ = -1; // ugh
  31       announce_element (Score_element_info (kit_p_,keyreq_l_));
  32       kit_p_->set (key_.multi_octave_b_, accidental_idx_arr_, old_accidental_idx_arr_);
  33     }
  34 }
  35
  36 bool
  37 Key_engraver::do_try_request (Request * req_l)
  38 {
  39   if (Key_change_req *kc = dynamic_cast <Key_change_req *> (req_l))
  40     {
  41       if (keyreq_l_)
  42         warning ("Fixme: key change merge.");
  43       keyreq_l_ = kc;
  44       read_req (keyreq_l_);
  45       return true;
  46     }
  47   return  false;
  48 }
  49
  50 void
  51 Key_engraver::acknowledge_element (Score_element_info info)
  52 {
  53   if (dynamic_cast <Clef_change_req *> (info.req_l_))
  54     {
  55       int i= get_property ("createKeyOnClefChange").length_i ();
  56       if (i)
  57         create_key ();
  58     }
  59   else if (dynamic_cast<Bar *> (info.elem_l_)
  60            && accidental_idx_arr_.size ())
  61     {
  62       if (!keyreq_l_)
  63         default_key_b_ = true;
  64       create_key ();
  65     }
  66
  67 }
  68
  69 void
  70 Key_engraver::do_process_requests ()
  71 {
  72   if (keyreq_l_)
  73     {
  74       create_key ();
  75     }
  76 }
  77
  78 void
  79 Key_engraver::do_pre_move_processing ()
  80 {
  81   if (kit_p_)
  82     {
  83       kit_p_->default_b_ = default_key_b_;
  84       typeset_element (kit_p_);
  85       kit_p_ = 0;
  86     }
  87 }
  88
  89
  90 /*
  91   TODO Slightly hairy.
  92  */
  93 void
  94 Key_engraver::read_req (Key_change_req const * r)
  95 {
  96   old_accidental_idx_arr_ = accidental_idx_arr_;
  97   key_.clear ();
  98   Scalar prop = get_property ("keyoctaviation");
  99   if (prop.length_i () > 0)
 100     {
 101       key_.multi_octave_b_ = ! prop.to_bool ();
 102     }
 103
 104   accidental_idx_arr_.clear ();
 105
 106   if (r->ordinary_key_b_)
 107     {
 108       int p;
 109       if (r->pitch_arr_.size () < 1)
 110         {
 111           r->warning (_ ("No key name: assuming `C'"));
 112           p = 0;
 113         }
 114       else
 115         {
 116           p = r->pitch_arr_[0].semitone_pitch ();
 117           if (r->minor_b ())
 118             p += 3;
 119         }
 120       /* Solve the equation 7*no_of_acc mod 12 = p, -6 <= no_of_acc <= 5 */
 121       int no_of_acc = (7*p) % 12;
 122       no_of_acc = (no_of_acc + 18) % 12 -6;
 123
 124       /* Correct from flats to sharps or vice versa */
 125       if (no_of_acc * r->pitch_arr_[0].accidental_i_ < 0)
 126         no_of_acc += 12 * sign (r->pitch_arr_[0].accidental_i_);
 127
 128       if (no_of_acc < 0)
 129         {
 130           int accidental = 6 ; // First accidental: bes
 131           for ( ; no_of_acc < 0 ; no_of_acc++ )
 132             {
 133               Musical_pitch m;
 134               m.accidental_i_ = -1;
 135               m.notename_i_ = accidental;
 136               if (key_.multi_octave_b_)
 137                 key_.set (m);
 138               else
 139                 key_.set (m.notename_i_, m.accidental_i_);
 140               accidental_idx_arr_.push (m);
 141
 142               accidental = (accidental + 3) % 7 ;
 143             }
 144         }
 145       else
 146         {
 147           int accidental = 3 ; // First accidental: fis
 148           for ( ; no_of_acc > 0 ; no_of_acc-- )
 149             {
 150               Musical_pitch m;
 151               m.accidental_i_ = 1;
 152               m.notename_i_ = accidental;
 153               if (key_.multi_octave_b_)
 154                 key_.set (m);
 155               else
 156                 key_.set (m.notename_i_, m.accidental_i_);
 157               accidental_idx_arr_.push (m);
 158
 159               accidental = (accidental + 4) % 7 ;
 160             }
 161         }
 162     }
 163   else // Special key
 164     {
 165       for (int i = 0; i < r->pitch_arr_.size (); i ++)
 166         {
 167           Musical_pitch m_l =r->pitch_arr_[i];
 168           if (key_.multi_octave_b_)
 169             key_.set (m_l);
 170           else
 171             key_.set (m_l.notename_i_, m_l.accidental_i_);
 172
 173           accidental_idx_arr_.push (m_l);
 174         }
 175     }
 176 }
 177
 178 void
 179 Key_engraver::do_post_move_processing ()
 180 {
 181   keyreq_l_ = 0;
 182   default_key_b_ = false;
 183   old_accidental_idx_arr_.clear ();
 184 }
 185
 186
 187 IMPLEMENT_IS_TYPE_B1 (Key_engraver,Engraver);
 188 ADD_THIS_TRANSLATOR (Key_engraver);
 189