2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2008--2012 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 (note_column);
38 DECLARE_ACKNOWLEDGER (dynamic);
39 DECLARE_ACKNOWLEDGER (footnote_spanner);
40 DECLARE_END_ACKNOWLEDGER (dynamic);
43 virtual void stop_translation_timestep ();
46 void create_line_spanner (Stream_event *cause);
47 void set_spanner_bounds (Spanner *line, bool end);
49 Spanner *ended_line_; // Spanner manually broken, don't use it for new grobs
50 Spanner *current_dynamic_spanner_;
51 vector<Spanner *> ended_;
52 vector<Spanner *> started_;
53 vector<Grob *> scripts_;
54 vector<Grob *> support_;
56 set<Spanner *> running_;
59 Dynamic_align_engraver::Dynamic_align_engraver ()
63 current_dynamic_spanner_ = 0;
66 ADD_ACKNOWLEDGER (Dynamic_align_engraver, dynamic);
67 ADD_ACKNOWLEDGER (Dynamic_align_engraver, note_column);
68 ADD_ACKNOWLEDGER (Dynamic_align_engraver, footnote_spanner);
69 ADD_END_ACKNOWLEDGER (Dynamic_align_engraver, dynamic);
72 Dynamic_align_engraver::create_line_spanner (Stream_event *event)
75 line_ = make_spanner ("DynamicLineSpanner",
76 event ? event->self_scm () : SCM_EOL);
80 Dynamic_align_engraver::acknowledge_end_dynamic (Grob_info info)
82 if (Spanner::has_interface (info.grob ()))
83 ended_.push_back (info.spanner ());
85 /* If the break flag is set, store the current spanner and let new dynamics
86 * create a new spanner
88 bool spanner_broken = current_dynamic_spanner_ == info.spanner ()
89 && to_boolean (current_dynamic_spanner_->get_property ("spanner-broken"));
90 if (spanner_broken && line_)
93 programming_error ("already have a force-ended DynamicLineSpanner.");
96 current_dynamic_spanner_ = 0;
101 Dynamic_align_engraver::acknowledge_footnote_spanner (Grob_info info)
103 Grob *parent = info.grob ()->get_parent (Y_AXIS);
105 && parent->internal_has_interface (ly_symbol2scm ("dynamic-interface")))
106 Axis_group_interface::add_element (line_, info.grob ());
110 Dynamic_align_engraver::acknowledge_note_column (Grob_info info)
112 support_.push_back (info.grob ());
116 Dynamic_align_engraver::acknowledge_dynamic (Grob_info info)
118 Stream_event *cause = info.event_cause ();
119 // Check whether an existing line spanner has the same direction
122 Direction line_dir = get_grob_direction (line_);
123 Direction grob_dir = to_dir (cause->get_property ("direction"));
125 // If we have an explicit direction for the new dynamic grob
126 // that differs from the current line spanner, break the spanner
127 if (grob_dir && (line_dir != grob_dir))
132 current_dynamic_spanner_ = 0;
136 create_line_spanner (cause);
137 if (Spanner::has_interface (info.grob ()))
139 started_.push_back (info.spanner ());
140 current_dynamic_spanner_ = info.spanner ();
142 else if (info.item ())
143 scripts_.push_back (info.item ());
145 info.grob ()->programming_error ("unknown dynamic grob");
147 Axis_group_interface::add_element (line_, info.grob ());
151 if (Direction d = to_dir (cause->get_property ("direction")))
152 set_grob_direction (line_, d);
157 Dynamic_align_engraver::set_spanner_bounds (Spanner *line, bool end)
164 if ((d == LEFT && !line->get_bound (LEFT))
165 || (end && d == RIGHT && !line->get_bound (RIGHT)))
167 vector<Spanner *> const &spanners
168 = (d == LEFT) ? started_ : ended_;
171 if (scripts_.size ())
173 else if (spanners.size ())
174 bound = spanners[0]->get_bound (d);
177 bound = unsmob_grob (get_property ("currentMusicalColumn"));
178 programming_error ("started DynamicLineSpanner but have no left bound");
181 line->set_bound (d, bound);
184 while (flip (&d) != LEFT);
188 Dynamic_align_engraver::stop_translation_timestep ()
190 for (vsize i = 0; i < started_.size (); i++)
191 running_.insert (started_[i]);
192 for (vsize i = 0; i < ended_.size (); i++)
194 Spanner *sp = ended_[i];
196 set<Spanner *>::iterator it = running_.find (sp);
197 if (it != running_.end ())
200 started_[i]->programming_error ("lost track of this dynamic spanner");
203 bool end = line_ && running_.empty ();
205 // Set the proper bounds for the current spanner and for a spanner that
207 set_spanner_bounds (ended_line_, true);
208 set_spanner_bounds (line_, end);
209 // If the flag is set to break the spanner after the current child, don't
210 // add any more support points (needed e.g. for style=none, where the
211 // invisible spanner should NOT be shifted since we don't have a line).
212 bool spanner_broken = current_dynamic_spanner_
213 && to_boolean (current_dynamic_spanner_->get_property ("spanner-broken"));
214 for (vsize i = 0; line_ && !spanner_broken && i < support_.size (); i++)
215 Side_position_interface::add_support (line_, support_[i]);
229 ADD_TRANSLATOR (Dynamic_align_engraver,
231 "Align hairpins and dynamic texts on a horizontal line.",
234 "DynamicLineSpanner ",
237 "currentMusicalColumn ",