lily/line-spanner.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2000--2011 Jan Nieuwenhuizen <janneke@gnu.org>
   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 "align-interface.hh"
  21 #include "axis-group-interface.hh"
  22 #include "font-interface.hh"
  23 #include "grob-interface.hh"
  24 #include "item.hh"
  25 #include "lily-proto.hh"
  26 #include "line-interface.hh"
  27 #include "output-def.hh"
  28 #include "pointer-group-interface.hh"
  29 #include "spanner.hh"
  30 #include "staff-symbol-referencer.hh"
  31 #include "system.hh"
  32 #include "text-interface.hh"
  33 #include "warn.hh"
  34
  35 class Line_spanner
  36 {
  37 public:
  38   DECLARE_SCHEME_CALLBACK (print, (SCM));
  39   DECLARE_SCHEME_CALLBACK (calc_left_bound_info, (SCM));
  40   DECLARE_SCHEME_CALLBACK (calc_left_bound_info_and_text, (SCM));
  41   DECLARE_SCHEME_CALLBACK (calc_right_bound_info, (SCM));
  42   DECLARE_SCHEME_CALLBACK (calc_bound_info, (SCM, Direction));
  43   DECLARE_GROB_INTERFACE ();
  44 };
  45
  46 Spanner *parent_spanner (Grob *g)
  47 {
  48   if (Spanner::has_interface (g))
  49     return dynamic_cast<Spanner *> (g);
  50   return parent_spanner (g->get_parent (Y_AXIS));
  51 }
  52
  53 SCM
  54 Line_spanner::calc_bound_info (SCM smob, Direction dir)
  55 {
  56   Spanner *me = unsmob_spanner (smob);
  57
  58   Grob *commonx = me->get_bound (LEFT)->common_refpoint (me->get_bound (RIGHT), X_AXIS);
  59   commonx = me->common_refpoint (commonx, X_AXIS);
  60
  61   SCM bound_details = me->get_property ("bound-details");
  62
  63   SCM details = SCM_BOOL_F;
  64   if (details == SCM_BOOL_F)
  65     details = ly_assoc_get ((dir == LEFT)
  66                             ? ly_symbol2scm ("left")
  67                             : ly_symbol2scm ("right"), bound_details, SCM_BOOL_F);
  68
  69   if (me->get_bound (dir)->break_status_dir ())
  70     {
  71       SCM extra = ly_assoc_get ((dir == LEFT)
  72                                 ? ly_symbol2scm ("left-broken")
  73                                 : ly_symbol2scm ("right-broken"), bound_details, SCM_EOL);
  74
  75       for (SCM s = scm_reverse (extra); scm_is_pair (s); s = scm_cdr (s))
  76         details = scm_cons (scm_car (s), details);
  77     }
  78
  79   if (details == SCM_BOOL_F)
  80     details = ly_assoc_get (ly_symbol2scm ("default"), bound_details, SCM_EOL);
  81
  82   SCM text = ly_assoc_get (ly_symbol2scm ("text"), details, SCM_BOOL_F);
  83   if (Text_interface::is_markup (text))
  84     {
  85       Output_def *layout = me->layout ();
  86       SCM properties = Font_interface::text_font_alist_chain (me);
  87       details = scm_acons (ly_symbol2scm ("stencil"),
  88                            Text_interface::interpret_markup (layout->self_scm (),
  89                                                              properties, text),
  90                            details);
  91     }
  92
  93   if (!scm_is_number (ly_assoc_get (ly_symbol2scm ("X"), details, SCM_BOOL_F)))
  94     {
  95       Direction attach = (Direction)
  96         robust_scm2int (ly_assoc_get (ly_symbol2scm ("attach-dir"),
  97                                                      details, SCM_BOOL_F),
  98                         CENTER);
  99
 100       Item *bound_item = me->get_bound (dir);
 101       Grob *bound_grob = bound_item;
 102       if (to_boolean (ly_assoc_get (ly_symbol2scm ("end-on-note"), details, SCM_BOOL_F))
 103           && bound_item->break_status_dir ())
 104         {
 105           extract_grob_set (me, "note-columns", columns);
 106           if (columns.size ())
 107             bound_grob = (dir == LEFT)
 108               ? columns[0] : columns.back();
 109         }
 110
 111       details = scm_acons (ly_symbol2scm ("X"),
 112                            scm_from_double (robust_relative_extent (bound_grob, commonx, X_AXIS)
 113                                             .linear_combination (attach)),
 114                            details);
 115     }
 116
 117
 118   if (!scm_is_number (ly_assoc_get (ly_symbol2scm ("Y"), details, SCM_BOOL_F)))
 119     {
 120       Real y = 0.0;
 121
 122       Real extra_dy = robust_scm2double (me->get_property ("extra-dy"),
 123                                          0.0);
 124
 125       Grob *common_y = me->common_refpoint (me->get_bound (dir), Y_AXIS);
 126       if (me->get_bound (dir)->break_status_dir ())
 127         {
 128           if (to_boolean (me->get_property ("simple-Y")))
 129             {
 130               Spanner *orig = dynamic_cast<Spanner *>(me->original ());
 131               Spanner *extreme = dir == LEFT ? orig->broken_intos_.front () : orig->broken_intos_.back ();
 132               Grob *e_bound = extreme->get_bound (dir);
 133               Grob *e_common_y = extreme->common_refpoint (e_bound, Y_AXIS);
 134               y = e_bound->extent (e_common_y, Y_AXIS).center ();
 135             }
 136           else
 137             {
 138               Spanner *next_sp = me->broken_neighbor (dir);
 139               Item *next_bound = next_sp->get_bound (dir);
 140
 141               if (next_bound->break_status_dir ())
 142                 {
 143                   programming_error ("no note heads for the line spanner on neighbor line?"
 144                                      " Confused.");
 145                   me->suicide ();
 146                   return SCM_EOL;
 147                 }
 148
 149               Spanner *next_bound_parent = parent_spanner (next_bound);
 150               Interval next_ext = next_bound->extent (next_bound_parent, Y_AXIS);
 151
 152               /*
 153                 We want to know what would be the y-position of the next
 154                 bound (relative to my y-parent) if it belonged to the
 155                 same system as this bound.  We rely on the fact that the
 156                 y-parent of the next bound is a spanner (probably the
 157                 VerticalAxisGroup of a staff) that extends over the break.
 158               */
 159               Spanner *next_bound_parent_on_this_line =
 160                 next_bound_parent->broken_neighbor (other_dir (dir));
 161
 162               if (next_bound_parent_on_this_line)
 163                 {
 164                   Grob *common = me->common_refpoint (next_bound_parent_on_this_line, Y_AXIS);
 165                   Real bound_offset = next_bound_parent_on_this_line->relative_coordinate (common, Y_AXIS);
 166                   y = next_ext.center () + bound_offset - me->relative_coordinate (common, Y_AXIS);
 167                 }
 168               else
 169                 {
 170                   /*
 171                     We fall back to assuming that the distance between
 172                     staves doesn't change over line breaks.
 173                   */
 174                   programming_error ("next-bound's parent doesn't extend to this line");
 175                   Grob *next_system = next_bound->get_system ();
 176                   Grob *this_system = me->get_system ();
 177                   y = next_ext.center () + next_bound_parent->relative_coordinate (next_system, Y_AXIS)
 178                       - me->relative_coordinate (this_system, Y_AXIS);
 179                 }
 180             }
 181         }
 182       else
 183         {
 184           y = me->get_bound (dir)->extent (common_y, Y_AXIS).center ();
 185           details = scm_acons (ly_symbol2scm ("common-Y"), common_y->self_scm (), details);
 186         }
 187
 188       y += dir * extra_dy / 2;
 189       details = scm_acons (ly_symbol2scm ("Y"), scm_from_double (y), details);
 190     }
 191
 192   return details;
 193 }
 194
 195 MAKE_SCHEME_CALLBACK (Line_spanner, calc_right_bound_info, 1);
 196 SCM
 197 Line_spanner::calc_right_bound_info (SCM smob)
 198 {
 199   return Line_spanner::calc_bound_info (smob, RIGHT);
 200 }
 201
 202 MAKE_SCHEME_CALLBACK (Line_spanner, calc_left_bound_info, 1);
 203 SCM
 204 Line_spanner::calc_left_bound_info (SCM smob)
 205 {
 206   return Line_spanner::calc_bound_info (smob, LEFT);
 207 }
 208
 209 MAKE_SCHEME_CALLBACK (Line_spanner, calc_left_bound_info_and_text, 1);
 210 SCM
 211 Line_spanner::calc_left_bound_info_and_text (SCM smob)
 212 {
 213   SCM alist = Line_spanner::calc_bound_info (smob, LEFT);
 214   Spanner *me = unsmob_spanner (smob);
 215
 216   SCM text = me->get_property ("text");
 217   if (Text_interface::is_markup (text)
 218       && me->get_bound (LEFT)->break_status_dir () == CENTER
 219       && ly_assoc_get (ly_symbol2scm ("stencil"), alist, SCM_BOOL_F) == SCM_BOOL_F)
 220     {
 221       Output_def *layout = me->layout ();
 222       SCM properties = Font_interface::text_font_alist_chain (me);
 223       alist = scm_acons (ly_symbol2scm ("stencil"),
 224                          Text_interface::interpret_markup (layout->self_scm (),
 225                                                            properties, text),
 226                          alist);
 227     }
 228
 229   return alist;
 230 }
 231
 232 MAKE_SCHEME_CALLBACK (Line_spanner, print, 1);
 233 SCM
 234 Line_spanner::print (SCM smob)
 235 {
 236   Spanner *me = dynamic_cast<Spanner *> (unsmob_grob (smob));
 237
 238   // Triggers simple-Y calculations
 239   bool simple_y = to_boolean (me->get_property ("simple-Y")) && !to_boolean (me->get_property ("cross-staff"));
 240
 241   Drul_array<SCM> bounds (me->get_property ("left-bound-info"),
 242                           me->get_property ("right-bound-info"));
 243
 244   Grob *commonx = me->get_bound (LEFT)->common_refpoint (me->get_bound (RIGHT), X_AXIS);
 245   commonx = me->common_refpoint (commonx, X_AXIS);
 246
 247   Drul_array<Offset> span_points;
 248
 249   Direction d =  LEFT;
 250   do
 251     {
 252       Offset z (robust_scm2double (ly_assoc_get (ly_symbol2scm ("X"),
 253                                                  bounds[d], SCM_BOOL_F), 0.0),
 254                 robust_scm2double (ly_assoc_get (ly_symbol2scm ("Y"),
 255                                                  bounds[d], SCM_BOOL_F), 0.0));
 256
 257       span_points[d] = z;
 258     }
 259   while (flip (&d) != LEFT);
 260
 261   Drul_array<Real> gaps (0, 0);
 262   Drul_array<bool> arrows (0, 0);
 263   Drul_array<Stencil *> stencils (0,0);
 264   Drul_array<Grob *> common_y (0, 0);
 265
 266   // For scaling of 'padding and 'stencil-offset
 267   Real magstep
 268     = pow (2, robust_scm2double (me->get_property ("font-size"), 0.0) / 6);
 269
 270   do
 271     {
 272       gaps[d] = robust_scm2double (ly_assoc_get (ly_symbol2scm ("padding"),
 273                                                  bounds[d], SCM_BOOL_F), 0.0);
 274       arrows[d] = to_boolean (ly_assoc_get (ly_symbol2scm ("arrow"),
 275                                             bounds[d], SCM_BOOL_F));
 276       stencils[d] = unsmob_stencil (ly_assoc_get (ly_symbol2scm ("stencil"),
 277                                                   bounds[d], SCM_BOOL_F));
 278       common_y[d] = unsmob_grob (ly_assoc_get (ly_symbol2scm ("common-Y"),
 279                                                bounds[d], SCM_BOOL_F));
 280       if (!common_y[d])
 281         common_y[d] = me;
 282     }
 283   while (flip (&d) != LEFT);
 284
 285   Grob *my_common_y = common_y[LEFT]->common_refpoint (common_y[RIGHT], Y_AXIS);
 286
 287   if (!simple_y)
 288     {
 289       do
 290         span_points[d][Y_AXIS] += common_y[d]->relative_coordinate (my_common_y, Y_AXIS);
 291       while (flip (&d) != LEFT);
 292     }
 293
 294   Interval normalized_endpoints = robust_scm2interval (me->get_property ("normalized-endpoints"), Interval (0, 1));
 295   Real y_length = span_points[RIGHT][Y_AXIS] - span_points[LEFT][Y_AXIS];
 296
 297   span_points[LEFT][Y_AXIS] += normalized_endpoints[LEFT] * y_length;
 298   span_points[RIGHT][Y_AXIS] -= (1 - normalized_endpoints[RIGHT]) * y_length;
 299
 300   Offset dz = (span_points[RIGHT] - span_points[LEFT]);
 301   Offset dz_dir = dz.direction ();
 302   if (gaps[LEFT] + gaps[RIGHT] > dz.length ())
 303     {
 304       return SCM_EOL;
 305     }
 306
 307   Stencil line;
 308   do
 309     {
 310       span_points[d] += -d * gaps[d] * magstep * dz.direction ();
 311
 312       if (stencils[d])
 313         {
 314           Stencil s = stencils[d]->translated (span_points[d]);
 315           SCM align = ly_assoc_get (ly_symbol2scm ("stencil-align-dir-y"),
 316                                     bounds[d], SCM_BOOL_F);
 317           SCM off = ly_assoc_get (ly_symbol2scm ("stencil-offset"),
 318                                   bounds[d], SCM_BOOL_F);
 319
 320           if (scm_is_number (align))
 321             s.align_to (Y_AXIS, scm_to_double (align));
 322
 323           if (is_number_pair (off))
 324             s.translate (ly_scm2offset (off) * magstep);
 325
 326           line.add_stencil (s);
 327         }
 328     }
 329   while (flip (&d) != LEFT);
 330
 331   do
 332     {
 333       if (stencils[d])
 334         span_points[d] += dz_dir *
 335           (stencils[d]->extent (X_AXIS)[-d] / dz_dir[X_AXIS]);
 336     }
 337   while (flip (&d) != LEFT);
 338
 339   Offset adjust = dz.direction() * Staff_symbol_referencer::staff_space (me);
 340
 341   Offset line_left = span_points[LEFT] + (arrows[LEFT] ? adjust*1.4 : Offset (0, 0));
 342   Offset line_right = span_points[RIGHT] - (arrows[RIGHT] ? adjust*0.55 : Offset (0, 0));
 343   if (line_right[X_AXIS] > line_left[X_AXIS])
 344     {
 345       line.add_stencil (Line_interface::line (me, line_left, line_right));
 346
 347       line.add_stencil (Line_interface::arrows (me,
 348                                                 span_points[LEFT],
 349                                                 span_points[RIGHT],
 350                                                 arrows[LEFT],
 351                                                 arrows[RIGHT]));
 352     }
 353
 354   line.translate (Offset (-me->relative_coordinate (commonx, X_AXIS),
 355                           simple_y ? 0.0 : -me->relative_coordinate (my_common_y, Y_AXIS)));
 356
 357
 358   return line.smobbed_copy ();
 359 }
 360
 361 ADD_INTERFACE (Line_spanner,
 362                "Generic line drawn between two objects, e.g., for use with"
 363                " glissandi.",
 364
 365                /* properties */
 366                "bound-details "
 367                "extra-dy "
 368                "gap "
 369                "left-bound-info "
 370                "note-columns "
 371                "right-bound-info "
 372                "simple-Y "
 373                "thickness "
 374                "to-barline "
 375                );