2 clef-engraver.cc -- implement Clef_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>,
8 Mats Bengtsson <matsb@s3.kth.se>
14 #include "bar-line.hh"
15 #include "staff-symbol-referencer.hh"
16 #include "engraver.hh"
17 #include "direction.hh"
18 #include "side-position-interface.hh"
20 class Clef_engraver : public Engraver
23 TRANSLATOR_DECLARATIONS (Clef_engraver);
25 Direction octave_dir_;
28 virtual void stop_translation_timestep ();
29 virtual void process_music ();
30 virtual void acknowledge_grob (Grob_info);
40 void inspect_clef_properties ();
43 Clef_engraver::Clef_engraver ()
50 will trigger a clef at the start since #f != ' ()
52 prev_cpos_ = prev_glyph_ = SCM_BOOL_F;
56 Clef_engraver::set_glyph ()
58 SCM glyph_sym = ly_symbol2scm ("glyph-name");
59 SCM glyph = get_property ("clefGlyph");
61 SCM basic = ly_symbol2scm ("Clef");
63 execute_pushpop_property (context (), basic, glyph_sym, SCM_UNDEFINED);
64 execute_pushpop_property (context (), basic, glyph_sym, glyph);
68 Generate a clef at the start of a measure. (when you see a Bar,
72 Clef_engraver::acknowledge_grob (Grob_info info)
74 Item *item = dynamic_cast<Item *> (info.grob_);
77 if (Bar_line::has_interface (info.grob_)
78 && scm_is_string (get_property ("clefGlyph")))
84 Clef_engraver::create_clef ()
88 Item *c = make_item ("Clef", SCM_EOL);
91 SCM cpos = get_property ("clefPosition");
93 if (scm_is_number (cpos))
94 clef_->set_property ("staff-position", cpos);
96 SCM oct = get_property ("clefOctavation");
97 if (scm_is_number (oct) && scm_to_int (oct))
99 Item *g = make_item ("OctavateEight", SCM_EOL);
101 int abs_oct = scm_to_int (oct);
102 int dir = sign (abs_oct);
103 abs_oct = abs (abs_oct) + 1;
105 SCM txt = scm_number_to_string (scm_int2num (abs_oct),
108 g->set_property ("text",
109 scm_list_n (ly_lily_module_constant ("vcenter-markup"),
110 txt, SCM_UNDEFINED));
111 Side_position_interface::add_support (g, clef_);
113 g->set_parent (clef_, Y_AXIS);
114 g->set_parent (clef_, X_AXIS);
115 g->set_property ("direction", scm_int2num (dir));
122 Clef_engraver::process_music ()
124 inspect_clef_properties ();
128 Clef_engraver::inspect_clef_properties ()
130 SCM glyph = get_property ("clefGlyph");
131 SCM clefpos = get_property ("clefPosition");
132 SCM octavation = get_property ("clefOctavation");
133 SCM force_clef = get_property ("forceClef");
135 if (clefpos == SCM_EOL
136 || scm_equal_p (glyph, prev_glyph_) == SCM_BOOL_F
137 || scm_equal_p (clefpos, prev_cpos_) == SCM_BOOL_F
138 || scm_equal_p (octavation, prev_octavation_) == SCM_BOOL_F
139 || to_boolean (force_clef))
144 clef_->set_property ("non-default", SCM_BOOL_T);
146 prev_cpos_ = clefpos;
148 prev_octavation_ = octavation;
151 if (to_boolean (force_clef))
153 Context *w = context ()->where_defined (ly_symbol2scm ("forceClef"));
154 w->set_property ("forceClef", SCM_EOL);
159 Clef_engraver::stop_translation_timestep ()
164 if (to_boolean (clef_->get_property ("non-default")))
166 vis = get_property ("explicitClefVisibility");
171 clef_->set_property ("break-visibility", vis);
174 octavate_->set_property ("break-visibility", vis);
185 ADD_TRANSLATOR (Clef_engraver,
186 /* descr */ "Determine and set reference point for pitches",
187 /* creats*/ "Clef OctavateEight",
189 /* acks */ "bar-line-interface",
190 /* reads */ "clefPosition clefGlyph middleCPosition clefOctavation explicitClefVisibility forceClef",