2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
5 Mats Bengtsson <matsb@s3.kth.se>
6 Copyright (C) 2010--2015 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 "staff-symbol-referencer.hh"
28 #include "engraver.hh"
29 #include "direction.hh"
30 #include "side-position-interface.hh"
32 #include "international.hh"
34 #include "translator.icc"
36 class Cue_clef_engraver : public Engraver
39 TRANSLATOR_DECLARATIONS (Cue_clef_engraver);
42 void stop_translation_timestep ();
43 void process_music ();
44 void acknowledge_bar_line (Grob_info);
46 virtual void derived_mark () const;
53 SCM prev_transposition_;
55 void create_end_clef ();
57 void inspect_clef_properties ();
58 void create_clef_modifier (SCM oct);
62 Cue_clef_engraver::derived_mark () const
64 scm_gc_mark (prev_transposition_);
65 scm_gc_mark (prev_cpos_);
66 scm_gc_mark (prev_glyph_);
69 Cue_clef_engraver::Cue_clef_engraver (Context *c)
75 prev_transposition_ = 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_clef_modifier (SCM transp)
106 if (scm_is_number (transp) && scm_to_int (transp))
108 Item *g = make_item ("ClefModifier", SCM_EOL);
110 int abs_transp = scm_to_int (transp);
111 int dir = sign (abs_transp);
112 abs_transp = abs (abs_transp) + 1;
114 SCM txt = scm_number_to_string (scm_from_int (abs_transp),
117 SCM style = get_property ("cueClefTranspositionStyle");
119 SCM formatter = get_property ("cueClefTranspositionFormatter");
120 if (ly_is_procedure (formatter))
121 g->set_property ("text", scm_call_2 (formatter, txt, style));
123 Side_position_interface::add_support (g, clef_);
125 g->set_parent (clef_, Y_AXIS);
126 g->set_parent (clef_, X_AXIS);
127 g->set_property ("direction", scm_from_int (dir));
133 Cue_clef_engraver::create_clef ()
137 Item *c = make_item ("CueClef", SCM_EOL);
140 SCM cpos = get_property ("cueClefPosition");
141 if (scm_is_number (cpos))
142 clef_->set_property ("staff-position", cpos);
144 create_clef_modifier (get_property ("cueClefTransposition"));
149 Cue_clef_engraver::create_end_clef ()
153 clef_ = make_item ("CueEndClef", SCM_EOL);
154 SCM cpos = get_property ("clefPosition");
155 if (scm_is_number (cpos))
156 clef_->set_property ("staff-position", cpos);
158 create_clef_modifier (get_property ("clefTransposition"));
163 Cue_clef_engraver::process_music ()
165 inspect_clef_properties ();
169 Cue_clef_engraver::inspect_clef_properties ()
171 SCM glyph = get_property ("cueClefGlyph");
172 SCM clefpos = get_property ("cueClefPosition");
173 SCM transposition = get_property ("cueClefTransposition");
175 if (!ly_is_equal (glyph, prev_glyph_)
176 || !ly_is_equal (clefpos, prev_cpos_)
177 || !ly_is_equal (transposition, prev_transposition_))
180 if (scm_is_string (glyph))
184 clef_->set_property ("non-default", SCM_BOOL_T);
189 prev_cpos_ = clefpos;
191 prev_transposition_ = transposition;
197 Cue_clef_engraver::stop_translation_timestep ()
202 if (to_boolean (clef_->get_property ("non-default")))
203 vis = get_property ("explicitCueClefVisibility");
206 clef_->set_property ("break-visibility", vis);
214 Cue_clef_engraver::boot ()
216 ADD_ACKNOWLEDGER (Cue_clef_engraver, bar_line);
219 ADD_TRANSLATOR (Cue_clef_engraver,
221 "Determine and set reference point for pitches in cued voices.",
230 "cueClefTransposition "
231 "cueClefTranspositionStyle "
233 "explicitCueClefVisibility "
234 "middleCCuePosition "
235 "clefTransposition ",