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 "warn.hh"
  27
  28 System::System (System const &src, int count)
  29   : Spanner (src, count)
  30 {
  31   all_elements_ = 0;
  32   pscore_ = 0;
  33   rank_ = 0;
  34   init_elements ();
  35 }
  36
  37 System::System (SCM s, Object_key const *key)
  38   : Spanner (s, key)
  39 {
  40   all_elements_ = 0;
  41   rank_ = 0;
  42   init_elements ();
  43 }
  44
  45 void
  46 System::init_elements ()
  47 {
  48   SCM scm_arr = Grob_array::make_array ();
  49   all_elements_ = unsmob_grob_array (scm_arr);
  50   set_object ("all-elements", scm_arr);
  51 }
  52
  53 Grob *
  54 System::clone (int count) const
  55 {
  56   return new System (*this, count);
  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_->uniq ();
 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       system->post_processing ();
 188       scm_vector_set_x (lines, scm_from_int (i),
 189                         system->get_paper_system ());
 190
 191       if (be_verbose_global)
 192         progress_indication (to_string (i) + "]");
 193     }
 194   return lines;
 195 }
 196
 197 void
 198 System::break_into_pieces (vector<Column_x_positions> const &breaking)
 199 {
 200   for (vsize i = 0; i < breaking.size (); i++)
 201     {
 202       System *system = dynamic_cast<System *> (clone (broken_intos_.size ()));
 203       system->rank_ = broken_intos_.size ();
 204
 205       vector<Grob*> c (breaking[i].cols_);
 206       pscore_->typeset_system (system);
 207
 208       system->set_bound (LEFT, c[0]);
 209       system->set_bound (RIGHT, c.back ());
 210       for (vsize j = 0; j < c.size (); j++)
 211         {
 212           c[j]->translate_axis (breaking[i].config_[j], X_AXIS);
 213           dynamic_cast<Paper_column *> (c[j])->system_ = system;
 214         }
 215       set_loose_columns (system, &breaking[i]);
 216       broken_intos_.push_back (system);
 217     }
 218 }
 219
 220 void
 221 System::add_column (Paper_column *p)
 222 {
 223   Grob *me = this;
 224   Grob_array *ga = unsmob_grob_array (me->get_object ("columns"));
 225   if (!ga)
 226     {
 227       SCM scm_ga = Grob_array::make_array ();
 228       me->set_object ("columns", scm_ga);
 229       ga = unsmob_grob_array (scm_ga);
 230     }
 231
 232   p->rank_
 233     = ga->size ()
 234     ? Paper_column::get_rank (ga->array ().back ()) + 1
 235     : 0;
 236
 237   ga->add (p);
 238   Axis_group_interface::add_element (this, p);
 239 }
 240
 241 void
 242 apply_tweaks (Grob *g, bool broken)
 243 {
 244   if (bool (g->original ()) == broken)
 245     {
 246       SCM tweaks = global_registry_->get_tweaks (g);
 247       for (SCM s = tweaks; scm_is_pair (s); s = scm_cdr (s))
 248         {
 249           SCM proc = scm_caar (s);
 250           SCM rest = scm_cdar (s);
 251           scm_apply_1 (proc, g->self_scm (), rest);
 252         }
 253     }
 254 }
 255
 256 void
 257 System::pre_processing ()
 258 {
 259   for (vsize i = 0; i < all_elements_->size (); i++)
 260     all_elements_->grob (i)->discretionary_processing ();
 261
 262   if (be_verbose_global)
 263     message (_f ("Grob count %d", element_count ()));
 264
 265   /*
 266     order is significant: broken grobs are added to the end of the
 267     array, and should be processed before the original is potentially
 268     killed.
 269   */
 270   for (vsize i = all_elements_->size (); i--;)
 271     all_elements_->grob (i)->handle_prebroken_dependencies ();
 272
 273   fixup_refpoints (all_elements_->array ());
 274
 275   for (vsize i = 0; i < all_elements_->size (); i++)
 276     apply_tweaks (all_elements_->grob (i), false);
 277
 278   for (vsize i = 0; i < all_elements_->size (); i++)
 279     {
 280       Grob *g = all_elements_->grob (i);
 281       (void) g->get_property ("before-line-breaking");
 282     }
 283
 284   for (vsize i = 0; i < all_elements_->size (); i++)
 285     {
 286       Grob *e = all_elements_->grob (i);
 287       (void) e->get_property ("springs-and-rods");
 288     }
 289 }
 290
 291 void
 292 System::post_processing ()
 293 {
 294   for (vsize i = 0; i < all_elements_->size (); i++)
 295     {
 296       Grob *g = all_elements_->grob (i);
 297
 298       apply_tweaks (g, true);
 299       (void) g->get_property ("after-line-breaking");
 300     }
 301
 302   Interval iv (extent (this, Y_AXIS));
 303   if (iv.is_empty ())
 304     programming_error ("system with empty extent");
 305   else
 306     translate_axis (-iv[MAX], Y_AXIS);
 307
 308   /* Generate all stencils to trigger font loads.
 309      This might seem inefficient, but Stencils are cached per grob
 310      anyway. */
 311
 312   vector<Grob*> all_elts_sorted (all_elements_->array ());
 313   vector_sort (all_elts_sorted, default_compare);
 314   uniq (all_elts_sorted);
 315   this->get_stencil ();
 316   for (vsize i = all_elts_sorted.size (); i--;)
 317     {
 318       Grob *g = all_elts_sorted[i];
 319       g->get_stencil ();
 320     }
 321 }
 322
 323 SCM
 324 System::get_paper_system ()
 325 {
 326   static int const LAYER_COUNT = 3;
 327
 328   SCM exprs = SCM_EOL;
 329   SCM *tail = &exprs;
 330
 331   /* Output stencils in three layers: 0, 1, 2.  Default layer: 1.
 332
 333   FIXME: softcode this.
 334   */
 335   for (int i = 0; i < LAYER_COUNT; i++)
 336     for (vsize j = 0; j < all_elements_->size (); j++)
 337       {
 338         Grob *g = all_elements_->grob (j);
 339         if (robust_scm2int (g->get_property ("layer"), 1) != i)
 340           continue;
 341
 342         Stencil st = g->get_print_stencil ();
 343
 344         if (st.expr() == SCM_EOL)
 345           continue;
 346
 347         Offset o;
 348         for (int a = X_AXIS; a < NO_AXES; a++)
 349           o[Axis (a)] = g->relative_coordinate (this, Axis (a));
 350
 351         Offset extra = robust_scm2offset (g->get_property ("extra-offset"),
 352                                           Offset (0, 0))
 353           * Staff_symbol_referencer::staff_space (g);
 354
 355         /* Must copy the stencil, for we cannot change the stencil
 356            cached in G.  */
 357
 358         st.translate (o + extra);
 359
 360         *tail = scm_cons (st.expr (), SCM_EOL);
 361         tail = SCM_CDRLOC (*tail);
 362       }
 363
 364   if (Stencil *me = get_stencil ())
 365     exprs = scm_cons (me->expr (), exprs);
 366
 367   Interval x (extent (this, X_AXIS));
 368   Interval y (extent (this, Y_AXIS));
 369   Stencil sys_stencil (Box (x, y),
 370                        scm_cons (ly_symbol2scm ("combine-stencil"),
 371                                  exprs));
 372
 373   Grob *left_bound = this->get_bound (LEFT);
 374   SCM prop_init = left_bound->get_property ("line-break-system-details");
 375   Prob *pl = make_paper_system (prop_init);
 376   paper_system_set_stencil (pl, sys_stencil);
 377
 378   /* backwards-compatibility hack for the old page-breaker */
 379   SCM turn_perm = left_bound->get_property ("page-break-permission");
 380   if (!scm_is_symbol (turn_perm))
 381     pl->set_property ("penalty", scm_from_double (10001.0));
 382   else if (turn_perm == ly_symbol2scm ("force"))
 383     pl->set_property ("penalty", scm_from_double (-10001.0));
 384   else
 385     pl->set_property ("penalty", scm_from_double (0.0));
 386
 387   if (!scm_is_pair (pl->get_property ("refpoint-Y-extent")))
 388     {
 389       Interval staff_refpoints;
 390       staff_refpoints.set_empty ();
 391       extract_grob_set (this, "spaceable-staves", staves);
 392       for (vsize i = 0; i < staves.size (); i++)
 393         {
 394           Grob *g = staves[i];
 395           staff_refpoints.add_point (g->relative_coordinate (this, Y_AXIS));
 396         }
 397       pl->set_property ("refpoint-Y-extent", ly_interval2scm (staff_refpoints));
 398     }
 399
 400   pl->set_property ("system-grob", this->self_scm ());
 401
 402   return pl->unprotect ();
 403 }
 404
 405 vector<Item*>
 406 System::broken_col_range (Item const *left, Item const *right) const
 407 {
 408   vector<Item*> ret;
 409
 410   left = left->get_column ();
 411   right = right->get_column ();
 412
 413   extract_grob_set (this, "columns", cols);
 414   vsize i = 0;
 415   while (i < cols.size ()
 416          && cols[i] != left)
 417     i++;
 418
 419   if (i < cols.size ())
 420     i++;
 421
 422   while (i < cols.size ()
 423          && cols[i] != right)
 424     {
 425       Paper_column *c = dynamic_cast<Paper_column *> (cols[i]);
 426       if (Paper_column::is_breakable (c) && !c->system_)
 427         ret.push_back (c);
 428       i++;
 429     }
 430
 431   return ret;
 432 }
 433
 434 /** Return all columns, but filter out any unused columns , since they might
 435     disrupt the spacing problem. */
 436 vector<Grob*>
 437 System::columns () const
 438 {
 439   extract_grob_set (this, "columns", ro_columns);
 440
 441   int last_breakable = ro_columns.size ();
 442
 443   while (last_breakable--)
 444     {
 445       if (Paper_column::is_breakable (ro_columns [last_breakable]))
 446         break;
 447     }
 448
 449   vector<Grob*> columns;
 450   for (int i = 0; i <= last_breakable; i++)
 451     {
 452       if (Paper_column::is_used (ro_columns[i]))
 453         columns.push_back (ro_columns[i]);
 454     }
 455
 456   return columns;
 457 }
 458
 459 Paper_score*
 460 System::paper_score () const
 461 {
 462   return pscore_;
 463 }
 464
 465 int
 466 System::get_rank () const
 467 {
 468   return rank_;
 469 }
 470
 471 System *
 472 get_root_system (Grob *me)
 473 {
 474   Grob *system_grob = me;
 475
 476   while (system_grob->get_parent (Y_AXIS))
 477     system_grob = system_grob->get_parent (Y_AXIS);
 478
 479   return dynamic_cast<System*> (system_grob);
 480 }
 481
 482
 483
 484 ADD_INTERFACE (System, "system-interface",
 485                "This is the toplevel object: each object in a score "
 486                "ultimately has a System object as its X and Y parent. ",
 487
 488                /* properties */
 489                "all-elements "
 490                "columns "
 491                "spaceable-staves "
 492                )