/*
- system.cc -- implement System
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
+ Copyright (C) 1996--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
- (c) 1996--2004 Han-Wen Nienhuys <hanwen@cs.uu.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 "input-smob.hh"
-#include "axis-group-interface.hh"
-#include "warn.hh"
#include "system.hh"
+
+#include "align-interface.hh"
+#include "all-font-metrics.hh"
+#include "axis-group-interface.hh"
+#include "break-align-interface.hh"
+#include "grob-array.hh"
+#include "hara-kiri-group-spanner.hh"
+#include "international.hh"
+#include "lookup.hh"
#include "main.hh"
+#include "output-def.hh"
+#include "page-layout-problem.hh"
#include "paper-column.hh"
-#include "paper-def.hh"
-#include "paper-outputter.hh"
#include "paper-score.hh"
-#include "string.hh"
-#include "warn.hh"
-#include "dimensions.hh"
-#include "molecule.hh"
-#include "all-font-metrics.hh"
-#include "spacing-interface.hh"
+#include "paper-system.hh"
+#include "pointer-group-interface.hh"
+#include "skyline-pair.hh"
#include "staff-symbol-referencer.hh"
+#include "text-interface.hh"
+#include "warn.hh"
-// todo: use map.
-void
-fixup_refpoints (SCM s)
+System::System (System const &src)
+ : Spanner (src)
{
- for (; gh_pair_p (s); s = ly_cdr (s))
- {
- Grob::fixup_refpoint (ly_car (s));
- }
+ all_elements_ = 0;
+ pscore_ = 0;
+ rank_ = 0;
+ checked_footnotes_ = false;
+ init_elements ();
}
-
System::System (SCM s)
: Spanner (s)
{
+ all_elements_ = 0;
rank_ = 0;
+ checked_footnotes_ = false;
+ init_elements ();
+}
+
+void
+System::init_elements ()
+{
+ SCM scm_arr = Grob_array::make_array ();
+ all_elements_ = unsmob_grob_array (scm_arr);
+ all_elements_->set_ordered (false);
+ set_object ("all-elements", scm_arr);
+}
+
+Grob *
+System::clone () const
+{
+ return new System (*this);
}
int
System::element_count () const
{
- return scm_ilength (get_grob_property ("all-elements"));
+ return all_elements_->size ();
}
int
System::spanner_count () const
{
- int k =0;
- for (SCM s = get_grob_property ("all-elements");
- gh_pair_p (s); s = ly_cdr (s))
- {
- if (dynamic_cast<Spanner*> (unsmob_grob (gh_car(s))))
- k++;
- }
-
+ int k = 0;
+ for (vsize i = all_elements_->size (); i--;)
+ if (dynamic_cast<Spanner *> (all_elements_->grob (i)))
+ k++;
return k;
}
-
-int
-scm_default_compare (const void * a, const void *b)
+void
+System::typeset_grob (Grob *elem)
{
- SCM pa = *(SCM *)a;
- SCM pb = *(SCM *)b;
-
- if (pa < pb) return -1 ;
- else if (pa > pb) return 1;
- else return 0;
+ if (elem->layout_)
+ programming_error ("adding element twice");
+ else
+ {
+ elem->layout_ = pscore_->layout ();
+ all_elements_->add (elem);
+ elem->unprotect ();
+ }
}
-/*
- modify L in place: sort it
-*/
-
-SCM
-uniquify_list (SCM l)
+void
+System::derived_mark () const
{
- int len = scm_ilength (l);
- SCM * arr = new SCM[len];
- int k = 0;
- for (SCM s =l ; SCM_NNULLP (s); s = SCM_CDR(s))
- arr[k++] = SCM_CAR(s);
-
- assert (k == len);
- qsort (arr, len, sizeof (SCM), &scm_default_compare);
-
- k = 0;
- SCM s =l;
- for (int i = 0; i < len ; i++)
+ if (!all_elements_->empty ())
{
- if (i && arr[i] == arr[i-1])
- continue;
-
- SCM_SETCAR(s, arr[i]);
-
- if (i < len - 1)
- s = SCM_CDR(s);
+ Grob **ptr = &all_elements_->array_reference ()[0];
+ Grob **end = ptr + all_elements_->size ();
+ while (ptr < end)
+ {
+ scm_gc_mark ((*ptr)->self_scm ());
+ ptr++;
+ }
}
- SCM_SETCDR(s, SCM_EOL);
- delete arr;
-
- return l;
+ if (pscore_)
+ scm_gc_mark (pscore_->self_scm ());
+
+ Spanner::derived_mark ();
}
-void
-System::typeset_grob (Grob * elem)
+static void
+fixup_refpoints (vector<Grob *> const &grobs)
{
- if (elem->pscore_)
- programming_error ("Adding element twice.");
-
- elem->pscore_ = pscore_;
- Pointer_group_interface::add_grob (this, ly_symbol2scm ("all-elements"), elem);
- scm_gc_unprotect_object (elem->self_scm ());
+ for (vsize i = grobs.size (); i--;)
+ grobs[i]->fixup_refpoint ();
}
void
-System::output_lines ()
+System::do_break_substitution_and_fixup_refpoints ()
{
- for (SCM s = get_grob_property ("all-elements");
- gh_pair_p (s); s = ly_cdr (s))
+ for (vsize i = 0; i < all_elements_->size (); i++)
{
- Grob * g = unsmob_grob (ly_car (s));
+ Grob *g = all_elements_->grob (i);
if (g->internal_has_interface (ly_symbol2scm ("only-prebreak-interface")))
{
/*
- Kill no longer needed grobs.
- */
- Item * it = dynamic_cast<Item*> (g);
- if (it && Item::breakable_b(it))
+ Kill no longer needed grobs.
+ */
+ Item *it = dynamic_cast<Item *> (g);
+ if (it && Item::is_non_musical (it))
{
- it->find_prebroken_piece (LEFT)->suicide();
- it->find_prebroken_piece (RIGHT)->suicide();
+ it->find_prebroken_piece (LEFT)->suicide ();
+ it->find_prebroken_piece (RIGHT)->suicide ();
}
g->suicide ();
}
- else if (g->live ())
+ else if (g->is_live ())
g->do_break_processing ();
}
fixups must be done in broken line_of_scores, because new elements
are put over there. */
int count = 0;
- for (int i=0; i < broken_intos_.size (); i++)
+ for (vsize i = 0; i < broken_intos_.size (); i++)
{
Grob *se = broken_intos_[i];
- SCM all = se->get_grob_property ("all-elements");
- for (SCM s = all; gh_pair_p (s); s = ly_cdr (s))
+
+ extract_grob_set (se, "all-elements", all_elts);
+ for (vsize j = 0; j < all_elts.size (); j++)
{
- fixup_refpoint (ly_car (s));
+ Grob *g = all_elts[j];
+ g->fixup_refpoint ();
}
- count += scm_ilength (all);
+
+ count += all_elts.size ();
}
-
+
/*
needed for doing items.
- */
- fixup_refpoints (get_grob_property ("all-elements"));
+ */
+ fixup_refpoints (all_elements_->array ());
+
+ for (vsize i = 0; i < all_elements_->size (); i++)
+ all_elements_->grob (i)->handle_broken_dependencies ();
-
- for (SCM s = get_grob_property ("all-elements");
- gh_pair_p (s); s = ly_cdr (s))
- {
- unsmob_grob (ly_car (s))->handle_broken_dependencies ();
- }
handle_broken_dependencies ();
- /*
- Because the this->get_grob_property (all-elements) contains items
- in 3 versions, handle_broken_dependencies () will leave duplicated
- items in all-elements. Strictly speaking this is harmless, but it
- leads to duplicated symbols in the output. uniquify_list() makes
- sure that no duplicates are in the list.
- */
- for (int i=0; i < broken_intos_.size (); i++)
+ /* Because the this->get_property (all-elements) contains items in 3
+ versions, handle_broken_dependencies () will leave duplicated
+ items in all-elements. Strictly speaking this is harmless, but
+ it leads to duplicated symbols in the output. uniq makes sure
+ that no duplicates are in the list. */
+ for (vsize i = 0; i < broken_intos_.size (); i++)
{
- /*
- don't do this: strange side effects.
- */
- // SCM al = broken_intos_[i]->get_grob_property ("all-elements");
- // al = uniquify_list (al);
+ System *child = dynamic_cast<System *> (broken_intos_[i]);
+ child->all_elements_->remove_duplicates ();
+ for (vsize j = 0; j < child->all_elements_->size (); j++)
+ {
+ Grob *g = child->all_elements_->grob (j);
+
+ (void) g->get_property ("after-line-breaking");
+ }
}
-
- if (verbose_global_b)
- progress_indication (_f ("Element count %d.", count + element_count ()));
-
- for (int i=0; i < broken_intos_.size (); i++)
- {
- System *system = dynamic_cast<System*> (broken_intos_[i]);
+ if (be_verbose_global)
+ message (_f ("Element count %d", count + element_count ()) + "\n");
+}
+
+SCM
+System::get_broken_system_grobs ()
+{
+ SCM ret = SCM_EOL;
+ for (vsize i = 0; i < broken_intos_.size (); i++)
+ ret = scm_cons (broken_intos_[i]->self_scm (), ret);
+ return scm_reverse (ret);
+}
- if (verbose_global_b)
+SCM
+System::get_paper_systems ()
+{
+ SCM lines = scm_c_make_vector (broken_intos_.size (), SCM_EOL);
+ for (vsize i = 0; i < broken_intos_.size (); i++)
+ {
+ if (be_verbose_global)
progress_indication ("[");
- bool last = i+1 == broken_intos_.size ();
- system->post_processing (last);
- if (verbose_global_b)
- {
- progress_indication (to_string (i));
- progress_indication ("]");
- }
+ System *system = dynamic_cast<System *> (broken_intos_[i]);
- if (i < broken_intos_.size () - 1)
- {
- SCM lastcol = ly_car (system->get_grob_property ("columns"));
- Grob* e = unsmob_grob (lastcol);
+ scm_vector_set_x (lines, scm_from_int (i),
+ system->get_paper_system ());
- SCM between = ly_symbol2scm ("between-system-string");
- SCM inter = e->internal_get_grob_property (between);
- if (gh_string_p (inter))
- {
- pscore_->outputter_
- ->output_scheme (scm_list_n (between,
- inter, SCM_UNDEFINED));
- }
- }
+ if (be_verbose_global)
+ progress_indication (to_string (i) + "]");
}
+ return lines;
}
+void
+System::populate_footnote_grob_vector ()
+{
+ extract_grob_set (this, "all-elements", all_elts);
+ for (vsize i = 0; i < all_elts.size (); i++)
+ if (all_elts[i]->internal_has_interface (ly_symbol2scm ("footnote-interface")))
+ footnote_grobs_.push_back (all_elts[i]);
+ sort (footnote_grobs_.begin (), footnote_grobs_.end (), Grob::less);
+ checked_footnotes_ = true;
+}
-
-/*
- Find the loose columns in POSNS, and drape them around the columns
- specified in BETWEEN-COLS. */
void
-set_loose_columns (System* which, Column_x_positions const *posns)
+System::get_footnote_grobs_in_range (vector<Grob *> &out, vsize start, vsize end)
{
- for (int i = 0; i < posns->loose_cols_.size (); i++)
+ if (!checked_footnotes_)
+ populate_footnote_grob_vector ();
+
+ for (vsize i = 0; i < footnote_grobs_.size (); i++)
{
- int divide_over = 1;
- Item *loose = dynamic_cast<Item*> (posns->loose_cols_[i]);
- Paper_column* col = dynamic_cast<Paper_column*> (loose);
+ int pos = footnote_grobs_[i]->spanned_rank_interval ()[LEFT];
+ bool end_of_line_visible = true;
+ if (Spanner *s = dynamic_cast<Spanner *>(footnote_grobs_[i]))
+ {
+ Direction spanner_placement = robust_scm2dir (s->get_property ("spanner-placement"), LEFT);
+ if (spanner_placement == CENTER)
+ spanner_placement = LEFT;
+
+ pos = s->spanned_rank_interval ()[spanner_placement];
+ }
- if (col->system_)
- continue;
-
- Item * left = 0;
- Item * right = 0;
- do
- {
- SCM between = loose->get_grob_property ("between-cols");
- if (!gh_pair_p (between))
- break;
-
+ if (Item *item = dynamic_cast<Item *>(footnote_grobs_[i]))
+ {
+ if (!Item::break_visible (item))
+ continue;
+ // safeguard to bring down the column rank so that end of line footnotes show up on the correct line
+ end_of_line_visible = (LEFT == item->break_status_dir ());
+ }
+
+ if (pos < int (start))
+ continue;
+ if (pos > int (end))
+ break;
+ if (pos == int (start) && end_of_line_visible)
+ continue;
+ if (pos == int (end) && !end_of_line_visible)
+ continue;
+ if (!footnote_grobs_[i]->is_live ())
+ continue;
+
+ out.push_back (footnote_grobs_[i]);
+ }
+}
- Item * l=dynamic_cast<Item*> (unsmob_grob (ly_car (between)));
- Item * r=dynamic_cast<Item*> (unsmob_grob (ly_cdr (between)));
+vector<Stencil *>
+System::get_footnotes_in_range (vsize start, vsize end)
+{
+ vector<Grob *> footnote_grobs;
+ get_footnote_grobs_in_range (footnote_grobs, start, end);
+ vector<Stencil *> out;
- if (!(l && r))
- break ;
-
- if (!left && l)
- {
- left = l->get_column ();
- if (!left->get_system ())
- left = left->find_prebroken_piece (RIGHT);
- }
+ for (vsize i = 0; i < footnote_grobs.size (); i++)
+ {
+ SCM footnote_markup = footnote_grobs[i]->get_property ("footnote-text");
- divide_over ++;
- loose = right = r->get_column ();
- }
- while (1);
+ if (!Text_interface::is_markup (footnote_markup))
+ continue;
- if (!right->get_system ())
- right = right->find_prebroken_piece (LEFT);
-
- /*
- We divide the remaining space of the column over the left and
- right side. At the moment, we
-
- */
- Grob * common = right->common_refpoint (left, X_AXIS);
-
- Real rx = right->extent(common, X_AXIS)[LEFT];
- Real lx = left->extent(common, X_AXIS)[RIGHT];
- Real total_dx = rx - lx;
- Interval cval =col->extent (col, X_AXIS);
+ SCM props = scm_call_1 (ly_lily_module_constant ("layout-extract-page-properties"),
+ pscore_->layout ()->self_scm ());
- /*
-
- We put it in the middle. This is not an ideal solution -- the
- break alignment code inserts a fixed space before the clef
- (about 1 SS), while the space following the clef is
- flexible. In tight situations, the clef will almost be on top
- of the following note.
-
- */
- Real dx = rx-lx - cval.length ();
- if (total_dx < 2* cval.length ())
- {
- /*
- todo: this is discontinuous. I'm too tired to
- invent a sliding mechanism. Duh.
+ SCM footnote_stl = Text_interface::interpret_markup (pscore_->layout ()->self_scm (),
+ props, footnote_markup);
- TODO.
- */
- dx *= 0.25;
- }
- else
- dx *= 0.5;
-
- col->system_ = which;
- col->translate_axis (- col->relative_coordinate (common, X_AXIS), X_AXIS);
- col->translate_axis (lx + dx - cval[LEFT], X_AXIS);
+ Stencil *footnote_stencil = unsmob_stencil (footnote_stl);
+ out.push_back (footnote_stencil);
}
+
+ return out;
}
-// const?
-void
-System::break_into_pieces (Array<Column_x_positions> const &breaking)
+Stencil
+System::make_footnote_stencil (Real padding)
{
- for (int i=0; i < breaking.size (); i++)
+ Stencil mol;
+
+ for (vsize i = 0; i < footnote_grobs_.size (); i++)
{
- System *system = dynamic_cast <System*> (clone ());
- system->rank_ = i;
+ SCM footnote_markup = footnote_grobs_[i]->get_property ("footnote-text");
+ if (Spanner *orig = dynamic_cast<Spanner *>(footnote_grobs_[i]))
+ if (orig->is_broken ())
+ footnote_markup = orig->broken_intos_[0]->get_property ("footnote-text");
- Link_array<Grob> c (breaking[i].cols_);
- pscore_->typeset_line (system);
-
- system->set_bound (LEFT,c[0]);
- system->set_bound (RIGHT,c.top ());
- for (int j=0; j < c.size (); j++)
- {
- c[j]->translate_axis (breaking[i].config_[j],X_AXIS);
- dynamic_cast<Paper_column*> (c[j])->system_ = system;
- }
- set_loose_columns (system, &breaking[i]);
- broken_intos_.push (system);
+ if (!Text_interface::is_markup (footnote_markup))
+ continue;
+
+ SCM props = scm_call_1 (ly_lily_module_constant ("layout-extract-page-properties"),
+ pscore_->layout ()->self_scm ());
+
+ SCM footnote_stl = Text_interface::interpret_markup (pscore_->layout ()->self_scm (),
+ props, footnote_markup);
+
+ mol.add_at_edge (Y_AXIS, DOWN, *unsmob_stencil (footnote_stl), padding);
}
+
+ return mol;
}
void
-System::output_molecule (SCM expr, Offset o)
+System::break_into_pieces (vector<Column_x_positions> const &breaking)
{
- while (1)
+ for (vsize i = 0; i < breaking.size (); i++)
{
- if (!gh_pair_p (expr))
- return;
-
- SCM head =ly_car (expr);
- if (unsmob_input (head))
- {
- Input * ip = unsmob_input (head);
-
- pscore_->outputter_->output_scheme (scm_list_n (ly_symbol2scm ("define-origin"),
- scm_makfrom0str (ip->file_string ().to_str0 ()),
- gh_int2scm (ip->line_number ()),
- gh_int2scm (ip->column_number ()),
- SCM_UNDEFINED));
- expr = ly_cadr (expr);
- }
- else if (head == ly_symbol2scm ("no-origin"))
- {
- pscore_->outputter_->output_scheme (scm_list_n (head, SCM_UNDEFINED));
- expr = ly_cadr (expr);
- }
- else if (head == ly_symbol2scm ("translate-molecule"))
- {
- o += ly_scm2offset (ly_cadr (expr));
- expr = ly_caddr (expr);
- }
- else if (head == ly_symbol2scm ("combine-molecule"))
- {
- output_molecule (ly_cadr (expr), o);
- expr = ly_caddr (expr);
- }
- else
+ System *system = dynamic_cast<System *> (clone ());
+ system->rank_ = broken_intos_.size ();
+
+ vector<Grob *> c (breaking[i].cols_);
+ pscore_->typeset_system (system);
+
+ int st = Paper_column::get_rank (c[0]);
+ int end = Paper_column::get_rank (c.back ());
+ Interval iv (pure_height (this, st, end));
+ system->set_property ("pure-Y-extent", ly_interval2scm (iv));
+
+ get_footnote_grobs_in_range (system->footnote_grobs_, st, end);
+
+ system->set_bound (LEFT, c[0]);
+ system->set_bound (RIGHT, c.back ());
+ SCM system_labels = SCM_EOL;
+ for (vsize j = 0; j < c.size (); j++)
{
- pscore_->outputter_->
- output_scheme (scm_list_n (ly_symbol2scm ("placebox"),
- gh_double2scm (o[X_AXIS]),
- gh_double2scm (o[Y_AXIS]),
- expr,
- SCM_UNDEFINED));
-
- return;
+ c[j]->translate_axis (breaking[i].config_[j], X_AXIS);
+ dynamic_cast<Paper_column *> (c[j])->set_system (system);
+ /* collect the column labels */
+ collect_labels (c[j], &system_labels);
}
+ /*
+ Collect labels from any loose columns too: theses will be set on
+ an empty bar line or a column which is otherwise unused mid-line
+ */
+ vector<Grob *> loose (breaking[i].loose_cols_);
+ for (vsize j = 0; j < loose.size (); j++)
+ collect_labels (loose[j], &system_labels);
+
+ system->set_property ("labels", system_labels);
+
+ set_loose_columns (system, &breaking[i]);
+ broken_intos_.push_back (system);
}
}
void
-System::output_scheme (SCM s)
+System::collect_labels (Grob const *col, SCM *labels)
{
- pscore_->outputter_->output_scheme (s);
+ SCM col_labels = col->get_property ("labels");
+ if (scm_is_pair (col_labels))
+ *labels = scm_append (scm_list_2 (col_labels, *labels));
}
void
-System::add_column (Paper_column*p)
+System::add_column (Paper_column *p)
{
Grob *me = this;
- SCM cs = me->get_grob_property ("columns");
- Grob * prev = gh_pair_p (cs) ? unsmob_grob (ly_car (cs)) : 0;
-
- p->rank_ = prev ? Paper_column::get_rank (prev) + 1 : 0;
+ Grob_array *ga = unsmob_grob_array (me->get_object ("columns"));
+ if (!ga)
+ {
+ SCM scm_ga = Grob_array::make_array ();
+ me->set_object ("columns", scm_ga);
+ ga = unsmob_grob_array (scm_ga);
+ }
- me->set_grob_property ("columns", gh_cons (p->self_scm (), cs));
+ p->set_rank (ga->size ());
- Axis_group_interface::add_element (me, p);
+ ga->add (p);
+ Axis_group_interface::add_element (this, p);
}
void
System::pre_processing ()
{
- for (SCM s = get_grob_property ("all-elements"); gh_pair_p (s); s = ly_cdr (s))
- unsmob_grob (ly_car (s))->discretionary_processing ();
+ for (vsize i = 0; i < all_elements_->size (); i++)
+ all_elements_->grob (i)->discretionary_processing ();
+
+ if (be_verbose_global)
+ message (_f ("Grob count %d", element_count ()));
- if (verbose_global_b)
- progress_indication (_f ("Grob count %d ", element_count ()));
+ /*
+ order is significant: broken grobs are added to the end of the
+ array, and should be processed before the original is potentially
+ killed.
+ */
+ for (vsize i = all_elements_->size (); i--;)
+ all_elements_->grob (i)->handle_prebroken_dependencies ();
-
- for (SCM s = get_grob_property ("all-elements"); gh_pair_p (s); s = ly_cdr (s))
- unsmob_grob (ly_car (s))->handle_prebroken_dependencies ();
-
- fixup_refpoints (get_grob_property ("all-elements"));
-
- for (SCM s = get_grob_property ("all-elements"); gh_pair_p (s); s = ly_cdr (s))
+ fixup_refpoints (all_elements_->array ());
+
+ for (vsize i = 0; i < all_elements_->size (); i++)
{
- Grob* sc = unsmob_grob (ly_car (s));
- sc->calculate_dependencies (PRECALCED, PRECALCING, ly_symbol2scm ("before-line-breaking-callback"));
+ Grob *g = all_elements_->grob (i);
+ (void) g->get_property ("before-line-breaking");
}
-
- progress_indication ("\n" + _ ("Calculating line breaks...") + " ");
- for (SCM s = get_grob_property ("all-elements"); gh_pair_p (s); s = ly_cdr (s))
+
+ for (vsize i = 0; i < all_elements_->size (); i++)
{
- Grob * e = unsmob_grob (ly_car (s));
- SCM proc = e->get_grob_property ("spacing-procedure");
- if (gh_procedure_p (proc))
- gh_call1 (proc, e->self_scm ());
+ Grob *e = all_elements_->grob (i);
+ (void) e->get_property ("springs-and-rods");
}
}
+void
+System::post_processing ()
+{
+ Interval iv (extent (this, Y_AXIS));
+ if (iv.is_empty ())
+ programming_error ("system with empty extent");
+ else
+ translate_axis (-iv[MAX], Y_AXIS);
- const int LAYER_COUNT= 3;
+ /* Generate all stencils to trigger font loads.
+ This might seem inefficient, but Stencils are cached per grob
+ anyway. */
+ vector<Grob *> all_elts_sorted (all_elements_->array ());
+ vector_sort (all_elts_sorted, std::less<Grob *> ());
+ uniq (all_elts_sorted);
+ this->get_stencil ();
+ for (vsize i = all_elts_sorted.size (); i--;)
+ {
+ Grob *g = all_elts_sorted[i];
+ g->get_stencil ();
+ }
+}
+struct Layer_entry
+{
+ Grob *grob_;
+ int layer_;
+};
-void
-System::post_processing (bool last_line)
+bool
+operator< (Layer_entry const &a,
+ Layer_entry const &b)
+{
+ return a.layer_ < b.layer_;
+}
+
+SCM
+System::get_paper_system ()
{
- for (SCM s = get_grob_property ("all-elements");
- gh_pair_p (s); s = ly_cdr (s))
+ SCM exprs = SCM_EOL;
+ SCM *tail = &exprs;
+
+ post_processing ();
+
+ vector<Layer_entry> entries;
+ for (vsize j = 0; j < all_elements_->size (); j++)
{
- Grob* sc = unsmob_grob (ly_car (s));
- sc->calculate_dependencies (POSTCALCED, POSTCALCING,
- ly_symbol2scm ("after-line-breaking-callback"));
+ Layer_entry e;
+ e.grob_ = all_elements_->grob (j);
+ e.layer_ = robust_scm2int (e.grob_->get_property ("layer"), 1);
+
+ entries.push_back (e);
}
- Interval i (extent (this, Y_AXIS));
- if (i.is_empty ())
- programming_error ("Huh? Empty System?");
- else
- translate_axis (- i[MAX], Y_AXIS);
+ vector_sort (entries, std::less<Layer_entry> ());
+ for (vsize j = 0; j < entries.size (); j++)
+ {
+ Grob *g = entries[j].grob_;
+ Stencil st = g->get_print_stencil ();
+
+ if (st.expr () == SCM_EOL)
+ continue;
+
+ Offset o;
+ for (int a = X_AXIS; a < NO_AXES; a++)
+ o[Axis (a)] = g->relative_coordinate (this, Axis (a));
- Real height = i.length ();
- if (height > 50 CM)
+ Offset extra = robust_scm2offset (g->get_property ("extra-offset"),
+ Offset (0, 0))
+ * Staff_symbol_referencer::staff_space (g);
+
+ /* Must copy the stencil, for we cannot change the stencil
+ cached in G. */
+
+ st.translate (o + extra);
+
+ *tail = scm_cons (st.expr (), SCM_EOL);
+ tail = SCM_CDRLOC (*tail);
+ }
+
+ if (Stencil *me = get_stencil ())
+ exprs = scm_cons (me->expr (), exprs);
+
+ Interval x (extent (this, X_AXIS));
+ Interval y (extent (this, Y_AXIS));
+ Stencil sys_stencil (Box (x, y),
+ scm_cons (ly_symbol2scm ("combine-stencil"),
+ exprs));
+ if (debug_skylines)
{
- programming_error ("Improbable system height");
- height = 50 CM;
+ Skyline_pair *skylines = Skyline_pair::unsmob (get_property ("vertical-skylines"));
+ if (skylines)
+ {
+ Stencil up
+ = Lookup::points_to_line_stencil (0.1, (*skylines)[UP].to_points (X_AXIS));
+ Stencil down
+ = Lookup::points_to_line_stencil (0.1, (*skylines)[DOWN].to_points (X_AXIS));
+ sys_stencil.add_stencil (up.in_color (255, 0, 0));
+ sys_stencil.add_stencil (down.in_color (0, 255, 0));
+ }
}
- /*
- generate all molecules to trigger all font loads.
+ Grob *left_bound = this->get_bound (LEFT);
+ SCM prop_init = left_bound->get_property ("line-break-system-details");
+ Prob *pl = make_paper_system (prop_init);
+ paper_system_set_stencil (pl, sys_stencil);
+
+ /* information that the page breaker might need */
+ Grob *right_bound = this->get_bound (RIGHT);
+ pl->set_property ("vertical-skylines", this->get_property ("vertical-skylines"));
+ pl->set_property ("page-break-permission", right_bound->get_property ("page-break-permission"));
+ pl->set_property ("page-turn-permission", right_bound->get_property ("page-turn-permission"));
+ pl->set_property ("page-break-penalty", right_bound->get_property ("page-break-penalty"));
+ pl->set_property ("page-turn-penalty", right_bound->get_property ("page-turn-penalty"));
+
+ Interval staff_refpoints;
+ if (Grob *align = get_vertical_alignment ())
+ {
+ extract_grob_set (align, "elements", staves);
+ for (vsize i = 0; i < staves.size (); i++)
+ if (staves[i]->is_live ()
+ && Page_layout_problem::is_spaceable (staves[i]))
+ staff_refpoints.add_point (staves[i]->relative_coordinate (this,
+ Y_AXIS));
+ }
+
+ pl->set_property ("staff-refpoint-extent", ly_interval2scm (staff_refpoints));
+ pl->set_property ("system-grob", this->self_scm ());
- (ugh. This is not very memory efficient.) */
+ return pl->unprotect ();
+}
+
+vector<Item *>
+System::broken_col_range (Item const *left, Item const *right) const
+{
+ vector<Item *> ret;
- SCM all = get_grob_property ("all-elements") ;
- all = uniquify_list (all);
+ left = left->get_column ();
+ right = right->get_column ();
- /*
- triger font loads first.
+ extract_grob_set (this, "columns", cols);
- This might seem inefficient, but Molecules are cached per grob
- anyway.
- */
- this->get_molecule();
- for (SCM s = all; gh_pair_p (s); s = ly_cdr (s))
+ vsize i = Paper_column::get_rank (left);
+ int end_rank = Paper_column::get_rank (right);
+ if (i < cols.size ())
+ i++;
+
+ while (i < cols.size ()
+ && Paper_column::get_rank (cols[i]) < end_rank)
{
- Grob * g = unsmob_grob (ly_car (s));
- g->get_molecule ();
+ Paper_column *c = dynamic_cast<Paper_column *> (cols[i]);
+ if (Paper_column::is_breakable (c) && !c->get_system ())
+ ret.push_back (c);
+ i++;
}
-
- /*
- font defs;
- */
- SCM font_names = ly_quote_scm (get_paper ()->font_descriptions ());
- output_scheme (scm_list_n (ly_symbol2scm ("define-fonts"),
- font_names,
- SCM_UNDEFINED));
- /*
- line preamble.
- */
- Interval j (extent (this, X_AXIS));
- Real length = j[RIGHT];
-
- output_scheme (scm_list_n (ly_symbol2scm ("start-system"),
- gh_double2scm (length),
- gh_double2scm (height),
- SCM_UNDEFINED));
-
- /* Output elements in three layers, 0, 1, 2.
- The default layer is 1. */
- {
- Molecule *m = this->get_molecule();
- if (m)
- output_molecule (m->get_expr (), Offset(0,0));
- }
-
- for (int i = 0; i < 3; i++)
- for (SCM s = get_grob_property ("all-elements"); gh_pair_p (s);
- s = ly_cdr (s))
- {
- Grob *sc = unsmob_grob (ly_car (s));
- Molecule *m = sc->get_molecule ();
- if (!m)
- continue;
-
- SCM s = sc->get_grob_property ("layer");
- int layer = gh_number_p (s) ? gh_scm2int (s) : 1;
- if (layer != i)
- continue;
-
- Offset o (sc->relative_coordinate (this, X_AXIS),
- sc->relative_coordinate (this, Y_AXIS));
-
- SCM e = sc->get_grob_property ("extra-offset");
- if (gh_pair_p (e))
- {
- Offset z = ly_scm2offset (e);
- z *= Staff_symbol_referencer::staff_space (sc);
-
- o += z;
- }
-
- output_molecule (m->get_expr (), o);
- }
+ return ret;
+}
+
+/** Return all columns, but filter out any unused columns , since they might
+ disrupt the spacing problem. */
+vector<Grob *>
+System::used_columns () const
+{
+ extract_grob_set (this, "columns", ro_columns);
+
+ int last_breakable = ro_columns.size ();
-
-
- if (last_line)
+ while (last_breakable--)
{
- output_scheme (scm_list_n (ly_symbol2scm ("stop-last-system"), SCM_UNDEFINED));
+ if (Paper_column::is_breakable (ro_columns [last_breakable]))
+ break;
}
- else
+
+ vector<Grob *> columns;
+ for (int i = 0; i <= last_breakable; i++)
{
- output_scheme (scm_list_n (ly_symbol2scm ("stop-system"), SCM_UNDEFINED));
+ if (Paper_column::is_used (ro_columns[i]))
+ columns.push_back (ro_columns[i]);
}
+
+ return columns;
+}
+
+Paper_column *
+System::column (vsize which) const
+{
+ extract_grob_set (this, "columns", columns);
+ if (which >= columns.size ())
+ return 0;
+
+ return dynamic_cast<Paper_column *> (columns[which]);
+}
+
+Paper_score *
+System::paper_score () const
+{
+ return pscore_;
}
+int
+System::get_rank () const
+{
+ return rank_;
+}
-Link_array<Item>
-System::broken_col_range (Item const*l, Item const*r) const
+System *
+get_root_system (Grob *me)
{
- Link_array<Item> ret;
+ Grob *system_grob = me;
- l = l->get_column ();
- r = r->get_column ();
- SCM s = get_grob_property ("columns");
+ while (system_grob->get_parent (Y_AXIS))
+ system_grob = system_grob->get_parent (Y_AXIS);
- while (gh_pair_p (s) && ly_car (s) != r->self_scm ())
- s = ly_cdr (s);
-
- if (gh_pair_p (s))
- s = ly_cdr (s);
-
- while (gh_pair_p (s) && ly_car (s) != l->self_scm ())
+ return dynamic_cast<System *> (system_grob);
+}
+
+Grob *
+System::get_vertical_alignment ()
+{
+ extract_grob_set (this, "elements", elts);
+ Grob *ret = 0;
+ for (vsize i = 0; i < elts.size (); i++)
+ if (Align_interface::has_interface (elts[i]))
+ {
+ if (ret)
+ programming_error ("found multiple vertical alignments in this system");
+ ret = elts[i];
+ }
+
+ if (!ret)
+ programming_error ("didn't find a vertical alignment in this system");
+ return ret;
+}
+
+// Finds the furthest staff in the given direction whose x-extent
+// overlaps with the given interval.
+Grob *
+System::get_extremal_staff (Direction dir, Interval const &iv)
+{
+ Grob *align = get_vertical_alignment ();
+ if (!align)
+ return 0;
+
+ extract_grob_set (align, "elements", elts);
+ vsize start = (dir == UP) ? 0 : elts.size () - 1;
+ vsize end = (dir == UP) ? elts.size () : VPOS;
+ for (vsize i = start; i != end; i += dir)
{
- Paper_column*c = dynamic_cast<Paper_column*> (unsmob_grob (ly_car (s)));
- if (Item::breakable_b (c) && !c->system_)
- ret.push (c);
+ if (Hara_kiri_group_spanner::has_interface (elts[i]))
+ Hara_kiri_group_spanner::consider_suicide (elts[i]);
- s = ly_cdr (s);
+ Interval intersection = elts[i]->extent (this, X_AXIS);
+ intersection.intersect (iv);
+ if (elts[i]->is_live () && !intersection.is_empty ())
+ return elts[i];
}
+ return 0;
+}
+
+Interval
+System::pure_refpoint_extent (vsize start, vsize end)
+{
+ Interval ret;
+ Grob *alignment = get_vertical_alignment ();
+ if (!alignment)
+ return Interval ();
+
+ extract_grob_set (alignment, "elements", staves);
+ vector<Real> offsets = Align_interface::get_pure_minimum_translations (alignment, staves, Y_AXIS, start, end);
+
+ for (vsize i = 0; i < offsets.size (); ++i)
+ if (Page_layout_problem::is_spaceable (staves[i]))
+ {
+ ret[UP] = offsets[i];
+ break;
+ }
+
+ for (vsize i = offsets.size (); i--;)
+ if (Page_layout_problem::is_spaceable (staves[i]))
+ {
+ ret[DOWN] = offsets[i];
+ break;
+ }
- ret.reverse ();
return ret;
}
-/**
- Return all columns, but filter out any unused columns , since they might
- disrupt the spacing problem.
- */
-Link_array<Grob>
-System::columns ()const
+Interval
+System::part_of_line_pure_height (vsize start, vsize end, bool begin)
{
- Link_array<Grob> acs
- = Pointer_group_interface__extract_grobs (this, (Grob*) 0, "columns");
- bool bfound = false;
- for (int i= acs.size (); i -- ;)
+ Grob *alignment = get_vertical_alignment ();
+ if (!alignment)
+ return Interval ();
+
+ extract_grob_set (alignment, "elements", staves);
+ vector<Real> offsets = Align_interface::get_pure_minimum_translations (alignment, staves, Y_AXIS, start, end);
+
+ Interval ret;
+ for (vsize i = 0; i < staves.size (); ++i)
{
- bool brb = Item::breakable_b (acs[i]);
- bfound = bfound || brb;
+ Interval iv = begin
+ ? Axis_group_interface::begin_of_line_pure_height (staves[i], start)
+ : Axis_group_interface::rest_of_line_pure_height (staves[i], start, end);
+ if (i < offsets.size ())
+ iv.translate (offsets[i]);
+ ret.unite (iv);
+ }
- /*
- the last column should be breakable. Weed out any columns that
- seem empty. We need to retain breakable columns, in case
- someone forced a breakpoint.
- */
- if (!bfound || !Paper_column::is_used (acs[i]))
- acs.del (i);
+ Interval other_elements = begin
+ ? Axis_group_interface::begin_of_line_pure_height (this, start)
+ : Axis_group_interface::rest_of_line_pure_height (this, start, end);
+
+ ret.unite (other_elements);
+
+ return ret;
+}
+
+Interval
+System::begin_of_line_pure_height (vsize start, vsize end)
+{
+ return part_of_line_pure_height (start, end, true);
+}
+
+Interval
+System::rest_of_line_pure_height (vsize start, vsize end)
+{
+ return part_of_line_pure_height (start, end, false);
+}
+
+// This differs from Axis_group_interface::calc_pure_relevant_grobs
+// because here, we are only interested in those few elements that aren't
+// descended from VerticalAlignment (ie. things like RehearsalMark, BarLine).
+MAKE_SCHEME_CALLBACK (System, calc_pure_relevant_grobs, 1);
+SCM
+System::calc_pure_relevant_grobs (SCM smob)
+{
+ Grob *me = unsmob_grob (smob);
+
+ extract_grob_set (me, "elements", elts);
+ vector<Grob *> relevant_grobs;
+ SCM pure_relevant_p = ly_lily_module_constant ("pure-relevant?");
+
+ for (vsize i = 0; i < elts.size (); ++i)
+ {
+ if (!Axis_group_interface::has_interface (elts[i]))
+ {
+ if (to_boolean (scm_apply_1 (pure_relevant_p, elts[i]->self_scm (), SCM_EOL)))
+ relevant_grobs.push_back (elts[i]);
+
+ if (Item *it = dynamic_cast<Item*> (elts[i]))
+ {
+ Direction d = LEFT;
+ do
+ {
+ Item *piece = it->find_prebroken_piece (d);
+ if (piece && to_boolean (scm_apply_1 (pure_relevant_p, piece->self_scm (), SCM_EOL)))
+ relevant_grobs.push_back (piece);
+ }
+ while (flip (&d) != LEFT);
+ }
+ }
}
- return acs;
+
+ SCM grobs_scm = Grob_array::make_array ();
+
+ unsmob_grob_array (grobs_scm)->set_array (relevant_grobs);
+ return grobs_scm;
+}
+
+MAKE_SCHEME_CALLBACK (System, height, 1);
+SCM
+System::height (SCM smob)
+{
+ return Axis_group_interface::height (smob);
+}
+
+MAKE_SCHEME_CALLBACK (System, calc_pure_height, 3);
+SCM
+System::calc_pure_height (SCM smob, SCM start_scm, SCM end_scm)
+{
+ System *me = dynamic_cast<System *> (unsmob_grob (smob));
+ int start = scm_to_int (start_scm);
+ int end = scm_to_int (end_scm);
+
+ Interval begin = me->begin_of_line_pure_height (start, end);
+ Interval rest = me->rest_of_line_pure_height (start, end);
+ begin.unite (rest);
+
+ return ly_interval2scm (begin);
}
-
+Grob*
+System::get_pure_bound (Direction d, int start, int end)
+{
+ vector<vsize> ranks = pscore_->get_break_ranks ();
+ vector<vsize> indices = pscore_->get_break_indices ();
+ vector<Grob*> cols = pscore_->get_columns ();
+
+ vsize target_rank = (d == LEFT ? start : end);
+ vector<vsize>::const_iterator i =
+ lower_bound (ranks.begin (), ranks.end (), target_rank, std::less<vsize> ());
+
+ if (i != ranks.end () && (*i) == target_rank)
+ return cols[indices[i - ranks.begin ()]];
+ else
+ return 0;
+}
+Grob*
+System::get_maybe_pure_bound (Direction d, bool pure, int start, int end)
+{
+ return pure ? get_pure_bound (d, start, end) : get_bound (d);
+}
-ADD_INTERFACE (System,"system-interface",
- "Super grob, parent of all: "
-"\n\n"
-"The columns of a score that form one line. The toplevel grob. Any "
-"grob has a Line_of_score as both X and Y reference point. The "
-"Paper_score contains one grob of this type. Control enters the "
-"Grob dependency calculation from this single Line_of_score "
-"object.",
- "between-system-string all-elements columns");
+ADD_INTERFACE (System,
+ "This is the top-level object: Each object in a score"
+ " ultimately has a @code{System} object as its X and"
+ " Y@tie{}parent.",
+
+ /* properties */
+ "all-elements "
+ "columns "
+ "labels "
+ "pure-Y-extent "
+ "skyline-horizontal-padding "
+ );
projects / lilypond.git / blobdiff