]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/paper-column-engraver.cc
Run `make grand-replace'.
[lilypond.git] / lily / paper-column-engraver.cc
index 652ab1a1b757d9fb7a6df12c1605362957058cf1..df3723fb79dd327ae318666e2fba568bc00360b8 100644 (file)
@@ -3,19 +3,22 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 2005--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  (c) 2005--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
 #include "paper-column-engraver.hh"
 #include "system.hh"
-#include "item.hh"
-#include "paper-column.hh"
-#include "staff-spacing.hh"
+#include "international.hh"
+#include "accidental-placement.hh"
+#include "accidental-interface.hh"
+#include "axis-group-interface.hh"
+#include "context.hh"
 #include "note-spacing.hh"
+#include "paper-column.hh"
 #include "pointer-group-interface.hh"
-#include "context.hh"
-#include "score-context.hh"
-#include "axis-group-interface.hh"
+#include "separation-item.hh"
+#include "staff-spacing.hh"
+#include "system.hh"
 #include "warn.hh"
 
 #include "translator.icc"
@@ -28,19 +31,18 @@ Paper_column_engraver::Paper_column_engraver ()
   breaks_ = 0;
   system_ = 0;
   first_ = true;
-  last_breakable_column_ = 0;
-  last_breakable_moment_ = Moment (-1);
 }
 
 void
 Paper_column_engraver::finalize ()
 {
-  if ((breaks_ % 8))
+  if ((breaks_ % 8))
     progress_indication ("[" + to_string (breaks_) + "]");
 
   if (command_column_)
     {
-      command_column_->set_property ("line-break-permission", ly_symbol2scm ("allow"));
+      if (!scm_is_symbol (command_column_->get_property ("line-break-permission")))
+       command_column_->set_property ("line-break-permission", ly_symbol2scm ("allow"));
       system_->set_bound (RIGHT, command_column_);
     }
 }
@@ -53,11 +55,11 @@ Paper_column_engraver::make_columns ()
   */
   Paper_column *p1 = make_paper_column ("NonMusicalPaperColumn");
   Paper_column *p2 = make_paper_column ("PaperColumn");
-
-  SCM m = now_mom ().smobbed_copy ();
-  p1->set_property ("when", m);
-  p2->set_property ("when", m);
-  p1->set_property ("line-break-permission", ly_symbol2scm ("allow"));
+  /* 
+     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.
+  */
 
   set_columns (p1, p2);
 }
@@ -85,6 +87,7 @@ Paper_column_engraver::acknowledge_staff_spacing (Grob_info gi)
                                     ly_symbol2scm ("spacing-wishes"),
                                     gi.grob ());
 }
+
 void
 Paper_column_engraver::acknowledge_note_spacing (Grob_info gi)
 {
@@ -109,12 +112,18 @@ Paper_column_engraver::set_columns (Paper_column *new_command,
   system_->add_column (musical_column_);
 }
 
-bool
-Paper_column_engraver::try_music (Music *m)
+IMPLEMENT_TRANSLATOR_LISTENER (Paper_column_engraver, break);
+void
+Paper_column_engraver::listen_break (Stream_event *ev)
 {
-  break_events_.push_back (m);
+  break_events_.push_back (ev);
+}
 
-  return true;
+IMPLEMENT_TRANSLATOR_LISTENER (Paper_column_engraver, label);
+void
+Paper_column_engraver::listen_label (Stream_event *ev)
+{
+  label_events_.push_back (ev);
 }
 
 void
@@ -123,18 +132,17 @@ Paper_column_engraver::process_music ()
   for (vsize i = 0; i < break_events_.size (); i++)
     {
       string prefix;
-      SCM name = break_events_[i]->get_property ("name");
-      if (name == ly_symbol2scm ("LineBreakEvent"))
-       prefix = "line-break";
-      else if (name == ly_symbol2scm ("PageBreakEvent"))
-       prefix = "page-break";
-      else if (name == ly_symbol2scm ("PageTurnEvent"))
-       prefix = "page-turn";
+      SCM name_sym = break_events_[i]->get_property ("class");
+      string name = ly_scm2string (scm_symbol_to_string (name_sym));
+      size_t end = name.rfind ("-event");
+      if (end)
+       prefix = name.substr (0, end);
       else
        {
          programming_error ("Paper_column_engraver doesn't know about this break-event");
          return;
        }
+
       string perm_str = prefix + "-permission";
       string pen_str = prefix + "-penalty";
 
@@ -152,11 +160,18 @@ Paper_column_engraver::process_music ()
        command_column_->set_property (perm_str.c_str (), perm);
     }
 
+  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");
+      command_column_->set_property ("labels", scm_cons (label, labels));
+    }
+
   bool start_of_measure = (last_moment_.main_part_ != now_mom ().main_part_
                           && !measure_position (context ()).main_part_);
 
   /*
-    We can't do this in start_translation_timestep(), since time sig
+    We can't do this in start_translation_timestep (), since time sig
     changes won't have happened by then.
   */
   if (start_of_measure)
@@ -173,46 +188,65 @@ Paper_column_engraver::process_music ()
 void
 Paper_column_engraver::stop_translation_timestep ()
 {
+  SCM m = now_mom ().smobbed_copy ();
+  command_column_->set_property ("when", m);
+  musical_column_->set_property ("when", m);
+
   for (vsize i = 0; i < items_.size (); i++)
     {
       Item *elem = items_[i];
-      if (!elem->get_parent (X_AXIS)
-         || !unsmob_grob (elem->get_object ("axis-group-parent-X")))
-       {
-         bool br = Item::is_non_musical (elem);
-         Axis_group_interface::add_element (br ? command_column_ : musical_column_, elem);
-       }
+      Grob *col = Item::is_non_musical (elem) ? command_column_ : musical_column_;
+
+      if (!elem->get_parent (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 ());
+
+      if (Accidental_placement::has_interface (elem))
+       Separation_item::add_conditional_item (col, elem);
+      else if (!Accidental_interface::has_interface (elem))
+       Separation_item::add_item (col, elem);
     }
   items_.clear ();
 
-  if (to_boolean (get_property ("forbidBreak")))
-    command_column_->set_property ("line-break-permission", SCM_EOL);
-  else
+  if (to_boolean (get_property ("forbidBreak"))
+     && breaks_) /* don't honour forbidBreak if it occurs on the first moment of a score */
+    {
+      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?"));
+       }
+    }
+  else if (Paper_column::is_breakable (command_column_))
     {
       breaks_++;
-      last_breakable_column_ = command_column_;
-      last_breakable_moment_ = now_mom ();
+
       if (! (breaks_%8))
        progress_indication ("[" + to_string (breaks_) + "]");
     }
 
-  SCM page_br = get_property ("allowPageTurn");
-  if (scm_is_pair (page_br) && last_breakable_moment_ >= Rational (0))
-    {
-      SCM pen = scm_cdr (page_br);
-      Moment *m = unsmob_moment (scm_car (page_br));
-      if (m && scm_is_number (pen) && *m <= last_breakable_moment_)
-       {
-         last_breakable_column_->set_property ("page-turn-permission", ly_symbol2scm ("allow"));
-         last_breakable_column_->set_property ("page-turn-penalty", pen);
-       }
-    }
-
   context ()->get_score_context ()->unset_property (ly_symbol2scm ("forbidBreak"));
-  context ()->get_score_context ()->unset_property (ly_symbol2scm ("allowPageTurn"));
 
   first_ = false;
   break_events_.clear ();
+  label_events_.clear ();
+
+  SCM mpos = get_property ("measurePosition");
+  SCM barnum = get_property ("internalBarNumber");
+  if (unsmob_moment (mpos)
+      && scm_is_integer (barnum))
+    {
+      SCM where = scm_cons (barnum,
+                           mpos);
+
+      command_column_->set_property ("rhythmic-location", where);
+      musical_column_->set_property ("rhythmic-location", where);
+    }
 }
 
 void
@@ -230,25 +264,27 @@ ADD_ACKNOWLEDGER (Paper_column_engraver, note_spacing);
 ADD_ACKNOWLEDGER (Paper_column_engraver, staff_spacing);
 
 ADD_TRANSLATOR (Paper_column_engraver,
-               /* doc */ "Takes 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 Bar_engraver "
-               "that does not have a barline at a certain point will set forbidBreaks "
-                "in the score context to stop linebreaks.  In practice, this "
-               "means that you can make a breakpoint by creating a barline (assuming "
-               "that there are no beams or notes that prevent a breakpoint.) ",
+               /* 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",
-               
-               /* accept */ "break-event",
+               "NonMusicalPaperColumn ",
+
                /* read */
-                "forbidBreak "
-                "allowPageTurn",
+                "forbidBreak ",
+
                /* write */
                 "forbidBreak "
-                "allowPageTurn "
                "currentCommandColumn "
-               "currentMusicalColumn");
+               "currentMusicalColumn "
+               );