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 "key-item.hh"
14 #include "local-key-item.hh"
16 #include "note-head.hh"
17 #include "staff-symbol-referencer.hh"
19 #include "command-request.hh"
21 #include "engraver.hh"
22 #include "direction.hh"
23 #include "side-position-interface.hh"
26 /// where is c-0 in the staff?
27 class Clef_engraver
: public Engraver
{
30 Clef_change_req
* clef_req_l_
;
33 bool set_type (String
);
35 virtual void do_process_music();
36 virtual void do_pre_move_processing();
37 virtual void do_creation_processing();
38 virtual void do_post_move_processing();
39 virtual bool do_try_music (Music
*);
40 virtual void acknowledge_element (Score_element_info
);
42 VIRTUAL_COPY_CONS(Translator
);
46 Direction octave_dir_
;
47 SCM clef_glyph_
; // no need for protection. Always referenced somewhere else.
53 Protected_scm current_settings_
;
57 Clef_engraver::Clef_engraver()
59 current_settings_
= SCM_EOL
;
62 clef_glyph_
= SCM_EOL
;
72 Clef_engraver::set_type (String s
)
74 if (s
.right_str(2) == "_8") // Down one octave
77 s
= s
.left_str(s
.length_i() - 2);
79 else if (s
.right_str(2) == "^8") // Up one octave
82 s
= s
.left_str(s
.length_i() - 2);
87 SCM c
= get_property ("supportedClefTypes");
88 SCM p
= get_property ("clefPitches");
92 SCM found
= scm_assoc (ly_str02scm (s
.ch_C()), c
);
93 if (found
== SCM_BOOL_F
)
96 clef_glyph_
= gh_cadr (found
);
97 SCM pos
= gh_caddr (found
);
99 clef_position_i_
= gh_scm2int (pos
);
101 found
= scm_assoc (clef_glyph_
, p
);
102 if (found
== SCM_BOOL_F
)
105 c0_position_i_
= clef_position_i_
+ gh_scm2int (gh_cdr (found
));
108 c0_position_i_
-= (int) octave_dir_
* 7;
110 SCM basic
= get_property ("basicClefItemProperties");
111 current_settings_
= gh_cons (gh_cons (ly_symbol2scm ("glyph"), clef_glyph_
), basic
);
113 gh_cons (gh_cons (ly_symbol2scm ("c0-position"),
114 gh_int2scm (c0_position_i_
)),
121 Generate a clef at the start of a measure. (when you see a Bar,
125 Clef_engraver::acknowledge_element (Score_element_info info
)
127 Item
* item
=dynamic_cast <Item
*> (info
.elem_l_
);
130 if (Bar::has_interface (info
.elem_l_
)
131 && gh_string_p (clef_glyph_
))
135 if (Note_head::has_interface (item
)
136 || Local_key_item::has_interface (item
))
138 int p
= int (Staff_symbol_referencer::position_f (item
)) + c0_position_i_
;
139 Staff_symbol_referencer::set_position (item
,p
);
142 else if (Key_item::has_interface (item
))
144 item
->set_elt_property ("c0-position", gh_int2scm (c0_position_i_
));
150 Clef_engraver::do_creation_processing()
152 SCM def
= get_property ("defaultClef");
153 if (gh_string_p (def
))
155 set_type (ly_scm2string (def
));
160 Clef_engraver::do_try_music (Music
* r_l
)
162 if (Clef_change_req
*cl
= dynamic_cast <Clef_change_req
*> (r_l
))
165 if (!set_type (cl
->clef_str_
))
166 cl
->error (_ ("unknown clef type"));
176 Clef_engraver::create_clef()
180 Item
*c
= new Item ( current_settings_
);
181 announce_element (Score_element_info (c
, clef_req_l_
));
183 Staff_symbol_referencer::set_interface (c
);
187 Staff_symbol_referencer::set_position(clef_p_
, clef_position_i_
);
190 Item
* g
= new Item (get_property ("basicOctavateEightProperties"));
191 Side_position::set_axis (g
,Y_AXIS
);
192 Side_position::add_support (g
,clef_p_
);
194 g
->set_parent (clef_p_
, Y_AXIS
);
195 g
->set_parent (clef_p_
, X_AXIS
);
196 g
->add_offset_callback (Side_position::aligned_on_self
, X_AXIS
);
197 g
->add_offset_callback (Side_position::centered_on_parent
, X_AXIS
);
198 g
->set_elt_property ("direction", gh_int2scm (octave_dir_
));
200 announce_element (Score_element_info (octavate_p_
, clef_req_l_
));
206 Clef_engraver::do_process_music()
208 if (clef_req_l_
|| first_b_
)
211 clef_p_
->set_elt_property ("non-default", SCM_BOOL_T
);
216 Clef_engraver::do_pre_move_processing()
221 if(to_boolean (clef_p_
->get_elt_property("non-default")))
223 vis
= ly_symbol2scm ("all-visible");
224 vis
= scm_eval (vis
);
229 clef_p_
->set_elt_property("visibility-lambda", vis
);
231 octavate_p_
->set_elt_property("visibility-lambda", vis
);
234 typeset_element (clef_p_
);
238 typeset_element(octavate_p_
);
247 Clef_engraver::do_post_move_processing()
252 ADD_THIS_TRANSLATOR(Clef_engraver
);