lily/span-bar.cc

   1 /*
   2   span-bar.cc -- implement Span_bar
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c)  1997--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9 #include "span-bar.hh"
  10 #include "font-interface.hh"
  11 #include "dimensions.hh"
  12 #include "paper-def.hh"
  13 #include "molecule.hh"
  14 #include "warn.hh"
  15 #include "axis-group-interface.hh"
  16 #include "group-interface.hh"
  17 #include "grob.hh"
  18 #include "bar.hh"
  19
  20 void
  21 Span_bar::add_bar (Grob*me, Grob*b)
  22 {
  23   Pointer_group_interface::add_element (me,"elements", b);
  24
  25   me->add_dependency (b);
  26 }
  27
  28 MAKE_SCHEME_CALLBACK (Span_bar,brew_molecule,1);
  29
  30 /**
  31  * Limitations/Bugs:
  32  *
  33  * (1) Elements from 'me->get_grob_property ("elements")' must be
  34  * ordered according to their y coordinates relative to their common
  35  * axis group parent.  Otherwise, the computation goes mad.  (TODO:
  36  * apply a sort algorithm that ensures this precondition.)  However,
  37  * until now, I have seen no case where lily has not fulfilled this
  38  * precondition.
  39  *
  40  * (2) This method depends on bar_engraver not being removed from
  41  * staff context.  If bar_engraver is removed, the size of the staff
  42  * lines is evaluated as 0, which results in a solid span bar line
  43  * with faulty y coordinate.
  44  */
  45
  46 /*
  47   This routine was originally by Juergen Reuter, but it was a on the
  48   bulky side. Rewritten by Han-Wen.
  49  */
  50 SCM
  51 Span_bar::brew_molecule (SCM smobbed_me)
  52 {
  53   Grob *me = unsmob_grob (smobbed_me);
  54   SCM first_elt = me->get_grob_property ("elements");
  55
  56   // compute common refpoint of elements
  57   Grob *refp = me;
  58   for (SCM elts = first_elt; gh_pair_p (elts); elts = gh_cdr (elts))
  59     {
  60       SCM smobbed_staff_bar = gh_car (elts);
  61       Grob *staff_bar = unsmob_grob (smobbed_staff_bar);
  62       refp = staff_bar->common_refpoint (refp, Y_AXIS);
  63     }
  64
  65   // evaluate glyph
  66   Span_bar::evaluate_glyph(me);
  67   SCM glyph = me->get_grob_property (ly_symbol2scm ("glyph"));
  68   String glyph_str = ly_scm2string (glyph);
  69
  70   // compose span_bar_mol
  71   Molecule span_bar_mol;
  72   Grob *prev_staff_bar = 0;
  73   for (SCM elts = first_elt; gh_pair_p (elts); elts = gh_cdr (elts))
  74     {
  75       SCM smobbed_staff_bar = gh_car (elts);
  76       Grob *staff_bar = unsmob_grob (smobbed_staff_bar);
  77       if (prev_staff_bar)
  78         {
  79           Interval l(prev_staff_bar->extent (refp, Y_AXIS)[UP],
  80                      staff_bar->extent (refp, Y_AXIS)[DOWN]);
  81
  82           Molecule interbar
  83             = Bar::compound_barline (staff_bar, glyph_str, l.length());
  84           interbar.translate_axis (l.center (), Y_AXIS);
  85           span_bar_mol.add_molecule (interbar);
  86         }
  87       prev_staff_bar = staff_bar;
  88     }
  89
  90   span_bar_mol.translate_axis (- me->relative_coordinate (refp, Y_AXIS), Y_AXIS);
  91
  92   return span_bar_mol.smobbed_copy ();
  93 }
  94
  95 MAKE_SCHEME_CALLBACK (Span_bar,width_callback,2);
  96 SCM
  97 Span_bar::width_callback (SCM element_smob, SCM scm_axis)
  98 {
  99   Grob *se = unsmob_grob (element_smob);
 100   Axis a = (Axis) gh_scm2int (scm_axis);
 101   assert (a == X_AXIS);
 102   String gl = ly_scm2string (se->get_grob_property ("glyph"));
 103
 104   /*
 105     urg.
 106   */
 107   Molecule m = Bar::compound_barline (se, gl, 40 PT);
 108
 109   return ly_interval2scm (m.extent (X_AXIS));
 110 }
 111
 112 MAKE_SCHEME_CALLBACK (Span_bar,before_line_breaking,1);
 113 SCM
 114 Span_bar::before_line_breaking (SCM smob)
 115 {
 116   evaluate_empty (unsmob_grob (smob));
 117   evaluate_glyph (unsmob_grob (smob));
 118
 119   /*
 120     no need to call   Bar::before_line_breaking (), because the info
 121     in ELEMENTS already has been procced by Bar::before_line_breaking ().
 122   */
 123   return SCM_UNSPECIFIED;
 124 }
 125
 126 MAKE_SCHEME_CALLBACK (Span_bar,center_on_spanned_callback,2);
 127
 128 SCM
 129 Span_bar::center_on_spanned_callback (SCM element_smob, SCM axis)
 130 {
 131   Grob *me = unsmob_grob (element_smob);
 132   Axis a = (Axis) gh_scm2int (axis);
 133   assert (a == Y_AXIS);
 134   Interval i (get_spanned_interval (me));
 135
 136   /*
 137     Bar::brew_molecule delivers a barline of y-extent (-h/2,h/2), so
 138     we have to translate ourselves to be in the center of the
 139     interval that we span.  */
 140   if (i.empty_b ())
 141     {
 142       me->suicide ();
 143       return gh_double2scm (0.0);
 144     }
 145
 146   return gh_double2scm (i.center ());
 147 }
 148
 149 void
 150 Span_bar::evaluate_empty (Grob*me)
 151 {
 152   /*
 153     TODO: filter all hara-kiried out of ELEMENS list, and then
 154     optionally do suicide. Call this cleanage function from
 155     center_on_spanned_callback () as well.
 156
 157    */
 158   if (!gh_pair_p (me->get_grob_property ("elements")))
 159     {
 160       me->suicide ();
 161     }
 162 }
 163
 164 void
 165 Span_bar::evaluate_glyph (Grob*me)
 166 {
 167   SCM elts = me->get_grob_property ("elements");
 168   Grob * b = unsmob_grob (gh_car (elts));
 169   SCM glsym =ly_symbol2scm ("glyph");
 170   SCM gl =b ->get_grob_property (glsym);
 171   if (!gh_string_p (gl))
 172     {
 173       me->suicide ();
 174       return ;
 175     }
 176
 177   String type = ly_scm2string (gl);
 178
 179   if (type == "|:")
 180     {
 181       type = ".|";
 182     }
 183   else if (type== ":|")
 184     {
 185       type = "|.";
 186     }
 187   else if (type== ":|:")
 188     {
 189       type = ".|.";
 190     }
 191
 192   gl = ly_str02scm (type.ch_C ());
 193   if (scm_equal_p (me->get_grob_property (glsym), gl) != SCM_BOOL_T)
 194     me->set_grob_property (glsym, gl);
 195 }
 196
 197 Interval
 198 Span_bar::get_spanned_interval (Grob*me)
 199 {
 200   return ly_scm2interval (Axis_group_interface::group_extent_callback (me->self_scm (), gh_int2scm (Y_AXIS)));
 201 }
 202
 203
 204 MAKE_SCHEME_CALLBACK (Span_bar,get_bar_size,1);
 205 SCM
 206 Span_bar::get_bar_size (SCM smob)
 207 {
 208   Grob* me =  unsmob_grob (smob);
 209   Interval iv (get_spanned_interval (me));
 210   if (iv.empty_b ())
 211     {
 212       /*
 213         This happens if the bars are hara-kiried from under us.
 214       */
 215       me->suicide ();
 216       return gh_double2scm (-1);
 217     }
 218   return gh_double2scm (iv.length ());
 219 }
 220
 221 void
 222 Span_bar::set_interface (Grob *me)
 223 {
 224   Bar::set_interface (me);
 225
 226   me->set_interface (ly_symbol2scm ("span-bar-interface"));
 227   me->set_extent_callback (SCM_EOL, Y_AXIS);
 228 }
 229
 230 bool
 231 Span_bar::has_interface (Grob*m)
 232 {
 233   return m && m->has_interface (ly_symbol2scm ("span-bar-interface"));
 234 }