lily/break-alignment-interface.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 "break-align-interface.hh"
  21
  22 #include "align-interface.hh"
  23 #include "axis-group-interface.hh"
  24 #include "dimensions.hh"
  25 #include "international.hh"
  26 #include "output-def.hh"
  27 #include "paper-column.hh"
  28 #include "pointer-group-interface.hh"
  29 #include "self-alignment-interface.hh"
  30 #include "side-position-interface.hh"
  31 #include "warn.hh"
  32
  33 /*
  34   This is tricky: we cannot modify 'elements, since callers are
  35   iterating the same list. Reordering the list in-place, or resetting
  36   'elements will skip elements in the loops of callers.
  37
  38   So we return the correct order as an array.
  39 */
  40 SCM
  41 Break_alignment_interface::break_align_order (Item *me)
  42 {
  43   SCM order_vec = me->get_property ("break-align-orders");
  44   if (!scm_is_vector (order_vec)
  45       || scm_c_vector_length (order_vec) < 3)
  46     return SCM_BOOL_F;
  47
  48   SCM order = scm_vector_ref (order_vec,
  49                               scm_from_int (me->break_status_dir () + 1));
  50
  51   return order;
  52 }
  53
  54 vector<Grob *>
  55 Break_alignment_interface::ordered_elements (Grob *grob)
  56 {
  57   Item *me = dynamic_cast<Item *> (grob);
  58   extract_grob_set (me, "elements", elts);
  59
  60   SCM order = break_align_order (me);
  61
  62   if (order == SCM_BOOL_F)
  63     return elts;
  64
  65   vector<Grob *> writable_elts (elts);
  66   /*
  67    Copy in order specified in BREAK-ALIGN-ORDER.
  68   */
  69   vector<Grob *> new_elts;
  70   for (; scm_is_pair (order); order = scm_cdr (order))
  71     {
  72       SCM sym = scm_car (order);
  73
  74       for (vsize i = writable_elts.size (); i--;)
  75         {
  76           Grob *g = writable_elts[i];
  77           if (g && sym == g->get_property ("break-align-symbol"))
  78             {
  79               new_elts.push_back (g);
  80               writable_elts.erase (writable_elts.begin () + i);
  81             }
  82         }
  83     }
  84
  85   return new_elts;
  86 }
  87
  88 void
  89 Break_alignment_interface::add_element (Grob *me, Grob *toadd)
  90 {
  91   Align_interface::add_element (me, toadd);
  92 }
  93
  94 MAKE_SCHEME_CALLBACK (Break_alignment_interface, calc_positioning_done, 1)
  95 SCM
  96 Break_alignment_interface::calc_positioning_done (SCM smob)
  97 {
  98   Grob *grob = unsmob_grob (smob);
  99   Item *me = dynamic_cast<Item *> (grob);
 100
 101   me->set_property ("positioning-done", SCM_BOOL_T);
 102
 103   vector<Grob *> elems = ordered_elements (me);
 104   vector<Interval> extents;
 105
 106   int last_nonempty = -1;
 107   for (vsize i = 0; i < elems.size (); i++)
 108     {
 109       Interval y = elems[i]->extent (elems[i], X_AXIS);
 110       extents.push_back (y);
 111       if (!y.is_empty ())
 112         last_nonempty = i;
 113     }
 114
 115   vsize idx = 0;
 116   while (idx < extents.size () && extents[idx].is_empty ())
 117     idx++;
 118
 119   vector<Real> offsets;
 120   offsets.resize (elems.size ());
 121   for (vsize i = 0; i < offsets.size (); i++)
 122     offsets[i] = 0.0;
 123
 124   Real extra_right_space = 0.0;
 125   vsize edge_idx = VPOS;
 126   while (idx < elems.size ())
 127     {
 128       vsize next_idx = idx + 1;
 129       while (next_idx < elems.size ()
 130              && extents[next_idx].is_empty ())
 131         next_idx++;
 132
 133       Grob *l = elems[idx];
 134       Grob *r = 0;
 135
 136       if (next_idx < elems.size ())
 137         r = elems[next_idx];
 138
 139       SCM alist = SCM_EOL;
 140
 141       /*
 142         Find the first grob with a space-alist entry.
 143       */
 144       extract_grob_set (l, "elements", elts);
 145
 146       for (vsize i = elts.size (); i--;)
 147         {
 148           Grob *elt = elts[i];
 149
 150           if (edge_idx == VPOS
 151               && (elt->get_property ("break-align-symbol")
 152                   == ly_symbol2scm ("left-edge")))
 153             edge_idx = idx;
 154
 155           SCM l = elt->get_property ("space-alist");
 156           if (scm_is_pair (l))
 157             {
 158               alist = l;
 159               break;
 160             }
 161         }
 162
 163       SCM rsym = r ? SCM_EOL : ly_symbol2scm ("right-edge");
 164
 165       /*
 166         We used to use #'cause to find out the symbol and the spacing
 167         table, but that gets icky when that grob is suicided for some
 168         reason.
 169       */
 170       if (r)
 171         {
 172           extract_grob_set (r, "elements", elts);
 173           for (vsize i = elts.size ();
 174                !scm_is_symbol (rsym) && i--;)
 175             {
 176               Grob *elt = elts[i];
 177               rsym = elt->get_property ("break-align-symbol");
 178             }
 179         }
 180
 181       if (rsym == ly_symbol2scm ("left-edge"))
 182         edge_idx = next_idx;
 183
 184       SCM entry = SCM_EOL;
 185       if (scm_is_symbol (rsym))
 186         entry = scm_assq (rsym, alist);
 187
 188       bool entry_found = scm_is_pair (entry);
 189       if (!entry_found)
 190         {
 191           string sym_string;
 192           if (scm_is_symbol (rsym))
 193             sym_string = ly_symbol2string (rsym);
 194
 195           string orig_string;
 196           if (unsmob_grob (l->get_property ("cause")))
 197             orig_string = unsmob_grob (l->get_property ("cause"))->name ();
 198
 199           programming_error (_f ("No spacing entry from %s to `%s'",
 200                                  orig_string.c_str (),
 201                                  sym_string.c_str ()));
 202         }
 203
 204       Real distance = 1.0;
 205       SCM type = ly_symbol2scm ("extra-space");
 206
 207       if (entry_found)
 208         {
 209           entry = scm_cdr (entry);
 210
 211           distance = scm_to_double (scm_cdr (entry));
 212           type = scm_car (entry);
 213         }
 214
 215       if (r)
 216         {
 217           if (type == ly_symbol2scm ("extra-space"))
 218             offsets[next_idx] = extents[idx][RIGHT] + distance
 219                                 - extents[next_idx][LEFT];
 220           /* should probably junk minimum-space */
 221           else if (type == ly_symbol2scm ("minimum-space"))
 222             offsets[next_idx] = max (extents[idx][RIGHT], distance);
 223         }
 224       else
 225         {
 226           extra_right_space = distance;
 227           if (idx + 1 < offsets.size ())
 228             offsets[idx + 1] = extents[idx][RIGHT] + distance;
 229         }
 230
 231       idx = next_idx;
 232     }
 233
 234   Real here = 0.0;
 235   Interval total_extent;
 236
 237   Real alignment_off = 0.0;
 238   for (vsize i = 0; i < offsets.size (); i++)
 239     {
 240       here += offsets[i];
 241       if (i == edge_idx)
 242         alignment_off = -here;
 243       total_extent.unite (extents[i] + here);
 244     }
 245
 246   if (total_extent.is_empty ())
 247     return SCM_BOOL_T;
 248
 249   if (me->break_status_dir () == LEFT)
 250     alignment_off = -total_extent[RIGHT] - extra_right_space;
 251   else if (edge_idx == VPOS)
 252     alignment_off = -total_extent[LEFT];
 253
 254   here = alignment_off;
 255   for (vsize i = 0; i < offsets.size (); i++)
 256     {
 257       here += offsets[i];
 258       elems[i]->translate_axis (here, X_AXIS);
 259     }
 260
 261   return SCM_BOOL_T;
 262 }
 263
 264 MAKE_SCHEME_CALLBACK (Break_alignable_interface, self_align_callback, 1)
 265 SCM
 266 Break_alignable_interface::self_align_callback (SCM grob)
 267 {
 268   Grob *me = unsmob_grob (grob);
 269   Item *alignment = dynamic_cast<Item *> (me->get_parent (X_AXIS));
 270   if (!Break_alignment_interface::has_interface (alignment))
 271     return scm_from_int (0);
 272
 273   SCM symbol_list = me->get_property ("break-align-symbols");
 274   vector<Grob *> elements = Break_alignment_interface::ordered_elements (alignment);
 275   if (elements.size () == 0)
 276     return scm_from_int (0);
 277
 278   int break_aligned_grob = -1;
 279   for (; scm_is_pair (symbol_list); symbol_list = scm_cdr (symbol_list))
 280     {
 281       SCM sym = scm_car (symbol_list);
 282       for (vsize i = 0; i < elements.size (); i++)
 283         {
 284           if (elements[i]->get_property ("break-align-symbol") == sym)
 285             {
 286               if (Item::break_visible (elements[i])
 287                   && !elements[i]->extent (elements[i], X_AXIS).is_empty ())
 288                 {
 289                   break_aligned_grob = i;
 290                   goto found_break_aligned_grob; /* ugh. need to break out of 2 loops */
 291                 }
 292               else if (break_aligned_grob == -1)
 293                 break_aligned_grob = i;
 294             }
 295         }
 296     }
 297
 298 found_break_aligned_grob:
 299   if (break_aligned_grob == -1)
 300     return scm_from_int (0);
 301
 302   Grob *alignment_parent = elements[break_aligned_grob];
 303   Grob *common = me->common_refpoint (alignment_parent, X_AXIS);
 304   Real anchor = robust_scm2double (alignment_parent->get_property ("break-align-anchor"), 0);
 305
 306   return scm_from_double (alignment_parent->relative_coordinate (common, X_AXIS)
 307                           - me->relative_coordinate (common, X_AXIS)
 308                           + anchor);
 309 }
 310
 311 MAKE_SCHEME_CALLBACK (Break_aligned_interface, calc_average_anchor, 1)
 312 SCM
 313 Break_aligned_interface::calc_average_anchor (SCM grob)
 314 {
 315   Grob *me = unsmob_grob (grob);
 316   Real avg = 0.0;
 317   int count = 0;
 318
 319   /* average the anchors of those children that have it set */
 320   extract_grob_set (me, "elements", elts);
 321   for (vsize i = 0; i < elts.size (); i++)
 322     {
 323       SCM anchor = elts[i]->get_property ("break-align-anchor");
 324       if (scm_is_number (anchor))
 325         {
 326           count++;
 327           avg += scm_to_double (anchor);
 328         }
 329     }
 330
 331   return scm_from_double (count > 0 ? avg / count : 0);
 332 }
 333
 334 MAKE_SCHEME_CALLBACK (Break_aligned_interface, calc_extent_aligned_anchor, 1)
 335 SCM
 336 Break_aligned_interface::calc_extent_aligned_anchor (SCM smob)
 337 {
 338   Grob *me = unsmob_grob (smob);
 339   Real alignment = robust_scm2double (me->get_property ("break-align-anchor-alignment"), 0.0);
 340   Interval iv = me->extent (me, X_AXIS);
 341
 342   if (isinf (iv[LEFT]) && isinf (iv[RIGHT])) /* avoid NaN */
 343     return scm_from_double (0.0);
 344
 345   return scm_from_double (iv.linear_combination (alignment));
 346 }
 347
 348 MAKE_SCHEME_CALLBACK (Break_aligned_interface, calc_break_visibility, 1)
 349 SCM
 350 Break_aligned_interface::calc_break_visibility (SCM smob)
 351 {
 352   /* a BreakAlignGroup is break-visible if it has one element that is break-visible */
 353   Grob *me = unsmob_grob (smob);
 354   SCM ret = scm_c_make_vector (3, SCM_EOL);
 355   extract_grob_set (me, "elements", elts);
 356   for (int dir = 0; dir <= 2; dir++)
 357     {
 358       bool visible = false;
 359       for (vsize i = 0; i < elts.size (); i++)
 360         {
 361           SCM vis = elts[i]->get_property ("break-visibility");
 362           if (scm_is_vector (vis) && to_boolean (scm_c_vector_ref (vis, dir)))
 363             visible = true;
 364         }
 365       scm_c_vector_set_x (ret, dir, scm_from_bool (visible));
 366     }
 367   return ret;
 368 }
 369
 370 ADD_INTERFACE (Break_alignable_interface,
 371                "Object that is aligned on a break alignment.",
 372
 373                /* properties */
 374                "break-align-symbols "
 375                "non-break-align-symbols "
 376               );
 377
 378 ADD_INTERFACE (Break_aligned_interface,
 379                "Items that are aligned in prefatory matter.\n"
 380                "\n"
 381                "The spacing of these items is controlled by the"
 382                " @code{space-alist} property.  It contains a list"
 383                " @code{break-align-symbol}s with a specification of the"
 384                " associated space.  The space specification can be\n"
 385                "\n"
 386                "@table @code\n"
 387                "@item (minimum-space . @var{spc}))\n"
 388                "Pad space until the distance is @var{spc}.\n"
 389                "@item (fixed-space . @var{spc})\n"
 390                "Set a fixed space.\n"
 391                "@item (semi-fixed-space . @var{spc})\n"
 392                "Set a space.  Half of it is fixed and half is stretchable."
 393                " (does not work at start of line. fixme)\n"
 394                "@item (extra-space . @var{spc})\n"
 395                "Add @var{spc} amount of space.\n"
 396                "@end table\n"
 397                "\n"
 398                "Special keys for the alist are @code{first-note} and"
 399                " @code{next-note}, signifying the first note on a line, and"
 400                " the next note halfway a line.\n"
 401                "\n"
 402                "Rules for this spacing are much more complicated than this."
 403                "  See [Wanske] page 126--134, [Ross] page 143--147.",
 404
 405                /* properties */
 406                "break-align-anchor "
 407                "break-align-anchor-alignment "
 408                "break-align-symbol "
 409                "space-alist "
 410               );
 411
 412 ADD_INTERFACE (Break_alignment_interface,
 413                "The object that performs break alignment.  See"
 414                " @ref{break-aligned-interface}.",
 415
 416                /* properties */
 417                "positioning-done "
 418                "break-align-orders "
 419               );