]> git.donarmstrong.com Git - lilypond.git/blob - lily/paper-column-engraver.cc
Doc: NR - spacing.itely: Various improvements
[lilypond.git] / lily / paper-column-engraver.cc
1 /*
2   This file is part of LilyPond, the GNU music typesetter.
3
4   Copyright (C) 2005--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
5
6   LilyPond is free software: you can redistribute it and/or modify
7   it under the terms of the GNU General Public License as published by
8   the Free Software Foundation, either version 3 of the License, or
9   (at your option) any later version.
10
11   LilyPond is distributed in the hope that it will be useful,
12   but WITHOUT ANY WARRANTY; without even the implied warranty of
13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14   GNU General Public License for more details.
15
16   You should have received a copy of the GNU General Public License
17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
18 */
19
20 #include "paper-column-engraver.hh"
21 #include "international.hh"
22 #include "accidental-placement.hh"
23 #include "accidental-interface.hh"
24 #include "arpeggio.hh"
25 #include "axis-group-interface.hh"
26 #include "context.hh"
27 #include "note-spacing.hh"
28 #include "paper-column.hh"
29 #include "pointer-group-interface.hh"
30 #include "separation-item.hh"
31 #include "staff-spacing.hh"
32 #include "system.hh"
33 #include "warn.hh"
34
35 #include "translator.icc"
36
37 Paper_column_engraver::Paper_column_engraver ()
38 {
39   last_moment_.main_part_ = Rational (-1, 1);
40   command_column_ = 0;
41   musical_column_ = 0;
42   breaks_ = 0;
43   system_ = 0;
44   first_ = true;
45   made_columns_ = false;
46 }
47
48 void
49 Paper_column_engraver::finalize ()
50 {
51   if (! (breaks_ % 8))
52     progress_indication ("[" + ::to_string (breaks_) + "]");
53
54   if (!made_columns_)
55     {
56       make_columns ();
57       SCM m = now_mom ().smobbed_copy ();
58       command_column_->set_property ("when", m);
59       musical_column_->set_property ("when", m);
60     }
61
62   if (command_column_)
63     {
64       // At the end of the score, allow page breaks and turns by default, but...
65       command_column_->set_property ("page-break-permission", ly_symbol2scm ("allow"));
66       command_column_->set_property ("page-turn-permission", ly_symbol2scm ("allow"));
67
68       // ...allow the user to override them.
69       handle_manual_breaks (true);
70
71       // On the other hand, line breaks are always allowed at the end of a score,
72       // even if they try to stop us.
73       if (!scm_is_symbol (command_column_->get_property ("line-break-permission")))
74         command_column_->set_property ("line-break-permission", ly_symbol2scm ("allow"));
75
76       system_->set_bound (RIGHT, command_column_);
77     }
78 }
79
80 void
81 Paper_column_engraver::make_columns ()
82 {
83   /*
84     ugh.
85   */
86   Paper_column *p1 = make_paper_column ("NonMusicalPaperColumn");
87   Paper_column *p2 = make_paper_column ("PaperColumn");
88   /*
89      The columns are timestamped with now_mom () in
90      stop_translation_timestep. Cannot happen now, because the
91      first column is sometimes created before now_mom is initialised.
92   */
93
94   set_columns (p1, p2);
95 }
96
97 void
98 Paper_column_engraver::initialize ()
99 {
100   system_ = unsmob<System> (get_property ("rootSystem"));
101   make_columns ();
102
103   system_->set_bound (LEFT, command_column_);
104   command_column_->set_property ("line-break-permission", ly_symbol2scm ("allow"));
105 }
106
107 void
108 Paper_column_engraver::acknowledge_item (Grob_info gi)
109 {
110   items_.push_back (gi.item ());
111 }
112
113 void
114 Paper_column_engraver::acknowledge_staff_spacing (Grob_info gi)
115 {
116   Pointer_group_interface::add_grob (command_column_,
117                                      ly_symbol2scm ("spacing-wishes"),
118                                      gi.grob ());
119 }
120
121 void
122 Paper_column_engraver::acknowledge_note_spacing (Grob_info gi)
123 {
124   Pointer_group_interface::add_grob (musical_column_,
125                                      ly_symbol2scm ("spacing-wishes"),
126                                      gi.grob ());
127 }
128
129 void
130 Paper_column_engraver::set_columns (Paper_column *new_command,
131                                     Paper_column *new_musical)
132 {
133   command_column_ = new_command;
134   musical_column_ = new_musical;
135   if (new_command)
136     context ()->set_property ("currentCommandColumn", new_command->self_scm ());
137
138   if (new_musical)
139     context ()->set_property ("currentMusicalColumn", new_musical->self_scm ());
140
141   system_->add_column (command_column_);
142   system_->add_column (musical_column_);
143 }
144
145 IMPLEMENT_TRANSLATOR_LISTENER (Paper_column_engraver, break);
146 void
147 Paper_column_engraver::listen_break (Stream_event *ev)
148 {
149   break_events_.push_back (ev);
150 }
151
152 IMPLEMENT_TRANSLATOR_LISTENER (Paper_column_engraver, label);
153 void
154 Paper_column_engraver::listen_label (Stream_event *ev)
155 {
156   label_events_.push_back (ev);
157 }
158
159 void
160 Paper_column_engraver::handle_manual_breaks (bool only_do_permissions)
161 {
162   for (vsize i = 0; i < break_events_.size (); i++)
163     {
164       string prefix;
165       SCM name_sym = scm_car (break_events_[i]->get_property ("class"));
166       string name = ly_symbol2string (name_sym);
167       size_t end = name.rfind ("-event");
168       if (end)
169         prefix = name.substr (0, end);
170       else
171         {
172           programming_error ("Paper_column_engraver doesn't know about this break-event");
173           return;
174         }
175
176       string perm_str = prefix + "-permission";
177       string pen_str = prefix + "-penalty";
178
179       SCM cur_pen = command_column_->get_property (pen_str.c_str ());
180       SCM pen = break_events_[i]->get_property ("break-penalty");
181       SCM perm = break_events_[i]->get_property ("break-permission");
182
183       if (!only_do_permissions && scm_is_number (pen))
184         {
185           Real new_pen = robust_scm2double (cur_pen, 0.0) + scm_to_double (pen);
186           command_column_->set_property (pen_str.c_str (), scm_from_double (new_pen));
187           command_column_->set_property (perm_str.c_str (), ly_symbol2scm ("allow"));
188         }
189       else
190         command_column_->set_property (perm_str.c_str (), perm);
191     }
192 }
193
194 void
195 Paper_column_engraver::process_music ()
196 {
197   handle_manual_breaks (false);
198
199   for (vsize i = 0; i < label_events_.size (); i++)
200     {
201       SCM label = label_events_[i]->get_property ("page-label");
202       SCM labels = command_column_->get_property ("labels");
203       command_column_->set_property ("labels", scm_cons (label, labels));
204     }
205
206   bool start_of_measure = (last_moment_.main_part_ != now_mom ().main_part_
207                            && !measure_position (context ()).main_part_);
208
209   /*
210     We can't do this in start_translation_timestep (), since time sig
211     changes won't have happened by then.
212   */
213   if (start_of_measure)
214     {
215       Moment mlen = Moment (measure_length (context ()));
216       Grob *column = unsmob<Grob> (get_property ("currentCommandColumn"));
217       if (column)
218         column->set_property ("measure-length", mlen.smobbed_copy ());
219       else
220         programming_error ("No command column?");
221     }
222 }
223
224 void
225 Paper_column_engraver::stop_translation_timestep ()
226 {
227   if (to_boolean (get_property ("skipTypesetting")))
228     return;
229
230   SCM m = now_mom ().smobbed_copy ();
231   command_column_->set_property ("when", m);
232   musical_column_->set_property ("when", m);
233
234   for (vsize i = 0; i < items_.size (); i++)
235     {
236       Item *elem = items_[i];
237       Grob *col = Item::is_non_musical (elem) ? command_column_ : musical_column_;
238
239       if (!elem->get_parent (X_AXIS))
240         elem->set_parent (col, X_AXIS);
241       if (!unsmob<Grob> (elem->get_object ("axis-group-parent-X")))
242         elem->set_object ("axis-group-parent-X", col->self_scm ());
243
244       if (has_interface<Accidental_placement> (elem)
245           || has_interface<Arpeggio> (elem))
246         Separation_item::add_conditional_item (col, elem);
247       else if (!has_interface<Accidental_interface> (elem))
248         Separation_item::add_item (col, elem);
249     }
250   items_.clear ();
251
252   if (to_boolean (get_property ("forbidBreak"))
253       && breaks_) /* don't honour forbidBreak if it occurs on the first moment of a score */
254     {
255       command_column_->set_property ("page-turn-permission", SCM_EOL);
256       command_column_->set_property ("page-break-permission", SCM_EOL);
257       command_column_->set_property ("line-break-permission", SCM_EOL);
258       for (vsize i = 0; i < break_events_.size (); i++)
259         {
260           SCM perm = break_events_[i]->get_property ("break-permission");
261           if (scm_is_eq (perm, ly_symbol2scm ("force"))
262               || scm_is_eq (perm, ly_symbol2scm ("allow")))
263             warning (_ ("forced break was overridden by some other event, "
264                         "should you be using bar checks?"));
265         }
266     }
267   else if (Paper_column::is_breakable (command_column_))
268     {
269       breaks_++;
270
271       if (! (breaks_ % 8))
272         progress_indication ("[" + ::to_string (breaks_) + "]");
273     }
274
275   context ()->get_score_context ()->unset_property (ly_symbol2scm ("forbidBreak"));
276
277   first_ = false;
278   label_events_.clear ();
279
280   SCM mpos = get_property ("measurePosition");
281   SCM barnum = get_property ("internalBarNumber");
282   if (unsmob<Moment> (mpos)
283       && scm_is_integer (barnum))
284     {
285       SCM where = scm_cons (barnum,
286                             mpos);
287
288       command_column_->set_property ("rhythmic-location", where);
289       musical_column_->set_property ("rhythmic-location", where);
290     }
291 }
292
293 void
294 Paper_column_engraver::start_translation_timestep ()
295 {
296   break_events_.clear ();
297   if (!first_ && !to_boolean (get_property ("skipTypesetting")))
298     {
299       make_columns ();
300       made_columns_ = true;
301     }
302 }
303
304 ADD_ACKNOWLEDGER (Paper_column_engraver, item);
305 ADD_ACKNOWLEDGER (Paper_column_engraver, note_spacing);
306 ADD_ACKNOWLEDGER (Paper_column_engraver, staff_spacing);
307
308 ADD_TRANSLATOR (Paper_column_engraver,
309                 /* doc */
310                 "Take care of generating columns.\n"
311                 "\n"
312                 "This engraver decides whether a column is breakable.  The"
313                 " default is that a column is always breakable.  However,"
314                 " every @code{Bar_engraver} that does not have a barline at a"
315                 " certain point will set @code{forbidBreaks} in the score"
316                 " context to stop line breaks.  In practice, this means that"
317                 " you can make a break point by creating a bar line (assuming"
318                 " that there are no beams or notes that prevent a break"
319                 " point).",
320
321                 /* create */
322                 "PaperColumn "
323                 "NonMusicalPaperColumn ",
324
325                 /* read */
326                 "forbidBreak ",
327
328                 /* write */
329                 "forbidBreak "
330                 "currentCommandColumn "
331                 "currentMusicalColumn "
332                );