2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2005--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
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/>.
21 #include "engraver.hh"
23 #include "align-interface.hh"
24 #include "axis-group-interface.hh"
26 #include "grob-array.hh"
28 #include "pointer-group-interface.hh"
30 #include "stream-event.hh"
31 #include "text-interface.hh"
33 #include "translator.icc"
38 Spanner *continuation_line_;
48 Stream_event *current_event_;
53 continuation_line_ = 0;
58 /* Reset (or init) all figure information to FALSE */
62 alteration_ = SCM_BOOL_F;
63 augmented_ = SCM_BOOL_F;
64 diminished_ = SCM_BOOL_F;
65 augmented_slash_ = SCM_BOOL_F;
68 /* Mark the members of the struct as used for the GUILE Garbage Collection */
71 scm_gc_mark (number_);
72 scm_gc_mark (alteration_);
73 scm_gc_mark (augmented_);
74 scm_gc_mark (diminished_);
75 scm_gc_mark (augmented_slash_);
78 bool group_is_equal_to (Stream_event *evt) const
81 ly_is_equal (number_, evt->get_property ("figure"))
82 && ly_is_equal (alteration_, evt->get_property ("alteration"))
83 && ly_is_equal (augmented_, evt->get_property ("augmented"))
84 && ly_is_equal (diminished_, evt->get_property ("diminished"))
85 && ly_is_equal (augmented_slash_, evt->get_property ("augmented-slash"))
86 && ly_is_equal (text_, evt->get_property ("text"));
88 bool is_continuation () const
92 && group_is_equal_to (current_event_);
94 void assign_from_event (Stream_event *currevt, Item *item)
96 number_ = current_event_->get_property ("figure");
97 alteration_ = currevt->get_property ("alteration");
98 augmented_ = currevt->get_property ("augmented");
99 diminished_ = currevt->get_property ("diminished");
100 augmented_slash_ = currevt->get_property ("augmented-slash");
101 text_ = currevt->get_property ("text");
106 struct Figured_bass_engraver : public Engraver
108 TRANSLATOR_DECLARATIONS (Figured_bass_engraver);
109 void clear_spanners ();
110 void add_brackets ();
111 void create_grobs ();
113 void center_continuations (vector<Spanner *> const &consecutive_lines);
114 void center_repeated_continuations ();
116 vector<Figure_group> groups_;
118 vector<Stream_event *> new_events_;
120 bool new_event_found_;
125 void listen_rest (Stream_event *);
126 void listen_bass_figure (Stream_event *);
128 virtual void derived_mark () const;
130 void start_translation_timestep ();
131 void stop_translation_timestep ();
132 void process_music ();
135 Figured_bass_engraver::Figured_bass_engraver ()
138 continuation_ = false;
140 new_event_found_ = false;
144 Figured_bass_engraver::derived_mark () const
146 for (vsize i = 0; i < groups_.size (); i++)
148 groups_[i].gc_mark ();
153 Figured_bass_engraver::start_translation_timestep ()
155 if (now_mom ().main_part_ < stop_moment_.main_part_
156 || now_mom ().grace_part_ < Rational (0))
160 new_events_.clear ();
161 for (vsize i = 0; i < groups_.size (); i++)
162 groups_[i].current_event_ = 0;
164 continuation_ = false;
168 Figured_bass_engraver::stop_translation_timestep ()
171 || now_mom ().main_part_ < stop_moment_.main_part_
172 || now_mom ().grace_part_ < Rational (0))
176 for (vsize i = 0; !found && i < groups_.size (); i++)
177 found = found || groups_[i].current_event_;
184 Figured_bass_engraver::listen_rest (Stream_event *)
190 Figured_bass_engraver::listen_bass_figure (Stream_event *ev)
192 new_event_found_ = true;
193 Moment stop = now_mom () + get_event_length (ev, now_mom ());
194 stop_moment_ = max (stop_moment_, stop);
196 // Handle no-continuation here, don't even add it to the already existing
197 // spanner... This fixes some layout issues (figure will be placed separately)
198 bool no_continuation = to_boolean (ev->get_property ("no-continuation"));
199 if (to_boolean (get_property ("useBassFigureExtenders")) && !no_continuation)
201 for (vsize i = 0; i < groups_.size (); i++)
203 if (!groups_[i].current_event_
204 && groups_[i].group_is_equal_to (ev))
206 groups_[i].current_event_ = ev;
207 continuation_ = true;
212 new_events_.push_back (ev);
216 Figured_bass_engraver::center_continuations (vector<Spanner *> const &consecutive_lines)
218 vector<Grob *> left_figs;
219 for (vsize j = consecutive_lines.size (); j--;)
220 left_figs.push_back (consecutive_lines[j]->get_bound (LEFT));
222 SCM ga = Grob_array::make_array ();
223 unsmob<Grob_array> (ga)->set_array (left_figs);
225 for (vsize j = consecutive_lines.size (); j--;)
226 consecutive_lines[j]->set_object ("figures",
227 unsmob<Grob_array> (ga)->smobbed_copy ());
231 Figured_bass_engraver::center_repeated_continuations ()
233 vector<Spanner *> consecutive_lines;
234 for (vsize i = 0; i <= groups_.size (); i++)
236 if (i < groups_.size ()
237 && groups_[i].continuation_line_
238 && (consecutive_lines.empty ()
239 || (consecutive_lines[0]->get_bound (LEFT)->get_column ()
240 == groups_[i].continuation_line_->get_bound (LEFT)->get_column ()
241 && consecutive_lines[0]->get_bound (RIGHT)->get_column ()
242 == groups_[i].continuation_line_->get_bound (RIGHT)->get_column ())))
243 consecutive_lines.push_back (groups_[i].continuation_line_);
246 center_continuations (consecutive_lines);
247 consecutive_lines.clear ();
253 Figured_bass_engraver::clear_spanners ()
258 announce_end_grob (alignment_, SCM_EOL);
261 if (to_boolean (get_property ("figuredBassCenterContinuations")))
262 center_repeated_continuations ();
264 for (vsize i = 0; i < groups_.size (); i++)
266 if (groups_[i].group_)
268 announce_end_grob (groups_[i].group_, SCM_EOL);
269 groups_[i].group_ = 0;
272 if (groups_[i].continuation_line_)
274 announce_end_grob (groups_[i].continuation_line_, SCM_EOL);
275 groups_[i].continuation_line_ = 0;
279 /* Check me, groups_.clear () ? */
283 Figured_bass_engraver::process_music ()
285 bool use_extenders = to_boolean (get_property ("useBassFigureExtenders"));
286 if (alignment_ && !use_extenders)
289 // If we have a rest, or we have no new or continued events, clear all spanners
290 bool ignore_rest = to_boolean (get_property ("ignoreFiguredBassRest"));
291 if ((ignore_rest && have_rest_)
292 || (!continuation_ && new_events_.empty ()))
299 if (!new_event_found_)
302 new_event_found_ = false;
305 Don't need to sync alignments, if we're not using extenders.
319 for (vsize i = 0; i < new_events_.size (); i++)
321 while (k < groups_.size ()
322 && groups_[k].current_event_)
325 if (k >= groups_.size ())
328 groups_.push_back (group);
331 groups_[k].reset_figure ();
332 groups_[k].current_event_ = new_events_[i];
333 groups_[k].figure_item_ = 0;
337 for (vsize i = 0; i < groups_.size (); i++)
339 if (!groups_[i].is_continuation ())
341 groups_[i].reset_figure ();
347 vector<int> junk_continuations;
348 for (vsize i = 0; i < groups_.size (); i++)
350 Figure_group &group = groups_[i];
352 if (group.is_continuation ())
354 if (!group.continuation_line_)
357 = make_spanner ("BassFigureContinuation", SCM_EOL);
358 Item *item = group.figure_item_;
359 group.continuation_line_ = line;
360 line->set_bound (LEFT, item);
363 Don't add as child. This will cache the wrong
364 (pre-break) stencil when callbacks are triggered.
366 line->set_parent (group.group_, Y_AXIS);
367 Pointer_group_interface::add_grob (line, ly_symbol2scm ("figures"), item);
369 group.figure_item_ = 0;
372 else if (group.continuation_line_)
373 junk_continuations.push_back (i);
379 vector<Spanner *> consecutive;
380 if (to_boolean (get_property ("figuredBassCenterContinuations")))
382 for (vsize i = 0; i <= junk_continuations.size (); i++)
384 if (i < junk_continuations.size ()
385 && (i == 0 || junk_continuations[i - 1] == junk_continuations[i] - 1))
386 consecutive.push_back (groups_[junk_continuations[i]].continuation_line_);
389 center_continuations (consecutive);
390 consecutive.clear ();
391 if (i < junk_continuations.size ())
392 consecutive.push_back (groups_[junk_continuations[i]].continuation_line_);
396 for (vsize i = 0; i < junk_continuations.size (); i++)
397 groups_[junk_continuations[i]].continuation_line_ = 0;
405 Figured_bass_engraver::create_grobs ()
408 = unsmob<Item> (get_property ("currentMusicalColumn"));
411 alignment_ = make_spanner ("BassFigureAlignment", SCM_EOL);
412 alignment_->set_bound (LEFT, muscol);
414 alignment_->set_bound (RIGHT, muscol);
416 SCM proc = get_property ("figuredBassFormatter");
417 for (vsize i = 0; i < groups_.size (); i++)
419 Figure_group &group = groups_[i];
421 if (group.current_event_)
424 = make_item ("BassFigure", group.current_event_->self_scm ());
425 group.assign_from_event (group.current_event_, item);
429 group.group_ = make_spanner ("BassFigureLine", SCM_EOL);
430 group.group_->set_bound (LEFT, muscol);
431 Align_interface::add_element (alignment_, group.group_);
434 if (scm_is_true (scm_memq (group.number_, get_property ("implicitBassFigures"))))
436 item->set_property ("transparent", SCM_BOOL_T);
437 item->set_property ("implicit", SCM_BOOL_T);
440 SCM text = group.text_;
441 if (!Text_interface::is_markup (text)
442 && ly_is_procedure (proc))
444 text = scm_call_3 (proc, group.number_, group.current_event_->self_scm (),
445 context ()->self_scm ());
448 item->set_property ("text", text);
450 Axis_group_interface::add_element (group.group_, item);
453 if (group.continuation_line_)
456 UGH should connect to the bass staff, and get the note heads.
457 For now, simply set the hidden figure to a default value to
458 ensure the extenders of different figures always end at the same
459 position, e.g. in <12 5> <12 5>
461 group.figure_item_->set_property ("transparent", SCM_BOOL_T);
462 group.figure_item_->set_property ("text", ly_string2scm ("0"));
463 group.continuation_line_->set_bound (RIGHT, group.figure_item_);
466 if (groups_[i].group_)
467 groups_[i].group_->set_bound (RIGHT, muscol);
474 Figured_bass_engraver::add_brackets ()
476 vector<Grob *> encompass;
478 for (vsize i = 0; i < groups_.size (); i++)
480 if (!groups_[i].current_event_)
483 if (to_boolean (groups_[i].current_event_->get_property ("bracket-start")))
486 if (inside && groups_[i].figure_item_)
487 encompass.push_back (groups_[i].figure_item_);
489 if (to_boolean (groups_[i].current_event_->get_property ("bracket-stop")))
493 Item *brack = make_item ("BassFigureBracket", groups_[i].current_event_->self_scm ());
494 for (vsize j = 0; j < encompass.size (); j++)
496 Pointer_group_interface::add_grob (brack,
497 ly_symbol2scm ("elements"),
506 Figured_bass_engraver::boot ()
508 ADD_LISTENER (Figured_bass_engraver, rest);
509 ADD_LISTENER (Figured_bass_engraver, bass_figure);
512 ADD_TRANSLATOR (Figured_bass_engraver,
514 "Make figured bass numbers.",
518 "BassFigureAlignment "
520 "BassFigureContinuation "
524 "figuredBassAlterationDirection "
525 "figuredBassCenterContinuations "
526 "figuredBassFormatter "
527 "implicitBassFigures "
528 "useBassFigureExtenders "
529 "ignoreFiguredBassRest ",