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);
65 Paper_column_engraver::initialize ()
67 system_ = dynamic_cast<System *> (unsmob_grob (get_property ("rootSystem")));
70 system_->set_bound (LEFT, command_column_);
71 command_column_->set_property ("line-break-permission", ly_symbol2scm ("allow"));
75 Paper_column_engraver::acknowledge_item (Grob_info gi)
77 items_.push_back (gi.item ());
81 Paper_column_engraver::acknowledge_staff_spacing (Grob_info gi)
83 Pointer_group_interface::add_grob (command_column_,
84 ly_symbol2scm ("spacing-wishes"),
88 Paper_column_engraver::acknowledge_note_spacing (Grob_info gi)
90 Pointer_group_interface::add_grob (musical_column_,
91 ly_symbol2scm ("spacing-wishes"),
96 Paper_column_engraver::set_columns (Paper_column *new_command,
97 Paper_column *new_musical)
99 command_column_ = new_command;
100 musical_column_ = new_musical;
102 context ()->set_property ("currentCommandColumn", new_command->self_scm ());
105 context ()->set_property ("currentMusicalColumn", new_musical->self_scm ());
107 system_->add_column (command_column_);
108 system_->add_column (musical_column_);
112 Paper_column_engraver::try_music (Music *m)
114 break_events_.push_back (m);
120 Paper_column_engraver::process_music ()
122 for (vsize i = 0; i < break_events_.size (); i++)
125 SCM name = break_events_[i]->get_property ("name");
126 if (name == ly_symbol2scm ("LineBreakEvent"))
127 prefix = "line-break";
128 else if (name == ly_symbol2scm ("PageBreakEvent"))
129 prefix = "page-break";
130 else if (name == ly_symbol2scm ("PageTurnEvent"))
131 prefix = "page-turn";
134 programming_error ("Paper_column_engraver doesn't know about this break-event");
137 string perm_str = prefix + "-permission";
138 string pen_str = prefix + "-penalty";
140 SCM cur_pen = command_column_->get_property (pen_str.c_str ());
141 SCM pen = break_events_[i]->get_property ("break-penalty");
142 SCM perm = break_events_[i]->get_property ("break-permission");
144 if (scm_is_number (pen))
146 Real new_pen = robust_scm2double (cur_pen, 0.0) + scm_to_double (pen);
147 command_column_->set_property (pen_str.c_str (), scm_from_double (new_pen));
148 command_column_->set_property (perm_str.c_str (), ly_symbol2scm ("allow"));
151 command_column_->set_property (perm_str.c_str (), perm);
154 bool start_of_measure = (last_moment_.main_part_ != now_mom ().main_part_
155 && !measure_position (context ()).main_part_);
158 We can't do this in start_translation_timestep(), since time sig
159 changes won't have happened by then.
161 if (start_of_measure)
163 Moment mlen = Moment (measure_length (context ()));
164 Grob *column = unsmob_grob (get_property ("currentCommandColumn"));
166 column->set_property ("measure-length", mlen.smobbed_copy ());
168 programming_error ("No command column?");
173 Paper_column_engraver::stop_translation_timestep ()
175 for (vsize i = 0; i < items_.size (); i++)
177 Item *elem = items_[i];
178 if (!elem->get_parent (X_AXIS)
179 || !unsmob_grob (elem->get_object ("axis-group-parent-X")))
181 bool br = Item::is_non_musical (elem);
182 Axis_group_interface::add_element (br ? command_column_ : musical_column_, elem);
187 if (to_boolean (get_property ("forbidBreak")))
188 command_column_->set_property ("line-break-permission", SCM_EOL);
189 else if (Paper_column::is_breakable (command_column_))
192 last_breakable_column_ = command_column_;
193 last_breakable_moment_ = now_mom ();
195 progress_indication ("[" + to_string (breaks_) + "]");
198 SCM page_br = get_property ("allowPageTurn");
199 if (scm_is_pair (page_br) && last_breakable_moment_ >= Rational (0))
201 SCM pen = scm_cdr (page_br);
202 Moment *m = unsmob_moment (scm_car (page_br));
203 if (m && scm_is_number (pen) && *m <= last_breakable_moment_)
205 last_breakable_column_->set_property ("page-turn-permission", ly_symbol2scm ("allow"));
206 last_breakable_column_->set_property ("page-turn-penalty", pen);
210 context ()->get_score_context ()->unset_property (ly_symbol2scm ("forbidBreak"));
211 context ()->get_score_context ()->unset_property (ly_symbol2scm ("allowPageTurn"));
214 break_events_.clear ();
218 Paper_column_engraver::start_translation_timestep ()
221 TODO: don't make columns when skipTypesetting is true.
227 ADD_ACKNOWLEDGER (Paper_column_engraver, item);
228 ADD_ACKNOWLEDGER (Paper_column_engraver, note_spacing);
229 ADD_ACKNOWLEDGER (Paper_column_engraver, staff_spacing);
231 ADD_TRANSLATOR (Paper_column_engraver,
232 /* doc */ "Takes care of generating columns."
234 "This engraver decides whether a column is breakable. The default is "
235 "that a column is always breakable. However, every Bar_engraver "
236 "that does not have a barline at a certain point will set forbidBreaks "
237 "in the score context to stop linebreaks. In practice, this "
238 "means that you can make a breakpoint by creating a barline (assuming "
239 "that there are no beams or notes that prevent a breakpoint.) ",
243 "NonMusicalPaperColumn",
245 /* accept */ "break-event",
252 "currentCommandColumn "
253 "currentMusicalColumn");