2 clef-engraver.cc -- implement Clef_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>,
8 Mats Bengtsson <matsb@s3.kth.se>
16 #include "bar-line.hh"
17 #include "staff-symbol-referencer.hh"
18 #include "engraver.hh"
19 #include "direction.hh"
20 #include "side-position-interface.hh"
22 #include "translator.icc"
24 class Clef_engraver : public Engraver
27 TRANSLATOR_DECLARATIONS (Clef_engraver);
29 Direction octave_dir_;
32 void stop_translation_timestep ();
33 void process_music ();
34 DECLARE_ACKNOWLEDGER (bar_line);
36 virtual void derived_mark () const;
46 void inspect_clef_properties ();
50 Clef_engraver::derived_mark () const
52 scm_gc_mark (prev_octavation_);
53 scm_gc_mark (prev_cpos_);
54 scm_gc_mark (prev_glyph_);
57 Clef_engraver::Clef_engraver ()
64 will trigger a clef at the start since #f != ' ()
66 prev_octavation_ = prev_cpos_ = prev_glyph_ = SCM_BOOL_F;
70 Clef_engraver::set_glyph ()
72 SCM glyph_sym = ly_symbol2scm ("glyph");
73 SCM basic = ly_symbol2scm ("Clef");
75 execute_pushpop_property (context (), basic, glyph_sym, SCM_UNDEFINED);
76 execute_pushpop_property (context (), basic, glyph_sym, get_property ("clefGlyph"));
80 Generate a clef at the start of a measure. (when you see a Bar,
84 Clef_engraver::acknowledge_bar_line (Grob_info info)
86 Item *item = dynamic_cast<Item *> (info.grob ());
87 if (item && scm_is_string (get_property ("clefGlyph")))
92 Clef_engraver::create_clef ()
96 Item *c = make_item ("Clef", SCM_EOL);
99 SCM cpos = get_property ("clefPosition");
101 if (scm_is_number (cpos))
102 clef_->set_property ("staff-position", cpos);
104 SCM oct = get_property ("clefOctavation");
105 if (scm_is_number (oct) && scm_to_int (oct))
107 Item *g = make_item ("OctavateEight", SCM_EOL);
109 int abs_oct = scm_to_int (oct);
110 int dir = sign (abs_oct);
111 abs_oct = abs (abs_oct) + 1;
113 SCM txt = scm_number_to_string (scm_from_int (abs_oct),
116 g->set_property ("text",
117 scm_list_n (ly_lily_module_constant ("vcenter-markup"),
118 txt, SCM_UNDEFINED));
119 Side_position_interface::add_support (g, clef_);
121 g->set_parent (clef_, Y_AXIS);
122 g->set_parent (clef_, X_AXIS);
123 g->set_property ("direction", scm_from_int (dir));
129 Clef_engraver::process_music ()
131 inspect_clef_properties ();
135 Clef_engraver::inspect_clef_properties ()
137 SCM glyph = get_property ("clefGlyph");
138 SCM clefpos = get_property ("clefPosition");
139 SCM octavation = get_property ("clefOctavation");
140 SCM force_clef = get_property ("forceClef");
142 if (clefpos == SCM_EOL
143 || scm_equal_p (glyph, prev_glyph_) == SCM_BOOL_F
144 || scm_equal_p (clefpos, prev_cpos_) == SCM_BOOL_F
145 || scm_equal_p (octavation, prev_octavation_) == SCM_BOOL_F
146 || to_boolean (force_clef))
148 set_context_property_on_children (context (),
149 ly_symbol2scm ("localKeySignature"),
150 get_property ("keySignature"));
153 if (prev_cpos_ != SCM_BOOL_F || to_boolean (get_property ("firstClef")))
157 clef_->set_property ("non-default", SCM_BOOL_T);
159 prev_cpos_ = clefpos;
161 prev_octavation_ = octavation;
164 if (to_boolean (force_clef))
167 Context *w = context ()->where_defined (ly_symbol2scm ("forceClef"), &prev);
168 w->set_property ("forceClef", SCM_EOL);
173 Clef_engraver::stop_translation_timestep ()
178 if (to_boolean (clef_->get_property ("non-default")))
179 vis = get_property ("explicitClefVisibility");
183 clef_->set_property ("break-visibility", vis);
185 octavate_->set_property ("break-visibility", vis);
194 ADD_ACKNOWLEDGER (Clef_engraver, bar_line);
195 ADD_TRANSLATOR (Clef_engraver,
196 /* doc */ "Determine and set reference point for pitches",
203 "explicitClefVisibility "