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