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"
12 #include "paper-column.hh"
13 #include "staff-spacing.hh"
14 #include "note-spacing.hh"
15 #include "pointer-group-interface.hh"
17 #include "score-context.hh"
18 #include "axis-group-interface.hh"
21 #include "translator.icc"
23 Paper_column_engraver::Paper_column_engraver ()
25 last_moment_.main_part_ = Rational (-1,1);
31 last_breakable_column_ = 0;
32 last_breakable_moment_ = Moment (-1);
36 Paper_column_engraver::finalize ()
39 progress_indication ("[" + to_string (breaks_) + "]");
43 command_column_->set_property ("line-break-permission", ly_symbol2scm ("allow"));
44 system_->set_bound (RIGHT, command_column_);
49 Paper_column_engraver::make_columns ()
54 Paper_column *p1 = make_paper_column ("NonMusicalPaperColumn");
55 Paper_column *p2 = make_paper_column ("PaperColumn");
57 SCM m = now_mom ().smobbed_copy ();
58 p1->set_property ("when", m);
59 p2->set_property ("when", m);
60 p1->set_property ("line-break-permission", ly_symbol2scm ("allow"));
66 Paper_column_engraver::initialize ()
68 system_ = dynamic_cast<System *> (unsmob_grob (get_property ("rootSystem")));
71 system_->set_bound (LEFT, command_column_);
72 command_column_->set_property ("line-break-permission", ly_symbol2scm ("allow"));
76 Paper_column_engraver::acknowledge_item (Grob_info gi)
78 items_.push_back (gi.item ());
82 Paper_column_engraver::acknowledge_staff_spacing (Grob_info gi)
84 Pointer_group_interface::add_grob (command_column_,
85 ly_symbol2scm ("spacing-wishes"),
89 Paper_column_engraver::acknowledge_note_spacing (Grob_info gi)
91 Pointer_group_interface::add_grob (musical_column_,
92 ly_symbol2scm ("spacing-wishes"),
97 Paper_column_engraver::set_columns (Paper_column *new_command,
98 Paper_column *new_musical)
100 command_column_ = new_command;
101 musical_column_ = new_musical;
103 context ()->set_property ("currentCommandColumn", new_command->self_scm ());
106 context ()->set_property ("currentMusicalColumn", new_musical->self_scm ());
108 system_->add_column (command_column_);
109 system_->add_column (musical_column_);
113 Paper_column_engraver::try_music (Music *m)
115 break_events_.push_back (m);
121 Paper_column_engraver::process_music ()
123 for (vsize i = 0; i < break_events_.size (); i++)
126 SCM name = break_events_[i]->get_property ("name");
127 if (name == ly_symbol2scm ("LineBreakEvent"))
128 prefix = "line-break";
129 else if (name == ly_symbol2scm ("PageBreakEvent"))
130 prefix = "page-break";
131 else if (name == ly_symbol2scm ("PageTurnEvent"))
132 prefix = "page-turn";
135 programming_error ("Paper_column_engraver doesn't know about this break-event");
138 string perm_str = prefix + "-permission";
139 string pen_str = prefix + "-penalty";
141 SCM cur_pen = command_column_->get_property (pen_str.c_str ());
142 SCM pen = break_events_[i]->get_property ("break-penalty");
143 SCM perm = break_events_[i]->get_property ("break-permission");
145 if (scm_is_number (pen))
147 Real new_pen = robust_scm2double (cur_pen, 0.0) + scm_to_double (pen);
148 command_column_->set_property (pen_str.c_str (), scm_from_double (new_pen));
149 command_column_->set_property (perm_str.c_str (), ly_symbol2scm ("allow"));
152 command_column_->set_property (perm_str.c_str (), perm);
155 bool start_of_measure = (last_moment_.main_part_ != now_mom ().main_part_
156 && !measure_position (context ()).main_part_);
159 We can't do this in start_translation_timestep(), since time sig
160 changes won't have happened by then.
162 if (start_of_measure)
164 Moment mlen = Moment (measure_length (context ()));
165 Grob *column = unsmob_grob (get_property ("currentCommandColumn"));
167 column->set_property ("measure-length", mlen.smobbed_copy ());
169 programming_error ("No command column?");
174 Paper_column_engraver::stop_translation_timestep ()
176 for (vsize i = 0; i < items_.size (); i++)
178 Item *elem = items_[i];
179 if (!elem->get_parent (X_AXIS)
180 || !unsmob_grob (elem->get_object ("axis-group-parent-X")))
182 bool br = Item::is_non_musical (elem);
183 Axis_group_interface::add_element (br ? command_column_ : musical_column_, elem);
188 if (to_boolean (get_property ("forbidBreak")))
189 command_column_->set_property ("line-break-permission", SCM_EOL);
193 last_breakable_column_ = command_column_;
194 last_breakable_moment_ = now_mom ();
196 progress_indication ("[" + to_string (breaks_) + "]");
199 SCM page_br = get_property ("allowPageTurn");
200 if (scm_is_pair (page_br) && last_breakable_moment_ >= Rational (0))
202 SCM pen = scm_cdr (page_br);
203 Moment *m = unsmob_moment (scm_car (page_br));
204 if (m && scm_is_number (pen) && *m <= last_breakable_moment_)
206 last_breakable_column_->set_property ("page-turn-permission", ly_symbol2scm ("allow"));
207 last_breakable_column_->set_property ("page-turn-penalty", pen);
211 context ()->get_score_context ()->unset_property (ly_symbol2scm ("forbidBreak"));
212 context ()->get_score_context ()->unset_property (ly_symbol2scm ("allowPageTurn"));
215 break_events_.clear ();
219 Paper_column_engraver::start_translation_timestep ()
222 TODO: don't make columns when skipTypesetting is true.
228 ADD_ACKNOWLEDGER (Paper_column_engraver, item);
229 ADD_ACKNOWLEDGER (Paper_column_engraver, note_spacing);
230 ADD_ACKNOWLEDGER (Paper_column_engraver, staff_spacing);
232 ADD_TRANSLATOR (Paper_column_engraver,
233 /* doc */ "Takes care of generating columns."
235 "This engraver decides whether a column is breakable. The default is "
236 "that a column is always breakable. However, every Bar_engraver "
237 "that does not have a barline at a certain point will set forbidBreaks "
238 "in the score context to stop linebreaks. In practice, this "
239 "means that you can make a breakpoint by creating a barline (assuming "
240 "that there are no beams or notes that prevent a breakpoint.) ",
244 "NonMusicalPaperColumn",
246 /* accept */ "break-event",
253 "currentCommandColumn "
254 "currentMusicalColumn");