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