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   if (!scm_is_number (ly_assoc_get (ly_symbol2scm ("Y"), details, SCM_BOOL_F)))
 118     {
 119       Real y = 0.0;
 120
 121       Real extra_dy = robust_scm2double (me->get_property ("extra-dy"),
 122                                          0.0);
 123
 124       Grob *common_y = me->common_refpoint (me->get_bound (dir), Y_AXIS);
 125       if (me->get_bound (dir)->break_status_dir ())
 126         {
 127           if (to_boolean (me->get_property ("simple-Y")))
 128             {
 129               Spanner *orig = dynamic_cast<Spanner *>(me->original ());
 130               Spanner *extreme = dir == LEFT ? orig->broken_intos_.front () : orig->broken_intos_.back ();
 131               Grob *e_bound = extreme->get_bound (dir);
 132               Grob *e_common_y = extreme->common_refpoint (e_bound, Y_AXIS);
 133               y = e_bound->extent (e_common_y, Y_AXIS).center ();
 134             }
 135           else
 136             {
 137               Spanner *next_sp = me->broken_neighbor (dir);
 138               Item *next_bound = next_sp->get_bound (dir);
 139
 140               if (next_bound->break_status_dir ())
 141                 {
 142                   programming_error ("no note heads for the line spanner on neighbor line?"
 143                                      " Confused.");
 144                   me->suicide ();
 145                   return SCM_EOL;
 146                 }
 147
 148               Spanner *next_bound_parent = parent_spanner (next_bound);
 149               Interval next_ext = next_bound->extent (next_bound_parent, Y_AXIS);
 150
 151               /*
 152                 We want to know what would be the y-position of the next
 153                 bound (relative to my y-parent) if it belonged to the
 154                 same system as this bound.  We rely on the fact that the
 155                 y-parent of the next bound is a spanner (probably the
 156                 VerticalAxisGroup of a staff) that extends over the break.
 157               */
 158               Spanner *next_bound_parent_on_this_line
 159                 = next_bound_parent->broken_neighbor (other_dir (dir));
 160
 161               if (next_bound_parent_on_this_line)
 162                 {
 163                   Grob *common = me->common_refpoint (next_bound_parent_on_this_line, Y_AXIS);
 164                   Real bound_offset = next_bound_parent_on_this_line->relative_coordinate (common, Y_AXIS);
 165                   y = next_ext.center () + bound_offset - me->relative_coordinate (common, Y_AXIS);
 166                 }
 167               else
 168                 {
 169                   /*
 170                     We fall back to assuming that the distance between
 171                     staves doesn't change over line breaks.
 172                   */
 173                   programming_error ("next-bound's parent doesn't extend to this line");
 174                   Grob *next_system = next_bound->get_system ();
 175                   Grob *this_system = me->get_system ();
 176                   y = next_ext.center () + next_bound_parent->relative_coordinate (next_system, Y_AXIS)
 177                       - me->relative_coordinate (this_system, Y_AXIS);
 178                 }
 179             }
 180         }
 181       else
 182         {
 183           y = me->get_bound (dir)->extent (common_y, Y_AXIS).center ();
 184           details = scm_acons (ly_symbol2scm ("common-Y"), common_y->self_scm (), details);
 185         }
 186
 187       y += dir * extra_dy / 2;
 188       details = scm_acons (ly_symbol2scm ("Y"), scm_from_double (y), details);
 189     }
 190
 191   return details;
 192 }
 193
 194 MAKE_SCHEME_CALLBACK (Line_spanner, calc_right_bound_info, 1);
 195 SCM
 196 Line_spanner::calc_right_bound_info (SCM smob)
 197 {
 198   return Line_spanner::calc_bound_info (smob, RIGHT);
 199 }
 200
 201 MAKE_SCHEME_CALLBACK (Line_spanner, calc_left_bound_info, 1);
 202 SCM
 203 Line_spanner::calc_left_bound_info (SCM smob)
 204 {
 205   return Line_spanner::calc_bound_info (smob, LEFT);
 206 }
 207
 208 MAKE_SCHEME_CALLBACK (Line_spanner, calc_left_bound_info_and_text, 1);
 209 SCM
 210 Line_spanner::calc_left_bound_info_and_text (SCM smob)
 211 {
 212   SCM alist = Line_spanner::calc_bound_info (smob, LEFT);
 213   Spanner *me = unsmob_spanner (smob);
 214
 215   SCM text = me->get_property ("text");
 216   if (Text_interface::is_markup (text)
 217       && me->get_bound (LEFT)->break_status_dir () == CENTER
 218       && ly_assoc_get (ly_symbol2scm ("stencil"), alist, SCM_BOOL_F) == SCM_BOOL_F)
 219     {
 220       Output_def *layout = me->layout ();
 221       SCM properties = Font_interface::text_font_alist_chain (me);
 222       alist = scm_acons (ly_symbol2scm ("stencil"),
 223                          Text_interface::interpret_markup (layout->self_scm (),
 224                                                            properties, text),
 225                          alist);
 226     }
 227
 228   return alist;
 229 }
 230
 231 MAKE_SCHEME_CALLBACK (Line_spanner, print, 1);
 232 SCM
 233 Line_spanner::print (SCM smob)
 234 {
 235   Spanner *me = dynamic_cast<Spanner *> (unsmob_grob (smob));
 236
 237   // Triggers simple-Y calculations
 238   bool simple_y = to_boolean (me->get_property ("simple-Y")) && !to_boolean (me->get_property ("cross-staff"));
 239
 240   Drul_array<SCM> bounds (me->get_property ("left-bound-info"),
 241                           me->get_property ("right-bound-info"));
 242
 243   Grob *commonx = me->get_bound (LEFT)->common_refpoint (me->get_bound (RIGHT), X_AXIS);
 244   commonx = me->common_refpoint (commonx, X_AXIS);
 245
 246   Drul_array<Offset> span_points;
 247
 248   Direction d = LEFT;
 249   do
 250     {
 251       Offset z (robust_scm2double (ly_assoc_get (ly_symbol2scm ("X"),
 252                                                  bounds[d], SCM_BOOL_F), 0.0),
 253                 robust_scm2double (ly_assoc_get (ly_symbol2scm ("Y"),
 254                                                  bounds[d], SCM_BOOL_F), 0.0));
 255
 256       span_points[d] = z;
 257     }
 258   while (flip (&d) != LEFT);
 259
 260   Drul_array<Real> gaps (0, 0);
 261   Drul_array<bool> arrows (0, 0);
 262   Drul_array<Stencil *> stencils (0, 0);
 263   Drul_array<Grob *> common_y (0, 0);
 264
 265   // For scaling of 'padding and 'stencil-offset
 266   Real magstep
 267     = pow (2, robust_scm2double (me->get_property ("font-size"), 0.0) / 6);
 268
 269   do
 270     {
 271       gaps[d] = robust_scm2double (ly_assoc_get (ly_symbol2scm ("padding"),
 272                                                  bounds[d], SCM_BOOL_F), 0.0);
 273       arrows[d] = to_boolean (ly_assoc_get (ly_symbol2scm ("arrow"),
 274                                             bounds[d], SCM_BOOL_F));
 275       stencils[d] = unsmob_stencil (ly_assoc_get (ly_symbol2scm ("stencil"),
 276                                                   bounds[d], SCM_BOOL_F));
 277       common_y[d] = unsmob_grob (ly_assoc_get (ly_symbol2scm ("common-Y"),
 278                                                bounds[d], SCM_BOOL_F));
 279       if (!common_y[d])
 280         common_y[d] = me;
 281     }
 282   while (flip (&d) != LEFT);
 283
 284   Grob *my_common_y = common_y[LEFT]->common_refpoint (common_y[RIGHT], Y_AXIS);
 285
 286   if (!simple_y)
 287     {
 288       do
 289         span_points[d][Y_AXIS] += common_y[d]->relative_coordinate (my_common_y, Y_AXIS);
 290       while (flip (&d) != LEFT);
 291     }
 292
 293   Interval normalized_endpoints = robust_scm2interval (me->get_property ("normalized-endpoints"), Interval (0, 1));
 294   Real y_length = span_points[RIGHT][Y_AXIS] - span_points[LEFT][Y_AXIS];
 295
 296   span_points[LEFT][Y_AXIS] += normalized_endpoints[LEFT] * y_length;
 297   span_points[RIGHT][Y_AXIS] -= (1 - normalized_endpoints[RIGHT]) * y_length;
 298
 299   Offset dz = (span_points[RIGHT] - span_points[LEFT]);
 300   Offset dz_dir = dz.direction ();
 301   if (gaps[LEFT] + gaps[RIGHT] > dz.length ())
 302     {
 303       return SCM_EOL;
 304     }
 305
 306   Stencil line;
 307   do
 308     {
 309       span_points[d] += -d * gaps[d] * magstep * dz.direction ();
 310
 311       if (stencils[d])
 312         {
 313           Stencil s = stencils[d]->translated (span_points[d]);
 314           SCM align = ly_assoc_get (ly_symbol2scm ("stencil-align-dir-y"),
 315                                     bounds[d], SCM_BOOL_F);
 316           SCM off = ly_assoc_get (ly_symbol2scm ("stencil-offset"),
 317                                   bounds[d], SCM_BOOL_F);
 318
 319           if (scm_is_number (align))
 320             s.align_to (Y_AXIS, scm_to_double (align));
 321
 322           if (is_number_pair (off))
 323             s.translate (ly_scm2offset (off) * magstep);
 324
 325           line.add_stencil (s);
 326         }
 327     }
 328   while (flip (&d) != LEFT);
 329
 330   do
 331     {
 332       if (stencils[d])
 333         span_points[d] += dz_dir *
 334                           (stencils[d]->extent (X_AXIS)[-d] / dz_dir[X_AXIS]);
 335     }
 336   while (flip (&d) != LEFT);
 337
 338   Offset adjust = dz.direction () * Staff_symbol_referencer::staff_space (me);
 339
 340   Offset line_left = span_points[LEFT] + (arrows[LEFT] ? adjust * 1.4 : Offset (0, 0));
 341   Offset line_right = span_points[RIGHT] - (arrows[RIGHT] ? adjust * 0.55 : Offset (0, 0));
 342   if (line_right[X_AXIS] > line_left[X_AXIS])
 343     {
 344       line.add_stencil (Line_interface::line (me, line_left, line_right));
 345
 346       line.add_stencil (Line_interface::arrows (me,
 347                                                 span_points[LEFT],
 348                                                 span_points[RIGHT],
 349                                                 arrows[LEFT],
 350                                                 arrows[RIGHT]));
 351     }
 352
 353   line.translate (Offset (-me->relative_coordinate (commonx, X_AXIS),
 354                           simple_y ? 0.0 : -me->relative_coordinate (my_common_y, Y_AXIS)));
 355
 356   return line.smobbed_copy ();
 357 }
 358
 359 ADD_INTERFACE (Line_spanner,
 360                "Generic line drawn between two objects, e.g., for use with"
 361                " glissandi.",
 362
 363                /* properties */
 364                "bound-details "
 365                "extra-dy "
 366                "gap "
 367                "left-bound-info "
 368                "note-columns "
 369                "right-bound-info "
 370                "simple-Y "
 371                "thickness "
 372                "to-barline "
 373               );