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--1999 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   item_p_ = 0;
  21   do_post_move_processing ();
  22 }
  23
  24 void
  25 Key_engraver::create_key ()
  26 {
  27   if (!item_p_)
  28     {
  29       item_p_ = new Key_item;
  30       item_p_->set_elt_property (break_priority_scm_sym, gh_int2scm(-1)); // ugh
  31       item_p_->multi_octave_b_ = key_.multi_octave_b_;
  32       announce_element (Score_element_info (item_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             item_p_->add (m_l.steps (), a);
  41           else
  42             item_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             item_p_->add_old (m_l.steps  (), a);
  51           else
  52             item_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", 0).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       bool def =  (!item_p_);
  85       create_key ();
  86       if (def)
  87         {
  88           item_p_->set_elt_property (visibility_lambda_scm_sym,
  89                                     gh_eval_str ("postbreak_only_visibility"));
  90         }
  91     }
  92
  93 }
  94
  95 void
  96 Key_engraver::do_process_requests ()
  97 {
  98   if (keyreq_l_)
  99     {
 100       create_key ();
 101     }
 102 }
 103
 104 void
 105 Key_engraver::do_pre_move_processing ()
 106 {
 107   if (item_p_)
 108     {
 109       typeset_element (item_p_);
 110       item_p_ = 0;
 111     }
 112 }
 113
 114
 115 /*
 116   TODO Slightly hairy.
 117  */
 118 void
 119 Key_engraver::read_req (Key_change_req const * r)
 120 {
 121   old_accidental_idx_arr_ = accidental_idx_arr_;
 122   key_.clear ();
 123   Scalar prop = get_property ("keyoctaviation", 0);
 124   if (prop.length_i () > 0)
 125     {
 126       key_.multi_octave_b_ = ! prop.to_bool ();
 127     }
 128
 129   accidental_idx_arr_.clear ();
 130
 131   if (r->ordinary_key_b_)
 132     {
 133       int p;
 134       if (r->pitch_arr_.size () < 1)
 135         {
 136           r->warning (_ ("No key name: assuming `C'"));
 137           p = 0;
 138         }
 139       else
 140         {
 141           p = r->pitch_arr_[0].semitone_pitch ();
 142           p += r->modality_i_;
 143         }
 144       /* Solve the equation 7*no_of_acc mod 12 = p, -6 <= no_of_acc <= 5 */
 145       int no_of_acc = (7*p) % 12;
 146       no_of_acc = (no_of_acc + 18) % 12 -6;
 147
 148       /* Correct from flats to sharps or vice versa */
 149       if (no_of_acc * r->pitch_arr_[0].accidental_i_ < 0)
 150         no_of_acc += 12 * sign (r->pitch_arr_[0].accidental_i_);
 151
 152       if (no_of_acc < 0)
 153         {
 154           int accidental = 6 ; // First accidental: bes
 155           for ( ; no_of_acc < 0 ; no_of_acc++ )
 156             {
 157               Musical_pitch m;
 158               m.accidental_i_ = -1;
 159               m.notename_i_ = accidental;
 160               if (key_.multi_octave_b_)
 161                 key_.set (m);
 162               else
 163                 key_.set (m.notename_i_, m.accidental_i_);
 164               accidental_idx_arr_.push (m);
 165
 166               accidental = (accidental + 3) % 7 ;
 167             }
 168         }
 169       else
 170         {
 171           int accidental = 3 ; // First accidental: fis
 172           for ( ; no_of_acc > 0 ; no_of_acc-- )
 173             {
 174               Musical_pitch m;
 175               m.accidental_i_ = 1;
 176               m.notename_i_ = accidental;
 177               if (key_.multi_octave_b_)
 178                 key_.set (m);
 179               else
 180                 key_.set (m.notename_i_, m.accidental_i_);
 181               accidental_idx_arr_.push (m);
 182
 183               accidental = (accidental + 4) % 7 ;
 184             }
 185         }
 186     }
 187   else // Special key
 188     {
 189       for (int i = 0; i < r->pitch_arr_.size (); i ++)
 190         {
 191           Musical_pitch m_l =r->pitch_arr_[i];
 192           if (key_.multi_octave_b_)
 193             key_.set (m_l);
 194           else
 195             key_.set (m_l.notename_i_, m_l.accidental_i_);
 196
 197           accidental_idx_arr_.push (m_l);
 198         }
 199     }
 200 }
 201
 202 void
 203 Key_engraver::do_post_move_processing ()
 204 {
 205   keyreq_l_ = 0;
 206   old_accidental_idx_arr_.clear ();
 207 }
 208
 209
 210
 211 ADD_THIS_TRANSLATOR (Key_engraver);
 212