3 clef-engraver.cc -- implement Clef_engraver
5 source file of the GNU LilyPond music typesetter
7 (c) 1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>,
9 Mats Bengtsson <matsb@s3.kth.se>
14 #include "translator-group.hh"
15 #include "key-item.hh"
16 #include "local-key-item.hh"
18 #include "note-head.hh"
19 #include "staff-symbol-referencer.hh"
21 #include "command-request.hh"
22 #include "engraver.hh"
23 #include "direction.hh"
24 #include "side-position-interface.hh"
27 /// where is c-0 in the staff?
28 class Clef_engraver : public Engraver
32 Clef_change_req * clef_req_l_;
35 bool set_type (String);
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);
44 VIRTUAL_COPY_CONS(Translator);
48 Direction octave_dir_;
49 SCM clef_glyph_; // no need for protection. Always referenced somewhere else.
57 Clef_engraver::Clef_engraver()
60 clef_glyph_ = SCM_EOL;
70 Clef_engraver::set_type (String s)
72 if (s.right_str(2) == "_8") // Down one octave
75 s = s.left_str(s.length_i() - 2);
77 else if (s.right_str(2) == "^8") // Up one octave
80 s = s.left_str(s.length_i() - 2);
85 SCM c = get_property ("supportedClefTypes");
86 SCM p = get_property ("clefPitches");
90 SCM found = scm_assoc (ly_str02scm (s.ch_C()), c);
91 if (found == SCM_BOOL_F)
94 clef_glyph_ = gh_cadr (found);
95 SCM pos = gh_caddr (found);
97 clef_position_i_ = gh_scm2int (pos);
99 found = scm_assoc (clef_glyph_, p);
100 if (found == SCM_BOOL_F)
103 c0_position_i_ = clef_position_i_ + gh_scm2int (gh_cdr (found));
106 c0_position_i_ -= (int) octave_dir_ * 7;
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_));
120 Generate a clef at the start of a measure. (when you see a Bar,
124 Clef_engraver::acknowledge_element (Score_element_info info)
126 Item * item =dynamic_cast <Item *> (info.elem_l_);
129 if (Bar::has_interface (info.elem_l_)
130 && gh_string_p (clef_glyph_))
134 if (Note_head::has_interface (item)
135 || Local_key_item::has_interface (item))
137 int p = int (Staff_symbol_referencer::position_f (item)) + c0_position_i_;
138 Staff_symbol_referencer::set_position (item,p);
141 else if (Key_item::has_interface (item))
143 item->set_elt_property ("c0-position", gh_int2scm (c0_position_i_));
149 Clef_engraver::do_creation_processing()
151 SCM def = get_property ("defaultClef");
152 if (gh_string_p (def))
154 set_type (ly_scm2string (def));
159 Clef_engraver::do_try_music (Music * r_l)
161 if (Clef_change_req *cl = dynamic_cast <Clef_change_req *> (r_l))
164 if (!set_type (cl->clef_str_))
165 cl->origin ()->warning (_ ("unknown clef type"));
175 Clef_engraver::create_clef()
179 Item *c= new Item (get_property ("basicClefItemProperties"));
180 announce_element (c, clef_req_l_);
182 Staff_symbol_referencer::set_interface (c);
186 Staff_symbol_referencer::set_position(clef_p_, clef_position_i_);
189 Item * g = new Item (get_property ("basicOctavateEightProperties"));
190 Side_position::set_axis (g,Y_AXIS);
191 Side_position::add_support (g,clef_p_);
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_));
199 announce_element (octavate_p_, clef_req_l_);
205 Clef_engraver::do_process_music()
207 if (clef_req_l_ || first_b_)
210 clef_p_->set_elt_property ("non-default", SCM_BOOL_T);
215 Clef_engraver::do_pre_move_processing()
220 if(to_boolean (clef_p_->get_elt_property("non-default")))
222 vis = get_property ("explicitClefVisibility");
227 clef_p_->set_elt_property("visibility-lambda", vis);
229 octavate_p_->set_elt_property("visibility-lambda", vis);
232 typeset_element (clef_p_);
236 typeset_element(octavate_p_);
245 Clef_engraver::do_post_move_processing()
250 ADD_THIS_TRANSLATOR(Clef_engraver);