lily/system.cc

   1 /*
   2   system.cc -- implement System
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1996--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9 #include "system.hh"
  10
  11 #include <cmath>
  12 using namespace std;
  13
  14 #include "align-interface.hh"
  15 #include "axis-group-interface.hh"
  16 #include "warn.hh"
  17 #include "main.hh"
  18 #include "paper-column.hh"
  19 #include "output-def.hh"
  20 #include "paper-score.hh"
  21 #include "warn.hh"
  22 #include "all-font-metrics.hh"
  23 #include "spacing-interface.hh"
  24 #include "staff-symbol-referencer.hh"
  25 #include "paper-book.hh"
  26 #include "paper-system.hh"
  27 #include "tweak-registration.hh"
  28 #include "grob-array.hh"
  29 #include "pointer-group-interface.hh"
  30
  31 System::System (System const &src, int count)
  32   : Spanner (src, count)
  33 {
  34   all_elements_ = 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   set_object ("all-elements", scm_arr);
  53 }
  54
  55 Grob *
  56 System::clone (int count) const
  57 {
  58   return new System (*this, count);
  59 }
  60
  61 int
  62 System::element_count () const
  63 {
  64   return all_elements_->size ();
  65 }
  66
  67 int
  68 System::spanner_count () const
  69 {
  70   int k = 0;
  71   for (int i = all_elements_->size (); i--;)
  72     if (dynamic_cast<Spanner *> (all_elements_->grob (i)))
  73       k++;
  74   return k;
  75 }
  76
  77 void
  78 System::typeset_grob (Grob *elem)
  79 {
  80   if (elem->pscore_)
  81     programming_error ("adding element twice");
  82   else
  83     {
  84       elem->pscore_ = pscore_;
  85       all_elements_->add (elem);
  86       elem->unprotect ();
  87     }
  88 }
  89
  90 void
  91 System::derived_mark () const
  92 {
  93   if (!all_elements_->is_empty ())
  94     {
  95       Grob **ptr = &all_elements_->array_reference ().elem_ref (0);
  96       Grob **end = ptr + all_elements_->size ();
  97       while (ptr < end)
  98         {
  99           scm_gc_mark ((*ptr)->self_scm ());
 100           ptr++;
 101         }
 102     }
 103
 104   if (pscore_)
 105     scm_gc_mark (pscore_->self_scm ());
 106
 107   Spanner::derived_mark ();
 108 }
 109
 110 static void
 111 fixup_refpoints (Link_array<Grob> const &grobs)
 112 {
 113   for (int i = grobs.size (); i--;)
 114     grobs[i]->fixup_refpoint ();
 115 }
 116
 117 SCM
 118 System::get_paper_systems ()
 119 {
 120   for (int i = 0; i < all_elements_->size (); i++)
 121     {
 122       Grob *g = all_elements_->grob (i);
 123       if (g->internal_has_interface (ly_symbol2scm ("only-prebreak-interface")))
 124         {
 125           /*
 126             Kill no longer needed grobs.
 127           */
 128           Item *it = dynamic_cast<Item *> (g);
 129           if (it && Item::is_breakable (it))
 130             {
 131               it->find_prebroken_piece (LEFT)->suicide ();
 132               it->find_prebroken_piece (RIGHT)->suicide ();
 133             }
 134           g->suicide ();
 135         }
 136       else if (g->is_live ())
 137         g->do_break_processing ();
 138     }
 139
 140   /*
 141     fixups must be done in broken line_of_scores, because new elements
 142     are put over there.  */
 143   int count = 0;
 144   for (int i = 0; i < broken_intos_.size (); i++)
 145     {
 146       Grob *se = broken_intos_[i];
 147
 148       extract_grob_set (se, "all-elements", all_elts);
 149       for (int j = 0; j < all_elts.size (); j++)
 150         {
 151           Grob *g = all_elts[j];
 152           g->fixup_refpoint ();
 153         }
 154
 155       count += all_elts.size ();
 156     }
 157
 158   /*
 159     needed for doing items.
 160   */
 161   fixup_refpoints (all_elements_->array ());
 162
 163   for (int i = 0; i < all_elements_->size (); i++)
 164     all_elements_->grob (i)->handle_broken_dependencies ();
 165
 166   handle_broken_dependencies ();
 167
 168 #if 0  /* FIXME: strange side effects.  */
 169
 170   /* Because the this->get_property (all-elements) contains items in 3
 171      versions, handle_broken_dependencies () will leave duplicated
 172      items in all-elements.  Strictly speaking this is harmless, but
 173      it leads to duplicated symbols in the output.  ly_list_qsort_uniq_x ()
 174      makes sure that no duplicates are in the list.  */
 175   for (int i = 0; i < line_count; i++)
 176     {
 177       SCM all = broken_intos_[i]->get_object ("all-elements");
 178       all = ly_list_qsort_uniq_x (all);
 179     }
 180 #endif
 181
 182   if (be_verbose_global)
 183     message (_f ("Element count %d.", count + element_count ()));
 184
 185   int line_count = broken_intos_.size ();
 186   SCM lines = scm_c_make_vector (line_count, SCM_EOL);
 187
 188   for (int i = 0; i < line_count; i++)
 189     {
 190       if (be_verbose_global)
 191         progress_indication ("[");
 192
 193       System *system = dynamic_cast<System *> (broken_intos_[i]);
 194       system->post_processing ();
 195       scm_vector_set_x (lines, scm_from_int (i), system->get_paper_system ());
 196
 197       if (be_verbose_global)
 198         progress_indication (to_string (i) + "]");
 199     }
 200   return lines;
 201 }
 202
 203 void
 204 System::break_into_pieces (Array<Column_x_positions> const &breaking)
 205 {
 206   for (int i = 0; i < breaking.size (); i++)
 207     {
 208       System *system = dynamic_cast<System *> (clone (i));
 209       system->rank_ = i;
 210
 211       Link_array<Grob> c (breaking[i].cols_);
 212       pscore_->typeset_system (system);
 213
 214       system->set_bound (LEFT, c[0]);
 215       system->set_bound (RIGHT, c.top ());
 216       for (int j = 0; j < c.size (); j++)
 217         {
 218           c[j]->translate_axis (breaking[i].config_[j], X_AXIS);
 219           dynamic_cast<Paper_column *> (c[j])->system_ = system;
 220         }
 221       set_loose_columns (system, &breaking[i]);
 222       broken_intos_.push (system);
 223     }
 224 }
 225
 226 void
 227 System::add_column (Paper_column *p)
 228 {
 229   Grob *me = this;
 230   Grob_array *ga = unsmob_grob_array (me->get_object ("columns"));
 231   if (!ga)
 232     {
 233       SCM scm_ga = Grob_array::make_array ();
 234       me->set_object ("columns", scm_ga);
 235       ga = unsmob_grob_array (scm_ga);
 236     }
 237
 238   p->rank_
 239     = ga->size ()
 240     ? Paper_column::get_rank (ga->array ().top ()) + 1
 241     : 0;
 242
 243   ga->add (p);
 244   Axis_group_interface::add_element (this, p);
 245 }
 246
 247 void
 248 apply_tweaks (Grob *g, bool broken)
 249 {
 250   if (bool (g->original_) == broken)
 251     {
 252       SCM tweaks = global_registry_->get_tweaks (g);
 253       for (SCM s = tweaks; scm_is_pair (s); s = scm_cdr (s))
 254         {
 255           SCM proc = scm_caar (s);
 256           SCM rest = scm_cdar (s);
 257           scm_apply_1 (proc, g->self_scm (), rest);
 258         }
 259     }
 260 }
 261
 262 void
 263 System::pre_processing ()
 264 {
 265   for (int i = 0; i < all_elements_->size (); i++)
 266     all_elements_->grob (i)->discretionary_processing ();
 267
 268   if (be_verbose_global)
 269     message (_f ("Grob count %d", element_count ()));
 270
 271   /*
 272     order is significant: broken grobs are added to the end of the
 273     array, and should be processed before the original is potentially
 274     killed.
 275   */
 276   for (int i = all_elements_->size (); i--;)
 277     all_elements_->grob (i)->handle_prebroken_dependencies ();
 278
 279   fixup_refpoints (all_elements_->array ());
 280
 281   for (int i = 0; i < all_elements_->size (); i++)
 282     apply_tweaks (all_elements_->grob (i), false);
 283
 284   for (int i = 0; i < all_elements_->size (); i++)
 285     all_elements_->grob (i)->calculate_dependencies (PRECALCED, PRECALCING,
 286                                                      ly_symbol2scm ("before-line-breaking-callback"));
 287
 288   message (_ ("Calculating line breaks..."));
 289   progress_indication (" ");
 290
 291   for (int i = 0; i < all_elements_->size (); i++)
 292     {
 293       Grob *e = all_elements_->grob (i);
 294       SCM proc = e->get_property ("spacing-procedure");
 295       if (ly_is_procedure (proc))
 296         scm_call_1 (proc, e->self_scm ());
 297     }
 298 }
 299
 300 void
 301 System::post_processing ()
 302 {
 303   for (int i = 0; i < all_elements_->size (); i++)
 304     {
 305       Grob *g = all_elements_->grob (i);
 306
 307       apply_tweaks (g, true);
 308       g->calculate_dependencies (POSTCALCED, POSTCALCING,
 309                                  ly_symbol2scm ("after-line-breaking-callback"));
 310     }
 311
 312   Interval iv (extent (this, Y_AXIS));
 313   if (iv.is_empty ())
 314     programming_error ("system with empty extent");
 315   else
 316     translate_axis (-iv[MAX], Y_AXIS);
 317
 318   /* Generate all stencils to trigger font loads.
 319      This might seem inefficient, but Stencils are cached per grob
 320      anyway. */
 321
 322   Link_array<Grob> all_elts_sorted (all_elements_->array ());
 323   all_elts_sorted.default_sort ();
 324   all_elts_sorted.uniq ();
 325   this->get_stencil ();
 326   for (int i = all_elts_sorted.size (); i--;)
 327     {
 328       Grob *g = all_elts_sorted[i];
 329       g->get_stencil ();
 330     }
 331 }
 332
 333 SCM
 334 System::get_paper_system ()
 335 {
 336   static int const LAYER_COUNT = 3;
 337
 338   SCM exprs = SCM_EOL;
 339   SCM *tail = &exprs;
 340
 341   /* Output stencils in three layers: 0, 1, 2.  Default layer: 1. */
 342   for (int i = 0; i < LAYER_COUNT; i++)
 343     for (int j = all_elements_->size (); j--;)
 344       {
 345         Grob *g = all_elements_->grob (j);
 346         Stencil *stil = g->get_stencil ();
 347
 348         /* Skip empty stencils and grobs that are not in this layer.  */
 349         if (!stil
 350             || robust_scm2int (g->get_property ("layer"), 1) != i)
 351           continue;
 352
 353         Offset o (g->relative_coordinate (this, X_AXIS),
 354                   g->relative_coordinate (this, Y_AXIS));
 355
 356         Offset extra = robust_scm2offset (g->get_property ("extra-offset"),
 357                                           Offset (0, 0))
 358           * Staff_symbol_referencer::staff_space (g);
 359
 360         /* Must copy the stencil, for we cannot change the stencil
 361            cached in G.  */
 362
 363         Stencil st = *stil;
 364         st.translate (o + extra);
 365
 366         *tail = scm_cons (st.expr (), SCM_EOL);
 367         tail = SCM_CDRLOC (*tail);
 368       }
 369
 370   if (Stencil *me = get_stencil ())
 371     exprs = scm_cons (me->expr (), exprs);
 372
 373   Interval x (extent (this, X_AXIS));
 374   Interval y (extent (this, Y_AXIS));
 375   Stencil sys_stencil (Box (x, y),
 376                        scm_cons (ly_symbol2scm ("combine-stencil"),
 377                                  exprs));
 378
 379   Interval staff_refpoints;
 380   staff_refpoints.set_empty ();
 381   extract_grob_set (this, "spaceable-staves", staves);
 382   for (int i = staves.size (); i--;)
 383     {
 384       Grob *g = staves[i];
 385       staff_refpoints.add_point (g->relative_coordinate (this, Y_AXIS));
 386     }
 387
 388   Paper_system *pl = new Paper_system (sys_stencil, false);
 389   pl->staff_refpoints_ = staff_refpoints;
 390   Item *break_point = this->get_bound (LEFT);
 391   pl->break_before_penalty_
 392     = robust_scm2double (break_point->get_property ("page-penalty"), 0.0);
 393
 394   return pl->unprotect ();
 395 }
 396
 397 Link_array<Item>
 398 System::broken_col_range (Item const *left, Item const *right) const
 399 {
 400   Link_array<Item> ret;
 401
 402   left = left->get_column ();
 403   right = right->get_column ();
 404
 405   extract_grob_set (this, "columns", cols);
 406   int i = 0;
 407   while (i < cols.size ()
 408          && cols[i] != left)
 409     i++;
 410
 411   if (i < cols.size ())
 412     i++;
 413
 414   while (i < cols.size ()
 415          && cols[i] != right)
 416     {
 417       Paper_column *c = dynamic_cast<Paper_column *> (cols[i]);
 418       if (Item::is_breakable (c) && !c->system_)
 419         ret.push (c);
 420       i++;
 421     }
 422
 423   return ret;
 424 }
 425
 426 /** Return all columns, but filter out any unused columns , since they might
 427     disrupt the spacing problem. */
 428 Link_array<Grob>
 429 System::columns () const
 430 {
 431   extract_grob_set (this, "columns", ro_columns);
 432
 433   int last_breakable = ro_columns.size ();
 434
 435   while (last_breakable--)
 436     {
 437       if (Item::is_breakable (ro_columns [last_breakable]))
 438         break;
 439     }
 440
 441   Link_array<Grob> columns;
 442   for (int i = 0; i <= last_breakable; i++)
 443     {
 444       if (Paper_column::is_used (ro_columns[i]))
 445         columns.push (ro_columns[i]);
 446     }
 447
 448   return columns;
 449 }
 450
 451 int
 452 System::get_rank () const
 453 {
 454   return rank_;
 455 }
 456
 457 ADD_INTERFACE (System, "system-interface",
 458                "This is the toplevel object: each object in a score "
 459                "ultimately has a System object as its X and Y parent. ",
 460                "all-elements spaceable-staves columns")