]> git.donarmstrong.com Git - lilypond.git/blob - lily/system.cc
Merge branch 'master' into lilypond/translation
[lilypond.git] / lily / system.cc
1 /*
2   This file is part of LilyPond, the GNU music typesetter.
3
4   Copyright (C) 1996--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
5
6   LilyPond is free software: you can redistribute it and/or modify
7   it under the terms of the GNU General Public License as published by
8   the Free Software Foundation, either version 3 of the License, or
9   (at your option) any later version.
10
11   LilyPond is distributed in the hope that it will be useful,
12   but WITHOUT ANY WARRANTY; without even the implied warranty of
13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14   GNU General Public License for more details.
15
16   You should have received a copy of the GNU General Public License
17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
18 */
19
20 #include "system.hh"
21
22 #include "align-interface.hh"
23 #include "all-font-metrics.hh"
24 #include "axis-group-interface.hh"
25 #include "grob-array.hh"
26 #include "hara-kiri-group-spanner.hh"
27 #include "international.hh"
28 #include "lookup.hh"
29 #include "main.hh"
30 #include "output-def.hh"
31 #include "page-layout-problem.hh"
32 #include "paper-column.hh"
33 #include "paper-score.hh"
34 #include "paper-system.hh"
35 #include "pointer-group-interface.hh"
36 #include "skyline-pair.hh"
37 #include "staff-symbol-referencer.hh"
38 #include "warn.hh"
39
40 System::System (System const &src)
41   : Spanner (src)
42 {
43   all_elements_ = 0;
44   pscore_ = 0;
45   rank_ = 0;
46   init_elements ();
47 }
48
49 System::System (SCM s)
50   : Spanner (s)
51 {
52   all_elements_ = 0;
53   rank_ = 0;
54   init_elements ();
55 }
56
57 void
58 System::init_elements ()
59 {
60   SCM scm_arr = Grob_array::make_array ();
61   all_elements_ = unsmob_grob_array (scm_arr);
62   all_elements_->set_ordered (false);
63   set_object ("all-elements", scm_arr);
64 }
65
66 Grob *
67 System::clone () const
68 {
69   return new System (*this);
70 }
71
72 int
73 System::element_count () const
74 {
75   return all_elements_->size ();
76 }
77
78 int
79 System::spanner_count () const
80 {
81   int k = 0;
82   for (vsize i = all_elements_->size (); i--;)
83     if (dynamic_cast<Spanner *> (all_elements_->grob (i)))
84       k++;
85   return k;
86 }
87
88 void
89 System::typeset_grob (Grob *elem)
90 {
91   if (elem->layout_)
92     programming_error ("adding element twice");
93   else
94     {
95       elem->layout_ = pscore_->layout ();
96       all_elements_->add (elem);
97       elem->unprotect ();
98     }
99 }
100
101 void
102 System::derived_mark () const
103 {
104   if (!all_elements_->empty ())
105     {
106       Grob **ptr = &all_elements_->array_reference ()[0];
107       Grob **end = ptr + all_elements_->size ();
108       while (ptr < end)
109         {
110           scm_gc_mark ((*ptr)->self_scm ());
111           ptr++;
112         }
113     }
114
115   if (pscore_)
116     scm_gc_mark (pscore_->self_scm ());
117
118   Spanner::derived_mark ();
119 }
120
121 static void
122 fixup_refpoints (vector<Grob *> const &grobs)
123 {
124   for (vsize i = grobs.size (); i--;)
125     grobs[i]->fixup_refpoint ();
126 }
127
128 void
129 System::do_break_substitution_and_fixup_refpoints ()
130 {
131   for (vsize i = 0; i < all_elements_->size (); i++)
132     {
133       Grob *g = all_elements_->grob (i);
134       if (g->internal_has_interface (ly_symbol2scm ("only-prebreak-interface")))
135         {
136           /*
137             Kill no longer needed grobs.
138           */
139           Item *it = dynamic_cast<Item *> (g);
140           if (it && Item::is_non_musical (it))
141             {
142               it->find_prebroken_piece (LEFT)->suicide ();
143               it->find_prebroken_piece (RIGHT)->suicide ();
144             }
145           g->suicide ();
146         }
147       else if (g->is_live ())
148         g->do_break_processing ();
149     }
150
151   /*
152     fixups must be done in broken line_of_scores, because new elements
153     are put over there.  */
154   int count = 0;
155   for (vsize i = 0; i < broken_intos_.size (); i++)
156     {
157       Grob *se = broken_intos_[i];
158
159       extract_grob_set (se, "all-elements", all_elts);
160       for (vsize j = 0; j < all_elts.size (); j++)
161         {
162           Grob *g = all_elts[j];
163           g->fixup_refpoint ();
164         }
165
166       count += all_elts.size ();
167     }
168
169   /*
170     needed for doing items.
171   */
172   fixup_refpoints (all_elements_->array ());
173
174   for (vsize i = 0; i < all_elements_->size (); i++)
175     all_elements_->grob (i)->handle_broken_dependencies ();
176
177   handle_broken_dependencies ();
178
179   /* Because the this->get_property (all-elements) contains items in 3
180      versions, handle_broken_dependencies () will leave duplicated
181      items in all-elements.  Strictly speaking this is harmless, but
182      it leads to duplicated symbols in the output.  uniq makes sure
183      that no duplicates are in the list.  */
184   for (vsize i = 0; i < broken_intos_.size (); i++)
185     {
186       System *child = dynamic_cast<System *> (broken_intos_[i]);
187       child->all_elements_->remove_duplicates ();
188       for (vsize j = 0; j < child->all_elements_->size (); j++)
189         {
190           Grob *g = child->all_elements_->grob (j);
191
192           (void) g->get_property ("after-line-breaking");
193         }
194     }
195
196   if (be_verbose_global)
197     message (_f ("Element count %d", count + element_count ()) + "\n");
198 }
199
200 SCM
201 System::get_broken_system_grobs ()
202 {
203   SCM ret = SCM_EOL;
204   for (vsize i = 0; i < broken_intos_.size (); i++)
205     ret = scm_cons (broken_intos_[i]->self_scm (), ret);
206   return scm_reverse (ret);
207 }
208
209 SCM
210 System::get_paper_systems ()
211 {
212   SCM lines = scm_c_make_vector (broken_intos_.size (), SCM_EOL);
213   for (vsize i = 0; i < broken_intos_.size (); i++)
214     {
215       if (be_verbose_global)
216         progress_indication ("[");
217
218       System *system = dynamic_cast<System *> (broken_intos_[i]);
219
220       scm_vector_set_x (lines, scm_from_int (i),
221                         system->get_paper_system ());
222
223       if (be_verbose_global)
224         progress_indication (to_string (i) + "]");
225     }
226   return lines;
227 }
228
229 void
230 System::break_into_pieces (vector<Column_x_positions> const &breaking)
231 {
232   for (vsize i = 0; i < breaking.size (); i++)
233     {
234       System *system = dynamic_cast<System *> (clone ());
235       system->rank_ = broken_intos_.size ();
236
237       vector<Grob *> c (breaking[i].cols_);
238       pscore_->typeset_system (system);
239
240       int st = Paper_column::get_rank (c[0]);
241       int end = Paper_column::get_rank (c.back ());
242       Interval iv (pure_height (this, st, end));
243       system->set_property ("pure-Y-extent", ly_interval2scm (iv));
244
245       system->set_bound (LEFT, c[0]);
246       system->set_bound (RIGHT, c.back ());
247       SCM system_labels = SCM_EOL;
248       for (vsize j = 0; j < c.size (); j++)
249         {
250           c[j]->translate_axis (breaking[i].config_[j], X_AXIS);
251           dynamic_cast<Paper_column *> (c[j])->set_system (system);
252           /* collect the column labels */
253           collect_labels (c[j], &system_labels);
254         }
255       /*
256         Collect labels from any loose columns too: theses will be set on
257         an empty bar line or a column which is otherwise unused mid-line
258       */
259       vector<Grob *> loose (breaking[i].loose_cols_);
260       for (vsize j = 0; j < loose.size (); j++)
261         collect_labels (loose[j], &system_labels);
262
263       system->set_property ("labels", system_labels);
264
265       set_loose_columns (system, &breaking[i]);
266       broken_intos_.push_back (system);
267     }
268 }
269
270 void
271 System::collect_labels (Grob const *col, SCM *labels)
272 {
273   SCM col_labels = col->get_property ("labels");
274   if (scm_is_pair (col_labels))
275     *labels = scm_append (scm_list_2 (col_labels, *labels));
276 }
277
278 void
279 System::add_column (Paper_column *p)
280 {
281   Grob *me = this;
282   Grob_array *ga = unsmob_grob_array (me->get_object ("columns"));
283   if (!ga)
284     {
285       SCM scm_ga = Grob_array::make_array ();
286       me->set_object ("columns", scm_ga);
287       ga = unsmob_grob_array (scm_ga);
288     }
289
290   p->set_rank (ga->size ());
291
292   ga->add (p);
293   Axis_group_interface::add_element (this, p);
294 }
295
296 void
297 System::pre_processing ()
298 {
299   for (vsize i = 0; i < all_elements_->size (); i++)
300     all_elements_->grob (i)->discretionary_processing ();
301
302   if (be_verbose_global)
303     message (_f ("Grob count %d", element_count ()));
304
305   /*
306     order is significant: broken grobs are added to the end of the
307     array, and should be processed before the original is potentially
308     killed.
309   */
310   for (vsize i = all_elements_->size (); i--;)
311     all_elements_->grob (i)->handle_prebroken_dependencies ();
312
313   fixup_refpoints (all_elements_->array ());
314
315   for (vsize i = 0; i < all_elements_->size (); i++)
316     {
317       Grob *g = all_elements_->grob (i);
318       (void) g->get_property ("before-line-breaking");
319     }
320
321   for (vsize i = 0; i < all_elements_->size (); i++)
322     {
323       Grob *e = all_elements_->grob (i);
324       (void) e->get_property ("springs-and-rods");
325     }
326 }
327
328 void
329 System::post_processing ()
330 {
331   Interval iv (extent (this, Y_AXIS));
332   if (iv.is_empty ())
333     programming_error ("system with empty extent");
334   else
335     translate_axis (-iv[MAX], Y_AXIS);
336
337   /* Generate all stencils to trigger font loads.
338      This might seem inefficient, but Stencils are cached per grob
339      anyway. */
340
341   vector<Grob *> all_elts_sorted (all_elements_->array ());
342   vector_sort (all_elts_sorted, std::less<Grob *> ());
343   uniq (all_elts_sorted);
344   this->get_stencil ();
345   for (vsize i = all_elts_sorted.size (); i--;)
346     {
347       Grob *g = all_elts_sorted[i];
348       g->get_stencil ();
349     }
350 }
351
352 struct Layer_entry
353 {
354   Grob *grob_;
355   int layer_;
356 };
357
358 bool
359 operator< (Layer_entry  const &a,
360            Layer_entry  const &b)
361 {
362   return a.layer_ < b.layer_;
363 }
364
365 SCM
366 System::get_paper_system ()
367 {
368   SCM exprs = SCM_EOL;
369   SCM *tail = &exprs;
370
371   post_processing ();
372
373   vector<Layer_entry> entries;
374   for (vsize j = 0; j < all_elements_->size (); j++)
375     {
376       Layer_entry e;
377       e.grob_ = all_elements_->grob (j);
378       e.layer_ = robust_scm2int (e.grob_->get_property ("layer"), 1);
379
380       entries.push_back (e);
381     }
382
383   vector_sort (entries, std::less<Layer_entry> ());
384   for (vsize j = 0; j < entries.size (); j++)
385     {
386       Grob *g = entries[j].grob_;
387       Stencil st = g->get_print_stencil ();
388
389       if (st.expr () == SCM_EOL)
390         continue;
391
392       Offset o;
393       for (int a = X_AXIS; a < NO_AXES; a++)
394         o[Axis (a)] = g->relative_coordinate (this, Axis (a));
395
396       Offset extra = robust_scm2offset (g->get_property ("extra-offset"),
397                                         Offset (0, 0))
398         * Staff_symbol_referencer::staff_space (g);
399
400       /* Must copy the stencil, for we cannot change the stencil
401          cached in G.  */
402
403       st.translate (o + extra);
404
405       *tail = scm_cons (st.expr (), SCM_EOL);
406       tail = SCM_CDRLOC (*tail);
407     }
408
409   if (Stencil *me = get_stencil ())
410     exprs = scm_cons (me->expr (), exprs);
411
412   Interval x (extent (this, X_AXIS));
413   Interval y (extent (this, Y_AXIS));
414   Stencil sys_stencil (Box (x, y),
415                        scm_cons (ly_symbol2scm ("combine-stencil"),
416                                  exprs));
417   if (debug_skylines)
418     {
419       Skyline_pair *skylines = Skyline_pair::unsmob (get_property ("vertical-skylines"));
420       if (skylines)
421         {
422           Stencil up
423             = Lookup::points_to_line_stencil (0.1, (*skylines)[UP].to_points (X_AXIS));
424           Stencil down
425             = Lookup::points_to_line_stencil (0.1, (*skylines)[DOWN].to_points (X_AXIS));
426           sys_stencil.add_stencil (up.in_color (255, 0, 0));
427           sys_stencil.add_stencil (down.in_color (0, 255, 0));
428         }
429     }
430
431   Grob *left_bound = this->get_bound (LEFT);
432   SCM prop_init = left_bound->get_property ("line-break-system-details");
433   Prob *pl = make_paper_system (prop_init);
434   paper_system_set_stencil (pl, sys_stencil);
435
436   /* information that the page breaker might need */
437   Grob *right_bound = this->get_bound (RIGHT);
438   pl->set_property ("vertical-skylines", this->get_property ("vertical-skylines"));
439   pl->set_property ("page-break-permission", right_bound->get_property ("page-break-permission"));
440   pl->set_property ("page-turn-permission", right_bound->get_property ("page-turn-permission"));
441   pl->set_property ("page-break-penalty", right_bound->get_property ("page-break-penalty"));
442   pl->set_property ("page-turn-penalty", right_bound->get_property ("page-turn-penalty"));
443
444   Interval staff_refpoints;
445   if (Grob *align = get_vertical_alignment ())
446     {
447       extract_grob_set (align, "elements", staves);
448       for (vsize i = 0; i < staves.size (); i++)
449         if (staves[i]->is_live ()
450             && Page_layout_problem::is_spaceable (staves[i]))
451           staff_refpoints.add_point (staves[i]->relative_coordinate (this,
452                                                                      Y_AXIS));
453     }
454
455   pl->set_property ("staff-refpoint-extent", ly_interval2scm (staff_refpoints));
456   pl->set_property ("system-grob", this->self_scm ());
457
458   return pl->unprotect ();
459 }
460
461 vector<Item *>
462 System::broken_col_range (Item const *left, Item const *right) const
463 {
464   vector<Item *> ret;
465
466   left = left->get_column ();
467   right = right->get_column ();
468
469   extract_grob_set (this, "columns", cols);
470
471   vsize i = Paper_column::get_rank (left);
472   int end_rank = Paper_column::get_rank (right);
473   if (i < cols.size ())
474     i++;
475
476   while (i < cols.size ()
477          && Paper_column::get_rank (cols[i]) < end_rank)
478     {
479       Paper_column *c = dynamic_cast<Paper_column *> (cols[i]);
480       if (Paper_column::is_breakable (c) && !c->get_system ())
481         ret.push_back (c);
482       i++;
483     }
484
485   return ret;
486 }
487
488 /** Return all columns, but filter out any unused columns , since they might
489     disrupt the spacing problem. */
490 vector<Grob *>
491 System::used_columns () const
492 {
493   extract_grob_set (this, "columns", ro_columns);
494
495   int last_breakable = ro_columns.size ();
496
497   while (last_breakable--)
498     {
499       if (Paper_column::is_breakable (ro_columns [last_breakable]))
500         break;
501     }
502
503   vector<Grob *> columns;
504   for (int i = 0; i <= last_breakable; i++)
505     {
506       if (Paper_column::is_used (ro_columns[i]))
507         columns.push_back (ro_columns[i]);
508     }
509
510   return columns;
511 }
512
513 Paper_column *
514 System::column (vsize which) const
515 {
516   extract_grob_set (this, "columns", columns);
517   if (which >= columns.size ())
518     return 0;
519
520   return dynamic_cast<Paper_column *> (columns[which]);
521 }
522
523 Paper_score *
524 System::paper_score () const
525 {
526   return pscore_;
527 }
528
529 int
530 System::get_rank () const
531 {
532   return rank_;
533 }
534
535 System *
536 get_root_system (Grob *me)
537 {
538   Grob *system_grob = me;
539
540   while (system_grob->get_parent (Y_AXIS))
541     system_grob = system_grob->get_parent (Y_AXIS);
542
543   return dynamic_cast<System *> (system_grob);
544 }
545
546 Grob *
547 System::get_vertical_alignment ()
548 {
549   extract_grob_set (this, "elements", elts);
550   Grob *ret = 0;
551   for (vsize i = 0; i < elts.size (); i++)
552     if (Align_interface::has_interface (elts[i]))
553       {
554         if (ret)
555           programming_error ("found multiple vertical alignments in this system");
556         ret = elts[i];
557       }
558
559   if (!ret)
560     programming_error ("didn't find a vertical alignment in this system");
561   return ret;
562 }
563
564 // Finds the furthest staff in the given direction whose x-extent
565 // overlaps with the given interval.
566 Grob *
567 System::get_extremal_staff (Direction dir, Interval const &iv)
568 {
569   Grob *align = get_vertical_alignment ();
570   if (!align)
571     return 0;
572
573   extract_grob_set (align, "elements", elts);
574   vsize start = (dir == UP) ? 0 : elts.size () - 1;
575   vsize end = (dir == UP) ? elts.size () : VPOS;
576   for (vsize i = start; i != end; i += dir)
577     {
578       if (Hara_kiri_group_spanner::has_interface (elts[i]))
579         Hara_kiri_group_spanner::consider_suicide (elts[i]);
580
581       Interval intersection = elts[i]->extent (this, X_AXIS);
582       intersection.intersect (iv);
583       if (elts[i]->is_live () && !intersection.is_empty ())
584         return elts[i];
585     }
586   return 0;
587 }
588
589 Interval
590 System::pure_refpoint_extent (vsize start, vsize end)
591 {
592   Interval ret;
593   Grob *alignment = get_vertical_alignment ();
594   if (!alignment)
595     return Interval ();
596
597   extract_grob_set (alignment, "elements", staves);
598   vector<Real> offsets = Align_interface::get_pure_minimum_translations (alignment, staves, Y_AXIS, start, end);
599
600   for (vsize i = 0; i < offsets.size (); ++i)
601     if (Page_layout_problem::is_spaceable (staves[i]))
602       {
603         ret[UP] = offsets[i];
604         break;
605       }
606
607   for (vsize i = offsets.size (); i--;)
608     if (Page_layout_problem::is_spaceable (staves[i]))
609       {
610         ret[DOWN] = offsets[i];
611         break;
612       }
613
614   return ret;
615 }
616
617 Interval
618 System::part_of_line_pure_height (vsize start, vsize end, bool begin)
619 {
620   Grob *alignment = get_vertical_alignment ();
621   if (!alignment)
622     return Interval ();
623
624   extract_grob_set (alignment, "elements", staves);
625   vector<Real> offsets = Align_interface::get_pure_minimum_translations (alignment, staves, Y_AXIS, start, end);
626
627   Interval ret;
628   for (vsize i = 0; i < staves.size (); ++i)
629     {
630       Interval iv = begin
631         ? Axis_group_interface::begin_of_line_pure_height (staves[i], start)
632         : Axis_group_interface::rest_of_line_pure_height (staves[i], start, end);
633       if (i < offsets.size ())
634         iv.translate (offsets[i]);
635       ret.unite (iv);
636     }
637
638   Interval other_elements = begin
639     ? Axis_group_interface::begin_of_line_pure_height (this, start)
640     : Axis_group_interface::rest_of_line_pure_height (this, start, end);
641
642   ret.unite (other_elements);
643
644   return ret;
645 }
646
647 Interval
648 System::begin_of_line_pure_height (vsize start, vsize end)
649 {
650   return part_of_line_pure_height (start, end, true);
651 }
652
653 Interval
654 System::rest_of_line_pure_height (vsize start, vsize end)
655 {
656   return part_of_line_pure_height (start, end, false);
657 }
658
659 // This differs from Axis_group_interface::calc_pure_relevant_grobs
660 // because here, we are only interested in those few elements that aren't
661 // descended from VerticalAlignment (ie. things like RehearsalMark, BarLine).
662 MAKE_SCHEME_CALLBACK (System, calc_pure_relevant_grobs, 1);
663 SCM
664 System::calc_pure_relevant_grobs (SCM smob)
665 {
666   Grob *me = unsmob_grob (smob);
667
668   extract_grob_set (me, "elements", elts);
669   vector<Grob *> relevant_grobs;
670   SCM pure_relevant_p = ly_lily_module_constant ("pure-relevant?");
671
672   for (vsize i = 0; i < elts.size (); ++i)
673     {
674       if (!Axis_group_interface::has_interface (elts[i]))
675         {
676           if (to_boolean (scm_apply_1 (pure_relevant_p, elts[i]->self_scm (), SCM_EOL)))
677             relevant_grobs.push_back (elts[i]);
678
679           if (Item *it = dynamic_cast<Item*> (elts[i]))
680             {
681               Direction d = LEFT;
682               do
683                 {
684                   Item *piece = it->find_prebroken_piece (d);
685                   if (piece && to_boolean (scm_apply_1 (pure_relevant_p, piece->self_scm (), SCM_EOL)))
686                     relevant_grobs.push_back (piece);
687                 }
688               while (flip (&d) != LEFT);
689             }
690         }
691     }
692
693   SCM grobs_scm = Grob_array::make_array ();
694
695   unsmob_grob_array (grobs_scm)->set_array (relevant_grobs);
696   return grobs_scm;
697 }
698
699 MAKE_SCHEME_CALLBACK (System, height, 1);
700 SCM
701 System::height (SCM smob)
702 {
703   return Axis_group_interface::height (smob);
704 }
705
706 MAKE_SCHEME_CALLBACK (System, calc_pure_height, 3);
707 SCM
708 System::calc_pure_height (SCM smob, SCM start_scm, SCM end_scm)
709 {
710   System *me = dynamic_cast<System *> (unsmob_grob (smob));
711   int start = scm_to_int (start_scm);
712   int end = scm_to_int (end_scm);
713
714   Interval begin = me->begin_of_line_pure_height (start, end);
715   Interval rest = me->rest_of_line_pure_height (start, end);
716   begin.unite (rest);
717
718   return ly_interval2scm (begin);
719 }
720
721 Grob*
722 System::get_pure_bound (Direction d, int start, int end)
723 {
724   vector<vsize> ranks = pscore_->get_break_ranks ();
725   vector<vsize> indices = pscore_->get_break_indices ();
726   vector<Grob*> cols = pscore_->get_columns ();
727
728   vsize target_rank = (d == LEFT ? start : end);
729   vector<vsize>::const_iterator i =
730     lower_bound (ranks.begin (), ranks.end (), target_rank, std::less<vsize> ());
731
732   if (i != ranks.end () && (*i) == target_rank)
733     return cols[indices[i - ranks.begin ()]];
734   else
735     return 0;
736 }
737
738 Grob*
739 System::get_maybe_pure_bound (Direction d, bool pure, int start, int end)
740 {
741   return pure ? get_pure_bound (d, start, end) : get_bound (d);
742 }
743
744 ADD_INTERFACE (System,
745                "This is the top-level object: Each object in a score"
746                " ultimately has a @code{System} object as its X and"
747                " Y@tie{}parent.",
748
749                /* properties */
750                "all-elements "
751                "columns "
752                "labels "
753                "pure-Y-extent "
754                "skyline-horizontal-padding "
755                );