2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2010 Han-Wen Nienhuys <hanwen@xs4all.nl>
5 Mats Bengtsson <matsb@s3.kth.se>
6 Copyright (C) 2010 Reinhold Kainhofer <reinhold@kainhofer.com>
8 LilyPond is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 LilyPond is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
27 #include "bar-line.hh"
28 #include "staff-symbol-referencer.hh"
29 #include "engraver.hh"
30 #include "direction.hh"
31 #include "side-position-interface.hh"
33 #include "international.hh"
35 #include "translator.icc"
37 class Cue_clef_engraver : public Engraver
40 TRANSLATOR_DECLARATIONS (Cue_clef_engraver);
43 void stop_translation_timestep ();
44 void process_music ();
45 DECLARE_ACKNOWLEDGER (bar_line);
47 virtual void derived_mark () const;
56 void create_end_clef ();
58 void inspect_clef_properties ();
59 void create_octavate_eight (SCM oct);
63 Cue_clef_engraver::derived_mark () const
65 scm_gc_mark (prev_octavation_);
66 scm_gc_mark (prev_cpos_);
67 scm_gc_mark (prev_glyph_);
70 Cue_clef_engraver::Cue_clef_engraver ()
75 prev_octavation_ = prev_cpos_ = prev_glyph_ = SCM_EOL;
79 Cue_clef_engraver::set_glyph ()
81 SCM glyph_sym = ly_symbol2scm ("glyph");
82 SCM basic = ly_symbol2scm ("CueClef");
83 execute_pushpop_property (context (), basic, glyph_sym, SCM_UNDEFINED);
84 execute_pushpop_property (context (), basic, glyph_sym, get_property ("cueClefGlyph"));
86 basic = ly_symbol2scm ("CueEndClef");
87 execute_pushpop_property (context (), basic, glyph_sym, SCM_UNDEFINED);
88 execute_pushpop_property (context (), basic, glyph_sym, get_property ("clefGlyph"));
92 Generate a clef at the start of a measure. (when you see a Bar,
96 Cue_clef_engraver::acknowledge_bar_line (Grob_info info)
98 Item *item = info.item ();
99 if (item && scm_is_string (get_property ("cueClefGlyph")))
104 Cue_clef_engraver::create_octavate_eight (SCM oct)
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));
126 // Inherit the break-visibility from the clef!
127 SCM vis = clef_->get_property ("break-visibility");
129 g->set_property ("break-visibility", vis);
136 Cue_clef_engraver::create_clef ()
140 Item *c = make_item ("CueClef", SCM_EOL);
143 SCM cpos = get_property ("cueClefPosition");
144 if (scm_is_number (cpos))
145 clef_->set_property ("staff-position", cpos);
147 create_octavate_eight (get_property ("cueClefOctavation"));
152 Cue_clef_engraver::create_end_clef ()
156 clef_ = make_item ("CueEndClef", SCM_EOL);
157 SCM cpos = get_property ("clefPosition");
158 if (scm_is_number (cpos))
159 clef_->set_property ("staff-position", cpos);
161 create_octavate_eight (get_property ("clefOctavation"));
166 Cue_clef_engraver::process_music ()
168 inspect_clef_properties ();
172 Cue_clef_engraver::inspect_clef_properties ()
174 SCM glyph = get_property ("cueClefGlyph");
175 SCM clefpos = get_property ("cueClefPosition");
176 SCM octavation = get_property ("cueClefOctavation");
178 if (scm_equal_p (glyph, prev_glyph_) == SCM_BOOL_F
179 || scm_equal_p (clefpos, prev_cpos_) == SCM_BOOL_F
180 || scm_equal_p (octavation, prev_octavation_) == SCM_BOOL_F
181 || to_boolean (force_clef))
184 if (scm_is_string (glyph))
188 clef_->set_property ("non-default", SCM_BOOL_T);
193 prev_cpos_ = clefpos;
195 prev_octavation_ = octavation;
201 Cue_clef_engraver::stop_translation_timestep ()
206 if (to_boolean (clef_->get_property ("non-default")))
207 vis = get_property ("explicitCueClefVisibility");
211 clef_->set_property ("break-visibility", vis);
213 octavate_->set_property ("break-visibility", vis);
221 ADD_ACKNOWLEDGER (Cue_clef_engraver, bar_line);
222 ADD_TRANSLATOR (Cue_clef_engraver,
224 "Determine and set reference point for pitches in cued voices.",
235 "explicitCueClefVisibility "
236 "middleCCuePosition "