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       System *system = dynamic_cast<System*> (broken_intos_[i]);
 187
 188       if (verbose_global_b)
 189         progress_indication ("[");
 190
 191       // bool last = (i + 1 == line_count);
 192
 193       system->post_processing ();
 194       scm_vector_set_x (lines, scm_int2num (i), system->get_line ());
 195
 196       if (verbose_global_b)
 197         {
 198           progress_indication (to_string (i));
 199           progress_indication ("]");
 200         }
 201
 202 #ifndef PAGE_LAYOUT
 203       if (i < line_count - 1)
 204         {
 205           SCM lastcol =  ly_car (system->get_property ("columns"));
 206           Grob*  e = unsmob_grob (lastcol);
 207
 208           SCM between = ly_symbol2scm ("between-system-string");
 209           SCM inter = e->internal_get_property (between);
 210           if (gh_string_p (inter))
 211             {
 212               pscore_->outputter_
 213                 ->output_scheme (scm_list_n (between,
 214                                              inter, SCM_UNDEFINED));
 215             }
 216         }
 217 #endif
 218     }
 219    return lines;
 220 }
 221
 222
 223
 224
 225 /*
 226   Find the loose columns in POSNS, and drape them around the columns
 227   specified in BETWEEN-COLS.  */
 228 void
 229 set_loose_columns (System* which, Column_x_positions const *posns)
 230 {
 231   for (int i = 0; i < posns->loose_cols_.size (); i++)
 232     {
 233       int divide_over = 1;
 234       Item *loose = dynamic_cast<Item*> (posns->loose_cols_[i]);
 235       Paper_column* col = dynamic_cast<Paper_column*> (loose);
 236
 237       if (col->system_)
 238         continue;
 239
 240       Item * left = 0;
 241       Item * right = 0;
 242       do
 243         {
 244           SCM between = loose->get_property ("between-cols");
 245           if (!gh_pair_p (between))
 246             break;
 247
 248
 249           Item * l=dynamic_cast<Item*> (unsmob_grob (ly_car (between)));
 250           Item * r=dynamic_cast<Item*> (unsmob_grob (ly_cdr (between)));
 251
 252           if (!(l && r))
 253             break ;
 254
 255           if (!left && l)
 256             {
 257               left = l->get_column ();
 258               if (!left->get_system ())
 259                 left = left->find_prebroken_piece (RIGHT);
 260             }
 261
 262           divide_over ++;
 263           loose = right = r->get_column ();
 264         }
 265       while (1);
 266
 267       if (!right->get_system ())
 268         right = right->find_prebroken_piece (LEFT);
 269
 270       /*
 271         We divide the remaining space of the column over the left and
 272         right side. At the moment, we
 273
 274       */
 275       Grob * common = right->common_refpoint (left, X_AXIS);
 276
 277       Real rx = right->extent (common, X_AXIS)[LEFT];
 278       Real lx = left->extent (common, X_AXIS)[RIGHT];
 279       Real total_dx = rx - lx;
 280       Interval cval =col->extent (col, X_AXIS);
 281
 282       /*
 283
 284         We put it in the middle. This is not an ideal solution -- the
 285         break alignment code inserts a fixed space before the clef
 286         (about 1 SS), while the space following the clef is
 287         flexible. In tight situations, the clef will almost be on top
 288         of the following note.
 289
 290       */
 291       Real dx = rx-lx - cval.length ();
 292       if (total_dx < 2* cval.length ())
 293         {
 294           /*
 295             todo: this is discontinuous. I'm too tired to
 296             invent a sliding mechanism. Duh.
 297
 298             TODO.
 299            */
 300           dx *= 0.25;
 301         }
 302       else
 303         dx *= 0.5;
 304
 305       col->system_ = which;
 306       col->translate_axis (- col->relative_coordinate (common, X_AXIS), X_AXIS);
 307       col->translate_axis (lx + dx - cval[LEFT], X_AXIS);
 308     }
 309 }
 310
 311 // const?
 312 void
 313 System::break_into_pieces (Array<Column_x_positions> const &breaking)
 314 {
 315   for (int i=0; i < breaking.size (); i++)
 316     {
 317       System *system = dynamic_cast <System*> (clone ());
 318       system->rank_ = i;
 319
 320       Link_array<Grob> c (breaking[i].cols_);
 321       pscore_->typeset_line (system);
 322
 323       system->set_bound (LEFT,c[0]);
 324       system->set_bound (RIGHT,c.top ());
 325       for (int j=0; j < c.size (); j++)
 326         {
 327           c[j]->translate_axis (breaking[i].config_[j],X_AXIS);
 328           dynamic_cast<Paper_column*> (c[j])->system_ = system;
 329         }
 330       set_loose_columns (system, &breaking[i]);
 331       broken_intos_.push (system);
 332     }
 333 }
 334
 335 void
 336 System::add_column (Paper_column*p)
 337 {
 338   Grob *me = this;
 339   SCM cs = me->get_property ("columns");
 340   Grob * prev =  gh_pair_p (cs) ? unsmob_grob (ly_car (cs)) : 0;
 341
 342   p->rank_ = prev ? Paper_column::get_rank (prev) + 1 : 0;
 343
 344   me->set_property ("columns",  gh_cons (p->self_scm (), cs));
 345
 346   Axis_group_interface::add_element (me, p);
 347 }
 348
 349 void
 350 System::pre_processing ()
 351 {
 352   for (SCM s = get_property ("all-elements"); gh_pair_p (s); s = ly_cdr (s))
 353     unsmob_grob (ly_car (s))->discretionary_processing ();
 354
 355   if (verbose_global_b)
 356     progress_indication (_f ("Grob count %d ",  element_count ()));
 357
 358
 359   for (SCM s = get_property ("all-elements"); gh_pair_p (s); s = ly_cdr (s))
 360     unsmob_grob (ly_car (s))->handle_prebroken_dependencies ();
 361
 362   fixup_refpoints (get_property ("all-elements"));
 363
 364   for (SCM s = get_property ("all-elements"); gh_pair_p (s); s = ly_cdr (s))
 365     {
 366       Grob* sc = unsmob_grob (ly_car (s));
 367       sc->calculate_dependencies (PRECALCED, PRECALCING, ly_symbol2scm ("before-line-breaking-callback"));
 368     }
 369
 370   progress_indication ("\n" + _ ("Calculating line breaks...") + " ");
 371   for (SCM s = get_property ("all-elements"); gh_pair_p (s); s = ly_cdr (s))
 372     {
 373       Grob * e = unsmob_grob (ly_car (s));
 374       SCM proc = e->get_property ("spacing-procedure");
 375       if (gh_procedure_p (proc))
 376         gh_call1 (proc, e->self_scm ());
 377     }
 378 }
 379
 380 void
 381 System::post_processing ()
 382 {
 383   for (SCM s = get_property ("all-elements"); gh_pair_p (s); s = ly_cdr (s))
 384     {
 385       Grob *g = unsmob_grob (ly_car (s));
 386       g->calculate_dependencies (POSTCALCED, POSTCALCING,
 387           ly_symbol2scm ("after-line-breaking-callback"));
 388     }
 389
 390   Interval iv (extent (this, Y_AXIS));
 391   if (iv.is_empty ())
 392     programming_error ("System with zero extent.");
 393   else
 394     translate_axis (-iv[MAX], Y_AXIS);
 395
 396   /* Generate all stencils to trigger font loads.
 397      This might seem inefficient, but Stencils are cached per grob
 398      anyway. */
 399   SCM all = get_property ("all-elements")  ;
 400   all = uniquify_list (all);
 401
 402   this->get_stencil ();
 403   for (SCM s = all; gh_pair_p (s); s = ly_cdr (s))
 404     {
 405       Grob *g = unsmob_grob (ly_car (s));
 406       g->get_stencil ();
 407     }
 408 }
 409
 410 /* Return line:
 411    ((HEIGHT . WIDTH) LINE)
 412    LINE: list of ((OFFSET-X . OFFSET-Y) . STENCIL)
 413    Maybe make clas/smob?  */
 414 SCM
 415 System::get_line ()
 416 {
 417   static int const LAYER_COUNT = 3;
 418   SCM line = SCM_EOL;
 419   if (Stencil *me = get_stencil ())
 420     line = scm_cons (scm_cons (ly_offset2scm (Offset (0, 0)),
 421                                me->smobbed_copy ()), line);
 422
 423   /* Output stencils in three layers: 0, 1, 2.  The default layer is
 424      1.  */
 425   for (int i = 0; i < LAYER_COUNT; i++)
 426     for (SCM s = get_property ("all-elements"); gh_pair_p (s); s = ly_cdr (s))
 427       {
 428         Grob *g = unsmob_grob (ly_car (s));
 429         Stencil *stil = g->get_stencil ();
 430
 431         /* Skip empty stencils and grobs that are not in this layer.  */
 432         if (!stil
 433             || robust_scm2int (g->get_property ("layer"), 1) != i)
 434           continue;
 435
 436         Offset o (g->relative_coordinate (this, X_AXIS),
 437                   g->relative_coordinate (this, Y_AXIS));
 438
 439         Offset extra = robust_scm2offset (g->get_property ("extra-offset"),
 440                                           Offset (0, 0))
 441           * Staff_symbol_referencer::staff_space (g);
 442         line = scm_cons (scm_cons (ly_offset2scm (o + extra),
 443                                    stil->smobbed_copy ()), line);
 444       }
 445
 446   Interval x (extent (this, X_AXIS));
 447   Interval y (extent (this, Y_AXIS));
 448   return scm_cons (ly_offset2scm (Offset (x.length (), y.length ())), line);
 449 }
 450
 451 Link_array<Item>
 452 System::broken_col_range (Item const*l, Item const*r) const
 453 {
 454   Link_array<Item> ret;
 455
 456   l = l->get_column ();
 457   r = r->get_column ();
 458   SCM s = get_property ("columns");
 459
 460   while (gh_pair_p (s) && ly_car (s) != r->self_scm ())
 461     s = ly_cdr (s);
 462
 463   if (gh_pair_p (s))
 464     s = ly_cdr (s);
 465
 466   while (gh_pair_p (s) && ly_car (s) != l->self_scm ())
 467     {
 468       Paper_column*c = dynamic_cast<Paper_column*> (unsmob_grob (ly_car (s)));
 469       if (Item::is_breakable (c) && !c->system_)
 470         ret.push (c);
 471
 472       s = ly_cdr (s);
 473     }
 474
 475   ret.reverse ();
 476   return ret;
 477 }
 478
 479 /**
 480    Return all columns, but filter out any unused columns , since they might
 481    disrupt the spacing problem.
 482  */
 483 Link_array<Grob>
 484 System::columns ()const
 485 {
 486   Link_array<Grob> acs
 487     = Pointer_group_interface__extract_grobs (this, (Grob*) 0, "columns");
 488   bool bfound = false;
 489   for (int i= acs.size (); i -- ;)
 490     {
 491       bool brb = Item::is_breakable (acs[i]);
 492       bfound = bfound || brb;
 493
 494       /*
 495         the last column should be breakable. Weed out any columns that
 496         seem empty. We need to retain breakable columns, in case
 497         someone forced a breakpoint.
 498       */
 499       if (!bfound || !Paper_column::is_used (acs[i]))
 500         acs.del (i);
 501     }
 502   return acs;
 503 }
 504
 505 ADD_INTERFACE (System,"system-interface",
 506                "This is the toplevel object: each object in a score "
 507                "ultimately has a System object as its X and Y parent. ",
 508                "between-system-string all-elements columns")