X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fsystem.cc;h=115ab8720c6f11e3460a44773a8260c0eb5ac7f9;hb=9091c04d20d3db4932ce023719973146ccc9d6ea;hp=f1994d21296532758be50914c34ae1b69f56647a;hpb=48631a04b6181cd7be65702574eaaa6c52284bd2;p=lilypond.git diff --git a/lily/system.cc b/lily/system.cc index f1994d2129..115ab8720c 100644 --- a/lily/system.cc +++ b/lily/system.cc @@ -3,77 +3,135 @@ source file of the GNU LilyPond music typesetter - (c) 1996--2002 Han-Wen Nienhuys + (c) 1996--2005 Han-Wen Nienhuys */ -#include "input-smob.hh" +#include "system.hh" + +#include + +#include "align-interface.hh" #include "axis-group-interface.hh" #include "warn.hh" -#include "system.hh" #include "main.hh" #include "paper-column.hh" -#include "paper-def.hh" -#include "paper-outputter.hh" +#include "output-def.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 "staff-symbol-referencer.hh" +#include "paper-book.hh" +#include "paper-system.hh" +#include "tweak-registration.hh" +#include "grob-array.hh" +#include "pointer-group-interface.hh" + +System::System (System const &src, int count) + : Spanner (src, count) +{ + all_elements_ = 0; + rank_ = 0; + init_elements (); +} + +System::System (SCM s, Object_key const *key) + : Spanner (s, key) +{ + all_elements_ = 0; + rank_ = 0; + init_elements (); +} -// todo: use map. void -fixup_refpoints (SCM s) +System::init_elements () { - for (; gh_pair_p (s); s = ly_cdr (s)) - { - Grob::fixup_refpoint (ly_car (s)); - } + SCM scm_arr = Grob_array::make_array (); + all_elements_ = unsmob_grob_array (scm_arr); + set_object ("all-elements", scm_arr); } -System::System (SCM s) - : Spanner (s) +Grob * +System::clone (int count) const { - rank_ = 0; + return new System (*this, count); } 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 (int i = all_elements_->size(); i--;) + if (dynamic_cast (all_elements_->grob (i))) + k++; + return k; } void -System::typeset_grob (Grob * elem) +System::typeset_grob (Grob *elem) { - elem->pscore_ = pscore_; - Pointer_group_interface::add_grob (this, ly_symbol2scm ("all-elements"),elem); - scm_gc_unprotect_object (elem->self_scm ()); + if (elem->pscore_) + programming_error ("adding element twice"); + else + { + elem->pscore_ = pscore_; + all_elements_->add (elem); + scm_gc_unprotect_object (elem->self_scm ()); + } } void -System::output_lines () +System::derived_mark () const { - for (SCM s = get_grob_property ("all-elements"); - gh_pair_p (s); s = ly_cdr (s)) + if (!all_elements_->is_empty ()) { - Grob * g = unsmob_grob (ly_car (s)); - if (Spacing_interface::has_interface (g)) + Grob **ptr = &all_elements_->array_reference ().elem_ref (0); + Grob **end = ptr + all_elements_->size (); + while (ptr < end) + { + scm_gc_mark ((*ptr)->self_scm ()); + ptr ++; + } + } + Spanner::derived_mark (); +} + +static void +fixup_refpoints (Link_array const &grobs) +{ + for (int i = grobs.size (); i--; ) + { + grobs[i]->fixup_refpoint (); + } +} + +SCM +System::get_paper_systems () +{ + for (int i = 0; i < all_elements_->size(); i++) + { + 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 (g); - if (it && Item::breakable_b(it)) + Kill no longer needed grobs. + */ + Item *it = dynamic_cast (g); + if (it && Item::is_breakable (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 (); } @@ -81,467 +139,324 @@ System::output_lines () 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 (int 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 (int 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 (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 (); - - if (verbose_global_b) - progress_indication (_f ("Element count %d.", count + element_count ())); + for (int i = 0 ; i < all_elements_->size(); i++) + all_elements_->grob (i)->handle_broken_dependencies (); + handle_broken_dependencies (); - for (int i=0; i < broken_intos_.size (); i++) +#if 0 /* don't do this: strange side effects. */ + + /* 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. ly_list_qsort_uniq_x () + makes sure that no duplicates are in the list. */ + for (int i = 0; i < line_count; i++) { - System *system = dynamic_cast (broken_intos_[i]); - - if (verbose_global_b) - progress_indication ("["); - system->post_processing (i+1 == broken_intos_.size ()); - - if (verbose_global_b) - { - progress_indication (to_string (i)); - progress_indication ("]"); - } - - if (i < broken_intos_.size () - 1) - { - SCM lastcol = ly_car (system->get_grob_property ("columns")); - Grob* e = unsmob_grob (lastcol); - - 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)); - } - } + SCM all = broken_intos_[i]->get_object ("all-elements"); + all = ly_list_qsort_uniq_x (all); } -} - +#endif + if (be_verbose_global) + message (_f ("Element count %d.", count + element_count ())); + int line_count = broken_intos_.size (); + SCM lines = scm_c_make_vector (line_count, SCM_EOL); -/* - 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) -{ - for (int i = 0; i < posns->loose_cols_.size (); i++) + for (int i = 0; i < line_count; i++) { - int divide_over = 1; - Item *loose = dynamic_cast (posns->loose_cols_[i]); - Paper_column* col = dynamic_cast (loose); - - 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; - - - Item * l=dynamic_cast (unsmob_grob (ly_car (between))); - Item * r=dynamic_cast (unsmob_grob (ly_cdr (between))); - - if (!(l && r)) - break ; - - if (!left && l) - { - left = l->get_column (); - } - - divide_over ++; - - loose = right = r->get_column (); - } - while (1); - - -#if 0 - Real rx = right->relative_coordinate (right->get_parent (X_AXIS), X_AXIS); - Real lx = left->relative_coordinate (left->get_parent (X_AXIS), X_AXIS); - - /* - divide space equally over loose columns. - */ - int j = 1; - loose = col; - while (1) - { - SCM between = loose->get_grob_property ("between-cols"); - if (!gh_pair_p (between)) - break; - - Paper_column *thiscol = dynamic_cast (loose); - - thiscol->system_ = which; - thiscol->translate_axis (lx + j*(rx - lx)/divide_over, X_AXIS); - - j ++; - loose = dynamic_cast (unsmob_grob (ly_cdr (between))); - } -#else - /* - 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); - - /* - - 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. + if (be_verbose_global) + progress_indication ("["); - TODO. - */ - dx *= 0.25; - } - else - dx *= 0.5; + System *system = dynamic_cast (broken_intos_[i]); + system->post_processing (); + scm_vector_set_x (lines, scm_int2num (i), system->get_paper_system ()); - col->system_ = which; - col->translate_axis (lx + dx - cval[LEFT], X_AXIS); -#endif + if (be_verbose_global) + progress_indication (to_string (i) + "]"); } + return lines; } -// const? void System::break_into_pieces (Array const &breaking) { - for (int i=0; i < breaking.size (); i++) + for (int i = 0; i < breaking.size (); i++) { - System *system = dynamic_cast (clone ()); + System *system = dynamic_cast (clone (i)); system->rank_ = i; - // system->set_immutable_grob_property ("rank", gh_int2scm (i)); + Link_array 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++) + pscore_->typeset_system (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 (c[j])->system_ = system; + c[j]->translate_axis (breaking[i].config_[j], X_AXIS); + dynamic_cast (c[j])->system_ = system; } set_loose_columns (system, &breaking[i]); broken_intos_.push (system); } } - void -System::output_molecule (SCM expr, Offset o) +System::add_column (Paper_column *p) { - - while (1) + Grob *me = this; + Grob_array *ga = unsmob_grob_array (me->get_object ("columns")); + if (!ga) { - 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 - { - pscore_->outputter_-> - output_scheme (scm_list_n (ly_symbol2scm ("placebox"), - gh_double2scm (o[X_AXIS]), - gh_double2scm (o[Y_AXIS]), - expr, - SCM_UNDEFINED)); - - return; - } + SCM scm_ga = Grob_array::make_array (); + me->set_object ("columns", scm_ga); + ga = unsmob_grob_array (scm_ga); } + + p->rank_ + = ga->size() + ? Paper_column::get_rank (ga->array ().top ()) + 1 + : 0; + + ga->add (p); + Axis_group_interface::add_element (this, p); } void -System::output_scheme (SCM s) +apply_tweaks (Grob *g, bool broken) { - pscore_->outputter_->output_scheme (s); + if (bool (g->original_) == broken) + { + SCM tweaks = global_registry_->get_tweaks (g); + for (SCM s = tweaks; scm_is_pair (s); s = scm_cdr (s)) + { + SCM proc = scm_caar (s); + SCM rest = scm_cdar (s); + scm_apply_1 (proc, g->self_scm (), rest); + } + } } void -System::add_column (Paper_column*p) +System::pre_processing () { - Grob *me = this; - SCM cs = me->get_grob_property ("columns"); - Grob * prev = gh_pair_p (cs) ? unsmob_grob (ly_car (cs)) : 0; + for (int i = 0 ; i < all_elements_->size(); i ++) + all_elements_->grob (i)->discretionary_processing (); + - p->rank_ = prev ? Paper_column::get_rank (prev) + 1 : 0; + if (be_verbose_global) + message (_f ("Grob count %d", element_count ())); - me->set_grob_property ("columns", gh_cons (p->self_scm (), cs)); + /* + order is significant: broken grobs are added to the end of the + array, and should be processed before the original is potentially + killed. + */ + for (int i = all_elements_->size(); i --; ) + all_elements_->grob (i)->handle_prebroken_dependencies (); - Axis_group_interface::add_element (me, p); -} + fixup_refpoints (all_elements_->array ()); + for (int i = 0 ; i < all_elements_->size(); i ++) + apply_tweaks (all_elements_->grob (i), false); + for (int i = 0 ; i < all_elements_->size(); i ++) + all_elements_->grob (i)->calculate_dependencies (PRECALCED, PRECALCING, + ly_symbol2scm ("before-line-breaking-callback")); -/* - TODO: use scm_map iso. for loops. - */ -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 (); - - if (verbose_global_b) - progress_indication (_f ("Grob count %d ", element_count ())); - - - 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")); + message (_ ("Calculating line breaks...")); + progress_indication (" "); - for (SCM s = get_grob_property ("all-elements"); gh_pair_p (s); s = ly_cdr (s)) + for (int 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")); - } - - progress_indication ("\n" + _ ("Calculating column positions...") + " "); - for (SCM s = get_grob_property ("all-elements"); gh_pair_p (s); s = ly_cdr (s)) - { - 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); + SCM proc = e->get_property ("spacing-procedure"); + if (ly_is_procedure (proc)) + scm_call_1 (proc, e->self_scm ()); } } void -System::post_processing (bool last_line) +System::post_processing () { - for (SCM s = get_grob_property ("all-elements"); - gh_pair_p (s); s = ly_cdr (s)) + for (int i = 0 ; i < all_elements_->size(); i ++) { - Grob* sc = unsmob_grob (ly_car (s)); - sc->calculate_dependencies (POSTCALCED, POSTCALCING, - ly_symbol2scm ("after-line-breaking-callback")); - } + Grob *g = all_elements_->grob (i); - Interval i (extent (this, Y_AXIS)); - if (i.empty_b ()) - programming_error ("Huh? Empty System?"); - else - translate_axis (- i[MAX], Y_AXIS); + apply_tweaks (g, true); + g->calculate_dependencies (POSTCALCED, POSTCALCING, + ly_symbol2scm ("after-line-breaking-callback")); + } - Real height = i.length (); - if (height > 50 CM) + Interval iv (extent (this, Y_AXIS)); + if (iv.is_empty ()) { - programming_error ("Improbable system height"); - height = 50 CM; + programming_error ("system with empty extent"); } + else + translate_axis (-iv[MAX], Y_AXIS); - /* - generate all molecules to trigger all font loads. + /* Generate all stencils to trigger font loads. + This might seem inefficient, but Stencils are cached per grob + anyway. */ - (ugh. This is not very memory efficient.) */ - this->get_molecule(); - for (SCM s = get_grob_property ("all-elements"); gh_pair_p (s); s = ly_cdr (s)) + + Link_array all_elts_sorted (all_elements_->array ()); + all_elts_sorted.default_sort (); + all_elts_sorted.uniq (); + this->get_stencil (); + for (int i = all_elts_sorted.size (); i--;) { - unsmob_grob (ly_car (s))->get_molecule (); + Grob *g = all_elts_sorted[i]; + g->get_stencil (); } - /* - 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. - */ - output_scheme (scm_list_n (ly_symbol2scm ("start-system"), - 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)) +SCM +System::get_paper_system () +{ + static int const LAYER_COUNT = 3; + + SCM exprs = SCM_EOL; + SCM *tail = &exprs; + + /* Output stencils in three layers: 0, 1, 2. Default layer: 1. */ + for (int i = 0; i < LAYER_COUNT; i++) + for (int j = all_elements_->size (); j --;) { - 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) + Grob *g = all_elements_->grob (j); + Stencil *stil = g->get_stencil (); + + /* Skip empty stencils and grobs that are not in this layer. */ + if (!stil + || robust_scm2int (g->get_property ("layer"), 1) != 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)) - { - o[X_AXIS] += gh_scm2double (ly_car (e)); - o[Y_AXIS] += gh_scm2double (ly_cdr (e)); - } - - output_molecule (m->get_expr (), o); + + Offset o (g->relative_coordinate (this, X_AXIS), + g->relative_coordinate (this, Y_AXIS)); + + 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. */ + + Stencil st = *stil; + st.translate (o + extra); + + *tail = scm_cons (st.expr (), SCM_EOL); + tail = SCM_CDRLOC (*tail); } - - - if (last_line) - { - output_scheme (scm_list_n (ly_symbol2scm ("stop-last-system"), SCM_UNDEFINED)); - } - else + 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)); + + Interval staff_refpoints; + staff_refpoints.set_empty (); + extract_grob_set (this, "spaceable-staves", staves); + for (int i = staves.size (); i--; ) { - output_scheme (scm_list_n (ly_symbol2scm ("stop-system"), SCM_UNDEFINED)); + Grob *g = staves[i]; + staff_refpoints.add_point (g->relative_coordinate (this, Y_AXIS)); } -} + Paper_system *pl = new Paper_system (sys_stencil, false); + pl->staff_refpoints_ = staff_refpoints; + Item *break_point = this->get_bound (LEFT); + pl->break_before_penalty_ + = robust_scm2double (break_point->get_property ("page-penalty"), 0.0); -Link_array -System::broken_col_range (Item const*l, Item const*r) const + return scm_gc_unprotect_object (pl->self_scm ()); +} + +Link_array +System::broken_col_range (Item const *left, Item const *right) const { Link_array ret; - l = l->get_column (); - r = r->get_column (); - SCM s = get_grob_property ("columns"); + left = left->get_column (); + right = right->get_column (); - while (gh_pair_p (s) && ly_car (s) != r->self_scm ()) - s = ly_cdr (s); - - if (gh_pair_p (s)) - s = ly_cdr (s); + extract_grob_set (this, "columns", cols); + int i = 0; + while (i < cols.size() + && cols[i] != left) + i++; + + if (i < cols.size()) + i ++; - while (gh_pair_p (s) && ly_car (s) != l->self_scm ()) + while (i < cols.size() + && cols[i] != right) { - Paper_column*c = dynamic_cast (unsmob_grob (ly_car (s))); - if (Item::breakable_b (c) && !c->system_) + Paper_column *c = dynamic_cast (cols[i]); + if (Item::is_breakable (c) && !c->system_) ret.push (c); - - s = ly_cdr (s); + i++; } - ret.reverse (); return ret; } -/** - Return all columns, but filter out any unused columns , since they might - disrupt the spacing problem. - */ +/** Return all columns, but filter out any unused columns , since they might + disrupt the spacing problem. */ Link_array -System::columns ()const +System::columns () const { - Link_array acs - = Pointer_group_interface__extract_grobs (this, (Grob*) 0, "columns"); - bool bfound = false; - for (int i= acs.size (); i -- ;) + extract_grob_set (this, "columns", ro_columns); + + int last_breakable = ro_columns.size (); + + while (last_breakable --) { - bool brb = Item::breakable_b (acs[i]); - bfound = bfound || brb; - - /* - 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::used_b (acs[i])) - acs.del (i); + if (Item::is_breakable (ro_columns [last_breakable])) + break; } - return acs; -} - + Link_array columns; + for (int i = 0; i <= last_breakable; i++) + { + if (Paper_column::is_used (ro_columns[i])) + columns.push (ro_columns[i]); + } + return columns; +} -ADD_INTERFACE (System,"system-interface", - "Super grob, parent of all: +int +System::get_rank () const +{ + return rank_; +} -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, "system-interface", + "This is the toplevel object: each object in a score " + "ultimately has a System object as its X and Y parent. ", + "all-elements spaceable-staves columns")