/*
- paper-column-engraver.cc -- implement Paper_column_engraver
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
+ Copyright (C) 2005--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
- (c) 2005--2006 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
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ LilyPond is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
*/
#include "paper-column-engraver.hh"
#include "system.hh"
#include "international.hh"
+#include "accidental-placement.hh"
+#include "accidental-interface.hh"
#include "axis-group-interface.hh"
#include "context.hh"
-#include "item.hh"
#include "note-spacing.hh"
#include "paper-column.hh"
#include "pointer-group-interface.hh"
+#include "separation-item.hh"
#include "staff-spacing.hh"
#include "system.hh"
#include "warn.hh"
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;
system_ = 0;
- last_special_barline_column_ = 0;
- last_breakable_column_ = 0;
first_ = true;
+ made_columns_ = false;
}
void
Paper_column_engraver::finalize ()
{
- if ((breaks_ % 8))
+ if (! (breaks_ % 8))
progress_indication ("[" + to_string (breaks_) + "]");
+ if (!made_columns_)
+ {
+ make_columns ();
+ SCM m = now_mom ().smobbed_copy ();
+ command_column_->set_property ("when", m);
+ musical_column_->set_property ("when", m);
+ }
+
if (command_column_)
{
- command_column_->set_property ("line-break-permission", ly_symbol2scm ("allow"));
+ // 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"));
+
system_->set_bound (RIGHT, command_column_);
}
}
*/
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.
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;
break_events_.push_back (ev);
}
+IMPLEMENT_TRANSLATOR_LISTENER (Paper_column_engraver, label);
void
-Paper_column_engraver::process_music ()
+Paper_column_engraver::listen_label (Stream_event *ev)
+{
+ label_events_.push_back (ev);
+}
+
+void
+Paper_column_engraver::handle_manual_breaks (bool only_do_permissions)
{
for (vsize i = 0; i < break_events_.size (); i++)
{
string name = ly_scm2string (scm_symbol_to_string (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";
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);
+ }
+}
+
+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");
+ 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_);
+ && !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)
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?");
- }
-}
-
-/* return either
- - the last column with a special (ie. not "|" or "") barline
- - the last column
- after the given moment
-*/
-Paper_column*
-Paper_column_engraver::find_turnable_column (Moment after_this)
-{
- if (last_special_barline_column_)
- {
- Moment m = *unsmob_moment (last_special_barline_column_->get_property ("when"));
- if (m >= after_this)
- return last_special_barline_column_;
+ programming_error ("No command column?");
}
- if (last_breakable_column_)
- {
- Moment m = *unsmob_moment (last_breakable_column_->get_property ("when"));
- if (m >= after_this)
- return last_breakable_column_;
- }
- return 0;
}
void
-Paper_column_engraver::revoke_page_turns (Moment after_this, Real new_penalty)
+Paper_column_engraver::stop_translation_timestep ()
{
- if (!page_turnable_columns_.size ())
+ if (to_boolean (get_property ("skipTypesetting")))
return;
- for (vsize i = page_turnable_columns_.size () - 1; i--;)
- {
- Paper_column *col = page_turnable_columns_[i];
- Moment mom = *unsmob_moment (col->get_property ("when"));
- if (mom >= after_this)
- {
- if (isinf (new_penalty))
- {
- col->del_property ( ly_symbol2scm ("page-turn-permission"));
- page_turnable_columns_.erase (page_turnable_columns_.begin () + i);
- }
- else
- {
- Real prev_pen = robust_scm2double (col->get_property ("page-turn-penalty"), 0);
- if (new_penalty > prev_pen)
- col->set_property ("page-turn-penalty", scm_from_double (new_penalty));
- }
- }
- }
-}
-
-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 (Paper_column::is_breakable (command_column_))
+ if (to_boolean (get_property ("forbidBreak"))
+ && breaks_) /* don't honour forbidBreak if it occurs on the first moment of a score */
{
- breaks_++;
- last_breakable_column_ = command_column_;
-
- SCM which_bar = get_property ("whichBar");
- if (scm_is_string (which_bar))
- {
- string bar = ly_scm2string (which_bar);
- if (bar != "" && bar != "|")
- last_special_barline_column_ = command_column_;
- }
-
- if (! (breaks_%8))
- progress_indication ("[" + to_string (breaks_) + "]");
+ 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 page_br = get_property ("allowPageTurn");
- if (scm_is_pair (page_br) && last_breakable_column_)
+ else if (Paper_column::is_breakable (command_column_))
{
- SCM pen = scm_cdr (page_br);
- Moment *m = unsmob_moment (scm_car (page_br));
- if (m)
- {
- Paper_column *turn = find_turnable_column (*m);
- if (turn)
- {
- turn->set_property ("page-turn-permission", ly_symbol2scm ("allow"));
- turn->set_property ("page-turn-penalty", pen);
- page_turnable_columns_.push_back (turn);
- }
- }
- }
+ breaks_++;
- /* The page-turn-engraver is allowed to change its mind and revoke previously-allowed
- page turns (for example if there is a volta repeat where a turn is inconvenient) */
- SCM revokes = get_property ("revokePageTurns");
- if (scm_is_pair (revokes))
- {
- Moment *start = unsmob_moment (scm_car (revokes));
- Real pen = robust_scm2double (scm_cdr (revokes), infinity_f);
- if (start)
- revoke_page_turns (*start, pen);
+ if (! (breaks_ % 8))
+ progress_indication ("[" + to_string (breaks_) + "]");
}
context ()->get_score_context ()->unset_property (ly_symbol2scm ("forbidBreak"));
- context ()->get_score_context ()->unset_property (ly_symbol2scm ("allowPageTurn"));
- context ()->get_score_context ()->unset_property (ly_symbol2scm ("revokePageTurns"));
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
Paper_column_engraver::start_translation_timestep ()
{
- /*
- TODO: don't make columns when skipTypesetting is true.
- */
- if (!first_)
- make_columns ();
+ if (!first_ && !to_boolean (get_property ("skipTypesetting")))
+ {
+ make_columns ();
+ made_columns_ = true;
+ }
}
ADD_ACKNOWLEDGER (Paper_column_engraver, item);
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.) ",
-
- /* create */
- "PaperColumn "
- "NonMusicalPaperColumn",
-
- /* accept */ "break-event",
- /* read */
- "forbidBreak "
- "allowPageTurn "
- "revokePageTurns "
- ,
- /* write */
+ /* 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 */
"forbidBreak "
- "allowPageTurn "
- "revokePageTurns "
- "currentCommandColumn "
- "currentMusicalColumn "
- );
+ "currentCommandColumn "
+ "currentMusicalColumn "
+ );
projects / lilypond.git / blobdiff