2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2008--2015 Han-Wen Nienhuys <hanwen@lilypond.org>
7 LilyPond is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 LilyPond is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
23 #include "engraver.hh"
25 #include "axis-group-interface.hh"
26 #include "directional-element-interface.hh"
28 #include "side-position-interface.hh"
30 #include "stream-event.hh"
32 #include "translator.icc"
37 class Dynamic_align_engraver : public Engraver
39 TRANSLATOR_DECLARATIONS (Dynamic_align_engraver);
40 DECLARE_ACKNOWLEDGER (rhythmic_head);
41 DECLARE_ACKNOWLEDGER (stem);
42 DECLARE_ACKNOWLEDGER (dynamic);
43 DECLARE_ACKNOWLEDGER (footnote_spanner);
44 DECLARE_END_ACKNOWLEDGER (dynamic);
47 virtual void stop_translation_timestep ();
50 void create_line_spanner (Grob *cause);
51 void set_spanner_bounds (Spanner *line, bool end);
53 Spanner *ended_line_; // Spanner manually broken, don't use it for new grobs
54 Spanner *current_dynamic_spanner_;
55 vector<Spanner *> ended_;
56 vector<Spanner *> started_;
57 vector<Grob *> scripts_;
58 vector<Grob *> support_;
60 set<Spanner *> running_;
63 Dynamic_align_engraver::Dynamic_align_engraver ()
67 current_dynamic_spanner_ = 0;
70 ADD_ACKNOWLEDGER (Dynamic_align_engraver, dynamic);
71 ADD_ACKNOWLEDGER (Dynamic_align_engraver, rhythmic_head);
72 ADD_ACKNOWLEDGER (Dynamic_align_engraver, stem);
73 ADD_ACKNOWLEDGER (Dynamic_align_engraver, footnote_spanner);
74 ADD_END_ACKNOWLEDGER (Dynamic_align_engraver, dynamic);
77 Dynamic_align_engraver::create_line_spanner (Grob *cause)
80 line_ = make_spanner ("DynamicLineSpanner", cause->self_scm ());
84 Dynamic_align_engraver::acknowledge_end_dynamic (Grob_info info)
86 if (has_interface<Spanner> (info.grob ()))
87 ended_.push_back (info.spanner ());
89 /* If the break flag is set, store the current spanner and let new dynamics
90 * create a new spanner
92 bool spanner_broken = current_dynamic_spanner_ == info.spanner ()
93 && to_boolean (current_dynamic_spanner_->get_property ("spanner-broken"));
94 if (spanner_broken && line_)
97 programming_error ("already have a force-ended DynamicLineSpanner.");
100 current_dynamic_spanner_ = 0;
105 Dynamic_align_engraver::acknowledge_footnote_spanner (Grob_info info)
107 Grob *parent = info.grob ()->get_parent (Y_AXIS);
109 && parent->internal_has_interface (ly_symbol2scm ("dynamic-interface")))
110 Axis_group_interface::add_element (line_, info.grob ());
114 Dynamic_align_engraver::acknowledge_rhythmic_head (Grob_info info)
116 support_.push_back (info.grob ());
120 Dynamic_align_engraver::acknowledge_stem (Grob_info info)
122 support_.push_back (info.grob ());
126 Dynamic_align_engraver::acknowledge_dynamic (Grob_info info)
128 Stream_event *cause = info.event_cause ();
129 // Check whether an existing line spanner has the same direction
132 Direction line_dir = get_grob_direction (line_);
133 Direction grob_dir = to_dir (cause->get_property ("direction"));
135 // If we have an explicit direction for the new dynamic grob
136 // that differs from the current line spanner, break the spanner
137 if (grob_dir && (line_dir != grob_dir))
142 current_dynamic_spanner_ = 0;
146 create_line_spanner (info.grob ());
147 if (has_interface<Spanner> (info.grob ()))
149 started_.push_back (info.spanner ());
150 current_dynamic_spanner_ = info.spanner ();
152 else if (info.item ())
153 scripts_.push_back (info.item ());
155 info.grob ()->programming_error ("unknown dynamic grob");
157 Axis_group_interface::add_element (line_, info.grob ());
161 if (Direction d = to_dir (cause->get_property ("direction")))
162 set_grob_direction (line_, d);
167 Dynamic_align_engraver::set_spanner_bounds (Spanner *line, bool end)
172 for (LEFT_and_RIGHT (d))
174 if ((d == LEFT && !line->get_bound (LEFT))
175 || (end && d == RIGHT && !line->get_bound (RIGHT)))
177 vector<Spanner *> const &spanners
178 = (d == LEFT) ? started_ : ended_;
181 if (scripts_.size ())
183 else if (spanners.size ())
184 bound = spanners[0]->get_bound (d);
187 bound = unsmob<Grob> (get_property ("currentMusicalColumn"));
188 programming_error ("started DynamicLineSpanner but have no left bound");
191 line->set_bound (d, bound);
197 Dynamic_align_engraver::stop_translation_timestep ()
199 for (vsize i = 0; i < started_.size (); i++)
200 running_.insert (started_[i]);
201 for (vsize i = 0; i < ended_.size (); i++)
203 Spanner *sp = ended_[i];
205 set<Spanner *>::iterator it = running_.find (sp);
206 if (it != running_.end ())
209 started_[i]->programming_error ("lost track of this dynamic spanner");
212 bool end = line_ && running_.empty ();
214 // Set the proper bounds for the current spanner and for a spanner that
216 set_spanner_bounds (ended_line_, true);
217 set_spanner_bounds (line_, end);
218 // If the flag is set to break the spanner after the current child, don't
219 // add any more support points (needed e.g. for style=none, where the
220 // invisible spanner should NOT be shifted since we don't have a line).
221 bool spanner_broken = current_dynamic_spanner_
222 && to_boolean (current_dynamic_spanner_->get_property ("spanner-broken"));
223 for (vsize i = 0; line_ && !spanner_broken && i < support_.size (); i++)
224 Side_position_interface::add_support (line_, support_[i]);
238 ADD_TRANSLATOR (Dynamic_align_engraver,
240 "Align hairpins and dynamic texts on a horizontal line.",
243 "DynamicLineSpanner ",
246 "currentMusicalColumn ",