lily/paper-column.cc

   1 /*
   2   paper-column.cc -- implement Paper_column
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #include "paper-column.hh"
  10
  11 #include "break-align-interface.hh"
  12 #include "moment.hh"
  13 #include "paper-score.hh"
  14 #include "warn.hh"
  15 #include "axis-group-interface.hh"
  16 #include "spaceable-grob.hh"
  17 #include "text-interface.hh"
  18 #include "lookup.hh"
  19 #include "font-interface.hh"
  20 #include "output-def.hh"
  21 #include "pointer-group-interface.hh"
  22 #include "grob-array.hh"
  23 #include "system.hh"
  24 #include "spring.hh"
  25 #include "lookup.hh"
  26 #include "separation-item.hh"
  27 #include "string-convert.hh"
  28
  29 Grob *
  30 Paper_column::clone () const
  31 {
  32   return new Paper_column (*this);
  33 }
  34
  35 void
  36 Paper_column::do_break_processing ()
  37 {
  38   Item::do_break_processing ();
  39 }
  40
  41 int
  42 Paper_column::get_rank (Grob const *me)
  43 {
  44   return dynamic_cast<Paper_column const *> (me)->rank_;
  45 }
  46
  47 System *
  48 Paper_column::get_system () const
  49 {
  50   return system_;
  51 }
  52
  53 void
  54 Paper_column::set_system (System *s)
  55 {
  56   system_ = s;
  57 }
  58
  59 Paper_column *
  60 Paper_column::get_column () const
  61 {
  62   return (Paper_column *) (this);
  63 }
  64
  65 Paper_column::Paper_column (SCM l)
  66   : Item (l)
  67 {
  68   system_ = 0;
  69   rank_ = -1;
  70 }
  71
  72 Paper_column::Paper_column (Paper_column const &src)
  73   : Item (src)
  74 {
  75   system_ = 0;
  76   rank_ = src.rank_;
  77 }
  78
  79 int
  80 Paper_column::compare (Grob * const &a,
  81                        Grob * const &b)
  82 {
  83   return sign (dynamic_cast<Paper_column*> (a)->rank_
  84                - dynamic_cast<Paper_column*> (b)->rank_);
  85 }
  86
  87 bool
  88 Paper_column::less_than (Grob *const &a,
  89                          Grob *const &b)
  90 {
  91   Paper_column *pa = dynamic_cast<Paper_column*> (a);
  92   Paper_column *pb = dynamic_cast<Paper_column*> (b);
  93
  94   return pa->rank_ < pb->rank_;
  95 }
  96
  97 Moment
  98 Paper_column::when_mom (Grob *me)
  99 {
 100   SCM m = me->get_property ("when");
 101   if (Moment *when = unsmob_moment (m))
 102     return *when;
 103   return Moment (0);
 104 }
 105
 106 bool
 107 Paper_column::is_musical (Grob *me)
 108 {
 109   SCM m = me->get_property ("shortest-starter-duration");
 110   Moment s (0);
 111   if (unsmob_moment (m))
 112     s = *unsmob_moment (m);
 113   return s != Moment (0);
 114 }
 115
 116 bool
 117 Paper_column::is_used (Grob *me)
 118 {
 119   extract_grob_set (me, "elements", elts);
 120   if (elts.size ())
 121     return true;
 122
 123   extract_grob_set (me, "bounded-by-me", bbm);
 124   if (bbm.size ())
 125     return true;
 126
 127   if (Paper_column::is_breakable (me))
 128     return true;
 129
 130   if (to_boolean (me->get_property ("used")))
 131     return true;
 132   return false;
 133 }
 134
 135 bool
 136 Paper_column::is_breakable (Grob *me)
 137 {
 138   return scm_is_symbol (me->get_property ("line-break-permission"));
 139 }
 140
 141 Real
 142 Paper_column::minimum_distance (Grob *left, Grob *right)
 143 {
 144   Drul_array<Grob*> cols (left, right);
 145   Drul_array<Skyline> skys = Drul_array<Skyline> (Skyline (RIGHT), Skyline (LEFT));
 146
 147   Direction d = LEFT;
 148   do
 149     {
 150       Skyline_pair *sp = Skyline_pair::unsmob (cols[d]->get_property ("horizontal-skylines"));
 151       if (sp)
 152         skys[d] = (*sp)[-d];
 153     }
 154   while (flip (&d) != LEFT);
 155
 156   skys[RIGHT].merge (Separation_item::conditional_skyline (right, left));
 157
 158   return max (0.0, skys[LEFT].distance (skys[RIGHT]));
 159 }
 160
 161 Interval
 162 Paper_column::break_align_width (Grob *me)
 163 {
 164   Grob *p = me->get_parent (X_AXIS);
 165
 166   if (is_musical (me))
 167     {
 168       me->programming_error ("tried to get break-align-width of a non-musical column");
 169       return Interval (0, 0) + me->relative_coordinate (p, X_AXIS);
 170     }
 171
 172   Grob *align = Pointer_group_interface::find_grob (me, ly_symbol2scm ("elements"),
 173                                                     Break_alignment_interface::has_interface);
 174   if (!align)
 175     return Interval (0, 0) + me->relative_coordinate (p, X_AXIS);
 176
 177   return align->extent (p, X_AXIS);
 178 }
 179
 180 /*
 181   Print a vertical line and  the rank number, to aid debugging.
 182 */
 183 MAKE_SCHEME_CALLBACK (Paper_column, print, 1);
 184 SCM
 185 Paper_column::print (SCM p)
 186 {
 187   Paper_column *me = dynamic_cast<Paper_column*> (unsmob_grob (p));
 188
 189   string r = to_string (Paper_column::get_rank (me));
 190
 191   Moment *mom = unsmob_moment (me->get_property ("when"));
 192   string when = mom ? mom->to_string () : "?/?";
 193
 194   Font_metric *musfont = Font_interface::get_default_font (me);
 195   SCM properties = Font_interface::text_font_alist_chain (me);
 196
 197   SCM scm_mol = Text_interface::interpret_markup (me->layout ()->self_scm (),
 198                                                   properties,
 199                                                   ly_string2scm (r));
 200   SCM when_mol = Text_interface::interpret_markup (me->layout ()->self_scm (),
 201                                                    properties,
 202                                                    ly_string2scm (when));
 203   Stencil t = *unsmob_stencil (scm_mol);
 204   t.add_at_edge (Y_AXIS, DOWN, *unsmob_stencil (when_mol), 0.1);
 205   t.align_to (X_AXIS, CENTER);
 206   t.align_to (Y_AXIS, DOWN);
 207
 208   Stencil l = Lookup::filled_box (Box (Interval (-0.01, 0.01),
 209                                        Interval (-2, -1)));
 210
 211   SCM small_letters = scm_cons (scm_acons (ly_symbol2scm ("font-size"),
 212                                            scm_from_int (-6), SCM_EOL),
 213                                 properties);
 214
 215   int j = 0;
 216   for (SCM s = me->get_object ("ideal-distances");
 217        scm_is_pair (s); s = scm_cdr (s))
 218     {
 219       Spring *sp = unsmob_spring (scm_caar (s));
 220       if (!unsmob_grob (scm_cdar (s))
 221           || !unsmob_grob (scm_cdar (s))->get_system ())
 222         continue;
 223
 224       j++;
 225       Real y = -j * 1 -3;
 226       vector<Offset> pts;
 227       pts.push_back (Offset (0, y));
 228
 229       Offset p2 (sp->distance (), y);
 230       pts.push_back (p2);
 231
 232       Stencil id_stencil = Lookup::points_to_line_stencil (0.1, pts);
 233       Stencil head (musfont->find_by_name ("arrowheads.open.01"));
 234
 235       SCM distance_stc = Text_interface::interpret_markup (me->layout ()->self_scm (),
 236                                                            small_letters,
 237                                                            ly_string2scm (String_convert::form_string ("%5.2lf", sp->distance ())));
 238
 239       id_stencil.add_stencil (unsmob_stencil (distance_stc)->translated (Offset (sp->distance ()/3, y+1)));
 240       id_stencil.add_stencil (head.translated (p2));
 241       id_stencil = id_stencil.in_color (0,0,1);
 242       l.add_stencil (id_stencil);
 243     }
 244
 245   for (SCM s = me->get_object ("minimum-distances");
 246        scm_is_pair (s); s = scm_cdr (s))
 247     {
 248       Real dist = scm_to_double (scm_cdar (s));
 249       Grob *other =  unsmob_grob (scm_caar (s));
 250       if (!other || other->get_system () != me->get_system ())
 251         continue;
 252
 253       j++;
 254
 255       Real y = -j * 1.0 -3.5;
 256       vector<Offset> pts;
 257       pts.push_back (Offset (0, y));
 258
 259       Offset p2 (dist, y);
 260       pts.push_back (p2);
 261
 262       Stencil id_stencil = Lookup::points_to_line_stencil (0.1, pts);
 263       Stencil head (musfont->find_by_name ("arrowheads.open.0M1"));
 264       head.translate_axis (y, Y_AXIS);
 265       id_stencil.add_stencil (head);
 266
 267       SCM distance_stc = Text_interface::interpret_markup (me->layout ()->self_scm (),
 268                                                            small_letters,
 269                                                            ly_string2scm (String_convert::form_string ("%5.2lf",
 270                                                                                                        dist)));
 271
 272       id_stencil.add_stencil (unsmob_stencil (distance_stc)->translated (Offset (dist/3, y-1)));
 273
 274
 275       id_stencil = id_stencil.in_color (1,0,0);
 276       l.add_stencil (id_stencil);
 277     }
 278   t.add_stencil (l);
 279   return t.smobbed_copy ();
 280 }
 281
 282 /*
 283   This is all too hairy. We use bounded-by-me to make sure that some
 284   columns are kept "alive". Unfortunately, when spanners are suicided,
 285   this falls apart again, because suicided spanners are still in
 286   bounded-by-me
 287
 288   THIS IS BROKEN KLUDGE. WE SHOULD INVENT SOMETHING BETTER.
 289 */
 290 MAKE_SCHEME_CALLBACK (Paper_column, before_line_breaking, 1);
 291 SCM
 292 Paper_column::before_line_breaking (SCM grob)
 293 {
 294   Grob *me = unsmob_grob (grob);
 295
 296   SCM bbm = me->get_object ("bounded-by-me");
 297   Grob_array *ga = unsmob_grob_array (bbm);
 298   if (!ga)
 299     return SCM_UNSPECIFIED;
 300
 301   vector<Grob*> &array (ga->array_reference ());
 302
 303   for (vsize i = array.size (); i--;)
 304     {
 305       Grob *g = array[i];
 306
 307       if (!g || !g->is_live ())
 308         /* UGH . potentially quadratic. */
 309         array.erase (array.begin () + i);
 310     }
 311
 312   return SCM_UNSPECIFIED;
 313 }
 314
 315
 316 ADD_INTERFACE (Paper_column,
 317                "@code{Paper_column} objects form the top-most X@tie{}parents"
 318                " for items.  There are two types of columns: musical columns,"
 319                " where are attached to, and non-musical columns, where"
 320                " bar-lines, clefs, etc., are attached to.  The spacing engine"
 321                " determines the X@tie{}positions of these objects.\n"
 322                "\n"
 323                "They are numbered, the first (leftmost) is column@tie{}0."
 324                "  Numbering happens before line breaking, and columns are not"
 325                " renumbered after line breaking.  Since many columns go"
 326                " unused, you should only use the rank field to get ordering"
 327                " information.  Two adjacent columns may have non-adjacent"
 328                " numbers.",
 329
 330                /* properties */
 331                "between-cols "
 332                "bounded-by-me "
 333                "grace-spacing "
 334                "labels "
 335                "line-break-system-details "
 336                "line-break-penalty "
 337                "line-break-permission "
 338                "page-break-penalty "
 339                "page-break-permission "
 340                "page-turn-penalty "
 341                "page-turn-permission "
 342                "rhythmic-location "
 343                "shortest-playing-duration "
 344                "shortest-starter-duration "
 345                "spacing "
 346                "used "
 347                "when "
 348                );
 349