lily/paper-column.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2011 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   Direction d = LEFT;
 172   do
 173     {
 174       Skyline_pair *sp = Skyline_pair::unsmob (cols[d]->get_property ("horizontal-skylines"));
 175       if (sp)
 176         skys[d] = (*sp)[-d];
 177     }
 178   while (flip (&d) != LEFT);
 179
 180   skys[RIGHT].merge (Separation_item::conditional_skyline (right, left));
 181
 182   return max (0.0, skys[LEFT].distance (skys[RIGHT]));
 183 }
 184
 185 Interval
 186 Paper_column::break_align_width (Grob *me, SCM align_sym)
 187 {
 188   Grob *p = me->get_parent (X_AXIS);
 189
 190   if (is_musical (me))
 191     {
 192       me->programming_error ("tried to get break-align-width of a musical column");
 193       return Interval (0, 0) + me->relative_coordinate (p, X_AXIS);
 194     }
 195
 196   Grob *align = 0;
 197   if (align_sym == ly_symbol2scm ("staff-bar")
 198       || align_sym == ly_symbol2scm ("break-alignment"))
 199     align
 200       = Pointer_group_interface::find_grob (me, ly_symbol2scm ("elements"),
 201                                             (align_sym == ly_symbol2scm ("staff-bar")
 202                                              ? Bar_line::non_empty_barline
 203                                              : Break_alignment_interface::has_interface));
 204   else
 205     {
 206       extract_grob_set (me, "elements", elts);
 207       for (vsize i = 0; i < elts.size (); i++)
 208         {
 209           if (elts[i]->get_property ("break-align-symbol") == align_sym)
 210             {
 211               align = elts[i];
 212               break;
 213             }
 214         }
 215     }
 216
 217   if (!align)
 218     return Interval (0, 0) + me->relative_coordinate (p, X_AXIS);
 219
 220   return align->extent (p, X_AXIS);
 221 }
 222
 223 /*
 224   Print a vertical line and  the rank number, to aid debugging.
 225 */
 226 MAKE_SCHEME_CALLBACK (Paper_column, print, 1);
 227 SCM
 228 Paper_column::print (SCM p)
 229 {
 230   Paper_column *me = dynamic_cast<Paper_column *> (unsmob_grob (p));
 231
 232   string r = to_string (Paper_column::get_rank (me));
 233
 234   Moment *mom = unsmob_moment (me->get_property ("when"));
 235   string when = mom ? mom->to_string () : "?/?";
 236
 237   Font_metric *musfont = Font_interface::get_default_font (me);
 238   SCM properties = Font_interface::text_font_alist_chain (me);
 239
 240   SCM scm_mol = Text_interface::interpret_markup (me->layout ()->self_scm (),
 241                                                   properties,
 242                                                   ly_string2scm (r));
 243   SCM when_mol = Text_interface::interpret_markup (me->layout ()->self_scm (),
 244                                                    properties,
 245                                                    ly_string2scm (when));
 246   Stencil t = *unsmob_stencil (scm_mol);
 247   t.add_at_edge (Y_AXIS, DOWN, *unsmob_stencil (when_mol), 0.1);
 248   t.align_to (X_AXIS, CENTER);
 249   t.align_to (Y_AXIS, DOWN);
 250
 251   Stencil l = Lookup::filled_box (Box (Interval (-0.01, 0.01),
 252                                        Interval (-2, -1)));
 253
 254   SCM small_letters = scm_cons (scm_acons (ly_symbol2scm ("font-size"),
 255                                            scm_from_int (-6), SCM_EOL),
 256                                 properties);
 257
 258   int j = 0;
 259   for (SCM s = me->get_object ("ideal-distances");
 260        scm_is_pair (s); s = scm_cdr (s))
 261     {
 262       Spring *sp = unsmob_spring (scm_caar (s));
 263       if (!unsmob_grob (scm_cdar (s))
 264           || !unsmob_grob (scm_cdar (s))->get_system ())
 265         continue;
 266
 267       j++;
 268       Real y = -j * 1 -3;
 269       vector<Offset> pts;
 270       pts.push_back (Offset (0, y));
 271
 272       Offset p2 (sp->distance (), y);
 273       pts.push_back (p2);
 274
 275       Stencil id_stencil = Lookup::points_to_line_stencil (0.1, pts);
 276       Stencil head (musfont->find_by_name ("arrowheads.open.01"));
 277
 278       SCM distance_stc = Text_interface::interpret_markup (me->layout ()->self_scm (),
 279                                                            small_letters,
 280                                                            ly_string2scm (String_convert::form_string ("%5.2lf", sp->distance ())));
 281
 282       id_stencil.add_stencil (unsmob_stencil (distance_stc)->translated (Offset (sp->distance () / 3, y + 1)));
 283       id_stencil.add_stencil (head.translated (p2));
 284       id_stencil = id_stencil.in_color (0,0,1);
 285       l.add_stencil (id_stencil);
 286     }
 287
 288   for (SCM s = me->get_object ("minimum-distances");
 289        scm_is_pair (s); s = scm_cdr (s))
 290     {
 291       Real dist = scm_to_double (scm_cdar (s));
 292       Grob *other = unsmob_grob (scm_caar (s));
 293       if (!other || other->get_system () != me->get_system ())
 294         continue;
 295
 296       j++;
 297
 298       Real y = -j * 1.0 -3.5;
 299       vector<Offset> pts;
 300       pts.push_back (Offset (0, y));
 301
 302       Offset p2 (dist, y);
 303       pts.push_back (p2);
 304
 305       Stencil id_stencil = Lookup::points_to_line_stencil (0.1, pts);
 306       Stencil head (musfont->find_by_name ("arrowheads.open.0M1"));
 307       head.translate_axis (y, Y_AXIS);
 308       id_stencil.add_stencil (head);
 309
 310       SCM distance_stc = Text_interface::interpret_markup (me->layout ()->self_scm (),
 311                                                            small_letters,
 312                                                            ly_string2scm (String_convert::form_string ("%5.2lf",
 313                                                                                                        dist)));
 314
 315       id_stencil.add_stencil (unsmob_stencil (distance_stc)->translated (Offset (dist / 3, y - 1)));
 316
 317       id_stencil = id_stencil.in_color (1,0,0);
 318       l.add_stencil (id_stencil);
 319     }
 320   t.add_stencil (l);
 321   return t.smobbed_copy ();
 322 }
 323
 324 /*
 325   This is all too hairy. We use bounded-by-me to make sure that some
 326   columns are kept "alive". Unfortunately, when spanners are suicided,
 327   this falls apart again, because suicided spanners are still in
 328   bounded-by-me
 329
 330   THIS IS BROKEN KLUDGE. WE SHOULD INVENT SOMETHING BETTER.
 331 */
 332 MAKE_SCHEME_CALLBACK (Paper_column, before_line_breaking, 1);
 333 SCM
 334 Paper_column::before_line_breaking (SCM grob)
 335 {
 336   Grob *me = unsmob_grob (grob);
 337
 338   SCM bbm = me->get_object ("bounded-by-me");
 339   Grob_array *ga = unsmob_grob_array (bbm);
 340   if (!ga)
 341     return SCM_UNSPECIFIED;
 342
 343   vector<Grob *> &array (ga->array_reference ());
 344
 345   for (vsize i = array.size (); i--;)
 346     {
 347       Grob *g = array[i];
 348
 349       if (!g || !g->is_live ())
 350         /* UGH . potentially quadratic. */
 351         array.erase (array.begin () + i);
 352     }
 353
 354   return SCM_UNSPECIFIED;
 355 }
 356
 357 /* FIXME: This is a hack that we use to identify columns that used to
 358    contain note-heads but whose note-heads were moved by one of the ligature
 359    engravers. Once the ligature engravers are fixed to behave nicely, this
 360    function can be removed.
 361 */
 362 bool
 363 Paper_column::is_extraneous_column_from_ligature (Grob *me)
 364 {
 365   if (!is_musical (me))
 366     return false;
 367
 368   // If all the note-heads that I think are my children actually belong
 369   // to another column, then I am extraneous.
 370   extract_grob_set (me, "elements", elts);
 371   bool has_notehead = false;
 372   for (vsize i = 0; i < elts.size (); i++)
 373     {
 374       if (Rhythmic_head::has_interface (elts[i]))
 375         {
 376           has_notehead = true;
 377           if (dynamic_cast<Item *> (elts[i])->get_column () == me)
 378             return false;
 379         }
 380     }
 381   return has_notehead;
 382 }
 383
 384 ADD_INTERFACE (Paper_column,
 385                "@code{Paper_column} objects form the top-most X@tie{}parents"
 386                " for items.  There are two types of columns: musical and"
 387                " non-musical, to which musical and non-musical objects are"
 388                " attached respectively.  The spacing engine determines the"
 389                " X@tie{}positions of these objects.\n"
 390                "\n"
 391                "They are numbered, the first (leftmost) is column@tie{}0."
 392                "  Numbering happens before line breaking, and columns are not"
 393                " renumbered after line breaking.  Since many columns go"
 394                " unused, you should only use the rank field to get ordering"
 395                " information.  Two adjacent columns may have non-adjacent"
 396                " numbers.",
 397
 398                /* properties */
 399                "between-cols "
 400                "bounded-by-me "
 401                "full-measure-extra-space "
 402                "grace-spacing "
 403                "labels "
 404                "line-break-system-details "
 405                "line-break-penalty "
 406                "line-break-permission "
 407                "maybe-loose "
 408                "page-break-penalty "
 409                "page-break-permission "
 410                "page-turn-penalty "
 411                "page-turn-permission "
 412                "rhythmic-location "
 413                "shortest-playing-duration "
 414                "shortest-starter-duration "
 415                "spacing "
 416                "used "
 417                "when ");
 418