lily/line-of-score.cc

   1 /*
   2   scoreline.cc -- implement Line_of_score
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1996--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9 #include "input-smob.hh"
  10 #include "axis-group-interface.hh"
  11 #include "debug.hh"
  12 #include "line-of-score.hh"
  13 #include "main.hh"
  14 #include "paper-column.hh"
  15 #include "paper-def.hh"
  16 #include "paper-outputter.hh"
  17 #include "paper-score.hh"
  18 #include "string.hh"
  19 #include "warn.hh"
  20 #include "dimensions.hh"
  21 #include "molecule.hh"
  22 #include "all-font-metrics.hh"
  23
  24 // todo: use map.
  25 void
  26 fixup_refpoints (SCM s)
  27 {
  28   for (; gh_pair_p (s); s = ly_cdr (s))
  29     {
  30       Grob::fixup_refpoint (ly_car (s));
  31     }
  32 }
  33
  34
  35 Line_of_score::Line_of_score (SCM s)
  36   : Spanner (s)
  37 {
  38   rank_i_ = 0;
  39
  40   Axis_group_interface::set_interface (this);
  41   Axis_group_interface::set_axes (this, Y_AXIS,X_AXIS);
  42 }
  43
  44 int
  45 Line_of_score::element_count () const
  46 {
  47   return scm_ilength (get_grob_property ("all-elements"));
  48 }
  49
  50 void
  51 Line_of_score::typeset_grob (Grob * elem_p)
  52 {
  53   elem_p->pscore_l_ = pscore_l_;
  54   Pointer_group_interface::add_grob (this, ly_symbol2scm ("all-elements"),elem_p);
  55   scm_gc_unprotect_object (elem_p->self_scm ());
  56 }
  57
  58 void
  59 Line_of_score::output_lines ()
  60 {
  61   for (SCM s = get_grob_property ("all-elements");
  62        gh_pair_p (s); s = ly_cdr (s))
  63     {
  64       unsmob_grob (ly_car (s))->do_break_processing ();
  65     }
  66
  67   /*
  68     fixups must be done in broken line_of_scores, because new elements
  69     are put over there.  */
  70   int count = 0;
  71   for (int i=0; i < broken_into_l_arr_.size (); i++)
  72     {
  73       Grob *se = broken_into_l_arr_[i];
  74       SCM all = se->get_grob_property ("all-elements");
  75       for (SCM s = all; gh_pair_p (s); s = ly_cdr (s))
  76         {
  77           fixup_refpoint (ly_car (s));
  78         }
  79       count += scm_ilength (all);
  80     }
  81
  82   /*
  83     needed for doing items.
  84    */
  85   fixup_refpoints (get_grob_property ("all-elements"));
  86
  87
  88   for (SCM s = get_grob_property ("all-elements");
  89        gh_pair_p (s); s = ly_cdr (s))
  90     {
  91       unsmob_grob (ly_car (s))->handle_broken_dependencies ();
  92     }
  93   handle_broken_dependencies ();
  94
  95   if (verbose_global_b)
  96     progress_indication (_f ("Element count %d.",  count + element_count ()));
  97
  98
  99   for (int i=0; i < broken_into_l_arr_.size (); i++)
 100     {
 101       Line_of_score *line_l = dynamic_cast<Line_of_score*> (broken_into_l_arr_[i]);
 102
 103       if (verbose_global_b)
 104         progress_indication ("[");
 105       line_l->post_processing (i+1 == broken_into_l_arr_.size ());
 106
 107       if (verbose_global_b)
 108         {
 109           progress_indication (to_str (i));
 110           progress_indication ("]");
 111         }
 112
 113       if (i < broken_into_l_arr_.size () - 1)
 114         {
 115           SCM lastcol =  ly_car (line_l->get_grob_property ("columns"));
 116           Grob*  e = unsmob_grob (lastcol);
 117
 118           SCM between = ly_symbol2scm ("between-system-string");
 119           SCM inter = e->internal_get_grob_property (between);
 120           if (gh_string_p (inter))
 121             {
 122               pscore_l_->outputter_l_
 123                 ->output_scheme (scm_list_n (between,
 124                                              inter, SCM_UNDEFINED));
 125             }
 126         }
 127     }
 128 }
 129
 130
 131
 132
 133 /*
 134   Find the loose columns in POSNS, and drape them around the columns
 135   specified in BETWEEN-COLS.  */
 136 void
 137 set_loose_columns (Line_of_score* which, Column_x_positions const *posns)
 138 {
 139   for (int i = 0; i < posns->loose_cols_.size (); i++)
 140     {
 141       int divide_over = 1;
 142       Item *loose = dynamic_cast<Item*> (posns->loose_cols_[i]);
 143       Paper_column* col = dynamic_cast<Paper_column*> (loose);
 144
 145       if (col->line_l_)
 146         continue;
 147
 148
 149       Item * left = 0;
 150       Item * right = 0;
 151       do
 152         {
 153           SCM between = loose->get_grob_property ("between-cols");
 154           if (!gh_pair_p (between))
 155             break;
 156
 157
 158           Item * l=dynamic_cast<Item*> (unsmob_grob (ly_car (between)));
 159           Item * r=dynamic_cast<Item*> (unsmob_grob (ly_cdr (between)));
 160
 161           if (!(l && r))
 162             break ;
 163
 164           if (!left && l)
 165             {
 166               left = l->column_l ();
 167             }
 168
 169           divide_over ++;
 170
 171           loose = right = r->column_l ();
 172         }
 173       while (1);
 174
 175       Real rx = right->relative_coordinate (right->get_parent (X_AXIS), X_AXIS);
 176       Real lx = left->relative_coordinate (left->get_parent (X_AXIS), X_AXIS);
 177
 178       int j = 1;
 179       loose = col;
 180       while (1)
 181         {
 182           SCM between = loose->get_grob_property ("between-cols");
 183           if (!gh_pair_p (between))
 184             break;
 185
 186           Paper_column *thiscol = dynamic_cast<Paper_column*> (loose);
 187
 188           thiscol->line_l_ = which;
 189           thiscol->translate_axis (lx + j*(rx - lx)/divide_over, X_AXIS);
 190
 191           j ++;
 192           loose = dynamic_cast<Item*> (unsmob_grob (ly_cdr (between)));
 193         }
 194
 195     }
 196 }
 197
 198 // const?
 199 void
 200 Line_of_score::break_into_pieces (Array<Column_x_positions> const &breaking)
 201 {
 202   for (int i=0; i < breaking.size (); i++)
 203     {
 204       Line_of_score *line_l = dynamic_cast <Line_of_score*> (clone ());
 205       line_l->rank_i_ = i;
 206       //      line_l->set_immutable_grob_property ("rank", gh_int2scm (i));
 207       Link_array<Grob> c (breaking[i].cols_);
 208       pscore_l_->typeset_line (line_l);
 209
 210       line_l->set_bound (LEFT,c[0]);
 211       line_l->set_bound (RIGHT,c.top ());
 212       for (int j=0; j < c.size (); j++)
 213         {
 214           c[j]->translate_axis (breaking[i].config_[j],X_AXIS);
 215           dynamic_cast<Paper_column*> (c[j])->line_l_ = line_l;
 216         }
 217       set_loose_columns (line_l, &breaking[i]);
 218       broken_into_l_arr_.push (line_l);
 219     }
 220 }
 221
 222
 223 #define GLOBAL_SYMBOL(cname, name)  \
 224 SCM cname ;                                     \
 225 void \
 226 cname ## _init_func ()                          \
 227 {                                               \
 228   cname = ly_symbol2scm (name);                 \
 229   scm_permanent_object (cname);                 \
 230 }                                               \
 231 ADD_SCM_INIT_FUNC (cname,cname ## _init_func);\
 232
 233
 234 GLOBAL_SYMBOL (offset_sym , "translate-molecule");
 235 GLOBAL_SYMBOL (placebox_sym , "placebox");
 236 GLOBAL_SYMBOL (combine_sym , "combine-molecule");
 237 GLOBAL_SYMBOL (no_origin_sym , "no-origin");
 238 GLOBAL_SYMBOL (define_origin_sym , "define-origin");
 239
 240
 241
 242 void
 243 Line_of_score::output_molecule (SCM expr, Offset o)
 244 {
 245
 246   while (1)
 247     {
 248       if (!gh_pair_p (expr))
 249         return;
 250
 251       SCM head =ly_car (expr);
 252       if (unsmob_input (head))
 253         {
 254           Input * ip = unsmob_input (head);
 255
 256
 257           pscore_l_->outputter_l_->output_scheme (scm_list_n (define_origin_sym,
 258                                                            ly_str02scm (ip->file_str ().ch_C ()),
 259                                                            gh_int2scm (ip->line_number ()),
 260                                                            gh_int2scm (ip->column_number ()),
 261                                                            SCM_UNDEFINED));
 262           expr = ly_cadr (expr);
 263         }
 264       else  if (head ==  no_origin_sym)
 265         {
 266           pscore_l_->outputter_l_->output_scheme (scm_list_n (no_origin_sym, SCM_UNDEFINED));
 267           expr = ly_cadr (expr);
 268         }
 269       else if (head == offset_sym)
 270         {
 271           o += ly_scm2offset (ly_cadr (expr));
 272           expr = ly_caddr (expr);
 273         }
 274       else if (head == combine_sym)
 275         {
 276           output_molecule (ly_cadr (expr), o);
 277           expr = ly_caddr (expr);
 278         }
 279       else
 280         {
 281           pscore_l_->outputter_l_->
 282             output_scheme (scm_list_n (placebox_sym,
 283                                     gh_double2scm (o[X_AXIS]),
 284                                     gh_double2scm (o[Y_AXIS]),
 285                                     expr,
 286                                     SCM_UNDEFINED));
 287
 288           return;
 289         }
 290     }
 291 }
 292
 293 void
 294 Line_of_score::output_scheme (SCM s)
 295 {
 296   pscore_l_->outputter_l_->output_scheme (s);
 297 }
 298
 299 void
 300 Line_of_score::add_column (Paper_column*p)
 301 {
 302   Grob *me = this;
 303   SCM cs = me->get_grob_property ("columns");
 304   Grob * prev =  gh_pair_p (cs) ? unsmob_grob (ly_car (cs)) : 0;
 305
 306   p->rank_i_ = prev ? Paper_column::rank_i (prev) + 1 : 0;
 307
 308   me->set_grob_property ("columns",  gh_cons (p->self_scm (), cs));
 309
 310   Axis_group_interface::add_element (me, p);
 311 }
 312
 313
 314
 315 /*
 316   TODO: use scm_map iso. for loops.
 317  */
 318 void
 319 Line_of_score::pre_processing ()
 320 {
 321   for (SCM s = get_grob_property ("all-elements"); gh_pair_p (s); s = ly_cdr (s))
 322     unsmob_grob (ly_car (s))->discretionary_processing ();
 323
 324   if (verbose_global_b)
 325     progress_indication (_f ("Element count %d ",  element_count ()));
 326
 327
 328   for (SCM s = get_grob_property ("all-elements"); gh_pair_p (s); s = ly_cdr (s))
 329     unsmob_grob (ly_car (s))->handle_prebroken_dependencies ();
 330
 331   fixup_refpoints (get_grob_property ("all-elements"));
 332
 333   for (SCM s = get_grob_property ("all-elements"); gh_pair_p (s); s = ly_cdr (s))
 334     {
 335       Grob* sc = unsmob_grob (ly_car (s));
 336       sc->calculate_dependencies (PRECALCED, PRECALCING, ly_symbol2scm ("before-line-breaking-callback"));
 337     }
 338
 339   progress_indication ("\n" + _ ("Calculating column positions...") + " ");
 340   for (SCM s = get_grob_property ("all-elements"); gh_pair_p (s); s = ly_cdr (s))
 341     {
 342       Grob * e = unsmob_grob (ly_car (s));
 343       SCM proc = e->get_grob_property ("spacing-procedure");
 344       if (gh_procedure_p (proc))
 345         gh_call1 (proc, e->self_scm ());
 346     }
 347 }
 348
 349 void
 350 Line_of_score::post_processing (bool last_line)
 351 {
 352   for (SCM s = get_grob_property ("all-elements");
 353        gh_pair_p (s); s = ly_cdr (s))
 354     {
 355       Grob* sc = unsmob_grob (ly_car (s));
 356       sc->calculate_dependencies (POSTCALCED, POSTCALCING,
 357                                   ly_symbol2scm ("after-line-breaking-callback"));
 358     }
 359
 360   Interval i (extent (this, Y_AXIS));
 361   if (i.empty_b ())
 362     programming_error ("Huh?  Empty Line_of_score?");
 363   else
 364     translate_axis (- i[MAX], Y_AXIS);
 365
 366   Real height = i.length ();
 367   if (height > 50 CM)
 368     {
 369       programming_error ("Improbable system height");
 370       height = 50 CM;
 371     }
 372
 373   /*
 374     generate all molecules  to trigger all font loads.
 375
 376     (ugh. This is not very memory efficient.)  */
 377   for (SCM s = get_grob_property ("all-elements"); gh_pair_p (s); s = ly_cdr (s))
 378     {
 379       unsmob_grob (ly_car (s))->get_molecule ();
 380     }
 381   /*
 382     font defs;
 383    */
 384   SCM font_names = ly_quote_scm (paper_l ()->font_descriptions ());
 385   output_scheme (scm_list_n (ly_symbol2scm ("define-fonts"),
 386                              font_names,
 387                              SCM_UNDEFINED));
 388
 389   /*
 390     line preamble.
 391    */
 392   output_scheme (scm_list_n (ly_symbol2scm ("start-line"),
 393                           gh_double2scm (height),
 394                           SCM_UNDEFINED));
 395
 396   /* Output elements in three layers, 0, 1, 2.
 397      The default layer is 1. */
 398   for (int i = 0; i < 3; i++)
 399     for (SCM s = get_grob_property ("all-elements"); gh_pair_p (s);
 400          s = ly_cdr (s))
 401       {
 402         Grob *sc = unsmob_grob (ly_car (s));
 403         Molecule *m = sc->get_molecule ();
 404         if (!m)
 405           continue;
 406
 407         SCM s = sc->get_grob_property ("layer");
 408         int layer = gh_number_p (s) ? gh_scm2int (s) : 1;
 409         if (layer != i)
 410           continue;
 411
 412         Offset o (sc->relative_coordinate (this, X_AXIS),
 413                   sc->relative_coordinate (this, Y_AXIS));
 414
 415         SCM e = sc->get_grob_property ("extra-offset");
 416         if (gh_pair_p (e))
 417           {
 418             o[X_AXIS] += gh_scm2double (ly_car (e));
 419             o[Y_AXIS] += gh_scm2double (ly_cdr (e));
 420           }
 421
 422         output_molecule (m->get_expr (), o);
 423       }
 424
 425   if (last_line)
 426     {
 427       output_scheme (scm_list_n (ly_symbol2scm ("stop-last-line"), SCM_UNDEFINED));
 428     }
 429   else
 430     {
 431       output_scheme (scm_list_n (ly_symbol2scm ("stop-line"), SCM_UNDEFINED));
 432     }
 433 }
 434
 435
 436 Link_array<Item>
 437 Line_of_score::broken_col_range (Item const*l, Item const*r) const
 438 {
 439   Link_array<Item> ret;
 440
 441   l = l->column_l ();
 442   r = r->column_l ();
 443   SCM s = get_grob_property ("columns");
 444
 445   while (gh_pair_p (s) && ly_car (s) != r->self_scm ())
 446     s = ly_cdr (s);
 447
 448   if (gh_pair_p (s))
 449     s = ly_cdr (s);
 450
 451   while (gh_pair_p (s) && ly_car (s) != l->self_scm ())
 452     {
 453       Paper_column*c = dynamic_cast<Paper_column*> (unsmob_grob (ly_car (s)));
 454       if (Item::breakable_b (c) && !c->line_l_)
 455         ret.push (c);
 456
 457       s = ly_cdr (s);
 458     }
 459
 460   ret.reverse ();
 461   return ret;
 462 }
 463
 464 /**
 465    Return all columns, but filter out any unused columns , since they might
 466    disrupt the spacing problem.
 467  */
 468 Link_array<Grob>
 469 Line_of_score::column_l_arr ()const
 470 {
 471   Link_array<Grob> acs
 472     = Pointer_group_interface__extract_grobs (this, (Grob*) 0, "columns");
 473   bool bfound = false;
 474   for (int i= acs.size (); i -- ;)
 475     {
 476       bool brb = Item::breakable_b (acs[i]);
 477       bfound = bfound || brb;
 478
 479       /*
 480         the last column should be breakable. Weed out any columns that
 481         seem empty. We need to retain breakable columns, in case
 482         someone forced a breakpoint.
 483       */
 484       if (!bfound || !Paper_column::used_b (acs[i]))
 485         acs.del (i);
 486     }
 487   return acs;
 488 }
 489