lily/clef-engraver.cc

   1 /*
   2   clef-engraver.cc -- implement Clef_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   Mats Bengtsson <matsb@s3.kth.se>
   9 */
  10
  11 #include <ctype.h>
  12
  13 #include "staff-symbol-referencer.hh"
  14 #include "debug.hh"
  15 #include "command-request.hh"
  16 #include "array.hh"
  17 #include "engraver.hh"
  18 #include "direction.hh"
  19 #include "side-position-interface.hh"
  20 #include "item.hh"
  21
  22 /// where is c-0 in the staff?
  23 class Clef_engraver : public  Engraver {
  24   Item * clef_p_;
  25   Item * octavate_p_;
  26   Clef_change_req * clef_req_l_;
  27
  28   void create_clef();
  29   bool set_type (String);
  30 protected:
  31   virtual void do_process_music();
  32   virtual void do_pre_move_processing();
  33   virtual void do_creation_processing();
  34   virtual void do_post_move_processing();
  35   virtual bool do_try_music (Music*);
  36   virtual void acknowledge_element (Score_element_info);
  37 public:
  38   VIRTUAL_COPY_CONS(Translator);
  39   int c0_position_i_;
  40   int clef_position_i_;
  41                                 // junkme.
  42   Direction octave_dir_;
  43   SCM clef_glyph_;              // no need for protection. Always referenced somewhere else.
  44
  45   Clef_engraver();
  46
  47   bool  first_b_;
  48
  49   Protected_scm current_settings_;
  50 };
  51
  52
  53 Clef_engraver::Clef_engraver()
  54 {
  55   current_settings_ = SCM_EOL;
  56
  57   first_b_ = true;
  58   clef_glyph_ = SCM_EOL;
  59   clef_p_ = 0;
  60   clef_req_l_ = 0;
  61   c0_position_i_ = 0;
  62   clef_position_i_ = 0;
  63   octave_dir_ = CENTER;
  64   octavate_p_ = 0;
  65 }
  66
  67 bool
  68 Clef_engraver::set_type (String s)
  69 {
  70   if (s.right_str(2) == "_8") // Down one octave
  71     {
  72       octave_dir_ = DOWN;
  73       s = s.left_str(s.length_i() - 2);
  74     }
  75   else if (s.right_str(2) == "^8") // Up one octave
  76     {
  77       octave_dir_ = UP;
  78       s = s.left_str(s.length_i() - 2);
  79     }
  80   else
  81     octave_dir_ = CENTER;
  82
  83   SCM c = get_property ("supportedClefTypes");
  84   SCM p = get_property ("clefPitches");
  85
  86   if (gh_list_p (c))
  87     {
  88       SCM found = scm_assoc (ly_str02scm (s.ch_C()), c);
  89       if (found == SCM_BOOL_F)
  90         return false;
  91
  92       clef_glyph_  = gh_cadr (found);
  93       SCM pos  = gh_caddr (found);
  94
  95       clef_position_i_ = gh_scm2int (pos);
  96
  97       found = scm_assoc (clef_glyph_, p);
  98       if (found == SCM_BOOL_F)
  99         return false;
 100
 101       c0_position_i_ = clef_position_i_ + gh_scm2int (gh_cdr (found));
 102     }
 103
 104   c0_position_i_ -= (int) octave_dir_ * 7;
 105
 106   SCM basic = get_property ("basicClefItemProperties");
 107   current_settings_ = gh_cons (gh_cons (ly_symbol2scm ("glyph"), clef_glyph_), basic);
 108   current_settings_ =
 109     gh_cons (gh_cons (ly_symbol2scm ("c0-position"),
 110                       gh_int2scm (c0_position_i_)),
 111              current_settings_);
 112
 113   return true;
 114 }
 115
 116 /**
 117   Generate a clef at the start of a measure. (when you see a Bar,
 118   ie. a breakpoint)
 119   */
 120 void
 121 Clef_engraver::acknowledge_element (Score_element_info info)
 122 {
 123   Item * item =dynamic_cast <Item *> (info.elem_l_);
 124   if (item)
 125     {
 126       if (to_boolean (info.elem_l_->get_elt_property ("bar-interface"))
 127           && gh_string_p (clef_glyph_))
 128         create_clef();
 129
 130
 131       if (to_boolean (item->get_elt_property("note-head-interface"))
 132           || to_boolean (item->get_elt_property ("accidentals-interface")))
 133         {
 134           Staff_symbol_referencer_interface si (item);
 135           si.set_position (int (si.position_f ()) + c0_position_i_);
 136         }
 137       else if (to_boolean (item->get_elt_property ("key-item-interface")))
 138         {
 139           item->set_elt_property ("c0-position", gh_int2scm (c0_position_i_));
 140         }
 141     }
 142 }
 143
 144 void
 145 Clef_engraver::do_creation_processing()
 146 {
 147   SCM def = get_property ("defaultClef");
 148   if (gh_string_p (def))
 149     {
 150       set_type (ly_scm2string (def));
 151     }
 152 }
 153
 154 bool
 155 Clef_engraver::do_try_music (Music * r_l)
 156 {
 157   if (Clef_change_req *cl = dynamic_cast <Clef_change_req *> (r_l))
 158     {
 159       clef_req_l_ = cl;
 160       if (!set_type (cl->clef_str_))
 161         cl->error (_ ("unknown clef type"));
 162
 163       return true;
 164     }
 165   else
 166     return false;
 167
 168 }
 169
 170 void
 171 Clef_engraver::create_clef()
 172 {
 173   if (!clef_p_)
 174     {
 175       Item *c= new Item ( current_settings_);
 176       announce_element (Score_element_info (c, clef_req_l_));
 177
 178       Staff_symbol_referencer_interface::set_interface (c);
 179
 180       clef_p_ = c;
 181     }
 182   Staff_symbol_referencer_interface si(clef_p_);
 183
 184   si.set_position (clef_position_i_);
 185   if (octave_dir_)
 186     {
 187       Item * g = new Item (get_property ("basicOctavateEightProperties"));
 188       Side_position_interface spi (g);
 189       spi.set_axis (Y_AXIS);
 190       spi.add_support (clef_p_);
 191       g->set_parent (clef_p_, Y_AXIS);
 192       g->set_parent (clef_p_, X_AXIS);
 193       g->add_offset_callback (Side_position_interface::aligned_on_self, X_AXIS);
 194       g->add_offset_callback (Side_position_interface::centered_on_parent, X_AXIS);
 195       g->set_elt_property ("direction", gh_int2scm (octave_dir_));
 196       octavate_p_ = g;
 197       announce_element (Score_element_info (octavate_p_, clef_req_l_));
 198     }
 199 }
 200
 201
 202 void
 203 Clef_engraver::do_process_music()
 204 {
 205   if (clef_req_l_ || first_b_)
 206     {
 207       create_clef();
 208       clef_p_->set_elt_property ("non-default", SCM_BOOL_T);
 209     }
 210 }
 211
 212 void
 213 Clef_engraver::do_pre_move_processing()
 214 {
 215   if (clef_p_)
 216     {
 217       SCM vis = 0;
 218       if(to_boolean (clef_p_->get_elt_property("non-default")))
 219         {
 220           vis = ly_symbol2scm ("all-visible");
 221           vis = scm_eval (vis);
 222         }
 223
 224       if (vis)
 225         {
 226           clef_p_->set_elt_property("visibility-lambda", vis);
 227           if (octavate_p_)
 228             octavate_p_->set_elt_property("visibility-lambda", vis);
 229         }
 230
 231       typeset_element (clef_p_);
 232       clef_p_ =0;
 233
 234       if (octavate_p_)
 235         typeset_element(octavate_p_);
 236
 237       octavate_p_ = 0;
 238     }
 239
 240   first_b_ = 0;
 241 }
 242
 243 void
 244 Clef_engraver::do_post_move_processing()
 245 {
 246   clef_req_l_ = 0;
 247 }
 248
 249 ADD_THIS_TRANSLATOR(Clef_engraver);
 250