lily/span-bar.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2012 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 "span-bar.hh"
  21
  22 #include "font-interface.hh"
  23 #include "dimensions.hh"
  24 #include "output-def.hh"
  25 #include "stencil.hh"
  26 #include "warn.hh"
  27 #include "axis-group-interface.hh"
  28 #include "bar-line.hh"
  29 #include "grob.hh"
  30 #include "pointer-group-interface.hh"
  31 #include "staff-symbol-referencer.hh"
  32
  33 void
  34 Span_bar::add_bar (Grob *me, Grob *b)
  35 {
  36   Pointer_group_interface::add_grob (me, ly_symbol2scm ("elements"), b);
  37 }
  38
  39 MAKE_SCHEME_CALLBACK (Span_bar, print, 1);
  40
  41 /* Limitations/Bugs:
  42
  43 (1) Elements from 'me->get_object ("elements")' must be
  44 ordered according to their y coordinates relative to their common
  45 axis group parent.  Otherwise, the computation goes mad.
  46
  47 (2) This method depends on bar_engraver not being removed from
  48 staff context.  If bar_engraver is removed, the size of the staff
  49 lines is evaluated as 0, which results in a solid span bar line
  50 with faulty y coordinate. */
  51
  52 /* This routine was originally by Juergen Reuter, but it was a on the
  53    bulky side. Rewritten by Han-Wen. */
  54 SCM
  55 Span_bar::print (SCM smobbed_me)
  56 {
  57   Grob *me = unsmob_grob (smobbed_me);
  58   extract_grob_set (me, "elements", elements);
  59   Grob *refp = common_refpoint_of_array (elements, me, Y_AXIS);
  60
  61   SCM glyph = me->get_property ("glyph-name");
  62
  63   /* glyph may not be a string, when ME is killed by Hara Kiri in
  64      between. */
  65   if (!scm_is_string (glyph))
  66     return SCM_EOL;
  67
  68   string glyph_string = ly_scm2string (glyph);
  69
  70   /* compose span_bar_mol */
  71   vector<Interval> extents;
  72   vector<bool> make_span_bar;
  73   Grob *model_bar = 0;
  74   for (vsize i = elements.size (); i--;)
  75     {
  76       Grob *bar = elements[i];
  77       Interval ext = Bar_line::bar_y_extent (bar, refp);
  78       if (Grob *staff = Staff_symbol_referencer::get_staff_symbol (bar))
  79         ext.unite (staff->extent (refp, Y_AXIS));
  80       if (ext.is_empty ())
  81         continue;
  82
  83       extents.push_back (ext);
  84       make_span_bar.push_back (to_boolean (bar->get_property ("allow-span-bar")));
  85       model_bar = bar;
  86     }
  87
  88   if (!model_bar)
  89     model_bar = me;
  90
  91   // Fixes problem with disappearing span bars when alignAboveContext is active
  92   vector_sort (extents, Interval::left_less);
  93
  94   Stencil span_bar;
  95   for (vsize i = 1; i < extents.size (); i++)
  96     {
  97       Interval prev_extent = extents[i - 1];
  98       Interval ext = extents[i];
  99       if (!prev_extent.is_empty ())
 100         {
 101           Interval l (prev_extent [UP],
 102                       ext[DOWN]);
 103
 104           if (l.is_empty () || !make_span_bar[i])
 105             {
 106               /* There is overlap between the bar lines.  Do nothing. */
 107             }
 108           else
 109             {
 110               Stencil interbar = Bar_line::compound_barline (model_bar,
 111                                                              glyph_string,
 112                                                              l,
 113                                                              false);
 114               span_bar.add_stencil (interbar);
 115             }
 116         }
 117       prev_extent = ext;
 118     }
 119
 120   span_bar.translate_axis (- me->relative_coordinate (refp, Y_AXIS),
 121                            Y_AXIS);
 122
 123   return span_bar.smobbed_copy ();
 124 }
 125
 126 MAKE_SCHEME_CALLBACK (Span_bar, width, 1);
 127 SCM
 128 Span_bar::width (SCM smob)
 129 {
 130   Grob *me = unsmob_grob (smob);
 131   SCM gn = me->get_property ("glyph-name");
 132   if (!me->is_live ())
 133     return ly_interval2scm (Interval ());
 134
 135   string gl = ly_scm2string (gn);
 136
 137   /*
 138     urg.
 139   */
 140   Stencil m
 141     = Bar_line::compound_barline (me, gl, Interval (-20 PT, 20 PT), false);
 142
 143   return ly_interval2scm (m.extent (X_AXIS));
 144 }
 145
 146 MAKE_SCHEME_CALLBACK (Span_bar, before_line_breaking, 1);
 147 SCM
 148 Span_bar::before_line_breaking (SCM smob)
 149 {
 150   Grob *me = unsmob_grob (smob);
 151   extract_grob_set (me, "elements", elements);
 152   if (elements.empty ())
 153     me->suicide ();
 154
 155   return SCM_UNSPECIFIED;
 156 }
 157
 158 MAKE_SCHEME_CALLBACK (Span_bar, center_on_spanned_callback, 1);
 159
 160 SCM
 161 Span_bar::center_on_spanned_callback (SCM smob)
 162 {
 163   Grob *me = unsmob_grob (smob);
 164   Interval i (get_spanned_interval (me));
 165
 166   /* Bar_line::print delivers a barline of y-extent (-h/2, h/2), so
 167      we have to translate ourselves to be in the center of the
 168      interval that we span. */
 169   if (i.is_empty ())
 170     {
 171       me->suicide ();
 172       return scm_from_double (0.0);
 173     }
 174
 175   return scm_from_double (i.center ());
 176 }
 177
 178 MAKE_SCHEME_CALLBACK (Span_bar, calc_glyph_name, 1);
 179 SCM
 180 Span_bar::calc_glyph_name (SCM smob)
 181 {
 182   Grob *me = unsmob_grob (smob);
 183   extract_grob_set (me, "elements", elements);
 184   SCM gl = SCM_EOL;
 185   for (vsize i = elements.size ();
 186        i-- && !scm_is_string (gl);)
 187     gl = elements[i]->get_property ("glyph-name");
 188
 189   if (!scm_is_string (gl))
 190     {
 191       me->suicide ();
 192       return SCM_UNSPECIFIED;
 193     }
 194
 195   string type = ly_scm2string (gl);
 196   if (type == "|:" || type == "||:")
 197     type = ".|";
 198   else if (type == ":|")
 199     type = "|.";
 200   else if (type == ":|:")
 201     type = ".|.";
 202   else if (type == ":|.|:")
 203     type = "|.|";
 204   else if (type == ":|.:")
 205     type = "|.";
 206   else if (type == "S" || type == "S|" || type == "|S")
 207     type = "||";
 208   else if (type == "S|:" || type == ".S|:")
 209     type = ".|";
 210   else if (type == ":|S" || type == ":|S.")
 211     type = "|.";
 212   else if (type == ":|S|:" || type == ":|S.|:")
 213     type = "|._.|";
 214   else if (type == "'")
 215     type = "";
 216
 217   return ly_string2scm (type);
 218 }
 219
 220 void
 221 Span_bar::notify_grobs_of_my_existence (Grob *me)
 222 {
 223   extract_grob_set (me, "elements", elts);
 224   vector<Grob *> sortable (elts.begin (), elts.end ());
 225   vector_sort (sortable, Grob::vertical_less);
 226   for (vsize i = 0; i < sortable.size (); i++)
 227     sortable[i]->set_property ("has-span-bar",
 228                                scm_cons (i != sortable.size () - 1 ? me->self_scm () : scm_from_bool (false),
 229                                          i != 0 ? me->self_scm () : scm_from_bool (false)));
 230 }
 231
 232 Interval
 233 Span_bar::get_spanned_interval (Grob *me)
 234 {
 235   return ly_scm2interval (Axis_group_interface::generic_group_extent (me, Y_AXIS));
 236 }
 237
 238 ADD_INTERFACE (Span_bar,
 239                "A bar line that is spanned between other barlines.  This"
 240                " interface is used for bar lines that connect different"
 241                " staves.",
 242
 243                /* properties */
 244                "glyph-name "
 245                "elements "
 246                "pure-Y-common "
 247                "pure-relevant-grobs "
 248                "pure-relevant-items "
 249                "pure-relevant-spanners "
 250               );
 251