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 <math.h>
  12
  13 #include "align-interface.hh"
  14 #include "axis-group-interface.hh"
  15 #include "warn.hh"
  16 #include "main.hh"
  17 #include "paper-column.hh"
  18 #include "output-def.hh"
  19 #include "paper-score.hh"
  20 #include "warn.hh"
  21 #include "all-font-metrics.hh"
  22 #include "spacing-interface.hh"
  23 #include "staff-symbol-referencer.hh"
  24 #include "paper-book.hh"
  25 #include "paper-system.hh"
  26 #include "tweak-registration.hh"
  27
  28
  29 System::System (System const &src, int count)
  30   : Spanner (src, count)
  31 {
  32   rank_ = 0;
  33 }
  34
  35 System::System (SCM s, Object_key const*key)
  36   : Spanner (s, key)
  37 {
  38   rank_ = 0;
  39 }
  40
  41
  42 Grob *
  43 System::clone (int count) const
  44 {
  45   return new System (*this, count);
  46 }
  47
  48
  49 int
  50 System::element_count () const
  51 {
  52   return scm_ilength (get_property ("all-elements"));
  53 }
  54
  55 int
  56 System::spanner_count () const
  57 {
  58   int k = 0;
  59   for (SCM s = get_property ("all-elements"); scm_is_pair (s); s = scm_cdr (s))
  60     if (dynamic_cast<Spanner*> (unsmob_grob (scm_car (s))))
  61       k++;
  62   return k;
  63 }
  64
  65 void
  66 System::typeset_grob (Grob * elem)
  67 {
  68   if (elem->pscore_)
  69     programming_error ("Adding element twice.");
  70   else
  71     {
  72       elem->pscore_ = pscore_;
  73       Pointer_group_interface::add_grob (this, ly_symbol2scm ("all-elements"), elem);
  74       scm_gc_unprotect_object (elem->self_scm ());
  75     }
  76 }
  77
  78 // todo: use map.
  79 static void
  80 fixup_refpoints (SCM s)
  81 {
  82   for (; scm_is_pair (s); s = scm_cdr (s))
  83     {
  84       Grob::fixup_refpoint (scm_car (s));
  85     }
  86 }
  87
  88 SCM
  89 System::get_lines ()
  90 {
  91   for (SCM s = get_property ("all-elements"); scm_is_pair (s); s = scm_cdr (s))
  92     {
  93       Grob *g = unsmob_grob (scm_car (s));
  94       if (g->internal_has_interface (ly_symbol2scm ("only-prebreak-interface")))
  95         {
  96           /*
  97             Kill no longer needed grobs.
  98            */
  99           Item * it = dynamic_cast<Item*> (g);
 100           if (it && Item::is_breakable (it))
 101             {
 102               it->find_prebroken_piece (LEFT)->suicide ();
 103               it->find_prebroken_piece (RIGHT)->suicide ();
 104             }
 105           g->suicide ();
 106         }
 107       else if (g->is_live ())
 108         g->do_break_processing ();
 109     }
 110
 111   /*
 112     fixups must be done in broken line_of_scores, because new elements
 113     are put over there.  */
 114   int count = 0;
 115   for (int i = 0; i < broken_intos_.size (); i++)
 116     {
 117       Grob *se = broken_intos_[i];
 118       SCM all = se->get_property ("all-elements");
 119       for (SCM s = all; scm_is_pair (s); s = scm_cdr (s))
 120         fixup_refpoint (scm_car (s));
 121       count += scm_ilength (all);
 122     }
 123
 124   /*
 125     needed for doing items.
 126    */
 127   fixup_refpoints (get_property ("all-elements"));
 128
 129   for (SCM s = get_property ("all-elements"); scm_is_pair (s); s = scm_cdr (s))
 130     unsmob_grob (scm_car (s))->handle_broken_dependencies ();
 131   handle_broken_dependencies ();
 132
 133 #if 0  /* don't do this: strange side effects.  */
 134
 135   /* Because the this->get_property (all-elements) contains items in 3
 136      versions, handle_broken_dependencies () will leave duplicated
 137      items in all-elements.  Strictly speaking this is harmless, but
 138      it leads to duplicated symbols in the output.  ly_list_qsort_uniq_x ()
 139      makes sure that no duplicates are in the list.  */
 140   for (int i = 0; i < line_count; i++)
 141     {
 142       SCM all = broken_intos_[i]->get_property ("all-elements");
 143       all = ly_list_qsort_uniq_x(all);
 144     }
 145 #endif
 146
 147   if (be_verbose_global)
 148     progress_indication (_f ("Element count %d.",  count + element_count ()));
 149
 150   int line_count = broken_intos_.size ();
 151   SCM lines = scm_c_make_vector (line_count, SCM_EOL);
 152
 153   for (int i = 0; i < line_count; i++)
 154     {
 155       if (be_verbose_global)
 156         progress_indication ("[");
 157
 158       System *system = dynamic_cast<System*> (broken_intos_[i]);
 159       system->post_processing ();
 160       scm_vector_set_x (lines, scm_int2num (i), system->get_line ());
 161
 162       if (be_verbose_global)
 163         progress_indication (to_string (i) + "]");
 164     }
 165   return lines;
 166 }
 167
 168 /* Find the loose columns in POSNS, and drape them around the columns
 169    specified in BETWEEN-COLS.  */
 170 static void
 171 set_loose_columns (System* which, Column_x_positions const *posns)
 172 {
 173   int loose_col_count = posns->loose_cols_.size ();
 174   for (int i = 0; i < loose_col_count; i++)
 175     {
 176       int divide_over = 1;
 177       Item *loose = dynamic_cast<Item*> (posns->loose_cols_[i]);
 178       Paper_column* col = dynamic_cast<Paper_column*> (loose);
 179
 180       if (col->system_)
 181         continue;
 182
 183       Item *left = 0;
 184       Item *right = 0;
 185       while (1)
 186         {
 187           SCM between = loose->get_property ("between-cols");
 188           if (!scm_is_pair (between))
 189             break;
 190
 191           Item *le = dynamic_cast<Item*> (unsmob_grob (scm_car (between)));
 192           Item *re = dynamic_cast<Item*> (unsmob_grob (scm_cdr (between)));
 193
 194           if (!(le && re))
 195             break;
 196
 197           if (!left && le)
 198             {
 199               left = le->get_column ();
 200               if (!left->get_system ())
 201                 left = left->find_prebroken_piece (RIGHT);
 202             }
 203
 204           divide_over++;
 205           loose = right = re->get_column ();
 206         }
 207
 208       if (!right->get_system ())
 209         right = right->find_prebroken_piece (LEFT);
 210
 211       /* Divide the remaining space of the column over the left and
 212         right side.  At the moment,  FIXME  */
 213       Grob *common = right->common_refpoint (left, X_AXIS);
 214
 215       Real right_point = right->extent (common, X_AXIS)[LEFT];
 216       Real left_point = left->extent (common, X_AXIS)[RIGHT];
 217       Interval my_extent = col->extent (col, X_AXIS);
 218
 219       Real space_left = (right_point - left_point)
 220         - (my_extent.is_empty() ? 0.0 : my_extent.length ());
 221
 222       Real padding = (space_left / 2) <? 1.0;
 223       /*
 224         Put it just left of the right column, with a bit of extra space
 225        */
 226       Real my_offset = right_point - my_extent[RIGHT] - padding;
 227
 228       col->system_ = which;
 229       col->translate_axis (my_offset - col->relative_coordinate (common, X_AXIS), X_AXIS);
 230     }
 231 }
 232
 233 // const?
 234 void
 235 System::break_into_pieces (Array<Column_x_positions> const &breaking)
 236 {
 237   for (int i = 0; i < breaking.size (); i++)
 238     {
 239       System *system = dynamic_cast <System*> (clone (i));
 240       system->rank_ = i;
 241
 242       Link_array<Grob> c (breaking[i].cols_);
 243       pscore_->typeset_line (system);
 244
 245       system->set_bound (LEFT, c[0]);
 246       system->set_bound (RIGHT, c.top ());
 247       for (int j = 0; j < c.size (); j++)
 248         {
 249           c[j]->translate_axis (breaking[i].config_[j], X_AXIS);
 250           dynamic_cast<Paper_column*> (c[j])->system_ = system;
 251         }
 252       set_loose_columns (system, &breaking[i]);
 253       broken_intos_.push (system);
 254     }
 255 }
 256
 257 void
 258 System::add_column (Paper_column*p)
 259 {
 260   Grob *me = this;
 261   SCM cs = me->get_property ("columns");
 262   Grob *prev =  scm_is_pair (cs) ? unsmob_grob (scm_car (cs)) : 0;
 263
 264   p->rank_ = prev ? Paper_column::get_rank (prev) + 1 : 0;
 265
 266   me->set_property ("columns", scm_cons (p->self_scm (), cs));
 267
 268   Axis_group_interface::add_element (me, p);
 269 }
 270
 271 void
 272 apply_tweaks (Grob *g, bool broken)
 273 {
 274   if (bool (g->original_) == broken)
 275     {
 276       SCM tweaks = global_registry_->get_tweaks (g);
 277       for (SCM s = tweaks; scm_is_pair (s); s = scm_cdr (s))
 278         {
 279           SCM proc = scm_caar (s);
 280           SCM rest = scm_cdar (s);
 281           scm_apply_1 (proc, g->self_scm(), rest);
 282         }
 283     }
 284 }
 285
 286 void
 287 System::pre_processing ()
 288 {
 289   for (SCM s = get_property ("all-elements"); scm_is_pair (s); s = scm_cdr (s))
 290     unsmob_grob (scm_car (s))->discretionary_processing ();
 291
 292   if (be_verbose_global)
 293     progress_indication (_f ("Grob count %d", element_count ()));
 294
 295   for (SCM s = get_property ("all-elements"); scm_is_pair (s); s = scm_cdr (s))
 296     unsmob_grob (scm_car (s))->handle_prebroken_dependencies ();
 297
 298   fixup_refpoints (get_property ("all-elements"));
 299
 300
 301   for (SCM s = get_property ("all-elements"); scm_is_pair (s); s = scm_cdr (s))
 302     apply_tweaks (unsmob_grob (scm_car (s)), false);
 303
 304   for (SCM s = get_property ("all-elements"); scm_is_pair (s); s = scm_cdr (s))
 305     {
 306       Grob *sc = unsmob_grob (scm_car (s));
 307       sc->calculate_dependencies (PRECALCED, PRECALCING, ly_symbol2scm ("before-line-breaking-callback"));
 308     }
 309
 310   progress_indication ("\n");
 311   progress_indication (_ ("Calculating line breaks..."));
 312   progress_indication (" ");
 313   for (SCM s = get_property ("all-elements"); scm_is_pair (s); s = scm_cdr (s))
 314     {
 315       Grob *e = unsmob_grob (scm_car (s));
 316       SCM proc = e->get_property ("spacing-procedure");
 317       if (ly_c_procedure_p (proc))
 318         scm_call_1 (proc, e->self_scm ());
 319     }
 320 }
 321
 322 void
 323 System::post_processing ()
 324 {
 325   for (SCM s = get_property ("all-elements"); scm_is_pair (s); s = scm_cdr (s))
 326     {
 327       Grob *g = unsmob_grob (scm_car (s));
 328
 329       apply_tweaks (g, true);
 330
 331       g->calculate_dependencies (POSTCALCED, POSTCALCING,
 332           ly_symbol2scm ("after-line-breaking-callback"));
 333     }
 334
 335   Interval iv (extent (this, Y_AXIS));
 336   if (iv.is_empty ())
 337     programming_error ("System with zero extent.");
 338   else
 339     translate_axis (-iv[MAX], Y_AXIS);
 340
 341   /* Generate all stencils to trigger font loads.
 342      This might seem inefficient, but Stencils are cached per grob
 343      anyway. */
 344   SCM all = get_property ("all-elements");
 345   all = ly_list_qsort_uniq_x (all);
 346
 347   this->get_stencil ();
 348   for (SCM s = all; scm_is_pair (s); s = scm_cdr (s))
 349     {
 350       Grob *g = unsmob_grob (scm_car (s));
 351       g->get_stencil ();
 352     }
 353 }
 354
 355 SCM
 356 System::get_line ()
 357 {
 358   static int const LAYER_COUNT = 3;
 359
 360   SCM exprs = SCM_EOL;
 361   SCM *tail = &exprs;
 362
 363   /* Output stencils in three layers: 0, 1, 2.  Default layer: 1. */
 364   SCM all = get_property ("all-elements");
 365
 366   for (int i = 0; i < LAYER_COUNT; i++)
 367     for (SCM s = all; scm_is_pair (s); s = scm_cdr (s))
 368       {
 369         Grob *g = unsmob_grob (scm_car (s));
 370         Stencil *stil = g->get_stencil ();
 371
 372         /* Skip empty stencils and grobs that are not in this layer.  */
 373         if (!stil
 374             || robust_scm2int (g->get_property ("layer"), 1) != i)
 375           continue;
 376
 377         Offset o (g->relative_coordinate (this, X_AXIS),
 378                   g->relative_coordinate (this, Y_AXIS));
 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         Stencil st = *stil;
 388         st.translate (o + extra);
 389
 390         *tail = scm_cons (st.expr (), SCM_EOL);
 391         tail = SCM_CDRLOC(*tail);
 392       }
 393
 394   if (Stencil *me = get_stencil ())
 395     exprs = scm_cons (me->expr (), exprs);
 396
 397   Interval x (extent (this, X_AXIS));
 398   Interval y (extent (this, Y_AXIS));
 399   Stencil sys_stencil (Box (x, y),
 400                        scm_cons (ly_symbol2scm ("combine-stencil"),
 401                                  exprs));
 402
 403   Interval staff_refpoints;
 404   staff_refpoints.set_empty();
 405   for (SCM s = get_property ("spaceable-staves");
 406        scm_is_pair (s); s = scm_cdr (s))
 407       {
 408         Grob *g = unsmob_grob (scm_car (s));
 409         staff_refpoints.add_point (g->relative_coordinate (this, Y_AXIS));
 410       }
 411
 412
 413   Paper_system *pl = new Paper_system (sys_stencil, false);
 414   pl->staff_refpoints_ = staff_refpoints;
 415   Item * break_point = this->get_bound(LEFT);
 416   pl->break_before_penalty_ =
 417     robust_scm2double (break_point->get_property ("page-penalty"), 0.0);
 418
 419   return scm_gc_unprotect_object (pl->self_scm ());
 420 }
 421
 422 Link_array<Item>
 423 System::broken_col_range (Item const *left, Item const *right) const
 424 {
 425   Link_array<Item> ret;
 426
 427   left = left->get_column ();
 428   right = right->get_column ();
 429   SCM s = get_property ("columns");
 430
 431   while (scm_is_pair (s) && scm_car (s) != right->self_scm ())
 432     s = scm_cdr (s);
 433
 434   if (scm_is_pair (s))
 435     s = scm_cdr (s);
 436
 437   while (scm_is_pair (s) && scm_car (s) != left->self_scm ())
 438     {
 439       Paper_column*c = dynamic_cast<Paper_column*> (unsmob_grob (scm_car (s)));
 440       if (Item::is_breakable (c) && !c->system_)
 441         ret.push (c);
 442
 443       s = scm_cdr (s);
 444     }
 445
 446   ret.reverse ();
 447   return ret;
 448 }
 449
 450 /** Return all columns, but filter out any unused columns , since they might
 451     disrupt the spacing problem. */
 452 Link_array<Grob>
 453 System::columns () const
 454 {
 455   Link_array<Grob> acs
 456     = extract_grob_array (this, ly_symbol2scm ("columns"));
 457   bool found = false;
 458   for (int i = acs.size (); i--;)
 459     {
 460       bool brb = Item::is_breakable (acs[i]);
 461       found = found || brb;
 462
 463       /*
 464         the last column should be breakable. Weed out any columns that
 465         seem empty. We need to retain breakable columns, in case
 466         someone forced a breakpoint.
 467       */
 468       if (!found || !Paper_column::is_used (acs[i]))
 469         acs.del (i);
 470     }
 471   return acs;
 472 }
 473
 474 ADD_INTERFACE (System, "system-interface",
 475                "This is the toplevel object: each object in a score "
 476                "ultimately has a System object as its X and Y parent. ",
 477                "all-elements spaceable-staves columns")