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