2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
5 Mats Bengtsson <matsb@s3.kth.se>
6 Copyright (C) 2010--2011 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
));
130 Cue_clef_engraver::create_clef ()
134 Item
*c
= make_item ("CueClef", SCM_EOL
);
137 SCM cpos
= get_property ("cueClefPosition");
138 if (scm_is_number (cpos
))
139 clef_
->set_property ("staff-position", cpos
);
141 create_octavate_eight (get_property ("cueClefOctavation"));
146 Cue_clef_engraver::create_end_clef ()
150 clef_
= make_item ("CueEndClef", SCM_EOL
);
151 SCM cpos
= get_property ("clefPosition");
152 if (scm_is_number (cpos
))
153 clef_
->set_property ("staff-position", cpos
);
155 create_octavate_eight (get_property ("clefOctavation"));
160 Cue_clef_engraver::process_music ()
162 inspect_clef_properties ();
166 Cue_clef_engraver::inspect_clef_properties ()
168 SCM glyph
= get_property ("cueClefGlyph");
169 SCM clefpos
= get_property ("cueClefPosition");
170 SCM octavation
= get_property ("cueClefOctavation");
172 if (scm_equal_p (glyph
, prev_glyph_
) == SCM_BOOL_F
173 || scm_equal_p (clefpos
, prev_cpos_
) == SCM_BOOL_F
174 || scm_equal_p (octavation
, prev_octavation_
) == SCM_BOOL_F
)
177 if (scm_is_string (glyph
))
181 clef_
->set_property ("non-default", SCM_BOOL_T
);
186 prev_cpos_
= clefpos
;
188 prev_octavation_
= octavation
;
194 Cue_clef_engraver::stop_translation_timestep ()
199 if (to_boolean (clef_
->get_property ("non-default")))
200 vis
= get_property ("explicitCueClefVisibility");
203 clef_
->set_property ("break-visibility", vis
);
210 ADD_ACKNOWLEDGER (Cue_clef_engraver
, bar_line
);
211 ADD_TRANSLATOR (Cue_clef_engraver
,
213 "Determine and set reference point for pitches in cued voices.",
224 "explicitCueClefVisibility "
225 "middleCCuePosition "