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