lily/break-alignment-interface.cc

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