lily/clef-engraver.cc

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