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--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7   */
   8
   9 #include "key-item.hh"
  10 #include "command-request.hh"
  11 #include "musical-request.hh"
  12 #include "item.hh"
  13 #include "bar.hh"
  14 #include "timing-translator.hh"
  15 #include "staff-symbol-referencer.hh"
  16 #include "translator-group.hh"
  17 #include "engraver.hh"
  18 #include "pitch.hh"
  19 #include "protected-scm.hh"
  20 #include "clef.hh"
  21
  22 /**
  23   Make the key signature.
  24  */
  25 class Key_engraver : public Engraver
  26 {
  27   void create_key(bool);
  28   void read_req (Key_change_req const * r);
  29
  30 public:
  31   Key_engraver();
  32
  33   VIRTUAL_COPY_CONS(Translator);
  34
  35   Key_change_req * keyreq_l_;
  36   Item * item_p_;
  37   Protected_scm old_accs_;      // ugh. -> property
  38
  39 protected:
  40   virtual void do_creation_processing();
  41   virtual void do_removal_processing ();
  42   virtual bool do_try_music (Music *req_l);
  43   void deprecated_process_music();
  44   virtual void do_pre_move_processing();
  45   virtual void do_post_move_processing();
  46   virtual void process_acknowledged ();
  47   virtual void acknowledge_element (Score_element_info);
  48 };
  49
  50
  51 void
  52 Key_engraver::do_removal_processing ()
  53 {
  54   old_accs_ = SCM_EOL;          // unprotect can not  be called from dtor.
  55 }
  56
  57 Key_engraver::Key_engraver ()
  58 {
  59   keyreq_l_ = 0;
  60   item_p_ = 0;
  61 }
  62
  63 void
  64 Key_engraver::create_key (bool def)
  65 {
  66   if (!item_p_)
  67     {
  68       item_p_ = new Item (get_property ("KeySignature"));
  69
  70       item_p_->set_elt_property ("c0-position", gh_int2scm (0));
  71
  72       // todo: put this in basic props.
  73       item_p_->set_elt_property ("old-accidentals", old_accs_);
  74       item_p_->set_elt_property ("new-accidentals", get_property ("keySignature"));
  75
  76       Staff_symbol_referencer::set_interface (item_p_);
  77       Key_item::set_interface (item_p_);
  78
  79       SCM prop = get_property ("keyOctaviation");
  80       bool multi = to_boolean (prop);
  81
  82       if (multi)
  83         item_p_->set_elt_property ("multi-octave", gh_bool2scm (multi));
  84
  85       announce_element (item_p_,keyreq_l_);
  86     }
  87
  88
  89   if (!def)
  90     {
  91       SCM vis = get_property ("explicitKeySignatureVisibility");
  92       if (gh_procedure_p (vis))
  93         item_p_->set_elt_property ("visibility-lambda",vis);
  94     }
  95 }
  96
  97
  98 bool
  99 Key_engraver::do_try_music (Music * req_l)
 100 {
 101   if (Key_change_req *kc = dynamic_cast <Key_change_req *> (req_l))
 102     {
 103       if (keyreq_l_)
 104         warning (_ ("FIXME: key change merge"));
 105       keyreq_l_ = kc;
 106       read_req (keyreq_l_);
 107       return true;
 108     }
 109   return  false;
 110 }
 111
 112 void
 113 Key_engraver::acknowledge_element (Score_element_info info)
 114 {
 115   if (Clef::has_interface (info.elem_l_))
 116     {
 117       SCM c =  get_property ("createKeyOnClefChange");
 118       if (to_boolean (c))
 119         {
 120           create_key (false);
 121         }
 122     }
 123   else if (Bar::has_interface (info.elem_l_)
 124            && gh_pair_p (get_property ("keySignature")))
 125     {
 126       create_key (true);
 127     }
 128
 129 }
 130
 131 void
 132 Key_engraver::process_acknowledged ()
 133 {
 134   deprecated_process_music ();
 135 }
 136
 137 void
 138 Key_engraver::deprecated_process_music ()
 139 {
 140   if (keyreq_l_ || old_accs_ != get_property ("keySignature"))
 141     {
 142       create_key (false);
 143     }
 144 }
 145
 146 void
 147 Key_engraver::do_pre_move_processing ()
 148 {
 149   if (item_p_)
 150     {
 151       typeset_element (item_p_);
 152       item_p_ = 0;
 153     }
 154 }
 155
 156 void
 157 Key_engraver::read_req (Key_change_req const * r)
 158 {
 159   SCM p = r->get_mus_property ("pitch-alist");
 160   if (!gh_pair_p (p))
 161     return;
 162
 163   SCM n = scm_list_copy (p);
 164   SCM accs = SCM_EOL;
 165   for (SCM s = get_property ("keyAccidentalOrder");
 166        gh_pair_p (s); s = gh_cdr (s))
 167     {
 168       if (gh_pair_p (scm_member (gh_car (s), n)))
 169         {
 170           accs = gh_cons (gh_car (s), accs);
 171           n = scm_delete_x (gh_car (s), n);
 172         }
 173     }
 174   for (SCM s = n ; gh_pair_p (s); s = gh_cdr (s))
 175     if (gh_scm2int (gh_cdar (s)))
 176       accs = gh_cons (gh_car (s), accs);
 177
 178   old_accs_ = get_property ("keySignature");
 179   daddy_trans_l_->set_property ("keySignature", accs);
 180 }
 181
 182 void
 183 Key_engraver::do_post_move_processing ()
 184 {
 185   keyreq_l_ = 0;
 186   old_accs_ = get_property ("keySignature");
 187 }
 188
 189 void
 190 Key_engraver::do_creation_processing ()
 191 {
 192   daddy_trans_l_->set_property ("keySignature", SCM_EOL);
 193   old_accs_ = SCM_EOL;
 194 }
 195
 196
 197 ADD_THIS_TRANSLATOR (Key_engraver);
 198