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"
34 class Dynamic_align_engraver : public Engraver
36 TRANSLATOR_DECLARATIONS (Dynamic_align_engraver);
37 DECLARE_ACKNOWLEDGER (rhythmic_head);
38 DECLARE_ACKNOWLEDGER (stem);
39 DECLARE_ACKNOWLEDGER (dynamic);
40 DECLARE_ACKNOWLEDGER (footnote_spanner);
41 DECLARE_END_ACKNOWLEDGER (dynamic);
44 virtual void stop_translation_timestep ();
47 void create_line_spanner (Grob *cause);
48 void set_spanner_bounds (Spanner *line, bool end);
50 Spanner *ended_line_; // Spanner manually broken, don't use it for new grobs
51 Spanner *current_dynamic_spanner_;
52 vector<Spanner *> ended_;
53 vector<Spanner *> started_;
54 vector<Grob *> scripts_;
55 vector<Grob *> support_;
57 set<Spanner *> running_;
60 Dynamic_align_engraver::Dynamic_align_engraver ()
64 current_dynamic_spanner_ = 0;
67 ADD_ACKNOWLEDGER (Dynamic_align_engraver, dynamic);
68 ADD_ACKNOWLEDGER (Dynamic_align_engraver, rhythmic_head);
69 ADD_ACKNOWLEDGER (Dynamic_align_engraver, stem);
70 ADD_ACKNOWLEDGER (Dynamic_align_engraver, footnote_spanner);
71 ADD_END_ACKNOWLEDGER (Dynamic_align_engraver, dynamic);
74 Dynamic_align_engraver::create_line_spanner (Grob *cause)
77 line_ = make_spanner ("DynamicLineSpanner", cause->self_scm ());
81 Dynamic_align_engraver::acknowledge_end_dynamic (Grob_info info)
83 if (Spanner::has_interface (info.grob ()))
84 ended_.push_back (info.spanner ());
86 /* If the break flag is set, store the current spanner and let new dynamics
87 * create a new spanner
89 bool spanner_broken = current_dynamic_spanner_ == info.spanner ()
90 && to_boolean (current_dynamic_spanner_->get_property ("spanner-broken"));
91 if (spanner_broken && line_)
94 programming_error ("already have a force-ended DynamicLineSpanner.");
97 current_dynamic_spanner_ = 0;
102 Dynamic_align_engraver::acknowledge_footnote_spanner (Grob_info info)
104 Grob *parent = info.grob ()->get_parent (Y_AXIS);
106 && parent->internal_has_interface (ly_symbol2scm ("dynamic-interface")))
107 Axis_group_interface::add_element (line_, info.grob ());
111 Dynamic_align_engraver::acknowledge_rhythmic_head (Grob_info info)
113 support_.push_back (info.grob ());
117 Dynamic_align_engraver::acknowledge_stem (Grob_info info)
119 support_.push_back (info.grob ());
123 Dynamic_align_engraver::acknowledge_dynamic (Grob_info info)
125 Stream_event *cause = info.event_cause ();
126 // Check whether an existing line spanner has the same direction
129 Direction line_dir = get_grob_direction (line_);
130 Direction grob_dir = to_dir (cause->get_property ("direction"));
132 // If we have an explicit direction for the new dynamic grob
133 // that differs from the current line spanner, break the spanner
134 if (grob_dir && (line_dir != grob_dir))
139 current_dynamic_spanner_ = 0;
143 create_line_spanner (info.grob ());
144 if (Spanner::has_interface (info.grob ()))
146 started_.push_back (info.spanner ());
147 current_dynamic_spanner_ = info.spanner ();
149 else if (info.item ())
150 scripts_.push_back (info.item ());
152 info.grob ()->programming_error ("unknown dynamic grob");
154 Axis_group_interface::add_element (line_, info.grob ());
158 if (Direction d = to_dir (cause->get_property ("direction")))
159 set_grob_direction (line_, d);
164 Dynamic_align_engraver::set_spanner_bounds (Spanner *line, bool end)
169 for (LEFT_and_RIGHT (d))
171 if ((d == LEFT && !line->get_bound (LEFT))
172 || (end && d == RIGHT && !line->get_bound (RIGHT)))
174 vector<Spanner *> const &spanners
175 = (d == LEFT) ? started_ : ended_;
178 if (scripts_.size ())
180 else if (spanners.size ())
181 bound = spanners[0]->get_bound (d);
184 bound = Grob::unsmob (get_property ("currentMusicalColumn"));
185 programming_error ("started DynamicLineSpanner but have no left bound");
188 line->set_bound (d, bound);
194 Dynamic_align_engraver::stop_translation_timestep ()
196 for (vsize i = 0; i < started_.size (); i++)
197 running_.insert (started_[i]);
198 for (vsize i = 0; i < ended_.size (); i++)
200 Spanner *sp = ended_[i];
202 set<Spanner *>::iterator it = running_.find (sp);
203 if (it != running_.end ())
206 started_[i]->programming_error ("lost track of this dynamic spanner");
209 bool end = line_ && running_.empty ();
211 // Set the proper bounds for the current spanner and for a spanner that
213 set_spanner_bounds (ended_line_, true);
214 set_spanner_bounds (line_, end);
215 // If the flag is set to break the spanner after the current child, don't
216 // add any more support points (needed e.g. for style=none, where the
217 // invisible spanner should NOT be shifted since we don't have a line).
218 bool spanner_broken = current_dynamic_spanner_
219 && to_boolean (current_dynamic_spanner_->get_property ("spanner-broken"));
220 for (vsize i = 0; line_ && !spanner_broken && i < support_.size (); i++)
221 Side_position_interface::add_support (line_, support_[i]);
235 ADD_TRANSLATOR (Dynamic_align_engraver,
237 "Align hairpins and dynamic texts on a horizontal line.",
240 "DynamicLineSpanner ",
243 "currentMusicalColumn ",