]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/paper-column-engraver.cc
Imported Upstream version 2.16.0
[lilypond.git] / lily / paper-column-engraver.cc
index 8b2b550f2f460891acb13dc46d2a36d3a1e15d14..8ff894d8facbc9f402af3d33d2834125d95d97d6 100644 (file)
@@ -1,7 +1,7 @@
 /*
   This file is part of LilyPond, the GNU music typesetter.
 
-  Copyright (C) 2005--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  Copyright (C) 2005--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
   LilyPond is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
@@ -36,7 +36,7 @@
 
 Paper_column_engraver::Paper_column_engraver ()
 {
-  last_moment_.main_part_ = Rational (-1,1); 
+  last_moment_.main_part_ = Rational (-1, 1);
   command_column_ = 0;
   musical_column_ = 0;
   breaks_ = 0;
@@ -61,8 +61,18 @@ Paper_column_engraver::finalize ()
 
   if (command_column_)
     {
+      // At the end of the score, allow page breaks and turns by default, but...
+      command_column_->set_property ("page-break-permission", ly_symbol2scm ("allow"));
+      command_column_->set_property ("page-turn-permission", ly_symbol2scm ("allow"));
+
+      // ...allow the user to override them.
+      handle_manual_breaks (true);
+
+      // On the other hand, line breaks are always allowed at the end of a score,
+      // even if they try to stop us.
       if (!scm_is_symbol (command_column_->get_property ("line-break-permission")))
-       command_column_->set_property ("line-break-permission", ly_symbol2scm ("allow"));
+        command_column_->set_property ("line-break-permission", ly_symbol2scm ("allow"));
+
       system_->set_bound (RIGHT, command_column_);
     }
 }
@@ -75,7 +85,7 @@ Paper_column_engraver::make_columns ()
   */
   Paper_column *p1 = make_paper_column ("NonMusicalPaperColumn");
   Paper_column *p2 = make_paper_column ("PaperColumn");
-  /* 
+  /*
      The columns are timestamped with now_mom () in
      stop_translation_timestep. Cannot happen now, because the
      first column is sometimes created before now_mom is initialised.
@@ -104,21 +114,21 @@ void
 Paper_column_engraver::acknowledge_staff_spacing (Grob_info gi)
 {
   Pointer_group_interface::add_grob (command_column_,
-                                    ly_symbol2scm ("spacing-wishes"),
-                                    gi.grob ());
+                                     ly_symbol2scm ("spacing-wishes"),
+                                     gi.grob ());
 }
 
 void
 Paper_column_engraver::acknowledge_note_spacing (Grob_info gi)
 {
   Pointer_group_interface::add_grob (musical_column_,
-                                    ly_symbol2scm ("spacing-wishes"),
-                                    gi.grob ());
+                                     ly_symbol2scm ("spacing-wishes"),
+                                     gi.grob ());
 }
 
 void
 Paper_column_engraver::set_columns (Paper_column *new_command,
-                                   Paper_column *new_musical)
+                                    Paper_column *new_musical)
 {
   command_column_ = new_command;
   musical_column_ = new_musical;
@@ -147,21 +157,21 @@ Paper_column_engraver::listen_label (Stream_event *ev)
 }
 
 void
-Paper_column_engraver::process_music ()
+Paper_column_engraver::handle_manual_breaks (bool only_do_permissions)
 {
   for (vsize i = 0; i < break_events_.size (); i++)
     {
       string prefix;
-      SCM name_sym = break_events_[i]->get_property ("class");
-      string name = ly_scm2string (scm_symbol_to_string (name_sym));
+      SCM name_sym = scm_car (break_events_[i]->get_property ("class"));
+      string name = ly_symbol2string (name_sym);
       size_t end = name.rfind ("-event");
       if (end)
-       prefix = name.substr (0, end);
+        prefix = name.substr (0, end);
       else
-       {
-         programming_error ("Paper_column_engraver doesn't know about this break-event");
-         return;
-       }
+        {
+          programming_error ("Paper_column_engraver doesn't know about this break-event");
+          return;
+        }
 
       string perm_str = prefix + "-permission";
       string pen_str = prefix + "-penalty";
@@ -170,17 +180,23 @@ Paper_column_engraver::process_music ()
       SCM pen = break_events_[i]->get_property ("break-penalty");
       SCM perm = break_events_[i]->get_property ("break-permission");
 
-      if (scm_is_number (pen))
-       {
-         Real new_pen = robust_scm2double (cur_pen, 0.0) + scm_to_double (pen);
-         command_column_->set_property (pen_str.c_str (), scm_from_double (new_pen));
-         command_column_->set_property (perm_str.c_str (), ly_symbol2scm ("allow"));
-       }
+      if (!only_do_permissions && scm_is_number (pen))
+        {
+          Real new_pen = robust_scm2double (cur_pen, 0.0) + scm_to_double (pen);
+          command_column_->set_property (pen_str.c_str (), scm_from_double (new_pen));
+          command_column_->set_property (perm_str.c_str (), ly_symbol2scm ("allow"));
+        }
       else
-       command_column_->set_property (perm_str.c_str (), perm);
+        command_column_->set_property (perm_str.c_str (), perm);
     }
+}
 
-  for (vsize i = 0 ; i < label_events_.size () ; i ++)
+void
+Paper_column_engraver::process_music ()
+{
+  handle_manual_breaks (false);
+
+  for (vsize i = 0; i < label_events_.size (); i++)
     {
       SCM label = label_events_[i]->get_property ("page-label");
       SCM labels = command_column_->get_property ("labels");
@@ -188,7 +204,7 @@ Paper_column_engraver::process_music ()
     }
 
   bool start_of_measure = (last_moment_.main_part_ != now_mom ().main_part_
-                          && !measure_position (context ()).main_part_);
+                           && !measure_position (context ()).main_part_);
 
   /*
     We can't do this in start_translation_timestep (), since time sig
@@ -199,9 +215,9 @@ Paper_column_engraver::process_music ()
       Moment mlen = Moment (measure_length (context ()));
       Grob *column = unsmob_grob (get_property ("currentCommandColumn"));
       if (column)
-       column->set_property ("measure-length", mlen.smobbed_copy ());
+        column->set_property ("measure-length", mlen.smobbed_copy ());
       else
-       programming_error ("No command column?");
+        programming_error ("No command column?");
     }
 }
 
@@ -221,43 +237,42 @@ Paper_column_engraver::stop_translation_timestep ()
       Grob *col = Item::is_non_musical (elem) ? command_column_ : musical_column_;
 
       if (!elem->get_parent (X_AXIS))
-       elem->set_parent (col, X_AXIS);
+        elem->set_parent (col, X_AXIS);
       if (!unsmob_grob (elem->get_object ("axis-group-parent-X")))
-       elem->set_object ("axis-group-parent-X", col->self_scm ());
+        elem->set_object ("axis-group-parent-X", col->self_scm ());
 
       if (Accidental_placement::has_interface (elem))
-       Separation_item::add_conditional_item (col, elem);
+        Separation_item::add_conditional_item (col, elem);
       else if (!Accidental_interface::has_interface (elem))
-       Separation_item::add_item (col, elem);
+        Separation_item::add_item (col, elem);
     }
   items_.clear ();
 
   if (to_boolean (get_property ("forbidBreak"))
-     && breaks_) /* don't honour forbidBreak if it occurs on the first moment of a score */
+      && breaks_) /* don't honour forbidBreak if it occurs on the first moment of a score */
     {
       command_column_->set_property ("page-turn-permission", SCM_EOL);
       command_column_->set_property ("page-break-permission", SCM_EOL);
       command_column_->set_property ("line-break-permission", SCM_EOL);
       for (vsize i = 0; i < break_events_.size (); i++)
-       {
-         SCM perm = break_events_[i]->get_property ("break-permission");
-         if (perm == ly_symbol2scm ("force") || perm == ly_symbol2scm ("allow"))
-           warning (_ ("forced break was overridden by some other event, "
-                       "should you be using bar checks?"));
-       }
+        {
+          SCM perm = break_events_[i]->get_property ("break-permission");
+          if (perm == ly_symbol2scm ("force") || perm == ly_symbol2scm ("allow"))
+            warning (_ ("forced break was overridden by some other event, "
+                        "should you be using bar checks?"));
+        }
     }
   else if (Paper_column::is_breakable (command_column_))
     {
       breaks_++;
 
-      if (! (breaks_%8))
-       progress_indication ("[" + to_string (breaks_) + "]");
+      if (! (breaks_ % 8))
+        progress_indication ("[" + to_string (breaks_) + "]");
     }
 
   context ()->get_score_context ()->unset_property (ly_symbol2scm ("forbidBreak"));
 
   first_ = false;
