X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fline-spanner.cc;h=0235243628b0dc1a74a9cab08c1d462b14a3bb42;hb=refs%2Fheads%2Fdon%2Fdep5_copyright;hp=ff37a4c25827c058a56babb7b11c0d16752bd875;hpb=9f3572d98bb948c9689cd1f75401a029451fa001;p=lilypond.git diff --git a/lily/line-spanner.cc b/lily/line-spanner.cc index ff37a4c258..0235243628 100644 --- a/lily/line-spanner.cc +++ b/lily/line-spanner.cc @@ -1,311 +1,363 @@ /* - line-spanner.cc -- implement Line_spanner + This file is part of LilyPond, the GNU music typesetter. - source file of the GNU LilyPond music typesetter + Copyright (C) 2000--2011 Jan Nieuwenhuizen - (c) 2000--2006 Jan Nieuwenhuizen -*/ + LilyPond is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. -#include "line-spanner.hh" + LilyPond is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + You should have received a copy of the GNU General Public License + along with LilyPond. If not, see . +*/ -#include "spanner.hh" +#include "align-interface.hh" +#include "axis-group-interface.hh" +#include "font-interface.hh" +#include "grob-interface.hh" +#include "item.hh" +#include "lily-proto.hh" +#include "line-interface.hh" #include "output-def.hh" -#include "paper-column.hh" +#include "pointer-group-interface.hh" +#include "spanner.hh" #include "staff-symbol-referencer.hh" -#include "font-interface.hh" +#include "system.hh" +#include "text-interface.hh" #include "warn.hh" -#include "align-interface.hh" -#include "lookup.hh" -#include "line-interface.hh" -Stencil -zigzag_stencil (Grob *me, - Offset from, - Offset to) +class Line_spanner { - Offset dz = to -from; +public: + DECLARE_SCHEME_CALLBACK (print, (SCM)); + DECLARE_SCHEME_CALLBACK (calc_left_bound_info, (SCM)); + DECLARE_SCHEME_CALLBACK (calc_left_bound_info_and_text, (SCM)); + DECLARE_SCHEME_CALLBACK (calc_right_bound_info, (SCM)); + DECLARE_SCHEME_CALLBACK (calc_bound_info, (SCM, Direction)); + DECLARE_GROB_INTERFACE (); +}; + +Spanner *parent_spanner (Grob *g) +{ + if (Spanner::has_interface (g)) + return dynamic_cast (g); + return parent_spanner (g->get_parent (Y_AXIS)); +} - Real thick = Staff_symbol_referencer::line_thickness (me); - thick *= robust_scm2double (me->get_property ("thickness"), 1.0); // todo: staff sym referencer? +SCM +Line_spanner::calc_bound_info (SCM smob, Direction dir) +{ + Spanner *me = unsmob_spanner (smob); - Real staff_space = Staff_symbol_referencer::staff_space (me); + Grob *commonx = me->get_bound (LEFT)->common_refpoint (me->get_bound (RIGHT), X_AXIS); + commonx = me->common_refpoint (commonx, X_AXIS); - Real w = robust_scm2double (me->get_property ("zigzag-width"), 1) * staff_space; - int count = (int) ceil (dz.length () / w); - w = dz.length () / count; + SCM bound_details = me->get_property ("bound-details"); - Real l = robust_scm2double (me->get_property ("zigzag-length"), 1) * w; - Real h = l > w / 2 ? sqrt (l * l - w * w / 4) : 0; + SCM details = SCM_BOOL_F; + if (details == SCM_BOOL_F) + details = ly_assoc_get ((dir == LEFT) + ? ly_symbol2scm ("left") + : ly_symbol2scm ("right"), bound_details, SCM_BOOL_F); - Offset rotation_factor = complex_exp (Offset (0, dz.arg ())); + if (me->get_bound (dir)->break_status_dir ()) + { + SCM extra = ly_assoc_get ((dir == LEFT) + ? ly_symbol2scm ("left-broken") + : ly_symbol2scm ("right-broken"), bound_details, SCM_EOL); - Offset points[3]; - points[0] = Offset (0, -h / 2); - points[1] = Offset (w / 2, h / 2); - points[2] = Offset (w, -h / 2); - for (int i = 0; i < 3; i++) - points[i] = complex_multiply (points[i], rotation_factor); + for (SCM s = scm_reverse (extra); scm_is_pair (s); s = scm_cdr (s)) + details = scm_cons (scm_car (s), details); + } - Stencil squiggle (Line_interface::make_line (thick, points[0], points[1])); - squiggle.add_stencil (Line_interface::make_line (thick, points[1], points[2])); + if (details == SCM_BOOL_F) + details = ly_assoc_get (ly_symbol2scm ("default"), bound_details, SCM_EOL); - Stencil total; - for (int i = 0; i < count; i++) + SCM text = ly_assoc_get (ly_symbol2scm ("text"), details, SCM_BOOL_F); + if (Text_interface::is_markup (text)) { - Stencil moved_squiggle (squiggle); - moved_squiggle.translate (from + Offset (i * w, 0) * rotation_factor); - total.add_stencil (moved_squiggle); + Output_def *layout = me->layout (); + SCM properties = Font_interface::text_font_alist_chain (me); + details = scm_acons (ly_symbol2scm ("stencil"), + Text_interface::interpret_markup (layout->self_scm (), + properties, text), + details); } - Box b; - b.add_point (Offset (0, 0)); - b.add_point (dz); - b[X_AXIS].widen (thick / 2); - b[Y_AXIS].widen (thick / 2); - - return Stencil (b, total.expr ()); -} + if (!scm_is_number (ly_assoc_get (ly_symbol2scm ("X"), details, SCM_BOOL_F))) + { + Direction attach = (Direction) + robust_scm2int (ly_assoc_get (ly_symbol2scm ("attach-dir"), + details, SCM_BOOL_F), + CENTER); + + Item *bound_item = me->get_bound (dir); + Grob *bound_grob = bound_item; + if (to_boolean (ly_assoc_get (ly_symbol2scm ("end-on-note"), details, SCM_BOOL_F)) + && bound_item->break_status_dir ()) + { + extract_grob_set (me, "note-columns", columns); + if (columns.size ()) + bound_grob = (dir == LEFT) + ? columns[0] : columns.back(); + } -MAKE_SCHEME_CALLBACK (Line_spanner, after_line_breaking, 1); -SCM -Line_spanner::after_line_breaking (SCM g) -{ - Grob *me = unsmob_grob (g); - Spanner *sp = dynamic_cast (me); + details = scm_acons (ly_symbol2scm ("X"), + scm_from_double (robust_relative_extent (bound_grob, commonx, X_AXIS) + .linear_combination (attach)), + details); + } - /* - We remove the line at the start of the line. For piano voice - indicators, it makes no sense to have them at the start of the - line. - I'm not sure what the official rules for glissandi are, but - usually the 2nd note of the glissando is "exact", so when playing - from the start of the line, there is no need to glide. + if (!scm_is_number (ly_assoc_get (ly_symbol2scm ("Y"), details, SCM_BOOL_F))) + { + Real y = 0.0; - From a typographical p.o.v. this makes sense, since the amount of - space left of a note at the start of a line is very small. + Real extra_dy = robust_scm2double (me->get_property ("extra-dy"), + 0.0); - --hwn. + Grob *common_y = me->common_refpoint (me->get_bound (dir), Y_AXIS); + if (me->get_bound (dir)->break_status_dir ()) + { + Spanner *next_sp = me->broken_neighbor (dir); + Item *next_bound = next_sp->get_bound (dir); + + if (next_bound->break_status_dir ()) + { + programming_error ("no note heads for the line spanner on neighbor line?" + " Confused."); + me->suicide (); + return SCM_EOL; + } + + Spanner *next_bound_parent = parent_spanner (next_bound); + Interval next_ext = next_bound->extent (next_bound_parent, Y_AXIS); + + /* + We want to know what would be the y-position of the next + bound (relative to my y-parent) if it belonged to the + same system as this bound. We rely on the fact that the + y-parent of the next bound is a spanner (probably the + VerticalAxisGroup of a staff) that extends over the break. + */ + Spanner *next_bound_parent_on_this_line = + next_bound_parent->broken_neighbor (other_dir (dir)); + + if (next_bound_parent_on_this_line) + { + Grob *common = me->common_refpoint (next_bound_parent_on_this_line, Y_AXIS); + Real bound_offset = next_bound_parent_on_this_line->relative_coordinate (common, Y_AXIS); + y = next_ext.center () + bound_offset - me->relative_coordinate (common, Y_AXIS); + } + else + { + /* + We fall back to assuming that the distance between + staves doesn't change over line breaks. + */ + programming_error ("next-bound's parent doesn't extend to this line"); + Grob *next_system = next_bound->get_system (); + Grob *this_system = me->get_system (); + y = next_ext.center () + next_bound_parent->relative_coordinate (next_system, Y_AXIS) + - me->relative_coordinate (this_system, Y_AXIS); + } + } + else + { + y = me->get_bound (dir)->extent (common_y, Y_AXIS).center (); + details = scm_acons (ly_symbol2scm ("common-Y"), common_y->self_scm (), details); + } - */ - if (sp->get_bound (LEFT)->break_status_dir () - && !sp->get_bound (RIGHT)->break_status_dir ()) - { - /* - Can't do suicide, since this mucks up finding the trend. - */ - me->set_property ("transparent", SCM_BOOL_T); + y += dir * extra_dy / 2; + details = scm_acons (ly_symbol2scm ("Y"), scm_from_double (y), details); } - return SCM_EOL; + + return details; } -Stencil -Line_spanner::line_stencil (Grob *me, - Offset from, - Offset to) +MAKE_SCHEME_CALLBACK (Line_spanner, calc_right_bound_info, 1); +SCM +Line_spanner::calc_right_bound_info (SCM smob) { - Offset dz = to -from; - SCM type = me->get_property ("style"); - - Stencil line; - - if (scm_is_symbol (type) - && (type == ly_symbol2scm ("line") - || type == ly_symbol2scm ("dashed-line") - || type == ly_symbol2scm ("dotted-line") - || type == ly_symbol2scm ("zigzag") - || (type == ly_symbol2scm ("trill") && dz[Y_AXIS] != 0))) - { - line = (type == ly_symbol2scm ("zigzag")) - ? zigzag_stencil (me, from, to) - : Line_interface::line (me, from, to); - } - else if (scm_is_symbol (type) - && type == ly_symbol2scm ("trill")) - { - SCM alist_chain = Font_interface::text_font_alist_chain (me); - SCM style_alist = scm_list_n (scm_cons (ly_symbol2scm ("font-encoding"), - ly_symbol2scm ("fetaMusic")), - SCM_UNDEFINED); - - Font_metric *fm = select_font (me->layout (), - scm_cons (style_alist, - alist_chain)); - Stencil m = fm->find_by_name ("scripts.trill_element"); - Stencil mol; - - do - mol.add_at_edge (X_AXIS, RIGHT, m, 0, 0); - while (m.extent (X_AXIS).length () - && mol.extent (X_AXIS).length () - + m.extent (X_AXIS).length () < dz[X_AXIS]) - ; - - /* - FIXME: should center element on x/y - */ - mol.translate_axis (m.extent (X_AXIS).length () / 2, X_AXIS); - mol.translate_axis (- (mol.extent (Y_AXIS)[DOWN] - + mol.extent (Y_AXIS).length ()) / 2, Y_AXIS); - - mol.translate (from); - line = mol; - } - - if (to_boolean (me->get_property ("arrow"))) - line.add_stencil (Line_interface::arrows (me, from, to, false, true)); + return Line_spanner::calc_bound_info (smob, RIGHT); +} - return line; +MAKE_SCHEME_CALLBACK (Line_spanner, calc_left_bound_info, 1); +SCM +Line_spanner::calc_left_bound_info (SCM smob) +{ + return Line_spanner::calc_bound_info (smob, LEFT); } -/* - Find a common Y parent, which --if found-- should be the - fixed-distance alignment. -*/ -Grob * -line_spanner_common_parent (Grob *me) +MAKE_SCHEME_CALLBACK (Line_spanner, calc_left_bound_info_and_text, 1); +SCM +Line_spanner::calc_left_bound_info_and_text (SCM smob) { - Grob *common = find_fixed_alignment_parent (me); - if (!common) + SCM alist = Line_spanner::calc_bound_info (smob, LEFT); + Spanner *me = unsmob_spanner (smob); + + SCM text = me->get_property ("text"); + if (Text_interface::is_markup (text) + && me->get_bound (LEFT)->break_status_dir () == CENTER + && ly_assoc_get (ly_symbol2scm ("stencil"), alist, SCM_BOOL_F) == SCM_BOOL_F) { - common = Staff_symbol_referencer::get_staff_symbol (me); - if (common) - common = common->get_parent (Y_AXIS); - else - common = me->get_parent (Y_AXIS); + Output_def *layout = me->layout (); + SCM properties = Font_interface::text_font_alist_chain (me); + alist = scm_acons (ly_symbol2scm ("stencil"), + Text_interface::interpret_markup (layout->self_scm (), + properties, text), + alist); } - return common; + return alist; } -/* - Warning: this thing is a cross-staff object, so it should have empty Y-dimensions. - - (If not, you risk that this is called from the staff-alignment - routine, via stencil_extent. At this point, the staves aren't - separated yet, so it doesn't work cross-staff. - - (huh? crossable staves have fixed distance? --hwn) -*/ - MAKE_SCHEME_CALLBACK (Line_spanner, print, 1); SCM Line_spanner::print (SCM smob) { Spanner *me = dynamic_cast (unsmob_grob (smob)); - Drul_array bound (me->get_bound (LEFT), - me->get_bound (RIGHT)); + Drul_array bounds (me->get_property ("left-bound-info"), + me->get_property ("right-bound-info")); - Real gap = robust_scm2double (me->get_property ("gap"), 0.0); + Grob *commonx = me->get_bound (LEFT)->common_refpoint (me->get_bound (RIGHT), X_AXIS); + commonx = me->common_refpoint (commonx, X_AXIS); - Offset ofxy (gap, 0); /* offset from start point to start of line */ - Offset dxy; - Offset my_off; - Offset his_off; + Drul_array span_points; - if (bound[RIGHT]->break_status_dir ()) + Direction d = LEFT; + do { - if (bound[LEFT]->break_status_dir ()) - { - programming_error ("line-spanner with two broken ends. Farewell sweet world."); + Offset z (robust_scm2double (ly_assoc_get (ly_symbol2scm ("X"), + bounds[d], SCM_BOOL_F), 0.0), + robust_scm2double (ly_assoc_get (ly_symbol2scm ("Y"), + bounds[d], SCM_BOOL_F), 0.0)); - me->suicide (); - return SCM_EOL; - } + span_points[d] = z; + } + while (flip (&d) != LEFT); - /* - This is hairy. For the normal case, we simply find common - parents, and draw a line between the bounds. When two note - heads are on different systems, there is no common parent - anymore. We have to find the piano-staff object. - */ + Drul_array gaps (0, 0); + Drul_array arrows (0, 0); + Drul_array anchor_align (0, 0); + Drul_array stencils (0,0); + Drul_array common_y (0, 0); - int k = broken_spanner_index (me); - Spanner *parent_sp = dynamic_cast (me->original ()); - Spanner *next_sp = parent_sp->broken_intos_ [k + 1]; - Item *next_bound = next_sp->get_bound (RIGHT); + // For scaling of 'padding and 'stencil-offset + Real magstep + = pow (2, robust_scm2double (me->get_property ("font-size"), 0.0) / 6); - if (next_bound->break_status_dir ()) - { - programming_error ("no note heads for the line spanner on next line?" - " Confused."); - me->suicide (); - return SCM_EOL; - } - - Grob *commonx = bound[LEFT]->common_refpoint (bound[RIGHT], X_AXIS); - commonx = me->common_refpoint (commonx, X_AXIS); + do + { + gaps[d] = robust_scm2double (ly_assoc_get (ly_symbol2scm ("padding"), + bounds[d], SCM_BOOL_F), 0.0); + arrows[d] = to_boolean (ly_assoc_get (ly_symbol2scm ("arrow"), + bounds[d], SCM_BOOL_F)); + anchor_align[d] = robust_scm2double (ly_assoc_get (ly_symbol2scm ("anchor-alignment"), + bounds[d], SCM_BOOL_F), LEFT); + stencils[d] = unsmob_stencil (ly_assoc_get (ly_symbol2scm ("stencil"), + bounds[d], SCM_BOOL_F)); + common_y[d] = unsmob_grob (ly_assoc_get (ly_symbol2scm ("common-Y"), + bounds[d], SCM_BOOL_F)); + if (!common_y[d]) + common_y[d] = me; + } + while (flip (&d) != LEFT); - Grob *next_common_y = line_spanner_common_parent (next_bound); - Grob *this_common_y = line_spanner_common_parent (bound[LEFT]); + Grob *my_common_y = common_y[LEFT]->common_refpoint (common_y[RIGHT], Y_AXIS); + do + span_points[d][Y_AXIS] += common_y[d]->relative_coordinate (my_common_y, Y_AXIS); + while (flip (&d) != LEFT); - Grob *all_common_y = me->common_refpoint (this_common_y, Y_AXIS); + Interval normalized_endpoints = robust_scm2interval (me->get_property ("normalized-endpoints"), Interval (0, 1)); + Real y_length = span_points[RIGHT][Y_AXIS] - span_points[LEFT][Y_AXIS]; - Interval next_ext = next_bound->extent (next_common_y, Y_AXIS); - Interval this_ext = bound[LEFT]->extent (this_common_y, Y_AXIS); + span_points[LEFT][Y_AXIS] += normalized_endpoints[LEFT] * y_length; + span_points[RIGHT][Y_AXIS] -= (1 - normalized_endpoints[RIGHT]) * y_length; - Real yoff = this_common_y->relative_coordinate (all_common_y, Y_AXIS); + Offset dz = (span_points[RIGHT] - span_points[LEFT]); + Offset dz_dir = dz.direction (); + if (gaps[LEFT] + gaps[RIGHT] > dz.length ()) + { + return SCM_EOL; + } - Offset p1 (bound[LEFT]->extent (commonx, X_AXIS)[RIGHT], - this_ext.center () + yoff); - Offset p2 (bound[RIGHT]->extent (commonx, X_AXIS)[LEFT], - next_ext.center () + yoff); + Stencil line; + do + { + span_points[d] += -d * gaps[d] * magstep * dz.direction (); - Offset dz (p2 -p1); - Real len = dz.length (); + if (stencils[d]) + { + Interval ext = stencils[d]->extent (X_AXIS); + Real anchor = ext.linear_combination (anchor_align[d]) - ext[LEFT]; + span_points[d][X_AXIS] -= anchor; - Offset dir = dz * (1 / len); - dz = (dz.length () - 2 * gap) * dir; + Stencil s = stencils[d]->translated (span_points[d]); + SCM align = ly_assoc_get (ly_symbol2scm ("stencil-align-dir-y"), + bounds[d], SCM_BOOL_F); + SCM off = ly_assoc_get (ly_symbol2scm ("stencil-offset"), + bounds[d], SCM_BOOL_F); - Stencil l (line_stencil (me, Offset (0, 0), dz)); + if (scm_is_number (align)) + s.align_to (Y_AXIS, scm_to_double (align)); - l.translate (dir * gap + p1 - - Offset (me->relative_coordinate (commonx, X_AXIS), - me->relative_coordinate (all_common_y, Y_AXIS))); + if (is_number_pair (off)) + s.translate (ly_scm2offset (off) * magstep); - return l.smobbed_copy (); + line.add_stencil (s); + } } - else + while (flip (&d) != LEFT); + + do { - Grob *common[] = { me, me }; - for (int a = X_AXIS; a < NO_AXES; a++) - { - common[a] = me->common_refpoint (bound[RIGHT], Axis (a)); - common[a] = common[a]->common_refpoint (bound[LEFT], Axis (a)); - } + if (stencils[d]) + span_points[d] += dz_dir * + (stencils[d]->extent (X_AXIS)[-d] / dz_dir[X_AXIS]); + } + while (flip (&d) != LEFT); - // distance from center to start of line - Real off = gap + ((bound[LEFT]->extent (bound[LEFT], X_AXIS).length () * 3) / 4); + Offset adjust = dz.direction() * Staff_symbol_referencer::staff_space (me); - for (int a = X_AXIS; a < NO_AXES; a++) - { - Axis ax = (Axis)a; - dxy[ax] - = + robust_relative_extent (bound[RIGHT], common[X_AXIS], ax).center () - - robust_relative_extent (bound[LEFT], common[X_AXIS], ax).center (); + Offset line_left = span_points[LEFT] + (arrows[LEFT] ? adjust*1.4 : Offset (0, 0)); + Offset line_right = span_points[RIGHT] - (arrows[RIGHT] ? adjust*0.55 : Offset (0, 0)); + if (line_right[X_AXIS] > line_left[X_AXIS]) + { + line.add_stencil (Line_interface::line (me, line_left, line_right)); - my_off[ax] = me->relative_coordinate (common[a], ax); - his_off[ax] = bound[LEFT]->relative_coordinate (common[a], ax); - } + line.add_stencil (Line_interface::arrows (me, + span_points[LEFT], + span_points[RIGHT], + arrows[LEFT], + arrows[RIGHT])); + } - ofxy = dxy * (off / dxy.length ()); - dxy -= 2*ofxy; + line.translate (Offset (-me->relative_coordinate (commonx, X_AXIS), + -me->relative_coordinate (my_common_y, Y_AXIS))); - Stencil line = line_stencil (me, Offset (0, 0), dxy); - line.translate_axis (bound[LEFT]->extent (bound[LEFT], X_AXIS).length () / 2, X_AXIS); - line.translate (ofxy - my_off + his_off); - return line.smobbed_copy (); - } + return line.smobbed_copy (); } -ADD_INTERFACE (Line_spanner, "line-spanner-interface", - "Generic line drawn between two objects, e.g. for use with glissandi.\n" - "The property @code{style} can be @code{line}, " - "@code{dashed-line}, @code{trill}, \n" - "@code{dotted-line} or @code{zigzag}.\n" - "\n", - "gap zigzag-width zigzag-length thickness arrow"); - +ADD_INTERFACE (Line_spanner, + "Generic line drawn between two objects, e.g., for use with" + " glissandi.", + + /* properties */ + "bound-details " + "extra-dy " + "gap " + "left-bound-info " + "note-columns " + "right-bound-info " + "thickness " + "to-barline " + );