2 figured-bass-engraver.cc -- implement Figured_bass_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 2005 Han-Wen Nienhuys <hanwen@xs4all.nl>
10 #include "engraver.hh"
16 #include "axis-group-interface.hh"
17 #include "align-interface.hh"
18 #include "pointer-group-interface.hh"
19 #include "text-interface.hh"
20 #include "grob-array.hh"
23 #include "translator.icc"
28 Spanner *continuation_line_;
34 Music *current_music_;
35 bool force_no_continuation_;
40 force_no_continuation_ = false;
41 continuation_line_ = 0;
43 alteration_ = SCM_EOL;
47 bool is_continuation () const
51 && !force_no_continuation_
52 && ly_is_equal (number_,
53 current_music_->get_property ("figure"))
54 && ly_is_equal (alteration_,
55 current_music_->get_property ("alteration"));
59 struct Figured_bass_engraver : public Engraver
61 TRANSLATOR_DECLARATIONS(Figured_bass_engraver);
62 void clear_spanners();
66 void center_continuations (Link_array<Spanner> const &consecutive_lines);
67 void center_repeated_continuations ();
69 Array<Figure_group> groups_;
71 Link_array<Music> new_musics_;
73 bool new_music_found_;
78 virtual bool try_music (Music *);
79 virtual void derived_mark () const;
81 void start_translation_timestep ();
82 void stop_translation_timestep ();
83 void process_music ();
87 Figured_bass_engraver::derived_mark () const
89 for (int i = 0; i < groups_.size (); i++)
91 scm_gc_mark (groups_[i].number_);
92 scm_gc_mark (groups_[i].alteration_);
97 Figured_bass_engraver::stop_translation_timestep ()
99 if (groups_.is_empty ()
100 || now_mom ().main_part_ < stop_moment_.main_part_
101 || now_mom ().grace_part_ < Rational (0))
105 for (int i = 0; !found && i < groups_.size (); i++)
106 found = found || groups_[i].current_music_;
112 Figured_bass_engraver::Figured_bass_engraver ()
115 continuation_ = false;
117 new_music_found_ = false;
121 Figured_bass_engraver::start_translation_timestep ()
123 if (now_mom ().main_part_ < stop_moment_.main_part_
124 || now_mom ().grace_part_ < Rational (0))
128 new_musics_.clear ();
129 for (int i = 0; i < groups_.size (); i++)
131 groups_[i].current_music_ = 0;
133 continuation_ = false;
137 Figured_bass_engraver::try_music (Music *m)
139 new_music_found_ = true;
140 if (m->is_mus_type ("rest-event"))
147 stop_moment_ = now_mom () + m->get_length ();
149 SCM fig = m->get_property ("figure");
150 for (int i = 0; i < groups_.size (); i++)
152 if (!groups_[i].current_music_
153 && ly_is_equal (groups_[i].number_, fig))
155 groups_[i].current_music_ = m;
156 groups_[i].force_no_continuation_
157 = to_boolean (m->get_property ("no-continuation"));
158 continuation_ = true;
163 new_musics_.push (m);
170 Figured_bass_engraver::center_continuations (Link_array<Spanner> const &consecutive_lines)
172 if (consecutive_lines.size () == 2)
174 Link_array<Grob> left_figs;
175 for (int j = consecutive_lines.size(); j--;)
176 left_figs.push (consecutive_lines[j]->get_bound (LEFT));
178 SCM ga = Grob_array::make_array ();
179 unsmob_grob_array (ga)->set_array (left_figs);
181 for (int j = consecutive_lines.size(); j--;)
182 consecutive_lines[j]->set_object ("figures",
183 unsmob_grob_array (ga)->smobbed_copy ());
188 Figured_bass_engraver::center_repeated_continuations ()
190 Link_array<Spanner> consecutive_lines;
191 for (int i = 0; i <= groups_.size(); i++)
193 if (i < groups_.size ()
194 && groups_[i].continuation_line_
195 && (consecutive_lines.is_empty ()
196 || (consecutive_lines[0]->get_bound(LEFT)->get_column ()
197 == groups_[i].continuation_line_->get_bound (LEFT)->get_column ()
198 && consecutive_lines[0]->get_bound(RIGHT)->get_column ()
199 == groups_[i].continuation_line_->get_bound (RIGHT)->get_column ())))
201 consecutive_lines.push (groups_[i].continuation_line_);
205 center_continuations (consecutive_lines);
206 consecutive_lines.clear ();
212 Figured_bass_engraver::clear_spanners ()
218 if (to_boolean (get_property ("figuredBassCenterContinuations")))
219 center_repeated_continuations();
225 Figured_bass_engraver::add_brackets ()
227 Link_array<Grob> encompass;
229 for (int i = 0; i < groups_.size (); i ++)
231 if (!groups_[i].current_music_)
234 if (to_boolean (groups_[i].current_music_->get_property ("bracket-start")))
239 if (inside && groups_[i].figure_item_)
240 encompass.push (groups_[i].figure_item_);
242 if (to_boolean (groups_[i].current_music_->get_property ("bracket-stop")))
246 Item * brack = make_item ("BassFigureBracket", groups_[i].current_music_->self_scm ());
247 for (int j = 0; j < encompass.size (); j++)
249 Pointer_group_interface::add_grob (brack,
250 ly_symbol2scm ("elements"),
259 Figured_bass_engraver::process_music ()
268 && new_musics_.is_empty ())
274 if (!new_music_found_)
277 new_music_found_ = false;
280 Don't need to sync alignments, if we're not using extenders.
282 bool use_extenders = to_boolean (get_property ("useBassFigureExtenders"));
285 if (to_boolean (get_property ("figuredBassCenterContinuations")))
286 center_repeated_continuations ();
288 for (int i = 0; i < groups_.size (); i++)
290 groups_[i].group_ = 0;
291 groups_[i].continuation_line_ = 0;
301 for (int i = 0; i < new_musics_.size (); i++)
303 while (k < groups_.size() &&
304 groups_[k].current_music_)
307 if (k >= groups_.size ())
310 groups_.push (group);
313 groups_[k].current_music_ = new_musics_[i];
314 groups_[k].figure_item_ = 0;
318 for (int i = 0; i < groups_.size (); i++)
320 if (!groups_[i].is_continuation ())
322 groups_[i].number_ = SCM_BOOL_F;
323 groups_[i].alteration_ = SCM_BOOL_F;
329 Array<int> junk_continuations;
330 for (int i = 0; i < groups_.size(); i++)
332 Figure_group &group = groups_[i];
334 if (group.is_continuation ())
336 if (!group.continuation_line_)
338 Spanner * line = make_spanner ("BassFigureContinuation", SCM_EOL);
339 Item * item = group.figure_item_;
340 group.continuation_line_ = line;
341 line->set_bound (LEFT, item);
344 Don't add as child. This will cache the wrong
345 (pre-break) stencil when callbacks are triggered.
347 line->set_parent (group.group_, Y_AXIS);
348 Pointer_group_interface::add_grob (line, ly_symbol2scm ("figures"), item);
350 group.figure_item_ = 0;
353 else if (group.continuation_line_)
354 junk_continuations.push (i);
360 Link_array<Spanner> consecutive;
361 if (to_boolean (get_property ("figuredBassCenterContinuations")))
363 for (int i = 0; i <= junk_continuations.size (); i++)
365 if (i < junk_continuations.size()
366 && (i == 0 || junk_continuations[i-1] == junk_continuations[i] - 1))
367 consecutive.push (groups_[junk_continuations[i]].continuation_line_);
370 center_continuations (consecutive);
371 consecutive.clear ();
372 if (i < junk_continuations.size ())
373 consecutive.push (groups_[junk_continuations[i]].continuation_line_);
377 for (int i = 0; i < junk_continuations.size (); i++)
378 groups_[junk_continuations[i]].continuation_line_ = 0;
386 Figured_bass_engraver::create_grobs ()
388 Grob *muscol = dynamic_cast<Item*> (unsmob_grob (get_property ("currentMusicalColumn")));
391 alignment_ = make_spanner ("BassFigureAlignment", SCM_EOL);
392 alignment_->set_bound (LEFT, muscol);
394 alignment_->set_bound (RIGHT, muscol);
396 SCM proc = get_property ("figuredBassFormatter");
397 for (int i = 0; i < groups_.size(); i++)
399 Figure_group &group = groups_[i];
401 if (group.current_music_)
404 = make_item ("BassFigure",
405 group.current_music_->self_scm ());
408 SCM fig = group.current_music_->get_property ("figure");
411 group.group_ = make_spanner ("BassFigureLine", SCM_EOL);
412 group.group_->set_bound (LEFT, muscol);
413 Align_interface::add_element (alignment_,
417 if (scm_memq (fig, get_property ("implicitBassFigures")) != SCM_BOOL_F)
419 item->set_property ("transparent", SCM_BOOL_T);
420 item->set_property ("implicit", SCM_BOOL_T);
424 group.alteration_ = group.current_music_->get_property ("alteration");
426 SCM text = group.current_music_->get_property ("text");
427 if (!Text_interface::is_markup (text)
428 && ly_is_procedure (proc))
430 text = scm_call_3 (proc, fig, group.current_music_->self_scm (),
431 context ()->self_scm ());
434 item->set_property ("text", text);
436 Axis_group_interface::add_element (group.group_, item);
437 group.figure_item_ = item;
440 if (group.continuation_line_)
443 UGH should connect to the bass staff, and get the note heads.
445 group.figure_item_->set_property ("transparent", SCM_BOOL_T);
446 group.continuation_line_->set_bound (RIGHT, group.figure_item_);
450 if (groups_[i].group_)
451 groups_[i].group_->set_bound (RIGHT, muscol);
456 ADD_TRANSLATOR (Figured_bass_engraver,
459 "Make figured bass numbers.",
462 "BassFigureAlignment "
464 "BassFigureContinuation "
468 "bass-figure-event rest-event",
471 "figuredBassCenterContinuations "
472 "implicitBassFigures "
473 "figuredBassFormatter "
474 "figuredBassAlterationDirection "
475 "useBassFigureExtenders",