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 virtual void stop_translation_timestep ();
37 virtual void start_translation_timestep ();
38 virtual void create_grobs ();
39 virtual void acknowledge_grob (Grob_info);
49 void set_central_c (SCM, SCM, SCM);
53 Clef_engraver::Clef_engraver ()
60 will trigger a clef at the start since #f != '()
62 prev_cpos_ = prev_glyph_ = SCM_BOOL_F;
66 Clef_engraver::set_central_c (SCM glyph,SCM clefpos, SCM octavation)
70 prev_octavation_ = octavation;
72 SCM p = get_property ("clefPitches");
76 SCM found = scm_assoc (glyph, p);
77 if (found == SCM_BOOL_F)
83 c0_position = gh_scm2int (gh_cdr (found));
85 if (gh_number_p (octavation))
86 c0_position -= gh_scm2int (octavation);
88 if (gh_number_p (clefpos))
89 c0_position += gh_scm2int (clefpos);
93 daddy_trans_l_->set_property ("centralCPosition", gh_int2scm (c0_position));
97 Clef_engraver::set_glyph ()
99 SCM glyph_sym = ly_symbol2scm ("glyph-name");
100 SCM glyph = get_property ("clefGlyph");
102 SCM basic = ly_symbol2scm ("Clef");
104 daddy_trans_l_->execute_single_pushpop_property (basic, glyph_sym, SCM_UNDEFINED);
105 daddy_trans_l_->execute_single_pushpop_property (basic, glyph_sym, glyph);
109 Generate a clef at the start of a measure. (when you see a Bar,
113 Clef_engraver::acknowledge_grob (Grob_info info)
116 Item * item =dynamic_cast <Item *> (info.elem_l_);
119 if (Bar::has_interface (info.elem_l_)
120 && gh_string_p (get_property ("clefGlyph")))
124 if (Note_head::has_interface (item)
125 || Local_key_item::has_interface (item)
126 || Custos::has_interface (item)
129 int p = int (Staff_symbol_referencer::position_f (item))
130 + gh_scm2int (get_property ("centralCPosition"));
131 Staff_symbol_referencer::set_position (item, p);
133 else if (Key_item::has_interface (item))
136 Key_item adapts its formatting to make sure that the
137 accidentals stay in the upper half of the staff. It needs
138 to know c0-pos for this. (?)
141 item->set_grob_property ("c0-position", get_property ("centralCPosition"));
147 Clef_engraver::create_clef ()
151 Item *c= new Item (get_property ("Clef"));
152 announce_grob (c, 0);
154 Staff_symbol_referencer::set_interface (c);
158 Staff_symbol_referencer::set_position (clef_p_,
159 gh_scm2int (get_property ("clefPosition")));
161 SCM oct = get_property("clefOctavation");
162 if (gh_number_p (oct) && gh_scm2int (oct))
164 Item * g = new Item (get_property ("OctavateEight"));
166 Side_position::add_support (g,clef_p_);
168 g->set_parent (clef_p_, Y_AXIS);
169 g->set_parent (clef_p_, X_AXIS);
171 g->set_grob_property ("direction", gh_int2scm (sign (gh_scm2int (oct))));
173 announce_grob (octavate_p_, 0);
178 Clef_engraver::create_grobs ()
180 SCM glyph = get_property ("clefGlyph");
181 SCM clefpos = get_property ("clefPosition");
182 SCM octavation = get_property ("clefOctavation");
183 SCM force_clef = get_property ("forceClef");
185 if (clefpos == SCM_EOL
186 || scm_equal_p (glyph, prev_glyph_) == SCM_BOOL_F
187 || scm_equal_p (clefpos, prev_cpos_) == SCM_BOOL_F
188 || scm_equal_p (octavation, prev_octavation_) == SCM_BOOL_F
189 || to_boolean (force_clef)
193 set_central_c (glyph, clefpos, octavation);
197 clef_p_->set_grob_property ("non-default", SCM_BOOL_T);
200 if (to_boolean (force_clef))
202 Translator_group * w = daddy_trans_l_->where_defined (ly_symbol2scm ("forceClef"));
203 w->set_property ("forceClef", SCM_EOL);
208 Clef_engraver::stop_translation_timestep ()
213 if (to_boolean (clef_p_->get_grob_property ("non-default")))
215 vis = get_property ("explicitClefVisibility");
220 clef_p_->set_grob_property ("visibility-lambda", vis);
222 octavate_p_->set_grob_property ("visibility-lambda", vis);
225 typeset_grob (clef_p_);
229 typeset_grob (octavate_p_);
236 Clef_engraver::start_translation_timestep ()
240 ADD_THIS_TRANSLATOR (Clef_engraver);