2 clef-engraver.cc -- implement Clef_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>,
8 Mats Bengtsson <matsb@s3.kth.se>
13 #include "translator-group.hh"
14 #include "key-item.hh"
16 #include "staff-symbol-referencer.hh"
18 #include "engraver.hh"
19 #include "direction.hh"
20 #include "side-position-interface.hh"
24 class Clef_engraver : public Engraver
27 VIRTUAL_COPY_CONS (Translator);
30 Direction octave_dir_;
33 virtual void stop_translation_timestep ();
34 virtual void start_translation_timestep ();
35 virtual void process_music ();
36 virtual void acknowledge_grob (Grob_info);
37 virtual void do_creation_processing ();
47 void inspect_clef_properties ();
50 Clef_engraver::Clef_engraver ()
57 will trigger a clef at the start since #f != ' ()
59 prev_cpos_ = prev_glyph_ = SCM_BOOL_F;
63 Clef_engraver::set_glyph ()
65 SCM glyph_sym = ly_symbol2scm ("glyph-name");
66 SCM glyph = get_property ("clefGlyph");
68 SCM basic = ly_symbol2scm ("Clef");
70 daddy_trans_l_->execute_single_pushpop_property (basic, glyph_sym, SCM_UNDEFINED);
71 daddy_trans_l_->execute_single_pushpop_property (basic, glyph_sym, glyph);
75 Generate a clef at the start of a measure. (when you see a Bar,
79 Clef_engraver::acknowledge_grob (Grob_info info)
81 Item * item =dynamic_cast <Item *> (info.elem_l_);
84 if (Bar::has_interface (info.elem_l_)
85 && gh_string_p (get_property ("clefGlyph")))
88 if (Key_item::has_interface (item))
91 Key_item adapts its formatting to make sure that the
92 accidentals stay in the upper half of the staff. It needs
93 to know c0-pos for this. (?)
96 item->set_grob_property ("c0-position", get_property ("centralCPosition"));
102 Clef_engraver::create_clef ()
106 Item *c= new Item (get_property ("Clef"));
107 announce_grob (c, 0);
109 Staff_symbol_referencer::set_interface (c);
113 Staff_symbol_referencer::set_position (clef_p_,
114 gh_scm2int (get_property ("clefPosition")));
116 SCM oct = get_property ("clefOctavation");
117 if (gh_number_p (oct) && gh_scm2int (oct))
119 Item * g = new Item (get_property ("OctavateEight"));
121 Side_position_interface::add_support (g,clef_p_);
123 g->set_parent (clef_p_, Y_AXIS);
124 g->set_parent (clef_p_, X_AXIS);
126 g->set_grob_property ("direction", gh_int2scm (sign (gh_scm2int (oct))));
128 announce_grob (octavate_p_, 0);
133 Clef_engraver::process_music ()
135 inspect_clef_properties ();
139 this must be done in creation_proc() since grace notes will be
140 processed before Clef_engraver::prcoess_music()
142 Grace notes and clef changes are still broken.
145 Clef_engraver::do_creation_processing ()
147 inspect_clef_properties ();
151 Clef_engraver::inspect_clef_properties ()
153 SCM glyph = get_property ("clefGlyph");
154 SCM clefpos = get_property ("clefPosition");
155 SCM octavation = get_property ("clefOctavation");
156 SCM force_clef = get_property ("forceClef");
158 if (clefpos == SCM_EOL
159 || scm_equal_p (glyph, prev_glyph_) == SCM_BOOL_F
160 || scm_equal_p (clefpos, prev_cpos_) == SCM_BOOL_F
161 || scm_equal_p (octavation, prev_octavation_) == SCM_BOOL_F
162 || to_boolean (force_clef)
168 clef_p_->set_grob_property ("non-default", SCM_BOOL_T);
170 prev_cpos_ = clefpos;
172 prev_octavation_ = octavation;
175 if (to_boolean (force_clef))
177 Translator_group * w = daddy_trans_l_->where_defined (ly_symbol2scm ("forceClef"));
178 w->set_property ("forceClef", SCM_EOL);
184 Clef_engraver::stop_translation_timestep ()
189 if (to_boolean (clef_p_->get_grob_property ("non-default")))
191 vis = get_property ("explicitClefVisibility");
196 clef_p_->set_grob_property ("visibility-lambda", vis);
198 octavate_p_->set_grob_property ("visibility-lambda", vis);
201 typeset_grob (clef_p_);
205 typeset_grob (octavate_p_);
212 Clef_engraver::start_translation_timestep ()
216 ADD_THIS_TRANSLATOR (Clef_engraver);