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>
15 #include "bar-line.hh"
16 #include "staff-symbol-referencer.hh"
17 #include "engraver.hh"
18 #include "direction.hh"
19 #include "side-position-interface.hh"
21 #include "translator.icc"
23 class Clef_engraver : public Engraver
26 TRANSLATOR_DECLARATIONS (Clef_engraver);
28 Direction octave_dir_;
31 void stop_translation_timestep ();
32 void process_music ();
33 DECLARE_ACKNOWLEDGER (bar_line);
35 virtual void derived_mark () const;
45 void inspect_clef_properties ();
49 Clef_engraver::derived_mark () const
51 scm_gc_mark (prev_octavation_);
52 scm_gc_mark (prev_cpos_);
53 scm_gc_mark (prev_glyph_);
56 Clef_engraver::Clef_engraver ()
63 will trigger a clef at the start since #f != ' ()
65 prev_octavation_ = prev_cpos_ = prev_glyph_ = SCM_BOOL_F;
69 Clef_engraver::set_glyph ()
71 SCM glyph_sym = ly_symbol2scm ("glyph-name");
72 SCM glyph = get_property ("clefGlyph");
74 SCM basic = ly_symbol2scm ("Clef");
76 execute_pushpop_property (context (), basic, glyph_sym, SCM_UNDEFINED);
77 execute_pushpop_property (context (), basic, glyph_sym, glyph);
81 Generate a clef at the start of a measure. (when you see a Bar,
85 Clef_engraver::acknowledge_bar_line (Grob_info info)
87 Item *item = dynamic_cast<Item *> (info.grob ());
88 if (item && scm_is_string (get_property ("clefGlyph")))
93 Clef_engraver::create_clef ()
97 Item *c = make_item ("Clef", SCM_EOL);
100 SCM cpos = get_property ("clefPosition");
102 if (scm_is_number (cpos))
103 clef_->set_property ("staff-position", cpos);
105 SCM oct = get_property ("clefOctavation");
106 if (scm_is_number (oct) && scm_to_int (oct))
108 Item *g = make_item ("OctavateEight", SCM_EOL);
110 int abs_oct = scm_to_int (oct);
111 int dir = sign (abs_oct);
112 abs_oct = abs (abs_oct) + 1;
114 SCM txt = scm_number_to_string (scm_from_int (abs_oct),
117 g->set_property ("text",
118 scm_list_n (ly_lily_module_constant ("vcenter-markup"),
119 txt, SCM_UNDEFINED));
120 Side_position_interface::add_support (g, clef_);
122 g->set_parent (clef_, Y_AXIS);
123 g->set_parent (clef_, X_AXIS);
124 g->set_property ("direction", scm_from_int (dir));
130 Clef_engraver::process_music ()
132 inspect_clef_properties ();
136 Clef_engraver::inspect_clef_properties ()
138 SCM glyph = get_property ("clefGlyph");
139 SCM clefpos = get_property ("clefPosition");
140 SCM octavation = get_property ("clefOctavation");
141 SCM force_clef = get_property ("forceClef");
143 if (clefpos == SCM_EOL
144 || scm_equal_p (glyph, prev_glyph_) == SCM_BOOL_F
145 || scm_equal_p (clefpos, prev_cpos_) == SCM_BOOL_F
146 || scm_equal_p (octavation, prev_octavation_) == SCM_BOOL_F
147 || to_boolean (force_clef))
150 if (prev_cpos_ != SCM_BOOL_F || to_boolean (get_property ("firstClef")))
154 clef_->set_property ("non-default", SCM_BOOL_T);
156 prev_cpos_ = clefpos;
158 prev_octavation_ = octavation;
161 if (to_boolean (force_clef))
164 Context *w = context ()->where_defined (ly_symbol2scm ("forceClef"), &prev);
165 w->set_property ("forceClef", SCM_EOL);
170 Clef_engraver::stop_translation_timestep ()
175 if (to_boolean (clef_->get_property ("non-default")))
176 vis = get_property ("explicitClefVisibility");
180 clef_->set_property ("break-visibility", vis);
182 octavate_->set_property ("break-visibility", vis);
191 ADD_ACKNOWLEDGER (Clef_engraver, bar_line);
192 ADD_TRANSLATOR (Clef_engraver,
193 /* doc */ "Determine and set reference point for pitches",
194 /* create */ "Clef OctavateEight",
196 /* read */ "clefPosition clefGlyph middleCPosition clefOctavation explicitClefVisibility forceClef",