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