-  break_events_.clear ();
   label_events_.clear ();
 
   SCM mpos = get_property ("measurePosition");
@@ -266,7 +281,7 @@ Paper_column_engraver::stop_translation_timestep ()
       && scm_is_integer (barnum))
     {
       SCM where = scm_cons (barnum,
-                           mpos);
+                            mpos);
 
       command_column_->set_property ("rhythmic-location", where);
       musical_column_->set_property ("rhythmic-location", where);
@@ -276,6 +291,7 @@ Paper_column_engraver::stop_translation_timestep ()
 void
 Paper_column_engraver::start_translation_timestep ()
 {
+  break_events_.clear ();
   if (!first_ && !to_boolean (get_property ("skipTypesetting")))
     {
       make_columns ();
@@ -288,27 +304,27 @@ ADD_ACKNOWLEDGER (Paper_column_engraver, note_spacing);
 ADD_ACKNOWLEDGER (Paper_column_engraver, staff_spacing);
 
 ADD_TRANSLATOR (Paper_column_engraver,
-               /* doc */
-               "Take care of generating columns.\n"
-               "\n"
-               "This engraver decides whether a column is breakable.  The"
-               " default is that a column is always breakable.  However,"
-               " every @code{Bar_engraver} that does not have a barline at a"
-               " certain point will set @code{forbidBreaks} in the score"
-               " context to stop line breaks.  In practice, this means that"
-               " you can make a break point by creating a bar line (assuming"
-               " that there are no beams or notes that prevent a break"
-               " point).",
-               
-               /* create */
-               "PaperColumn "
-               "NonMusicalPaperColumn ",
-
-               /* read */
+                /* doc */
+                "Take care of generating columns.\n"
+                "\n"
+                "This engraver decides whether a column is breakable.  The"
+                " default is that a column is always breakable.  However,"
+                " every @code{Bar_engraver} that does not have a barline at a"
+                " certain point will set @code{forbidBreaks} in the score"
+                " context to stop line breaks.  In practice, this means that"
+                " you can make a break point by creating a bar line (assuming"
+                " that there are no beams or notes that prevent a break"
+                " point).",
+
+                /* create */
+                "PaperColumn "
+                "NonMusicalPaperColumn ",
+
+                /* read */
                 "forbidBreak ",
 
-               /* write */
+                /* write */
                 "forbidBreak "
-               "currentCommandColumn "
-               "currentMusicalColumn "
-               );
+                "currentCommandColumn "
+                "currentMusicalColumn "
+               );