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--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       kit_p_->multi_octave_b_ = key_.multi_octave_b_;
  32       announce_element (Score_element_info (kit_p_,keyreq_l_));
  33
  34
  35       for (int i = 0; i < accidental_idx_arr_.size(); i++)
  36         {
  37           Musical_pitch m_l =accidental_idx_arr_[i];
  38           int a =m_l.accidental_i_;
  39           if (key_.multi_octave_b_)
  40             kit_p_->add (m_l.steps (), a);
  41           else
  42             kit_p_->add (m_l.notename_i_, a);
  43         }
  44
  45       for (int i = 0 ; i< old_accidental_idx_arr_.size(); i++)
  46         {
  47           Musical_pitch m_l =old_accidental_idx_arr_[i];
  48           int a =m_l.accidental_i_;
  49           if (key_.multi_octave_b_)
  50             kit_p_->add_old (m_l.steps  (), a);
  51           else
  52             kit_p_->add_old (m_l.notename_i_, a);
  53         }
  54     }
  55 }
  56
  57
  58 bool
  59 Key_engraver::do_try_music (Music * req_l)
  60 {
  61   if (Key_change_req *kc = dynamic_cast <Key_change_req *> (req_l))
  62     {
  63       if (keyreq_l_)
  64         warning ("Fixme: key change merge.");
  65       keyreq_l_ = kc;
  66       read_req (keyreq_l_);
  67       return true;
  68     }
  69   return  false;
  70 }
  71
  72 void
  73 Key_engraver::acknowledge_element (Score_element_info info)
  74 {
  75   if (dynamic_cast <Clef_change_req *> (info.req_l_))
  76     {
  77       int i= get_property ("createKeyOnClefChange").length_i ();
  78       if (i)
  79         create_key ();
  80     }
  81   else if (dynamic_cast<Bar *> (info.elem_l_)
  82            && accidental_idx_arr_.size ())
  83     {
  84       if (!keyreq_l_)
  85         default_key_b_ = true;
  86       create_key ();
  87     }
  88
  89 }
  90
  91 void
  92 Key_engraver::do_process_requests ()
  93 {
  94   if (keyreq_l_)
  95     {
  96       create_key ();
  97     }
  98 }
  99
 100 void
 101 Key_engraver::do_pre_move_processing ()
 102 {
 103   if (kit_p_)
 104     {
 105       kit_p_->default_b_ = default_key_b_;
 106       typeset_element (kit_p_);
 107       kit_p_ = 0;
 108     }
 109 }
 110
 111
 112 /*
 113   TODO Slightly hairy.
 114  */
 115 void
 116 Key_engraver::read_req (Key_change_req const * r)
 117 {
 118   old_accidental_idx_arr_ = accidental_idx_arr_;
 119   key_.clear ();
 120   Scalar prop = get_property ("keyoctaviation");
 121   if (prop.length_i () > 0)
 122     {
 123       key_.multi_octave_b_ = ! prop.to_bool ();
 124     }
 125
 126   accidental_idx_arr_.clear ();
 127
 128   if (r->ordinary_key_b_)
 129     {
 130       int p;
 131       if (r->pitch_arr_.size () < 1)
 132         {
 133           r->warning (_ ("No key name: assuming `C'"));
 134           p = 0;
 135         }
 136       else
 137         {
 138           p = r->pitch_arr_[0].semitone_pitch ();
 139           p += r->modality_i_;
 140         }
 141       /* Solve the equation 7*no_of_acc mod 12 = p, -6 <= no_of_acc <= 5 */
 142       int no_of_acc = (7*p) % 12;
 143       no_of_acc = (no_of_acc + 18) % 12 -6;
 144
 145       /* Correct from flats to sharps or vice versa */
 146       if (no_of_acc * r->pitch_arr_[0].accidental_i_ < 0)
 147         no_of_acc += 12 * sign (r->pitch_arr_[0].accidental_i_);
 148
 149       if (no_of_acc < 0)
 150         {
 151           int accidental = 6 ; // First accidental: bes
 152           for ( ; no_of_acc < 0 ; no_of_acc++ )
 153             {
 154               Musical_pitch m;
 155               m.accidental_i_ = -1;
 156               m.notename_i_ = accidental;
 157               if (key_.multi_octave_b_)
 158                 key_.set (m);
 159               else
 160                 key_.set (m.notename_i_, m.accidental_i_);
 161               accidental_idx_arr_.push (m);
 162
 163               accidental = (accidental + 3) % 7 ;
 164             }
 165         }
 166       else
 167         {
 168           int accidental = 3 ; // First accidental: fis
 169           for ( ; no_of_acc > 0 ; no_of_acc-- )
 170             {
 171               Musical_pitch m;
 172               m.accidental_i_ = 1;
 173               m.notename_i_ = accidental;
 174               if (key_.multi_octave_b_)
 175                 key_.set (m);
 176               else
 177                 key_.set (m.notename_i_, m.accidental_i_);
 178               accidental_idx_arr_.push (m);
 179
 180               accidental = (accidental + 4) % 7 ;
 181             }
 182         }
 183     }
 184   else // Special key
 185     {
 186       for (int i = 0; i < r->pitch_arr_.size (); i ++)
 187         {
 188           Musical_pitch m_l =r->pitch_arr_[i];
 189           if (key_.multi_octave_b_)
 190             key_.set (m_l);
 191           else
 192             key_.set (m_l.notename_i_, m_l.accidental_i_);
 193
 194           accidental_idx_arr_.push (m_l);
 195         }
 196     }
 197 }
 198
 199 void
 200 Key_engraver::do_post_move_processing ()
 201 {
 202   keyreq_l_ = 0;
 203   default_key_b_ = false;
 204   old_accidental_idx_arr_.clear ();
 205 }
 206
 207
 208
 209 ADD_THIS_TRANSLATOR (Key_engraver);
 210