2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2000--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
6 LilyPond is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 LilyPond is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
20 #include "align-interface.hh"
21 #include "axis-group-interface.hh"
22 #include "engraver.hh"
23 #include "page-layout-problem.hh"
24 #include "pointer-group-interface.hh"
25 #include "side-position-interface.hh"
27 #include "text-interface.hh"
29 #include "translator.icc"
31 class Instrument_name_engraver : public Engraver
34 TRANSLATOR_DECLARATIONS (Instrument_name_engraver);
37 Spanner *text_spanner_;
42 vector<Grob *> axis_groups_;
43 vector<Grob *> backup_axis_groups_;
45 virtual void finalize ();
46 void acknowledge_axis_group (Grob_info);
47 void process_music ();
48 void start_spanner ();
49 void consider_start_spanner ();
52 virtual void derived_mark () const;
56 Instrument_name_engraver::derived_mark () const
58 scm_gc_mark (long_text_);
59 scm_gc_mark (short_text_);
62 Instrument_name_engraver::Instrument_name_engraver (Context *c)
68 short_text_ = SCM_EOL;
72 Instrument_name_engraver::process_music ()
74 consider_start_spanner ();
78 Instrument_name_engraver::consider_start_spanner ()
80 SCM long_text = get_property ("instrumentName");
81 SCM short_text = get_property ("shortInstrumentName");
83 if (!(Text_interface::is_markup (long_text)
84 || Text_interface::is_markup (short_text)))
86 long_text = get_property ("vocalName");
87 short_text = get_property ("shortVocalName");
90 if ((Text_interface::is_markup (long_text)
91 || Text_interface::is_markup (short_text))
93 || !scm_is_eq (short_text_, short_text)
94 || !scm_is_eq (long_text_, long_text)))
99 short_text_ = short_text;
100 long_text_ = long_text;
107 Instrument_name_engraver::start_spanner ()
109 text_spanner_ = make_spanner ("InstrumentName", SCM_EOL);
111 Grob *col = unsmob<Grob> (get_property ("currentCommandColumn"));
112 text_spanner_->set_bound (LEFT, col);
113 text_spanner_->set_property ("text", short_text_);
114 text_spanner_->set_property ("long-text", long_text_);
117 UGH, should handle this in Score_engraver.
119 Grob *system = unsmob<Grob> (get_property ("rootSystem"));
121 Axis_group_interface::add_element (system, text_spanner_);
123 text_spanner_->programming_error ("cannot find root system");
127 Instrument_name_engraver::acknowledge_axis_group (Grob_info info)
129 if (dynamic_cast<Spanner *> (info.grob ())
130 && Axis_group_interface::has_axis (info.grob (), Y_AXIS)
134 && !info.grob ()->internal_has_interface (ly_symbol2scm ("dynamic-interface"))
135 && !info.grob ()->internal_has_interface (ly_symbol2scm ("piano-pedal-interface"))
136 && !info.grob ()->internal_has_interface (ly_symbol2scm ("volta-interface"))
137 && (!has_interface<Align_interface> (info.grob ())))
139 if (Page_layout_problem::is_spaceable (info.grob ()))
140 axis_groups_.push_back (info.grob ());
142 // By default, don't include non-spaceable staves in the
143 // support of an instrument name. However, if the only staves
144 // are non-spaceable, we'll fall back to using them.
145 backup_axis_groups_.push_back (info.grob ());
150 Instrument_name_engraver::finalize ()
157 Instrument_name_engraver::stop_spanner ()
159 if (axis_groups_.empty ())
160 axis_groups_ = backup_axis_groups_;
162 for (vsize i = 0; i < axis_groups_.size (); i++)
163 Pointer_group_interface::add_grob (text_spanner_,
164 ly_symbol2scm ("elements"),
167 text_spanner_->set_bound (RIGHT,
168 unsmob<Grob> (get_property ("currentCommandColumn")));
170 Pointer_group_interface::set_ordered (text_spanner_,
171 ly_symbol2scm ("elements"),
179 Instrument_name_engraver::boot ()
181 ADD_ACKNOWLEDGER (Instrument_name_engraver, axis_group);
184 ADD_TRANSLATOR (Instrument_name_engraver,
186 "Create a system start text for instrument or vocal names.",
192 "currentCommandColumn "
194 "shortInstrumentName "