2 clef-engraver.cc -- implement Clef_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>,
8 Mats Bengtsson <matsb@s3.kth.se>
13 #include "translator-group.hh"
14 #include "key-item.hh"
15 #include "local-key-item.hh"
17 #include "note-head.hh"
18 #include "staff-symbol-referencer.hh"
20 #include "engraver.hh"
21 #include "direction.hh"
22 #include "side-position-interface.hh"
26 /// where is c-0 in the staff?
27 class Clef_engraver : public Engraver
30 VIRTUAL_COPY_CONS (Translator);
33 Direction octave_dir_;
36 void deprecated_process_music ();
37 virtual void stop_translation_timestep ();
38 virtual void do_creation_processing ();
39 virtual void start_translation_timestep ();
40 virtual void create_grobs ();
41 virtual void acknowledge_grob (Grob_info);
51 void set_central_c (SCM, SCM, SCM);
55 Clef_engraver::Clef_engraver ()
62 will trigger a clef at the start since #f != '()
64 prev_cpos_ = prev_glyph_ = SCM_BOOL_F;
68 Clef_engraver::set_central_c (SCM glyph,SCM clefpos, SCM octavation)
72 prev_octavation_ = octavation;
74 SCM p = get_property ("clefPitches");
78 SCM found = scm_assoc (glyph, p);
79 if (found == SCM_BOOL_F)
85 c0_position = gh_scm2int (gh_cdr (found));
87 if (gh_number_p (octavation))
88 c0_position -= gh_scm2int (octavation);
90 if (gh_number_p (clefpos))
91 c0_position += gh_scm2int (clefpos);
95 daddy_trans_l_->set_property ("centralCPosition", gh_int2scm (c0_position));
99 Clef_engraver::set_glyph ()
101 SCM glyph_sym = ly_symbol2scm ("glyph");
102 SCM glyph = get_property ("clefGlyph");
104 SCM basic = ly_symbol2scm ("Clef");
106 daddy_trans_l_->execute_single_pushpop_property (basic, glyph_sym, SCM_UNDEFINED);
107 daddy_trans_l_->execute_single_pushpop_property (basic, glyph_sym, glyph);
111 Generate a clef at the start of a measure. (when you see a Bar,
115 Clef_engraver::acknowledge_grob (Grob_info info)
117 deprecated_process_music ();
118 Item * item =dynamic_cast <Item *> (info.elem_l_);
121 if (Bar::has_interface (info.elem_l_)
122 && gh_string_p (get_property ("clefGlyph")))
126 if (Note_head::has_interface (item)
127 || Local_key_item::has_interface (item)
128 || Custos::has_interface (item)
131 int p = int (Staff_symbol_referencer::position_f (item))
132 + gh_scm2int (get_property ("centralCPosition"));
133 Staff_symbol_referencer::set_position (item, p);
135 else if (Key_item::has_interface (item))
138 Key_item adapts its formatting to make sure that the
139 accidentals stay in the upper half of the staff. It needs
140 to know c0-pos for this. (?)
143 item->set_grob_property ("c0-position", get_property ("centralCPosition"));
149 Clef_engraver::do_creation_processing ()
156 Clef_engraver::create_clef ()
160 Item *c= new Item (get_property ("Clef"));
161 announce_grob (c, 0);
163 Staff_symbol_referencer::set_interface (c);
167 Staff_symbol_referencer::set_position (clef_p_,
168 gh_scm2int (get_property ("clefPosition")));
170 SCM oct = get_property("clefOctavation");
171 if (gh_number_p (oct) && gh_scm2int (oct))
173 Item * g = new Item (get_property ("OctavateEight"));
175 Side_position::add_support (g,clef_p_);
177 g->set_parent (clef_p_, Y_AXIS);
178 g->set_parent (clef_p_, X_AXIS);
180 g->set_grob_property ("direction", gh_int2scm (sign (gh_scm2int (oct))));
182 announce_grob (octavate_p_, 0);
187 Clef_engraver::create_grobs ()
189 deprecated_process_music ();
193 Clef_engraver::deprecated_process_music ()
195 SCM glyph = get_property ("clefGlyph");
196 SCM clefpos = get_property ("clefPosition");
197 SCM octavation = get_property ("clefOctavation");
199 if (clefpos == SCM_EOL
200 || scm_equal_p (glyph, prev_glyph_) == SCM_BOOL_F
201 || scm_equal_p (clefpos, prev_cpos_) == SCM_BOOL_F
202 || scm_equal_p (octavation, prev_octavation_) == SCM_BOOL_F)
205 set_central_c (glyph, clefpos, octavation);
209 clef_p_->set_grob_property ("non-default", SCM_BOOL_T);
214 Clef_engraver::stop_translation_timestep ()
219 if (to_boolean (clef_p_->get_grob_property ("non-default")))
221 vis = get_property ("explicitClefVisibility");
226 clef_p_->set_grob_property ("visibility-lambda", vis);
228 octavate_p_->set_grob_property ("visibility-lambda", vis);
231 typeset_grob (clef_p_);
235 typeset_grob (octavate_p_);
242 Clef_engraver::start_translation_timestep ()
246 ADD_THIS_TRANSLATOR (Clef_engraver);