2 paper-column-engraver.cc -- implement Paper_column_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 2005--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
9 #include "paper-column-engraver.hh"
11 #include "international.hh"
12 #include "axis-group-interface.hh"
15 #include "note-spacing.hh"
16 #include "paper-column.hh"
17 #include "pointer-group-interface.hh"
18 #include "staff-spacing.hh"
22 #include "translator.icc"
24 Paper_column_engraver::Paper_column_engraver ()
26 last_moment_.main_part_ = Rational (-1,1);
31 last_special_barline_column_ = 0;
32 last_breakable_column_ = 0;
37 Paper_column_engraver::finalize ()
40 progress_indication ("[" + to_string (breaks_) + "]");
44 command_column_->set_property ("line-break-permission", ly_symbol2scm ("allow"));
45 command_column_->set_property ("page-turn-permission", ly_symbol2scm ("allow"));
46 system_->set_bound (RIGHT, command_column_);
51 Paper_column_engraver::make_columns ()
56 Paper_column *p1 = make_paper_column ("NonMusicalPaperColumn");
57 Paper_column *p2 = make_paper_column ("PaperColumn");
59 The columns are timestamped with now_mom () in
60 stop_translation_timestep. Cannot happen now, because the
61 first column is sometimes created before now_mom is initialised.
68 Paper_column_engraver::initialize ()
70 system_ = dynamic_cast<System *> (unsmob_grob (get_property ("rootSystem")));
73 system_->set_bound (LEFT, command_column_);
74 command_column_->set_property ("line-break-permission", ly_symbol2scm ("allow"));
78 Paper_column_engraver::acknowledge_item (Grob_info gi)
80 items_.push_back (gi.item ());
84 Paper_column_engraver::acknowledge_staff_spacing (Grob_info gi)
86 Pointer_group_interface::add_grob (command_column_,
87 ly_symbol2scm ("spacing-wishes"),
92 Paper_column_engraver::acknowledge_note_spacing (Grob_info gi)
94 Pointer_group_interface::add_grob (musical_column_,
95 ly_symbol2scm ("spacing-wishes"),
100 Paper_column_engraver::set_columns (Paper_column *new_command,
101 Paper_column *new_musical)
103 command_column_ = new_command;
104 musical_column_ = new_musical;
106 context ()->set_property ("currentCommandColumn", new_command->self_scm ());
109 context ()->set_property ("currentMusicalColumn", new_musical->self_scm ());
111 system_->add_column (command_column_);
112 system_->add_column (musical_column_);
115 IMPLEMENT_TRANSLATOR_LISTENER (Paper_column_engraver, break);
117 Paper_column_engraver::listen_break (Stream_event *ev)
119 break_events_.push_back (ev);
123 Paper_column_engraver::process_music ()
125 for (vsize i = 0; i < break_events_.size (); i++)
128 SCM name_sym = break_events_[i]->get_property ("class");
129 string name = ly_scm2string (scm_symbol_to_string (name_sym));
130 size_t end = name.rfind ("-event");
132 prefix = name.substr (0, end);
135 programming_error ("Paper_column_engraver doesn't know about this break-event");
139 string perm_str = prefix + "-permission";
140 string pen_str = prefix + "-penalty";
142 SCM cur_pen = command_column_->get_property (pen_str.c_str ());
143 SCM pen = break_events_[i]->get_property ("break-penalty");
144 SCM perm = break_events_[i]->get_property ("break-permission");
146 if (scm_is_number (pen))
148 Real new_pen = robust_scm2double (cur_pen, 0.0) + scm_to_double (pen);
149 command_column_->set_property (pen_str.c_str (), scm_from_double (new_pen));
150 command_column_->set_property (perm_str.c_str (), ly_symbol2scm ("allow"));
153 command_column_->set_property (perm_str.c_str (), perm);
156 bool start_of_measure = (last_moment_.main_part_ != now_mom ().main_part_
157 && !measure_position (context ()).main_part_);
160 We can't do this in start_translation_timestep(), since time sig
161 changes won't have happened by then.
163 if (start_of_measure)
165 Moment mlen = Moment (measure_length (context ()));
166 Grob *column = unsmob_grob (get_property ("currentCommandColumn"));
168 column->set_property ("measure-length", mlen.smobbed_copy ());
170 programming_error ("No command column?");
175 - the last column with a special (ie. not "|" or "") barline
177 after the given moment
180 Paper_column_engraver::find_turnable_column (Moment after_this)
182 if (last_special_barline_column_)
184 Moment m = *unsmob_moment (last_special_barline_column_->get_property ("when"));
186 return last_special_barline_column_;
188 if (last_breakable_column_)
190 Moment m = *unsmob_moment (last_breakable_column_->get_property ("when"));
192 return last_breakable_column_;
198 Paper_column_engraver::revoke_page_turns (Moment after_this, Real new_penalty)
200 if (!page_turnable_columns_.size ())
203 for (vsize i = page_turnable_columns_.size () - 1; i--;)
205 Paper_column *col = page_turnable_columns_[i];
206 Moment mom = *unsmob_moment (col->get_property ("when"));
207 if (mom >= after_this)
209 if (isinf (new_penalty))
211 col->del_property ( ly_symbol2scm ("page-turn-permission"));
212 page_turnable_columns_.erase (page_turnable_columns_.begin () + i);
216 Real prev_pen = robust_scm2double (col->get_property ("page-turn-penalty"), 0);
217 if (new_penalty > prev_pen)
218 col->set_property ("page-turn-penalty", scm_from_double (new_penalty));
225 Paper_column_engraver::stop_translation_timestep ()
227 SCM m = now_mom ().smobbed_copy ();
228 command_column_->set_property ("when", m);
229 musical_column_->set_property ("when", m);
231 for (vsize i = 0; i < items_.size (); i++)
233 Item *elem = items_[i];
234 if (!elem->get_parent (X_AXIS)
235 || !unsmob_grob (elem->get_object ("axis-group-parent-X")))
237 bool br = Item::is_non_musical (elem);
238 Axis_group_interface::add_element (br ? command_column_ : musical_column_, elem);
243 if (to_boolean (get_property ("forbidBreak")))
244 command_column_->set_property ("line-break-permission", SCM_EOL);
245 else if (Paper_column::is_breakable (command_column_))
248 last_breakable_column_ = command_column_;
250 SCM which_bar = get_property ("whichBar");
251 if (scm_is_string (which_bar))
253 string bar = ly_scm2string (which_bar);
254 if (bar != "" && bar != "|")
255 last_special_barline_column_ = command_column_;
259 progress_indication ("[" + to_string (breaks_) + "]");
262 SCM page_br = get_property ("allowPageTurn");
263 if (scm_is_pair (page_br) && last_breakable_column_)
265 SCM pen = scm_cdr (page_br);
266 Moment *m = unsmob_moment (scm_car (page_br));
269 Paper_column *turn = find_turnable_column (*m);
272 turn->set_property ("page-turn-permission", ly_symbol2scm ("allow"));
273 turn->set_property ("page-turn-penalty", pen);
274 page_turnable_columns_.push_back (turn);
279 /* The page-turn-engraver is allowed to change its mind and revoke previously-allowed
280 page turns (for example if there is a volta repeat where a turn is inconvenient) */
281 SCM revokes = get_property ("revokePageTurns");
282 if (scm_is_pair (revokes))
284 Moment *start = unsmob_moment (scm_car (revokes));
285 Real pen = robust_scm2double (scm_cdr (revokes), infinity_f);
287 revoke_page_turns (*start, pen);
290 context ()->get_score_context ()->unset_property (ly_symbol2scm ("forbidBreak"));
291 context ()->get_score_context ()->unset_property (ly_symbol2scm ("allowPageTurn"));
292 context ()->get_score_context ()->unset_property (ly_symbol2scm ("revokePageTurns"));
295 break_events_.clear ();
299 Paper_column_engraver::start_translation_timestep ()
302 TODO: don't make columns when skipTypesetting is true.
308 ADD_ACKNOWLEDGER (Paper_column_engraver, item);
309 ADD_ACKNOWLEDGER (Paper_column_engraver, note_spacing);
310 ADD_ACKNOWLEDGER (Paper_column_engraver, staff_spacing);
312 ADD_TRANSLATOR (Paper_column_engraver,
313 /* doc */ "Takes care of generating columns."
315 "This engraver decides whether a column is breakable. The default is "
316 "that a column is always breakable. However, every Bar_engraver "
317 "that does not have a barline at a certain point will set forbidBreaks "
318 "in the score context to stop linebreaks. In practice, this "
319 "means that you can make a breakpoint by creating a barline (assuming "
320 "that there are no beams or notes that prevent a breakpoint.) ",
324 "NonMusicalPaperColumn",
326 /* accept */ "break-event",
336 "currentCommandColumn "
337 "currentMusicalColumn "