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>
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 "axis-group-interface.hh"
20 #include "translator.icc"
22 Paper_column_engraver::Paper_column_engraver ()
33 Paper_column_engraver::finalize ()
36 progress_indication ("[" + to_string (breaks_) + "]");
40 command_column_->set_property ("breakable", SCM_BOOL_T);
41 system_->set_bound (RIGHT, command_column_);
46 Paper_column_engraver::make_columns ()
51 Paper_column *p1 = make_paper_column ("NonMusicalPaperColumn");
52 Paper_column *p2 = make_paper_column ("PaperColumn");
54 SCM m = now_mom ().smobbed_copy ();
55 p1->set_property ("when", m);
56 p2->set_property ("when", m);
62 Paper_column_engraver::initialize ()
64 system_ = dynamic_cast<System *> (unsmob_grob (get_property ("rootSystem")));
67 system_->set_bound (LEFT, command_column_);
68 command_column_->set_property ("breakable", SCM_BOOL_T);
72 Paper_column_engraver::acknowledge_item (Grob_info gi)
74 items_.push (gi.item ());
78 Paper_column_engraver::acknowledge_staff_spacing (Grob_info gi)
80 Pointer_group_interface::add_grob (command_column_,
81 ly_symbol2scm ("spacing-wishes"),
85 Paper_column_engraver::acknowledge_note_spacing (Grob_info gi)
87 Pointer_group_interface::add_grob (musical_column_,
88 ly_symbol2scm ("spacing-wishes"),
93 Paper_column_engraver::set_columns (Paper_column *new_command,
94 Paper_column *new_musical)
96 command_column_ = new_command;
97 musical_column_ = new_musical;
100 context ()->set_property ("currentCommandColumn", new_command->self_scm ());
105 context ()->set_property ("currentMusicalColumn", new_musical->self_scm ());
108 system_->add_column (command_column_);
109 system_->add_column (musical_column_);
113 Paper_column_engraver::forbid_breaks ()
115 if (command_column_ && !first_)
116 command_column_->set_property ("breakable", SCM_EOL);
120 Paper_column_engraver::try_music (Music *m)
128 Paper_column_engraver::process_music ()
132 SCM pen = command_column_->get_property ("penalty");
133 Real total_penalty = scm_is_number (pen) ? scm_to_double (pen) : 0.0;
135 SCM mpen = break_event_->get_property ("penalty");
136 if (scm_is_number (mpen))
137 total_penalty += scm_to_double (mpen);
139 command_column_->set_property ("penalty", scm_from_double (total_penalty));
141 /* ugh. arbitrary, hardcoded */
142 if (total_penalty > 10000.0)
145 SCM page_pen = command_column_->get_property ("page-penalty");
146 Real total_pp = scm_is_number (page_pen) ? scm_to_double (page_pen) : 0.0;
147 SCM mpage_pen = break_event_->get_property ("page-penalty");
148 if (scm_is_number (mpage_pen))
149 total_pp += scm_to_double (mpage_pen);
151 command_column_->set_property ("page-penalty", scm_from_double (total_pp));
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 (int 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 = to_boolean (elem->get_property ("breakable"));
182 Axis_group_interface::add_element (br ? command_column_ : musical_column_, elem);
187 if (to_boolean (command_column_->get_property ("breakable")))
191 progress_indication ("[" + to_string (breaks_) + "]");
199 Paper_column_engraver::start_translation_timestep ()
202 TODO: don't make columns when skipTypesetting is true.
208 ADD_ACKNOWLEDGER (Paper_column_engraver, item);
209 ADD_ACKNOWLEDGER (Paper_column_engraver, note_spacing);
210 ADD_ACKNOWLEDGER (Paper_column_engraver, staff_spacing);
212 ADD_TRANSLATOR (Paper_column_engraver,
213 /* doc */ "Takes care of generating columns."
215 "This engraver decides whether a column is breakable. The default is "
216 "that a column is always breakable. However, when every Bar_engraver "
217 "that does not have a barline at a certain point will call "
218 "Score_engraver::forbid_breaks to stop linebreaks. In practice, this "
219 "means that you can make a breakpoint by creating a barline (assuming "
220 "that there are no beams or notes that prevent a breakpoint.) ",
221 /* create */ "PaperColumn NonMusicalPaperColumn",
222 /* accept */ "break-event",
224 /* write */ "currentCommandColumn currentMusicalColumn");