lily/system.cc

   1 /*
   2   system.cc -- implement System
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1996--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #include "system.hh"
  10
  11 #include "align-interface.hh"
  12 #include "all-font-metrics.hh"
  13 #include "axis-group-interface.hh"
  14 #include "grob-array.hh"
  15 #include "international.hh"
  16 #include "main.hh"
  17 #include "output-def.hh"
  18 #include "paper-column.hh"
  19 #include "paper-score.hh"
  20 #include "paper-system.hh"
  21 #include "pointer-group-interface.hh"
  22 #include "spacing-interface.hh"
  23 #include "staff-symbol-referencer.hh"
  24 #include "tweak-registration.hh"
  25 #include "warn.hh"
  26 #include "lookup.hh"
  27
  28 extern bool debug_skylines;
  29
  30 System::System (System const &src, int count)
  31   : Spanner (src, count)
  32 {
  33   all_elements_ = 0;
  34   pscore_ = 0;
  35   rank_ = 0;
  36   init_elements ();
  37 }
  38
  39 System::System (SCM s, Object_key const *key)
  40   : Spanner (s, key)
  41 {
  42   all_elements_ = 0;
  43   rank_ = 0;
  44   init_elements ();
  45 }
  46
  47 void
  48 System::init_elements ()
  49 {
  50   SCM scm_arr = Grob_array::make_array ();
  51   all_elements_ = unsmob_grob_array (scm_arr);
  52   all_elements_->set_ordered (false);
  53   set_object ("all-elements", scm_arr);
  54 }
  55
  56 Grob *
  57 System::clone (int index) const
  58 {
  59   return new System (*this, index);
  60 }
  61
  62 int
  63 System::element_count () const
  64 {
  65   return all_elements_->size ();
  66 }
  67
  68 int
  69 System::spanner_count () const
  70 {
  71   int k = 0;
  72   for (vsize i = all_elements_->size (); i--;)
  73     if (dynamic_cast<Spanner *> (all_elements_->grob (i)))
  74       k++;
  75   return k;
  76 }
  77
  78 void
  79 System::typeset_grob (Grob *elem)
  80 {
  81   if (elem->layout_)
  82     programming_error ("adding element twice");
  83   else
  84     {
  85       elem->layout_ = pscore_->layout ();
  86       all_elements_->add (elem);
  87       elem->unprotect ();
  88     }
  89 }
  90
  91 void
  92 System::derived_mark () const
  93 {
  94   if (!all_elements_->empty ())
  95     {
  96       Grob **ptr = &all_elements_->array_reference ()[0];
  97       Grob **end = ptr + all_elements_->size ();
  98       while (ptr < end)
  99         {
 100           scm_gc_mark ((*ptr)->self_scm ());
 101           ptr++;
 102         }
 103     }
 104
 105   if (pscore_)
 106     scm_gc_mark (pscore_->self_scm ());
 107
 108   Spanner::derived_mark ();
 109 }
 110
 111 static void
 112 fixup_refpoints (vector<Grob*> const &grobs)
 113 {
 114   for (vsize i = grobs.size (); i--;)
 115     grobs[i]->fixup_refpoint ();
 116 }
 117
 118 SCM
 119 System::get_paper_systems ()
 120 {
 121   for (vsize i = 0; i < all_elements_->size (); i++)
 122     {
 123       Grob *g = all_elements_->grob (i);
 124       if (g->internal_has_interface (ly_symbol2scm ("only-prebreak-interface")))
 125         {
 126           /*
 127             Kill no longer needed grobs.
 128           */
 129           Item *it = dynamic_cast<Item *> (g);
 130           if (it && Item::is_non_musical (it))
 131             {
 132               it->find_prebroken_piece (LEFT)->suicide ();
 133               it->find_prebroken_piece (RIGHT)->suicide ();
 134             }
 135           g->suicide ();
 136         }
 137       else if (g->is_live ())
 138         g->do_break_processing ();
 139     }
 140
 141   /*
 142     fixups must be done in broken line_of_scores, because new elements
 143     are put over there.  */
 144   int count = 0;
 145   for (vsize i = 0; i < broken_intos_.size (); i++)
 146     {
 147       Grob *se = broken_intos_[i];
 148
 149       extract_grob_set (se, "all-elements", all_elts);
 150       for (vsize j = 0; j < all_elts.size (); j++)
 151         {
 152           Grob *g = all_elts[j];
 153           g->fixup_refpoint ();
 154         }
 155
 156       count += all_elts.size ();
 157     }
 158
 159   /*
 160     needed for doing items.
 161   */
 162   fixup_refpoints (all_elements_->array ());
 163
 164   for (vsize i = 0; i < all_elements_->size (); i++)
 165     all_elements_->grob (i)->handle_broken_dependencies ();
 166
 167   handle_broken_dependencies ();
 168
 169   /* Because the this->get_property (all-elements) contains items in 3
 170      versions, handle_broken_dependencies () will leave duplicated
 171      items in all-elements.  Strictly speaking this is harmless, but
 172      it leads to duplicated symbols in the output.  uniq makes sure
 173      that no duplicates are in the list.  */
 174   for (vsize i = 0; i < broken_intos_.size (); i++)
 175     {
 176       System *child = dynamic_cast<System*> (broken_intos_[i]);
 177       child->all_elements_->remove_duplicates ();
 178     }
 179
 180   if (be_verbose_global)
 181     message (_f ("Element count %d.", count + element_count ()));
 182
 183   SCM lines = scm_c_make_vector (broken_intos_.size (), SCM_EOL);
 184   for (vsize i = 0; i < broken_intos_.size (); i++)
 185     {
 186       if (be_verbose_global)
 187         progress_indication ("[");
 188
 189       System *system = dynamic_cast<System *> (broken_intos_[i]);
 190
 191       system->post_processing ();
 192       system->build_skylines ();
 193       if (i > 0)
 194         {
 195           System *prev = dynamic_cast<System*> (broken_intos_[i-1]);
 196           Real r = prev->skylines_[DOWN].distance (system->skylines_[UP]);
 197           system->set_property ("skyline-distance", scm_from_double (r));
 198         }
 199       scm_vector_set_x (lines, scm_from_int (i),
 200                         system->get_paper_system ());
 201
 202       if (be_verbose_global)
 203         progress_indication (to_string (i) + "]");
 204     }
 205   return lines;
 206 }
 207
 208 void
 209 System::break_into_pieces (vector<Column_x_positions> const &breaking)
 210 {
 211   for (vsize i = 0; i < breaking.size (); i++)
 212     {
 213       System *system = dynamic_cast<System *> (clone (broken_intos_.size ()));
 214       system->rank_ = broken_intos_.size ();
 215
 216       vector<Grob*> c (breaking[i].cols_);
 217       pscore_->typeset_system (system);
 218
 219       int st = Paper_column::get_rank (c[0]);
 220       int end = Paper_column::get_rank (c.back ());
 221       Interval iv (pure_height (this, st, end));
 222       system->set_property ("pure-Y-extent", ly_interval2scm (iv));
 223
 224       system->set_bound (LEFT, c[0]);
 225       system->set_bound (RIGHT, c.back ());
 226       for (vsize j = 0; j < c.size (); j++)
 227         {
 228           c[j]->translate_axis (breaking[i].config_[j], X_AXIS);
 229           dynamic_cast<Paper_column *> (c[j])->system_ = system;
 230         }
 231
 232       set_loose_columns (system, &breaking[i]);
 233       broken_intos_.push_back (system);
 234     }
 235 }
 236
 237 void
 238 System::add_column (Paper_column *p)
 239 {
 240   Grob *me = this;
 241   Grob_array *ga = unsmob_grob_array (me->get_object ("columns"));
 242   if (!ga)
 243     {
 244       SCM scm_ga = Grob_array::make_array ();
 245       me->set_object ("columns", scm_ga);
 246       ga = unsmob_grob_array (scm_ga);
 247     }
 248
 249   p->rank_ = ga->size ();
 250
 251   ga->add (p);
 252   Axis_group_interface::add_element (this, p);
 253 }
 254
 255 void
 256 apply_tweaks (Grob *g, bool broken)
 257 {
 258   if (bool (g->original ()) == broken)
 259     {
 260       SCM tweaks = global_registry_->get_tweaks (g);
 261       for (SCM s = tweaks; scm_is_pair (s); s = scm_cdr (s))
 262         {
 263           SCM proc = scm_caar (s);
 264           SCM rest = scm_cdar (s);
 265           scm_apply_1 (proc, g->self_scm (), rest);
 266         }
 267     }
 268 }
 269
 270 void
 271 System::pre_processing ()
 272 {
 273   for (vsize i = 0; i < all_elements_->size (); i++)
 274     all_elements_->grob (i)->discretionary_processing ();
 275
 276   if (be_verbose_global)
 277     message (_f ("Grob count %d", element_count ()));
 278
 279   /*
 280     order is significant: broken grobs are added to the end of the
 281     array, and should be processed before the original is potentially
 282     killed.
 283   */
 284   for (vsize i = all_elements_->size (); i--;)
 285     all_elements_->grob (i)->handle_prebroken_dependencies ();
 286
 287   fixup_refpoints (all_elements_->array ());
 288
 289   for (vsize i = 0; i < all_elements_->size (); i++)
 290     apply_tweaks (all_elements_->grob (i), false);
 291
 292   for (vsize i = 0; i < all_elements_->size (); i++)
 293     {
 294       Grob *g = all_elements_->grob (i);
 295       (void) g->get_property ("before-line-breaking");
 296     }
 297
 298   for (vsize i = 0; i < all_elements_->size (); i++)
 299     {
 300       Grob *e = all_elements_->grob (i);
 301       (void) e->get_property ("springs-and-rods");
 302     }
 303 }
 304
 305 void
 306 System::post_processing ()
 307 {
 308   for (vsize i = 0; i < all_elements_->size (); i++)
 309     {
 310       Grob *g = all_elements_->grob (i);
 311
 312       apply_tweaks (g, true);
 313       (void) g->get_property ("after-line-breaking");
 314     }
 315
 316   Interval iv (extent (this, Y_AXIS));
 317   if (iv.is_empty ())
 318     programming_error ("system with empty extent");
 319   else
 320     translate_axis (-iv[MAX], Y_AXIS);
 321
 322   /* Generate all stencils to trigger font loads.
 323      This might seem inefficient, but Stencils are cached per grob
 324      anyway. */
 325
 326   vector<Grob*> all_elts_sorted (all_elements_->array ());
 327   vector_sort (all_elts_sorted, std::less<Grob*> ());
 328   uniq (all_elts_sorted);
 329   this->get_stencil ();
 330   for (vsize i = all_elts_sorted.size (); i--;)
 331     {
 332       Grob *g = all_elts_sorted[i];
 333       g->get_stencil ();
 334     }
 335 }
 336
 337 struct Layer_entry
 338 {
 339   Grob *grob_;
 340   int layer_;
 341 };
 342
 343 bool
 344 operator< (Layer_entry  const &a,
 345            Layer_entry  const &b)
 346 {
 347   return a.layer_ < b.layer_;
 348 }
 349
 350
 351 SCM
 352 System::get_paper_system ()
 353 {
 354   SCM exprs = SCM_EOL;
 355   SCM *tail = &exprs;
 356
 357   vector<Layer_entry> entries;
 358   for (vsize j = 0; j < all_elements_->size (); j++)
 359     {
 360       Layer_entry e;
 361       e.grob_ = all_elements_->grob (j);
 362       e.layer_ = robust_scm2int (e.grob_->get_property ("layer"), 1);
 363
 364       entries.push_back (e);
 365     }
 366
 367   vector_sort (entries, std::less<Layer_entry> ());
 368   for (vsize j = 0; j < entries.size (); j++)
 369     {
 370       Grob *g = entries[j].grob_;
 371       Stencil st = g->get_print_stencil ();
 372
 373       if (st.expr() == SCM_EOL)
 374         continue;
 375
 376       Offset o;
 377       for (int a = X_AXIS; a < NO_AXES; a++)
 378         o[Axis (a)] = g->relative_coordinate (this, Axis (a));
 379
 380       Offset extra = robust_scm2offset (g->get_property ("extra-offset"),
 381                                         Offset (0, 0))
 382         * Staff_symbol_referencer::staff_space (g);
 383
 384       /* Must copy the stencil, for we cannot change the stencil
 385          cached in G.  */
 386
 387       st.translate (o + extra);
 388
 389       *tail = scm_cons (st.expr (), SCM_EOL);
 390       tail = SCM_CDRLOC (*tail);
 391     }
 392
 393   if (Stencil *me = get_stencil ())
 394     exprs = scm_cons (me->expr (), exprs);
 395
 396   Interval x (extent (this, X_AXIS));
 397   Interval y (extent (this, Y_AXIS));
 398   Stencil sys_stencil (Box (x, y),
 399                        scm_cons (ly_symbol2scm ("combine-stencil"),
 400                                  exprs));
 401   if (debug_skylines)
 402     {
 403       sys_stencil.add_stencil (Lookup::points_to_line_stencil (0.1, skylines_[UP].to_points ()).in_color (255, 0, 0));
 404       sys_stencil.add_stencil (Lookup::points_to_line_stencil (0.1, skylines_[DOWN].to_points ()).in_color (0, 255, 0));
 405     }
 406
 407   Grob *left_bound = this->get_bound (LEFT);
 408   SCM prop_init = left_bound->get_property ("line-break-system-details");
 409   Prob *pl = make_paper_system (prop_init);
 410   paper_system_set_stencil (pl, sys_stencil);
 411
 412   /* information that the page breaker might need */
 413   Grob *right_bound = this->get_bound (RIGHT);
 414   pl->set_property ("skyline-distance", get_property ("skyline-distance"));
 415   pl->set_property ("page-break-permission", right_bound->get_property ("page-break-permission"));
 416   pl->set_property ("page-turn-permission", right_bound->get_property ("page-turn-permission"));
 417   pl->set_property ("page-break-penalty", right_bound->get_property ("page-break-penalty"));
 418   pl->set_property ("page-turn-penalty", right_bound->get_property ("page-turn-penalty"));
 419
 420   if (!scm_is_pair (pl->get_property ("refpoint-Y-extent")))
 421     {
 422       Interval staff_refpoints;
 423       staff_refpoints.set_empty ();
 424       extract_grob_set (this, "spaceable-staves", staves);
 425       for (vsize i = 0; i < staves.size (); i++)
 426         {
 427           Grob *g = staves[i];
 428           staff_refpoints.add_point (g->relative_coordinate (this, Y_AXIS));
 429         }
 430       pl->set_property ("refpoint-Y-extent", ly_interval2scm (staff_refpoints));
 431     }
 432
 433   pl->set_property ("system-grob", this->self_scm ());
 434
 435   return pl->unprotect ();
 436 }
 437
 438 vector<Item*>
 439 System::broken_col_range (Item const *left, Item const *right) const
 440 {
 441   vector<Item*> ret;
 442
 443   left = left->get_column ();
 444   right = right->get_column ();
 445
 446
 447   extract_grob_set (this, "columns", cols);
 448
 449   vsize i = Paper_column::get_rank (left);
 450   int end_rank = Paper_column::get_rank (right);
 451   if (i < cols.size ())
 452     i++;
 453
 454   while (i < cols.size ()
 455          && Paper_column::get_rank (cols[i]) < end_rank)
 456     {
 457       Paper_column *c = dynamic_cast<Paper_column *> (cols[i]);
 458       if (Paper_column::is_breakable (c) && !c->system_)
 459         ret.push_back (c);
 460       i++;
 461     }
 462
 463   return ret;
 464 }
 465
 466
 467 /** Return all columns, but filter out any unused columns , since they might
 468     disrupt the spacing problem. */
 469 vector<Grob*>
 470 System::columns () const
 471 {
 472   extract_grob_set (this, "columns", ro_columns);
 473
 474   int last_breakable = ro_columns.size ();
 475
 476   while (last_breakable--)
 477     {
 478       if (Paper_column::is_breakable (ro_columns [last_breakable]))
 479         break;
 480     }
 481
 482   vector<Grob*> columns;
 483   for (int i = 0; i <= last_breakable; i++)
 484     {
 485       if (Paper_column::is_used (ro_columns[i]))
 486         columns.push_back (ro_columns[i]);
 487     }
 488
 489   return columns;
 490 }
 491
 492 Grob*
 493 System::column (int which) const
 494 {
 495   extract_grob_set (this, "columns", columns);
 496   return columns[which];
 497 }
 498
 499 Paper_score*
 500 System::paper_score () const
 501 {
 502   return pscore_;
 503 }
 504
 505 int
 506 System::get_rank () const
 507 {
 508   return rank_;
 509 }
 510
 511 System *
 512 get_root_system (Grob *me)
 513 {
 514   Grob *system_grob = me;
 515
 516   while (system_grob->get_parent (Y_AXIS))
 517     system_grob = system_grob->get_parent (Y_AXIS);
 518
 519   return dynamic_cast<System*> (system_grob);
 520 }
 521
 522 void
 523 System::build_skylines ()
 524 {
 525   vector<Box> boxes;
 526   for (vsize i = 0; i < all_elements_->size (); i++)
 527     {
 528       Grob *g = all_elements_->grob (i);
 529       if (!unsmob_stencil (g->get_property ("stencil")))
 530         continue;
 531
 532       Interval xiv = g->extent (this, X_AXIS);
 533       Interval yiv = g->extent (this, Y_AXIS);
 534       if (!xiv.is_empty () && !yiv.is_empty ())
 535         boxes.push_back (Box (xiv, yiv));
 536     }
 537
 538   SCM horizon_padding_scm = get_property ("skyline-horizontal-padding");
 539   Real horizon_padding = robust_scm2double (horizon_padding_scm, 0);
 540   skylines_[UP] = Skyline (boxes, horizon_padding, X_AXIS, UP);
 541   skylines_[DOWN] = Skyline (boxes, horizon_padding, X_AXIS, DOWN);
 542 }
 543
 544
 545 ADD_INTERFACE (System,
 546                "This is the toplevel object: each object in a score "
 547                "ultimately has a System object as its X and Y parent. ",
 548
 549                /* properties */
 550                "all-elements "
 551                "columns "
 552                "pure-Y-extent "
 553                "spaceable-staves "
 554                "skyline-distance "
 555                "skyline-horizontal-padding "
 556                )