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
  27 System::System (System const &src, int count)
  28   : Spanner (src, count)
  29 {
  30   all_elements_ = 0;
  31   pscore_ = 0;
  32   rank_ = 0;
  33   init_elements ();
  34 }
  35
  36 System::System (SCM s, Object_key const *key)
  37   : Spanner (s, key)
  38 {
  39   all_elements_ = 0;
  40   rank_ = 0;
  41   init_elements ();
  42 }
  43
  44 void
  45 System::init_elements ()
  46 {
  47   SCM scm_arr = Grob_array::make_array ();
  48   all_elements_ = unsmob_grob_array (scm_arr);
  49   all_elements_->set_ordered (false);
  50   set_object ("all-elements", scm_arr);
  51 }
  52
  53 Grob *
  54 System::clone (int index) const
  55 {
  56   return new System (*this, index);
  57 }
  58
  59 int
  60 System::element_count () const
  61 {
  62   return all_elements_->size ();
  63 }
  64
  65 int
  66 System::spanner_count () const
  67 {
  68   int k = 0;
  69   for (vsize i = all_elements_->size (); i--;)
  70     if (dynamic_cast<Spanner *> (all_elements_->grob (i)))
  71       k++;
  72   return k;
  73 }
  74
  75 void
  76 System::typeset_grob (Grob *elem)
  77 {
  78   if (elem->layout_)
  79     programming_error ("adding element twice");
  80   else
  81     {
  82       elem->layout_ = pscore_->layout ();
  83       all_elements_->add (elem);
  84       elem->unprotect ();
  85     }
  86 }
  87
  88 void
  89 System::derived_mark () const
  90 {
  91   if (!all_elements_->empty ())
  92     {
  93       Grob **ptr = &all_elements_->array_reference ()[0];
  94       Grob **end = ptr + all_elements_->size ();
  95       while (ptr < end)
  96         {
  97           scm_gc_mark ((*ptr)->self_scm ());
  98           ptr++;
  99         }
 100     }
 101
 102   if (pscore_)
 103     scm_gc_mark (pscore_->self_scm ());
 104
 105   Spanner::derived_mark ();
 106 }
 107
 108 static void
 109 fixup_refpoints (vector<Grob*> const &grobs)
 110 {
 111   for (vsize i = grobs.size (); i--;)
 112     grobs[i]->fixup_refpoint ();
 113 }
 114
 115 SCM
 116 System::get_paper_systems ()
 117 {
 118   for (vsize i = 0; i < all_elements_->size (); i++)
 119     {
 120       Grob *g = all_elements_->grob (i);
 121       if (g->internal_has_interface (ly_symbol2scm ("only-prebreak-interface")))
 122         {
 123           /*
 124             Kill no longer needed grobs.
 125           */
 126           Item *it = dynamic_cast<Item *> (g);
 127           if (it && Item::is_non_musical (it))
 128             {
 129               it->find_prebroken_piece (LEFT)->suicide ();
 130               it->find_prebroken_piece (RIGHT)->suicide ();
 131             }
 132           g->suicide ();
 133         }
 134       else if (g->is_live ())
 135         g->do_break_processing ();
 136     }
 137
 138   /*
 139     fixups must be done in broken line_of_scores, because new elements
 140     are put over there.  */
 141   int count = 0;
 142   for (vsize i = 0; i < broken_intos_.size (); i++)
 143     {
 144       Grob *se = broken_intos_[i];
 145
 146       extract_grob_set (se, "all-elements", all_elts);
 147       for (vsize j = 0; j < all_elts.size (); j++)
 148         {
 149           Grob *g = all_elts[j];
 150           g->fixup_refpoint ();
 151         }
 152
 153       count += all_elts.size ();
 154     }
 155
 156   /*
 157     needed for doing items.
 158   */
 159   fixup_refpoints (all_elements_->array ());
 160
 161   for (vsize i = 0; i < all_elements_->size (); i++)
 162     all_elements_->grob (i)->handle_broken_dependencies ();
 163
 164   handle_broken_dependencies ();
 165
 166   /* Because the this->get_property (all-elements) contains items in 3
 167      versions, handle_broken_dependencies () will leave duplicated
 168      items in all-elements.  Strictly speaking this is harmless, but
 169      it leads to duplicated symbols in the output.  uniq makes sure
 170      that no duplicates are in the list.  */
 171   for (vsize i = 0; i < broken_intos_.size (); i++)
 172     {
 173       System *child = dynamic_cast<System*> (broken_intos_[i]);
 174       child->all_elements_->remove_duplicates ();
 175     }
 176
 177   if (be_verbose_global)
 178     message (_f ("Element count %d.", count + element_count ()));
 179
 180   SCM lines = scm_c_make_vector (broken_intos_.size (), SCM_EOL);
 181   for (vsize i = 0; i < broken_intos_.size (); i++)
 182     {
 183       if (be_verbose_global)
 184         progress_indication ("[");
 185
 186       System *system = dynamic_cast<System *> (broken_intos_[i]);
 187
 188       system->post_processing ();
 189       system->build_skylines ();
 190       if (i > 0)
 191         {
 192           System *prev = dynamic_cast<System*> (broken_intos_[i-1]);
 193           Real r = prev->skylines_[DOWN].distance (system->skylines_[UP]);
 194           system->set_property ("skyline-distance", scm_from_double (r));
 195         }
 196       scm_vector_set_x (lines, scm_from_int (i),
 197                         system->get_paper_system ());
 198
 199       if (be_verbose_global)
 200         progress_indication (to_string (i) + "]");
 201     }
 202   return lines;
 203 }
 204
 205 void
 206 System::break_into_pieces (vector<Column_x_positions> const &breaking)
 207 {
 208   for (vsize i = 0; i < breaking.size (); i++)
 209     {
 210       System *system = dynamic_cast<System *> (clone (broken_intos_.size ()));
 211       system->rank_ = broken_intos_.size ();
 212
 213       vector<Grob*> c (breaking[i].cols_);
 214       pscore_->typeset_system (system);
 215
 216       int st = Paper_column::get_rank (c[0]);
 217       int end = Paper_column::get_rank (c.back ());
 218       Interval iv (pure_height (this, st, end));
 219       system->set_property ("pure-Y-extent", ly_interval2scm (iv));
 220
 221       system->set_bound (LEFT, c[0]);
 222       system->set_bound (RIGHT, c.back ());
 223       for (vsize j = 0; j < c.size (); j++)
 224         {
 225           c[j]->translate_axis (breaking[i].config_[j], X_AXIS);
 226           dynamic_cast<Paper_column *> (c[j])->system_ = system;
 227         }
 228
 229       set_loose_columns (system, &breaking[i]);
 230       broken_intos_.push_back (system);
 231     }
 232 }
 233
 234 void
 235 System::add_column (Paper_column *p)
 236 {
 237   Grob *me = this;
 238   Grob_array *ga = unsmob_grob_array (me->get_object ("columns"));
 239   if (!ga)
 240     {
 241       SCM scm_ga = Grob_array::make_array ();
 242       me->set_object ("columns", scm_ga);
 243       ga = unsmob_grob_array (scm_ga);
 244     }
 245
 246   p->rank_
 247     = ga->size ()
 248     ? Paper_column::get_rank (ga->array ().back ()) + 1
 249     : 0;
 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
 402   Grob *left_bound = this->get_bound (LEFT);
 403   SCM prop_init = left_bound->get_property ("line-break-system-details");
 404   Prob *pl = make_paper_system (prop_init);
 405   paper_system_set_stencil (pl, sys_stencil);
 406
 407   /* information that the page breaker might need */
 408   Grob *right_bound = this->get_bound (RIGHT);
 409   pl->set_property ("skyline-distance", get_property ("skyline-distance"));
 410   pl->set_property ("page-break-permission", right_bound->get_property ("page-break-permission"));
 411   pl->set_property ("page-turn-permission", right_bound->get_property ("page-turn-permission"));
 412   pl->set_property ("page-break-penalty", right_bound->get_property ("page-break-penalty"));
 413   pl->set_property ("page-turn-penalty", right_bound->get_property ("page-turn-penalty"));
 414
 415   if (!scm_is_pair (pl->get_property ("refpoint-Y-extent")))
 416     {
 417       Interval staff_refpoints;
 418       staff_refpoints.set_empty ();
 419       extract_grob_set (this, "spaceable-staves", staves);
 420       for (vsize i = 0; i < staves.size (); i++)
 421         {
 422           Grob *g = staves[i];
 423           staff_refpoints.add_point (g->relative_coordinate (this, Y_AXIS));
 424         }
 425       pl->set_property ("refpoint-Y-extent", ly_interval2scm (staff_refpoints));
 426     }
 427
 428   pl->set_property ("system-grob", this->self_scm ());
 429
 430   return pl->unprotect ();
 431 }
 432
 433 vector<Item*>
 434 System::broken_col_range (Item const *left, Item const *right) const
 435 {
 436   vector<Item*> ret;
 437
 438   left = left->get_column ();
 439   right = right->get_column ();
 440
 441   extract_grob_set (this, "columns", cols);
 442   vsize i = 0;
 443   while (i < cols.size ()
 444          && cols[i] != left)
 445     i++;
 446
 447   if (i < cols.size ())
 448     i++;
 449
 450   while (i < cols.size ()
 451          && cols[i] != right)
 452     {
 453       Paper_column *c = dynamic_cast<Paper_column *> (cols[i]);
 454       if (Paper_column::is_breakable (c) && !c->system_)
 455         ret.push_back (c);
 456       i++;
 457     }
 458
 459   return ret;
 460 }
 461
 462 /** Return all columns, but filter out any unused columns , since they might
 463     disrupt the spacing problem. */
 464 vector<Grob*>
 465 System::columns () const
 466 {
 467   extract_grob_set (this, "columns", ro_columns);
 468
 469   int last_breakable = ro_columns.size ();
 470
 471   while (last_breakable--)
 472     {
 473       if (Paper_column::is_breakable (ro_columns [last_breakable]))
 474         break;
 475     }
 476
 477   vector<Grob*> columns;
 478   for (int i = 0; i <= last_breakable; i++)
 479     {
 480       if (Paper_column::is_used (ro_columns[i]))
 481         columns.push_back (ro_columns[i]);
 482     }
 483
 484   return columns;
 485 }
 486
 487 Paper_score*
 488 System::paper_score () const
 489 {
 490   return pscore_;
 491 }
 492
 493 int
 494 System::get_rank () const
 495 {
 496   return rank_;
 497 }
 498
 499 System *
 500 get_root_system (Grob *me)
 501 {
 502   Grob *system_grob = me;
 503
 504   while (system_grob->get_parent (Y_AXIS))
 505     system_grob = system_grob->get_parent (Y_AXIS);
 506
 507   return dynamic_cast<System*> (system_grob);
 508 }
 509
 510 void
 511 System::build_skylines ()
 512 {
 513   vector<Box> boxes;
 514   for (vsize i = 0; i < all_elements_->size (); i++)
 515     {
 516       Grob *g = all_elements_->grob (i);
 517       if (!unsmob_stencil (g->get_property ("stencil")))
 518         continue;
 519
 520       Interval xiv = g->extent (this, X_AXIS);
 521       Interval yiv = g->extent (this, Y_AXIS);
 522       if (!xiv.is_empty () && !yiv.is_empty ())
 523         boxes.push_back (Box (xiv, yiv));
 524     }
 525
 526   skylines_[UP] = Skyline (boxes, X_AXIS, UP);
 527   skylines_[DOWN] = Skyline (boxes, X_AXIS, DOWN);
 528 }
 529
 530
 531 ADD_INTERFACE (System, "system-interface",
 532                "This is the toplevel object: each object in a score "
 533                "ultimately has a System object as its X and Y parent. ",
 534
 535                /* properties */
 536                "all-elements "
 537                "columns "
 538                "pure-Y-extent "
 539                "spaceable-staves "
 540                "skyline-distance "
 541                )