lily/system.cc

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