2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
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.
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.
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/>.
22 #include "axis-group-interface.hh"
23 #include "paper-score.hh"
25 #include "paper-column.hh"
26 #include "lily-guile.hh"
28 #include "pointer-group-interface.hh"
35 return new Item (*this);
41 broken_to_drul_[LEFT] = broken_to_drul_[RIGHT] = 0;
42 cached_pure_height_valid_ = false;
46 Item copy ctor. Copy nothing: everything should be a elt property
47 or a special purpose pointer (such as broken_to_drul_[]) */
48 Item::Item (Item const &s)
51 broken_to_drul_[LEFT] = broken_to_drul_[RIGHT] = 0;
52 cached_pure_height_valid_ = false;
56 Item::is_non_musical (Grob *me)
61 Item *i = dynamic_cast<Item *> (me->get_parent (X_AXIS));
62 return i ? Item::is_non_musical (i) : to_boolean (me->get_property ("non-musical"));
66 Item::get_column () const
68 Item *parent = dynamic_cast<Item *> (get_parent (X_AXIS));
69 return parent ? parent->get_column () : 0;
73 Item::get_system () const
75 Grob *g = get_parent (X_AXIS);
76 return g ? g->get_system () : 0;
80 Item::copy_breakable_items ()
82 Drul_array<Item *> new_copies;
86 Grob *dolly = clone ();
87 Item *item = dynamic_cast<Item *> (dolly);
88 get_root_system (this)->typeset_grob (item);
91 while (flip (&i) != LEFT);
93 broken_to_drul_ = new_copies;
97 Item::is_broken () const
99 return broken_to_drul_[LEFT] || broken_to_drul_[RIGHT];
103 Generate items for begin and end-of line.
106 Item::discretionary_processing ()
111 if (Item::is_non_musical (this))
112 copy_breakable_items ();
116 Item::find_broken_piece (System *l) const
118 if (get_system () == l)
119 return (Item *) (this);
124 Grob *s = broken_to_drul_[d];
125 if (s && s->get_system () == l)
128 while (flip (&d) != LEFT);
134 Item::maybe_find_prebroken_piece (Item *g, Direction d)
136 Item *ret = g->find_prebroken_piece (d);
143 Item::find_prebroken_piece (Direction d) const
145 Item *me = (Item *) (this);
148 return dynamic_cast<Item *> (broken_to_drul_[d]);
152 Item::break_status_dir () const
156 Item *i = dynamic_cast<Item *> (original ());
158 return (i->broken_to_drul_[LEFT] == this) ? LEFT : RIGHT;
165 Item::handle_prebroken_dependencies ()
167 Grob::handle_prebroken_dependencies ();
170 Can't do this earlier, because try_visibility_lambda () might set
171 the elt property transparent, which would then be copied.
173 if (!Item::break_visible (this))
178 Item::break_visible (Grob *g)
180 Item *it = dynamic_cast<Item *> (g);
181 SCM vis = g->get_property ("break-visibility");
182 if (scm_is_vector (vis))
183 return to_boolean (scm_c_vector_ref (vis, it->break_status_dir () + 1));
188 Item::pure_is_visible (int start, int end) const
190 SCM vis = get_property ("break-visibility");
191 if (scm_is_vector (vis))
194 int pc_rank = Paper_column::get_rank (get_column ());
195 if (pc_rank == start)
197 else if (pc_rank == end)
199 return to_boolean (scm_vector_ref (vis, scm_from_int (pos)));
205 Item::spanned_rank_interval () const
207 int c = get_column ()->get_rank ();
208 return Interval_t<int> (c, c);
212 spanned_time_interval (Item *l, Item *r)
214 Drul_array<Item *> bounds (l, r);
215 Interval_t<Moment> iv;
220 if (bounds[d] && bounds[d]->get_column ())
221 iv[d] = robust_scm2moment (bounds[d]->get_column ()->get_property ("when"),
224 while (flip (&d) != LEFT);
228 if (!bounds[d] || !bounds[d]->get_column ())
231 while (flip (&d) != LEFT);
237 Item::derived_mark () const
239 if (broken_to_drul_[LEFT])
240 scm_gc_mark (broken_to_drul_[LEFT]->self_scm ());
241 if (broken_to_drul_[RIGHT])
242 scm_gc_mark (broken_to_drul_[RIGHT]->self_scm ());
248 return dynamic_cast<Item *> (unsmob_grob (s));
252 Item::pure_height (Grob *g, int start, int end)
254 if (cached_pure_height_valid_)
255 return cached_pure_height_ + pure_relative_y_coordinate (g, start, end);
257 cache_pure_height (Grob::pure_height (this, start, end));
258 return cached_pure_height_ + pure_relative_y_coordinate (g, start, end);
262 Item::cache_pure_height (Interval height)
264 cached_pure_height_ = height;
265 cached_pure_height_valid_ = true;
269 "Grobs can be distinguished in their role in the horizontal"
270 " spacing. Many grobs define constraints on the spacing by"
271 " their sizes, for example, note heads, clefs, stems, and all"
272 " other symbols with a fixed shape. These grobs form a"
273 " subtype called @code{Item}.\n"
275 "Some items need special treatment for line breaking. For"
276 " example, a clef is normally only printed at the start of a"
277 " line (i.e., after a line break). To model this,"
278 " @q{breakable} items (clef, key signature, bar lines, etc.)"
279 " are copied twice. Then we have three versions of each"
280 " breakable item: one version if there is no line break, one"
281 " version that is printed before the line break (at the end of"
282 " a system), and one version that is printed after the line"
285 "Whether these versions are visible and take up space is"
286 " determined by the outcome of the @code{break-visibility}"
287 " grob property, which is a function taking a direction"
288 " (@w{@code{-1}}, @code{0} or@tie{}@code{1}) as an argument. It"
289 " returns a cons of booleans, signifying whether this grob"
290 " should be transparent and have no extent.\n"
292 "The following variables for @code{break-visibility} are"
295 " grob will show: before no after\n"
296 " break break break\n"
297 " all-invisible no no no\n"
298 " begin-of-line-visible no no yes\n"
299 " end-of-line-visible yes no no\n"
300 " all-visible yes yes yes\n"
301 " begin-of-line-invisible yes yes no\n"
302 " end-of-line-invisible no yes yes\n"
303 " center-invisible yes no yes\n"
308 "extra-spacing-height "
309 "extra-spacing-width "