2 paper-column-engraver.cc -- implement Paper_column_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 2005 Han-Wen Nienhuys <hanwen@xs4all.nl>
10 #include "paper-column-engraver.hh"
13 #include "paper-column.hh"
14 #include "staff-spacing.hh"
15 #include "note-spacing.hh"
16 #include "pointer-group-interface.hh"
18 #include "axis-group-interface.hh"
21 #include "translator.icc"
24 Paper_column_engraver::Paper_column_engraver ()
35 Paper_column_engraver::finalize ()
38 progress_indication ("[" + to_string (breaks_) + "]");
42 command_column_->set_property ("breakable", SCM_BOOL_T);
43 system_->set_bound (RIGHT, command_column_);
48 Paper_column_engraver::make_columns ()
53 Paper_column *p1 = make_paper_column ("NonMusicalPaperColumn");
54 Paper_column *p2 = make_paper_column ("PaperColumn");
56 SCM m = now_mom().smobbed_copy();
57 p1->set_property ("when", m);
58 p2->set_property ("when", m);
65 Paper_column_engraver::initialize ()
67 system_ = dynamic_cast<System*> (unsmob_grob (get_property ("rootSystem")));
71 system_->set_bound (LEFT, command_column_);
72 command_column_->set_property ("breakable", SCM_BOOL_T);
76 Paper_column_engraver::acknowledge_item (Grob_info gi)
78 items_.push (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;
104 context ()->set_property ("currentCommandColumn", new_command->self_scm ());
109 context ()->set_property ("currentMusicalColumn", new_musical->self_scm ());
112 system_->add_column (command_column_);
113 system_->add_column (musical_column_);
118 Paper_column_engraver::forbid_breaks ()
120 if (command_column_ && !first_)
121 command_column_->set_property ("breakable", SCM_EOL);
126 Paper_column_engraver::try_music (Music *m)
134 Paper_column_engraver::process_music ()
138 SCM pen = command_column_->get_property ("penalty");
139 Real total_penalty = scm_is_number (pen) ? scm_to_double (pen) : 0.0;
141 SCM mpen = break_event_->get_property ("penalty");
142 if (scm_is_number (mpen))
143 total_penalty += scm_to_double (mpen);
145 command_column_->set_property ("penalty", scm_from_double (total_penalty));
147 /* ugh. arbitrary, hardcoded */
148 if (total_penalty > 10000.0)
151 SCM page_pen = command_column_->get_property ("page-penalty");
152 Real total_pp = scm_is_number (page_pen) ? scm_to_double (page_pen) : 0.0;
153 SCM mpage_pen = break_event_->get_property ("page-penalty");
154 if (scm_is_number (mpage_pen))
155 total_pp += scm_to_double (mpage_pen);
157 command_column_->set_property ("page-penalty", scm_from_double (total_pp));
161 bool start_of_measure = (last_moment_.main_part_ != now_mom ().main_part_
162 && !measure_position (context ()).main_part_);
165 We can't do this in start_translation_timestep(), since time sig
166 changes won't have happened by then.
168 if (start_of_measure)
170 Moment mlen = Moment (measure_length (context ()));
171 Grob * column = unsmob_grob (get_property ("currentCommandColumn"));
173 column->set_property ("measure-length", mlen.smobbed_copy ());
175 programming_error("No command column?");
180 Paper_column_engraver::stop_translation_timestep ()
182 for (int i = 0; i < items_.size (); i++)
184 Item *elem = items_[i];
185 if (!elem->get_parent (X_AXIS)
186 || !unsmob_grob (elem->get_object ("axis-group-parent-X")))
188 bool br = to_boolean (elem->get_property ("breakable"));
189 Axis_group_interface::add_element (br ? command_column_ : musical_column_, elem);
194 if (to_boolean (command_column_->get_property ("breakable")))
198 progress_indication ("[" + to_string (breaks_) + "]");
206 Paper_column_engraver::start_translation_timestep ()
209 TODO: don't make columns when skipTypesetting is true.
215 ADD_ACKNOWLEDGER (Paper_column_engraver,item);
216 ADD_ACKNOWLEDGER (Paper_column_engraver,note_spacing);
217 ADD_ACKNOWLEDGER (Paper_column_engraver,staff_spacing);
220 ADD_TRANSLATOR (Paper_column_engraver,
221 /* doc */ "Takes care of generating columns."
223 "This engraver decides whether a column is breakable. The default is "
224 "that a column is always breakable. However, when every Bar_engraver "
225 "that does not have a barline at a certain point will call "
226 "Score_engraver::forbid_breaks to stop linebreaks. In practice, this "
227 "means that you can make a breakpoint by creating a barline (assuming "
228 "that there are no beams or notes that prevent a breakpoint.) ",
229 /* create */ "PaperColumn NonMusicalPaperColumn",
230 /* accept */ "break-event",
232 /* write */ "currentCommandColumn currentMusicalColumn");