lily/paper-column.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
   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 "paper-column.hh"
  21
  22 #include "axis-group-interface.hh"
  23 #include "bar-line.hh"
  24 #include "break-align-interface.hh"
  25 #include "font-interface.hh"
  26 #include "grob-array.hh"
  27 #include "lookup.hh"
  28 #include "lookup.hh"
  29 #include "moment.hh"
  30 #include "output-def.hh"
  31 #include "paper-score.hh"
  32 #include "pointer-group-interface.hh"
  33 #include "rhythmic-head.hh"
  34 #include "separation-item.hh"
  35 #include "skyline-pair.hh"
  36 #include "spaceable-grob.hh"
  37 #include "spring.hh"
  38 #include "string-convert.hh"
  39 #include "system.hh"
  40 #include "text-interface.hh"
  41 #include "warn.hh"
  42
  43 Grob *
  44 Paper_column::clone () const
  45 {
  46   return new Paper_column (*this);
  47 }
  48
  49 void
  50 Paper_column::do_break_processing ()
  51 {
  52   Item::do_break_processing ();
  53 }
  54
  55 int
  56 Paper_column::get_rank (Grob const *me)
  57 {
  58   return dynamic_cast<Paper_column const *> (me)->rank_;
  59 }
  60
  61 void
  62 Paper_column::set_rank (int rank)
  63 {
  64   rank_ = rank;
  65 }
  66
  67 System *
  68 Paper_column::get_system () const
  69 {
  70   return system_;
  71 }
  72
  73 void
  74 Paper_column::set_system (System *s)
  75 {
  76   system_ = s;
  77 }
  78
  79 Paper_column *
  80 Paper_column::get_column () const
  81 {
  82   return (Paper_column *) (this);
  83 }
  84
  85 Paper_column::Paper_column (SCM l)
  86   : Item (l)
  87 {
  88   system_ = 0;
  89   rank_ = -1;
  90 }
  91
  92 Paper_column::Paper_column (Paper_column const &src)
  93   : Item (src)
  94 {
  95   system_ = 0;
  96   rank_ = src.rank_;
  97 }
  98
  99 int
 100 Paper_column::compare (Grob *const &a,
 101                        Grob *const &b)
 102 {
 103   return sign (dynamic_cast<Paper_column *> (a)->rank_
 104                - dynamic_cast<Paper_column *> (b)->rank_);
 105 }
 106
 107 bool
 108 Paper_column::less_than (Grob *const &a,
 109                          Grob *const &b)
 110 {
 111   Paper_column *pa = dynamic_cast<Paper_column *> (a);
 112   Paper_column *pb = dynamic_cast<Paper_column *> (b);
 113
 114   return pa->rank_ < pb->rank_;
 115 }
 116
 117 Moment
 118 Paper_column::when_mom (Grob *me)
 119 {
 120   SCM m = me->get_property ("when");
 121   if (Moment *when = unsmob_moment (m))
 122     return *when;
 123   return Moment (0);
 124 }
 125
 126 bool
 127 Paper_column::is_musical (Grob *me)
 128 {
 129   SCM m = me->get_property ("shortest-starter-duration");
 130   Moment s (0);
 131   if (unsmob_moment (m))
 132     s = *unsmob_moment (m);
 133   return s != Moment (0);
 134 }
 135
 136 bool
 137 Paper_column::is_used (Grob *me)
 138 {
 139   extract_grob_set (me, "elements", elts);
 140   if (elts.size ())
 141     return true;
 142
 143   extract_grob_set (me, "bounded-by-me", bbm);
 144   if (bbm.size ())
 145     return true;
 146
 147   if (Paper_column::is_breakable (me))
 148     return true;
 149
 150   if (to_boolean (me->get_property ("used")))
 151     return true;
 152
 153   if (scm_is_pair (me->get_property ("labels")))
 154     return true;
 155
 156   return false;
 157 }
 158
 159 bool
 160 Paper_column::is_breakable (Grob *me)
 161 {
 162   return scm_is_symbol (me->get_property ("line-break-permission"));
 163 }
 164
 165 Real
 166 Paper_column::minimum_distance (Grob *left, Grob *right)
 167 {
 168   Drul_array<Grob *> cols (left, right);
 169   Drul_array<Skyline> skys = Drul_array<Skyline> (Skyline (RIGHT), Skyline (LEFT));
 170
 171   for (LEFT_and_RIGHT (d))
 172     {
 173       Skyline_pair *sp = Skyline_pair::unsmob (cols[d]->get_property ("horizontal-skylines"));
 174       if (sp)
 175         skys[d] = (*sp)[-d];
 176     }
 177
 178   skys[RIGHT].merge (Separation_item::conditional_skyline (right, left));
 179
 180   return max (0.0, skys[LEFT].distance (skys[RIGHT]));
 181 }
 182
 183 Interval
 184 Paper_column::break_align_width (Grob *me, SCM align_sym)
 185 {
 186   Grob *p = me->get_parent (X_AXIS);
 187
 188   if (is_musical (me))
 189     {
 190       me->programming_error ("tried to get break-align-width of a musical column");
 191       return Interval (0, 0) + me->relative_coordinate (p, X_AXIS);
 192     }
 193
 194   Grob *align = 0;
 195   if (align_sym == ly_symbol2scm ("staff-bar")
 196       || align_sym == ly_symbol2scm ("break-alignment"))
 197     align
 198       = Pointer_group_interface::find_grob (me, ly_symbol2scm ("elements"),
 199                                             (align_sym == ly_symbol2scm ("staff-bar")
 200                                              ? Bar_line::non_empty_barline
 201                                              : Break_alignment_interface::has_interface));
 202   else
 203     {
 204       extract_grob_set (me, "elements", elts);
 205       for (vsize i = 0; i < elts.size (); i++)
 206         {
 207           if (elts[i]->get_property ("break-align-symbol") == align_sym)
 208             {
 209               align = elts[i];
 210               break;
 211             }
 212         }
 213     }
 214
 215   if (!align)
 216     return Interval (0, 0) + me->relative_coordinate (p, X_AXIS);
 217
 218   return align->extent (p, X_AXIS);
 219 }
 220
 221 /*
 222   Print a:
 223   - vertical line,
 224   - the rank number,
 225   - rank moment,
 226   - blue arrow representing ideal distance,
 227   - red arrow representing minimum distance
 228   to aid debugging.  To turn this on, simply add
 229   \override Score.PaperColumn #'stencil = #ly:paper-column::print
 230   \override Score.NonMusicalPaperColumn #'stencil = #ly:paper-column::print
 231   to your score.
 232   Also, as of 2013-10-16 there's a switch in Frescobaldi that turns this on.
 233 */
 234 MAKE_SCHEME_CALLBACK (Paper_column, print, 1);
 235 SCM
 236 Paper_column::print (SCM p)
 237 {
 238   Paper_column *me = dynamic_cast<Paper_column *> (unsmob_grob (p));
 239
 240   string r = ::to_string (Paper_column::get_rank (me));
 241
 242   Moment *mom = unsmob_moment (me->get_property ("when"));
 243   string when = mom ? mom->to_string () : "?/?";
 244
 245   Font_metric *musfont = Font_interface::get_default_font (me);
 246   SCM properties = Font_interface::text_font_alist_chain (me);
 247   SCM scm_mol = Text_interface::interpret_markup (me->layout ()->self_scm (),
 248                                                   properties,
 249                                                   ly_string2scm (r));
 250   SCM when_mol = Text_interface::interpret_markup (me->layout ()->self_scm (),
 251                                                    properties,
 252                                                    ly_string2scm (when));
 253   Stencil t = *unsmob_stencil (scm_mol);
 254   t.scale (1.2, 1.4);
 255   t.add_at_edge (Y_AXIS, DOWN, *unsmob_stencil (when_mol), 0.1);
 256   t.align_to (X_AXIS, LEFT);
 257   // compensate for font serifs and half letter-distance
 258   t.translate (Offset (-0.1, 0));
 259   t.align_to (Y_AXIS, DOWN);
 260
 261   Stencil l = Lookup::filled_box (Box (Interval (0, 0.02),
 262                                        Interval (-8, -1)));
 263
 264   Real small_pad = 0.15;
 265   Real big_pad = 0.35;
 266
 267   // number of printed arrows from *both* loops
 268   int j = 0;
 269
 270   for (SCM s = me->get_object ("ideal-distances");
 271        scm_is_pair (s); s = scm_cdr (s))
 272     {
 273       Spring *sp = unsmob_spring (scm_caar (s));
 274       if (!unsmob_grob (scm_cdar (s))
 275           || !unsmob_grob (scm_cdar (s))->get_system ())
 276         continue;
 277
 278       j++;
 279
 280       Stencil arrowhead (musfont->find_by_name ("arrowheads.open.01"));
 281       // initial scaling; it will also scale with font-size.
 282       arrowhead.scale (1, 1.66);
 283       Real head_len = arrowhead.extent (X_AXIS).length ();
 284
 285       SCM stil = Text_interface::interpret_markup (me->layout ()->self_scm (),
 286                                                    properties,
 287                                                    ly_string2scm (String_convert::form_string ("%5.2lf", sp->distance ())));
 288       Stencil *number_stc = unsmob_stencil (stil);
 289       number_stc->scale (1, 1.1);
 290       Real num_height = number_stc->extent (Y_AXIS).length ();
 291       Real num_len = number_stc->extent (X_AXIS).length ();
 292       number_stc->align_to (Y_AXIS, DOWN);
 293
 294       // arrow's y-coord relative to the top of l stencil:
 295       Real y = -2.5;
 296       y -= j * (num_height + small_pad + big_pad);
 297       // horizontally center number on the arrow, excluding arrowhead.
 298       Offset num_off = Offset ((sp->distance () - num_len - head_len) / 2,
 299                                y + small_pad);
 300
 301       vector<Offset> pts;
 302       pts.push_back (Offset (0, y));
 303
 304       Offset p2 (sp->distance (), y);
 305       pts.push_back (p2);
 306
 307       Stencil id_stencil = Lookup::points_to_line_stencil (0.1, pts);
 308       id_stencil.add_stencil (arrowhead.translated (p2));
 309       id_stencil.add_stencil (number_stc->translated (num_off));
 310       // use a lighter shade of blue so it will remain legible on black background.
 311       id_stencil = id_stencil.in_color (0.2, 0.4, 1);
 312       l.add_stencil (id_stencil);
 313     }
 314
 315   for (SCM s = me->get_object ("minimum-distances");
 316        scm_is_pair (s); s = scm_cdr (s))
 317     {
 318       Real dist = scm_to_double (scm_cdar (s));
 319       Grob *other = unsmob_grob (scm_caar (s));
 320       if (!other || other->get_system () != me->get_system ())
 321         continue;
 322
 323       j++;
 324
 325       Stencil arrowhead (musfont->find_by_name ("arrowheads.open.01"));
 326       // initial scaling; it will also scale with font-size.
 327       arrowhead.scale (1, 1.66);
 328       Real head_len = arrowhead.extent (X_AXIS).length ();
 329
 330       SCM stil = Text_interface::interpret_markup (me->layout ()->self_scm (),
 331                                                    properties,
 332                                                    ly_string2scm (String_convert::form_string ("%5.2lf", dist)));
 333       Stencil *number_stc = unsmob_stencil (stil);
 334       number_stc->scale (1, 1.1);
 335       Real num_height = number_stc->extent (Y_AXIS).length ();
 336       Real num_len = number_stc->extent (X_AXIS).length ();
 337       number_stc->align_to (Y_AXIS, UP);
 338
 339       // arrow's y-coord relative to the top of l stencil:
 340       Real y = -3;
 341       y -= j * (num_height + small_pad + big_pad);
 342       // horizontally center number on the arrow, excluding arrowhead.
 343       Offset num_off = Offset ((dist - num_len - head_len) / 2,
 344                                y - small_pad);
 345
 346       vector<Offset> pts;
 347       pts.push_back (Offset (0, y));
 348
 349       Offset p2 (dist, y);
 350       pts.push_back (p2);
 351
 352       Stencil id_stencil = Lookup::points_to_line_stencil (0.1, pts);
 353       id_stencil.add_stencil (arrowhead.translated (p2));
 354       id_stencil.add_stencil (number_stc->translated (num_off));
 355       // use a lighter shade of red so it will remain legible on black background.
 356       id_stencil = id_stencil.in_color (1, 0.25, 0.25);
 357       l.add_stencil (id_stencil);
 358     }
 359   t.add_stencil (l);
 360   return t.smobbed_copy ();
 361 }
 362
 363 /*
 364   This is all too hairy. We use bounded-by-me to make sure that some
 365   columns are kept "alive". Unfortunately, when spanners are suicided,
 366   this falls apart again, because suicided spanners are still in
 367   bounded-by-me
 368
 369   THIS IS BROKEN KLUDGE. WE SHOULD INVENT SOMETHING BETTER.
 370 */
 371 MAKE_SCHEME_CALLBACK (Paper_column, before_line_breaking, 1);
 372 SCM
 373 Paper_column::before_line_breaking (SCM grob)
 374 {
 375   Grob *me = unsmob_grob (grob);
 376
 377   SCM bbm = me->get_object ("bounded-by-me");
 378   Grob_array *ga = unsmob_grob_array (bbm);
 379   if (!ga)
 380     return SCM_UNSPECIFIED;
 381
 382   vector<Grob *> &array (ga->array_reference ());
 383
 384   for (vsize i = array.size (); i--;)
 385     {
 386       Grob *g = array[i];
 387
 388       if (!g || !g->is_live ())
 389         /* UGH . potentially quadratic. */
 390         array.erase (array.begin () + i);
 391     }
 392
 393   return SCM_UNSPECIFIED;
 394 }
 395
 396 /* FIXME: This is a hack that we use to identify columns that used to
 397    contain note-heads but whose note-heads were moved by one of the ligature
 398    engravers. Once the ligature engravers are fixed to behave nicely, this
 399    function can be removed.
 400 */
 401 bool
 402 Paper_column::is_extraneous_column_from_ligature (Grob *me)
 403 {
 404   if (!is_musical (me))
 405     return false;
 406
 407   // If all the note-heads that I think are my children actually belong
 408   // to another column, then I am extraneous.
 409   extract_grob_set (me, "elements", elts);
 410   bool has_notehead = false;
 411   for (vsize i = 0; i < elts.size (); i++)
 412     {
 413       if (Rhythmic_head::has_interface (elts[i]))
 414         {
 415           has_notehead = true;
 416           if (dynamic_cast<Item *> (elts[i])->get_column () == me)
 417             return false;
 418         }
 419     }
 420   return has_notehead;
 421 }
 422
 423 ADD_INTERFACE (Paper_column,
 424                "@code{Paper_column} objects form the top-most X@tie{}parents"
 425                " for items.  There are two types of columns: musical and"
 426                " non-musical, to which musical and non-musical objects are"
 427                " attached respectively.  The spacing engine determines the"
 428                " X@tie{}positions of these objects.\n"
 429                "\n"
 430                "They are numbered, the first (leftmost) is column@tie{}0."
 431                "  Numbering happens before line breaking, and columns are not"
 432                " renumbered after line breaking.  Since many columns go"
 433                " unused, you should only use the rank field to get ordering"
 434                " information.  Two adjacent columns may have non-adjacent"
 435                " numbers.",
 436
 437                /* properties */
 438                "between-cols "
 439                "bounded-by-me "
 440                "full-measure-extra-space "
 441                "grace-spacing "
 442                "labels "
 443                "line-break-system-details "
 444                "line-break-penalty "
 445                "line-break-permission "
 446                "maybe-loose "
 447                "page-break-penalty "
 448                "page-break-permission "
 449                "page-turn-penalty "
 450                "page-turn-permission "
 451                "rhythmic-location "
 452                "shortest-playing-duration "
 453                "shortest-starter-duration "
 454                "spacing "
 455                "used "
 456                "when ");
 457