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 void
 169 System::break_into_pieces (Array<Column_x_positions> const &breaking)
 170 {
 171   for (int i = 0; i < breaking.size (); i++)
 172     {
 173       System *system = dynamic_cast <System*> (clone (i));
 174       system->rank_ = i;
 175
 176       Link_array<Grob> c (breaking[i].cols_);
 177       pscore_->typeset_line (system);
 178
 179       system->set_bound (LEFT, c[0]);
 180       system->set_bound (RIGHT, c.top ());
 181       for (int j = 0; j < c.size (); j++)
 182         {
 183           c[j]->translate_axis (breaking[i].config_[j], X_AXIS);
 184           dynamic_cast<Paper_column*> (c[j])->system_ = system;
 185         }
 186       set_loose_columns (system, &breaking[i]);
 187       broken_intos_.push (system);
 188     }
 189 }
 190
 191 void
 192 System::add_column (Paper_column*p)
 193 {
 194   Grob *me = this;
 195   SCM cs = me->get_property ("columns");
 196   Grob *prev =  scm_is_pair (cs) ? unsmob_grob (scm_car (cs)) : 0;
 197
 198   p->rank_ = prev ? Paper_column::get_rank (prev) + 1 : 0;
 199
 200   me->set_property ("columns", scm_cons (p->self_scm (), cs));
 201
 202   Axis_group_interface::add_element (me, p);
 203 }
 204
 205 void
 206 apply_tweaks (Grob *g, bool broken)
 207 {
 208   if (bool (g->original_) == broken)
 209     {
 210       SCM tweaks = global_registry_->get_tweaks (g);
 211       for (SCM s = tweaks; scm_is_pair (s); s = scm_cdr (s))
 212         {
 213           SCM proc = scm_caar (s);
 214           SCM rest = scm_cdar (s);
 215           scm_apply_1 (proc, g->self_scm(), rest);
 216         }
 217     }
 218 }
 219
 220 void
 221 System::pre_processing ()
 222 {
 223   for (SCM s = get_property ("all-elements"); scm_is_pair (s); s = scm_cdr (s))
 224     unsmob_grob (scm_car (s))->discretionary_processing ();
 225
 226   if (be_verbose_global)
 227     progress_indication (_f ("Grob count %d", element_count ()));
 228
 229   for (SCM s = get_property ("all-elements"); scm_is_pair (s); s = scm_cdr (s))
 230     unsmob_grob (scm_car (s))->handle_prebroken_dependencies ();
 231
 232   fixup_refpoints (get_property ("all-elements"));
 233
 234
 235   for (SCM s = get_property ("all-elements"); scm_is_pair (s); s = scm_cdr (s))
 236     apply_tweaks (unsmob_grob (scm_car (s)), false);
 237
 238   for (SCM s = get_property ("all-elements"); scm_is_pair (s); s = scm_cdr (s))
 239     {
 240       Grob *sc = unsmob_grob (scm_car (s));
 241       sc->calculate_dependencies (PRECALCED, PRECALCING, ly_symbol2scm ("before-line-breaking-callback"));
 242     }
 243
 244   progress_indication ("\n");
 245   progress_indication (_ ("Calculating line breaks..."));
 246   progress_indication (" ");
 247   for (SCM s = get_property ("all-elements"); scm_is_pair (s); s = scm_cdr (s))
 248     {
 249       Grob *e = unsmob_grob (scm_car (s));
 250       SCM proc = e->get_property ("spacing-procedure");
 251       if (ly_c_procedure_p (proc))
 252         scm_call_1 (proc, e->self_scm ());
 253     }
 254 }
 255
 256 void
 257 System::post_processing ()
 258 {
 259   for (SCM s = get_property ("all-elements"); scm_is_pair (s); s = scm_cdr (s))
 260     {
 261       Grob *g = unsmob_grob (scm_car (s));
 262
 263       apply_tweaks (g, true);
 264
 265       g->calculate_dependencies (POSTCALCED, POSTCALCING,
 266           ly_symbol2scm ("after-line-breaking-callback"));
 267     }
 268
 269   Interval iv (extent (this, Y_AXIS));
 270   if (iv.is_empty ())
 271     programming_error ("System with zero extent.");
 272   else
 273     translate_axis (-iv[MAX], Y_AXIS);
 274
 275   /* Generate all stencils to trigger font loads.
 276      This might seem inefficient, but Stencils are cached per grob
 277      anyway. */
 278   SCM all = get_property ("all-elements");
 279   all = ly_list_qsort_uniq_x (all);
 280
 281   this->get_stencil ();
 282   for (SCM s = all; scm_is_pair (s); s = scm_cdr (s))
 283     {
 284       Grob *g = unsmob_grob (scm_car (s));
 285       g->get_stencil ();
 286     }
 287 }
 288
 289 SCM
 290 System::get_line ()
 291 {
 292   static int const LAYER_COUNT = 3;
 293
 294   SCM exprs = SCM_EOL;
 295   SCM *tail = &exprs;
 296
 297   /* Output stencils in three layers: 0, 1, 2.  Default layer: 1. */
 298   SCM all = get_property ("all-elements");
 299
 300   for (int i = 0; i < LAYER_COUNT; i++)
 301     for (SCM s = all; scm_is_pair (s); s = scm_cdr (s))
 302       {
 303         Grob *g = unsmob_grob (scm_car (s));
 304         Stencil *stil = g->get_stencil ();
 305
 306         /* Skip empty stencils and grobs that are not in this layer.  */
 307         if (!stil
 308             || robust_scm2int (g->get_property ("layer"), 1) != i)
 309           continue;
 310
 311         Offset o (g->relative_coordinate (this, X_AXIS),
 312                   g->relative_coordinate (this, Y_AXIS));
 313
 314         Offset extra = robust_scm2offset (g->get_property ("extra-offset"),
 315                                           Offset (0, 0))
 316           * Staff_symbol_referencer::staff_space (g);
 317
 318         /* Must copy the stencil, for we cannot change the stencil
 319            cached in G.  */
 320
 321         Stencil st = *stil;
 322         st.translate (o + extra);
 323
 324         *tail = scm_cons (st.expr (), SCM_EOL);
 325         tail = SCM_CDRLOC(*tail);
 326       }
 327
 328   if (Stencil *me = get_stencil ())
 329     exprs = scm_cons (me->expr (), exprs);
 330
 331   Interval x (extent (this, X_AXIS));
 332   Interval y (extent (this, Y_AXIS));
 333   Stencil sys_stencil (Box (x, y),
 334                        scm_cons (ly_symbol2scm ("combine-stencil"),
 335                                  exprs));
 336
 337   Interval staff_refpoints;
 338   staff_refpoints.set_empty();
 339   for (SCM s = get_property ("spaceable-staves");
 340        scm_is_pair (s); s = scm_cdr (s))
 341       {
 342         Grob *g = unsmob_grob (scm_car (s));
 343         staff_refpoints.add_point (g->relative_coordinate (this, Y_AXIS));
 344       }
 345
 346
 347   Paper_system *pl = new Paper_system (sys_stencil, false);
 348   pl->staff_refpoints_ = staff_refpoints;
 349   Item * break_point = this->get_bound(LEFT);
 350   pl->break_before_penalty_ =
 351     robust_scm2double (break_point->get_property ("page-penalty"), 0.0);
 352
 353   return scm_gc_unprotect_object (pl->self_scm ());
 354 }
 355
 356 Link_array<Item>
 357 System::broken_col_range (Item const *left, Item const *right) const
 358 {
 359   Link_array<Item> ret;
 360
 361   left = left->get_column ();
 362   right = right->get_column ();
 363   SCM s = get_property ("columns");
 364
 365   while (scm_is_pair (s) && scm_car (s) != right->self_scm ())
 366     s = scm_cdr (s);
 367
 368   if (scm_is_pair (s))
 369     s = scm_cdr (s);
 370
 371   while (scm_is_pair (s) && scm_car (s) != left->self_scm ())
 372     {
 373       Paper_column*c = dynamic_cast<Paper_column*> (unsmob_grob (scm_car (s)));
 374       if (Item::is_breakable (c) && !c->system_)
 375         ret.push (c);
 376
 377       s = scm_cdr (s);
 378     }
 379
 380   ret.reverse ();
 381   return ret;
 382 }
 383
 384 /** Return all columns, but filter out any unused columns , since they might
 385     disrupt the spacing problem. */
 386 Link_array<Grob>
 387 System::columns () const
 388 {
 389   Link_array<Grob> acs
 390     = extract_grob_array (this, ly_symbol2scm ("columns"));
 391   bool found = false;
 392   for (int i = acs.size (); i--;)
 393     {
 394       bool brb = Item::is_breakable (acs[i]);
 395       found = found || brb;
 396
 397       /*
 398         the last column should be breakable. Weed out any columns that
 399         seem empty. We need to retain breakable columns, in case
 400         someone forced a breakpoint.
 401       */
 402       if (!found || !Paper_column::is_used (acs[i]))
 403         acs.del (i);
 404     }
 405   return acs;
 406 }
 407
 408 ADD_INTERFACE (System, "system-interface",
 409                "This is the toplevel object: each object in a score "
 410                "ultimately has a System object as its X and Y parent. ",
 411                "all-elements spaceable-staves columns")