2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2000--2015 Jan Nieuwenhuizen <janneke@gnu.org>
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/>.
20 #include "align-interface.hh"
21 #include "axis-group-interface.hh"
22 #include "font-interface.hh"
23 #include "grob-interface.hh"
25 #include "lily-proto.hh"
26 #include "line-interface.hh"
27 #include "note-column.hh"
28 #include "output-def.hh"
29 #include "paper-column.hh"
30 #include "pointer-group-interface.hh"
32 #include "staff-symbol-referencer.hh"
34 #include "text-interface.hh"
40 DECLARE_SCHEME_CALLBACK (print, (SCM));
41 DECLARE_SCHEME_CALLBACK (calc_cross_staff, (SCM));
42 DECLARE_SCHEME_CALLBACK (calc_left_bound_info, (SCM));
43 DECLARE_SCHEME_CALLBACK (calc_left_bound_info_and_text, (SCM));
44 DECLARE_SCHEME_CALLBACK (calc_right_bound_info, (SCM));
45 DECLARE_SCHEME_CALLBACK (calc_bound_info, (SCM, Direction));
46 DECLARE_GROB_INTERFACE ();
49 Spanner *parent_spanner (Grob *g)
51 if (Spanner::has_interface (g))
52 return dynamic_cast<Spanner *> (g);
53 return parent_spanner (g->get_parent (Y_AXIS));
57 Line_spanner::calc_bound_info (SCM smob, Direction dir)
59 Spanner *me = Spanner::unsmob (smob);
61 Grob *commonx = me->get_bound (LEFT)->common_refpoint (me->get_bound (RIGHT), X_AXIS);
62 commonx = me->common_refpoint (commonx, X_AXIS);
64 SCM bound_details = me->get_property ("bound-details");
66 SCM details = SCM_BOOL_F;
67 if (details == SCM_BOOL_F)
68 details = ly_assoc_get ((dir == LEFT)
69 ? ly_symbol2scm ("left")
70 : ly_symbol2scm ("right"), bound_details, SCM_BOOL_F);
72 if (me->get_bound (dir)->break_status_dir ())
74 SCM extra = ly_assoc_get ((dir == LEFT)
75 ? ly_symbol2scm ("left-broken")
76 : ly_symbol2scm ("right-broken"), bound_details, SCM_EOL);
78 details = scm_append (scm_list_2 (extra, details));
81 if (details == SCM_BOOL_F)
82 details = ly_assoc_get (ly_symbol2scm ("default"), bound_details, SCM_EOL);
84 SCM text = ly_assoc_get (ly_symbol2scm ("text"), details, SCM_BOOL_F);
85 if (Text_interface::is_markup (text))
87 Output_def *layout = me->layout ();
88 SCM properties = Font_interface::text_font_alist_chain (me);
89 details = scm_acons (ly_symbol2scm ("stencil"),
90 Text_interface::interpret_markup (layout->self_scm (),
95 if (!scm_is_number (ly_assoc_get (ly_symbol2scm ("X"), details, SCM_BOOL_F)))
97 Direction attach = (Direction)
98 robust_scm2int (ly_assoc_get (ly_symbol2scm ("attach-dir"),
102 Item *bound_item = me->get_bound (dir);
103 Grob *bound_grob = bound_item;
104 if (to_boolean (ly_assoc_get (ly_symbol2scm ("end-on-note"), details, SCM_BOOL_F))
105 && bound_item->break_status_dir ())
107 extract_grob_set (me, "note-columns", columns);
109 bound_grob = (dir == LEFT)
110 ? columns[0] : columns.back ();
113 Real x_coord = (Paper_column::has_interface (bound_grob)
114 ? Axis_group_interface::generic_bound_extent (bound_grob, commonx, X_AXIS)
115 : robust_relative_extent (bound_grob, commonx, X_AXIS)).linear_combination (attach);
117 Grob *acc = Grob::unsmob (bound_grob->get_object ("accidental-grob"));
118 if (acc && to_boolean (ly_assoc_get (ly_symbol2scm ("end-on-accidental"), details, SCM_BOOL_F)))
119 x_coord = robust_relative_extent (acc, commonx, X_AXIS).linear_combination (attach);
121 Grob *dot = Grob::unsmob (bound_grob->get_object ("dot"));
122 if (dot && to_boolean (ly_assoc_get (ly_symbol2scm ("start-at-dot"), details, SCM_BOOL_F)))
123 x_coord = robust_relative_extent (dot, commonx, X_AXIS).linear_combination (attach);
125 details = scm_acons (ly_symbol2scm ("X"),
126 scm_from_double (x_coord),
130 if (!scm_is_number (ly_assoc_get (ly_symbol2scm ("Y"), details, SCM_BOOL_F)))
134 Real extra_dy = robust_scm2double (me->get_property ("extra-dy"),
137 Grob *common_y = me->common_refpoint (me->get_bound (dir), Y_AXIS);
138 if (me->get_bound (dir)->break_status_dir ())
140 if (to_boolean (me->get_property ("simple-Y")))
142 Spanner *orig = dynamic_cast<Spanner *>(me->original ());
143 Spanner *extreme = dir == LEFT ? orig->broken_intos_.front () : orig->broken_intos_.back ();
144 Grob *e_bound = extreme->get_bound (dir);
145 Grob *e_common_y = extreme->common_refpoint (e_bound, Y_AXIS);
146 y = e_bound->extent (e_common_y, Y_AXIS).center ();
150 Spanner *next_sp = me->broken_neighbor (dir);
151 Item *next_bound = next_sp->get_bound (dir);
153 if (next_bound->break_status_dir ())
155 programming_error ("no note heads for the line spanner on neighbor line?"
161 Spanner *next_bound_parent = parent_spanner (next_bound);
162 Interval next_ext = next_bound->extent (next_bound_parent, Y_AXIS);
165 We want to know what would be the y-position of the next
166 bound (relative to my y-parent) if it belonged to the
167 same system as this bound. We rely on the fact that the
168 y-parent of the next bound is a spanner (probably the
169 VerticalAxisGroup of a staff) that extends over the break.
171 Spanner *next_bound_parent_on_this_line
172 = next_bound_parent->broken_neighbor (other_dir (dir));
174 if (next_bound_parent_on_this_line)
176 Grob *common = me->common_refpoint (next_bound_parent_on_this_line, Y_AXIS);
177 Real bound_offset = next_bound_parent_on_this_line->relative_coordinate (common, Y_AXIS);
178 y = next_ext.center () + bound_offset - me->relative_coordinate (common, Y_AXIS);
183 We fall back to assuming that the distance between
184 staves doesn't change over line breaks.
186 programming_error ("next-bound's parent doesn't extend to this line");
187 Grob *next_system = next_bound->get_system ();
188 Grob *this_system = me->get_system ();
189 y = next_ext.center () + next_bound_parent->relative_coordinate (next_system, Y_AXIS)
190 - me->relative_coordinate (this_system, Y_AXIS);
196 Interval ii = me->get_bound (dir)->extent (common_y, Y_AXIS);
199 details = scm_acons (ly_symbol2scm ("common-Y"), common_y->self_scm (), details);
202 y += dir * extra_dy / 2;
203 details = scm_acons (ly_symbol2scm ("Y"), scm_from_double (y), details);
209 MAKE_SCHEME_CALLBACK (Line_spanner, calc_cross_staff, 1);
211 Line_spanner::calc_cross_staff (SCM smob)
213 Spanner *me = Spanner::unsmob (smob);
217 if (to_boolean (me->get_bound (LEFT)->get_property ("non-musical"))
218 || to_boolean (me->get_bound (RIGHT)->get_property ("non-musical")))
221 return scm_from_bool (Staff_symbol_referencer::get_staff_symbol (me->get_bound (LEFT))
222 != Staff_symbol_referencer::get_staff_symbol (me->get_bound (RIGHT)));
225 MAKE_SCHEME_CALLBACK (Line_spanner, calc_right_bound_info, 1);
227 Line_spanner::calc_right_bound_info (SCM smob)
229 return Line_spanner::calc_bound_info (smob, RIGHT);
232 MAKE_SCHEME_CALLBACK (Line_spanner, calc_left_bound_info, 1);
234 Line_spanner::calc_left_bound_info (SCM smob)
236 return Line_spanner::calc_bound_info (smob, LEFT);
239 MAKE_SCHEME_CALLBACK (Line_spanner, calc_left_bound_info_and_text, 1);
241 Line_spanner::calc_left_bound_info_and_text (SCM smob)
243 SCM alist = Line_spanner::calc_bound_info (smob, LEFT);
244 Spanner *me = Spanner::unsmob (smob);
246 SCM text = me->get_property ("text");
247 if (Text_interface::is_markup (text)
248 && me->get_bound (LEFT)->break_status_dir () == CENTER
249 && ly_assoc_get (ly_symbol2scm ("stencil"), alist, SCM_BOOL_F) == SCM_BOOL_F)
251 Output_def *layout = me->layout ();
252 SCM properties = Font_interface::text_font_alist_chain (me);
253 alist = scm_acons (ly_symbol2scm ("stencil"),
254 Text_interface::interpret_markup (layout->self_scm (),
262 MAKE_SCHEME_CALLBACK (Line_spanner, print, 1);
264 Line_spanner::print (SCM smob)
266 Spanner *me = dynamic_cast<Spanner *> (Grob::unsmob (smob));
268 // Triggers simple-Y calculations
269 bool simple_y = to_boolean (me->get_property ("simple-Y")) && !to_boolean (me->get_property ("cross-staff"));
271 Drul_array<SCM> bounds (me->get_property ("left-bound-info"),
272 me->get_property ("right-bound-info"));
274 Grob *commonx = me->get_bound (LEFT)->common_refpoint (me->get_bound (RIGHT), X_AXIS);
275 commonx = me->common_refpoint (commonx, X_AXIS);
277 Drul_array<Offset> span_points;
279 for (LEFT_and_RIGHT (d))
281 Offset z (robust_scm2double (ly_assoc_get (ly_symbol2scm ("X"),
282 bounds[d], SCM_BOOL_F), 0.0),
283 robust_scm2double (ly_assoc_get (ly_symbol2scm ("Y"),
284 bounds[d], SCM_BOOL_F), 0.0));
289 Drul_array<Real> gaps (0, 0);
290 Drul_array<bool> arrows (0, 0);
291 Drul_array<Stencil *> stencils (0, 0);
292 Drul_array<Grob *> common_y (0, 0);
294 // For scaling of 'padding and 'stencil-offset
296 = pow (2, robust_scm2double (me->get_property ("font-size"), 0.0) / 6);
298 for (LEFT_and_RIGHT (d))
300 gaps[d] = robust_scm2double (ly_assoc_get (ly_symbol2scm ("padding"),
301 bounds[d], SCM_BOOL_F), 0.0);
302 arrows[d] = to_boolean (ly_assoc_get (ly_symbol2scm ("arrow"),
303 bounds[d], SCM_BOOL_F));
304 stencils[d] = Stencil::unsmob (ly_assoc_get (ly_symbol2scm ("stencil"),
305 bounds[d], SCM_BOOL_F));
306 common_y[d] = Grob::unsmob (ly_assoc_get (ly_symbol2scm ("common-Y"),
307 bounds[d], SCM_BOOL_F));
312 Grob *my_common_y = common_y[LEFT]->common_refpoint (common_y[RIGHT], Y_AXIS);
316 for (LEFT_and_RIGHT (d))
317 span_points[d][Y_AXIS] += common_y[d]->relative_coordinate (my_common_y, Y_AXIS);
320 Interval normalized_endpoints = robust_scm2interval (me->get_property ("normalized-endpoints"), Interval (0, 1));
321 Real y_length = span_points[RIGHT][Y_AXIS] - span_points[LEFT][Y_AXIS];
323 span_points[LEFT][Y_AXIS] += normalized_endpoints[LEFT] * y_length;
324 span_points[RIGHT][Y_AXIS] -= (1 - normalized_endpoints[RIGHT]) * y_length;
326 Offset dz = (span_points[RIGHT] - span_points[LEFT]);
327 Offset dz_dir = dz.direction ();
328 if (gaps[LEFT] + gaps[RIGHT] > dz.length ())
334 for (LEFT_and_RIGHT (d))
336 span_points[d] += -d * gaps[d] * magstep * dz.direction ();
340 Stencil s = stencils[d]->translated (span_points[d]);
341 SCM align = ly_assoc_get (ly_symbol2scm ("stencil-align-dir-y"),
342 bounds[d], SCM_BOOL_F);
343 SCM off = ly_assoc_get (ly_symbol2scm ("stencil-offset"),
344 bounds[d], SCM_BOOL_F);
346 if (scm_is_number (align))
347 s.align_to (Y_AXIS, scm_to_double (align));
349 if (is_number_pair (off))
350 s.translate (ly_scm2offset (off) * magstep);
352 line.add_stencil (s);
356 for (LEFT_and_RIGHT (d))
359 span_points[d] += dz_dir *
360 (stencils[d]->extent (X_AXIS)[-d] / dz_dir[X_AXIS]);
363 Offset adjust = dz.direction () * Staff_symbol_referencer::staff_space (me);
364 Offset line_left = span_points[LEFT] + (arrows[LEFT] ? adjust * 1.4 : Offset (0, 0));
365 Offset line_right = span_points[RIGHT] - (arrows[RIGHT] ? adjust * 0.55 : Offset (0, 0));
367 if (line_right[X_AXIS] > line_left[X_AXIS])
369 line.add_stencil (Line_interface::line (me, line_left, line_right));
371 line.add_stencil (Line_interface::arrows (me,
378 line.translate (Offset (-me->relative_coordinate (commonx, X_AXIS),
379 simple_y ? 0.0 : -me->relative_coordinate (my_common_y, Y_AXIS)));
381 return line.smobbed_copy ();
384 ADD_INTERFACE (Line_spanner,
385 "Generic line drawn between two objects, e.g., for use with"