]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/span-bar.cc
Run `make grand-replace'.
[lilypond.git] / lily / span-bar.cc
index 8956019fefa6370460a6bb56bac260fb60714f42..08a04e3cffc6d9b538f2c627703c47a6ec19c141 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
 #include "span-bar.hh"
+
 #include "font-interface.hh"
 #include "dimensions.hh"
-#include "paper-def.hh"
-#include "molecule.hh"
+#include "output-def.hh"
+#include "stencil.hh"
 #include "warn.hh"
 #include "axis-group-interface.hh"
-#include "group-interface.hh"
-#include "grob.hh"
 #include "bar-line.hh"
+#include "grob.hh"
+#include "pointer-group-interface.hh"
 
 void
-Span_bar::add_bar (Grob*me, Grob*b)
+Span_bar::add_bar (Grob *me, Grob *b)
 {
-  Pointer_group_interface::add_grob (me, ly_symbol2scm ("elements"),  b);
-
-  me->add_dependency (b);
+  Pointer_group_interface::add_grob (me, ly_symbol2scm ("elements"), b);
 }
 
-MAKE_SCHEME_CALLBACK (Span_bar,brew_molecule,1);
+MAKE_SCHEME_CALLBACK (Span_bar, print, 1);
 
 /* Limitations/Bugs:
 
-   (1) Elements from 'me->get_grob_property ("elements")' must be
-   ordered according to their y coordinates relative to their common
-   axis group parent.  Otherwise, the computation goes mad.
-
-   (TODO:
-   apply a sort algorithm that ensures this precondition.)  However,
-   until now, I have seen no case where lily has not fulfilled this
-   precondition.
+(1) Elements from 'me->get_object ("elements")' must be
+ordered according to their y coordinates relative to their common
+axis group parent.  Otherwise, the computation goes mad.
 
-   (2) This method depends on bar_engraver not being removed from
-   staff context.  If bar_engraver is removed, the size of the staff
-   lines is evaluated as 0, which results in a solid span bar line
-   with faulty y coordinate. */
+(2) This method depends on bar_engraver not being removed from
+staff context.  If bar_engraver is removed, the size of the staff
+lines is evaluated as 0, which results in a solid span bar line
+with faulty y coordinate. */
 
 /* This routine was originally by Juergen Reuter, but it was a on the
    bulky side. Rewritten by Han-Wen. */
 SCM
-Span_bar::brew_molecule (SCM smobbed_me) 
+Span_bar::print (SCM smobbed_me)
 {
   Grob *me = unsmob_grob (smobbed_me);
-  SCM first_elt = me->get_grob_property ("elements");
+  extract_grob_set (me, "elements", elements);
+  Grob *refp = common_refpoint_of_array (elements, me, Y_AXIS);
 
-  /* compute common refpoint of elements */
-  Grob *refp = me;
-  for (SCM elts = first_elt; gh_pair_p (elts); elts = ly_cdr (elts))
-    {
-      SCM smobbed_staff_bar = ly_car (elts);
-      Grob *staff_bar = unsmob_grob (smobbed_staff_bar);
-      refp = staff_bar->common_refpoint (refp, Y_AXIS);
-    }
-
-  Span_bar::evaluate_glyph (me);
-  SCM glyph = me->get_grob_property ("glyph");
+  SCM glyph = me->get_property ("glyph-name");
 
   /* glyph may not be a string, when ME is killed by Hara Kiri in
-    between. */
-  if (!gh_string_p (glyph))
+     between. */
+  if (!scm_is_string (glyph))
     return SCM_EOL;
-  
-  String glyph_string = ly_scm2string (glyph);
+
+  string glyph_string = ly_scm2string (glyph);
 
   /* compose span_bar_mol */
-  Molecule span_bar_mol;
+  vector<Interval> extents;
+  vector<bool> make_span_bar;
+  Grob *model_bar = 0;
+  for (vsize i = elements.size (); i--;)
+    {
+      Grob *bar = elements[i];
+      Interval ext = Bar_line::bar_y_extent (bar, refp);
+      if (ext.is_empty ())
+       continue;
+
+      extents.push_back (ext);
+      make_span_bar.push_back (to_boolean (bar->get_property ("allow-span-bar")));
+      model_bar = bar;
+    }
+
+  if (!model_bar)
+    model_bar = me;
+
+  vector_sort (extents, Interval::left_less);
 
-  Interval prev_extent;
-  for (SCM elts = first_elt; gh_pair_p (elts); elts = ly_cdr (elts))
+  Stencil span_bar;
+  for (vsize i = 1; i < extents.size (); i++)
     {
-      SCM smobbed_staff_bar = ly_car (elts);
-      Grob *staff_bar = unsmob_grob (smobbed_staff_bar);
-      Interval ext = staff_bar->extent (refp, Y_AXIS);
-      if (ext.empty_b ())
-       continue; 
-      
-      if (!prev_extent.empty_b ())
+      Interval prev_extent = extents[i - 1];
+      Interval ext = extents[i];
+      if (!prev_extent.is_empty ())
        {
          Interval l (prev_extent [UP],
-                    ext[DOWN]);
+                     ext[DOWN]);
 
-         if (l.empty_b ())
+         if (l.is_empty () || !make_span_bar[i])
            {
              /* There is overlap between the bar lines.  Do nothing. */
            }
          else
            {
-             Molecule interbar = Bar_line::compound_barline (staff_bar,
-                                                             glyph_string,
-                                                             l.length ());
+             Stencil interbar = Bar_line::compound_barline (model_bar,
+                                                            glyph_string,
+                                                            l.length (),
+                                                            false);
              interbar.translate_axis (l.center (), Y_AXIS);
-             span_bar_mol.add_molecule (interbar);
+             span_bar.add_stencil (interbar);
            }
        }
       prev_extent = ext;
     }
 
-  span_bar_mol.translate_axis (- me->relative_coordinate (refp, Y_AXIS),
-                              Y_AXIS);
-  
-  return span_bar_mol.smobbed_copy ();
+  span_bar.translate_axis (- me->relative_coordinate (refp, Y_AXIS),
+                          Y_AXIS);
+
+  return span_bar.smobbed_copy ();
 }
 
-MAKE_SCHEME_CALLBACK (Span_bar,width_callback,2);
+MAKE_SCHEME_CALLBACK (Span_bar, width, 1);
 SCM
-Span_bar::width_callback (SCM element_smob, SCM scm_axis)
+Span_bar::width (SCM smob)
 {
-  Grob *se = unsmob_grob (element_smob);
-  Axis a = (Axis) gh_scm2int (scm_axis);
-  assert (a == X_AXIS);
-  String gl = ly_scm2string (se->get_grob_property ("glyph"));
+  Grob *me = unsmob_grob (smob);
+  SCM gn = me->get_property ("glyph-name");
+  if (!me->is_live ())
+    return ly_interval2scm (Interval ());
+  
+  string gl = ly_scm2string (gn);
 
   /*
     urg.
   */
-  Molecule m = Bar_line::compound_barline (se, gl, 40 PT);
-  
+  Stencil m = Bar_line::compound_barline (me, gl, 40 PT, false);
+
   return ly_interval2scm (m.extent (X_AXIS));
 }
 
-MAKE_SCHEME_CALLBACK (Span_bar,before_line_breaking,1);
+MAKE_SCHEME_CALLBACK (Span_bar, before_line_breaking, 1);
 SCM
 Span_bar::before_line_breaking (SCM smob)
 {
-  evaluate_empty (unsmob_grob (smob));
-  evaluate_glyph (unsmob_grob (smob));
+  Grob *me = unsmob_grob (smob);
+  extract_grob_set (me, "elements", elements);
+  if (elements.empty ())
+    me->suicide ();
 
-  /* No need to call Bar_line::before_line_breaking (), because the info
-     in ELEMENTS already has been procced by
-     Bar_line::before_line_breaking (). */
   return SCM_UNSPECIFIED;
 }
 
-MAKE_SCHEME_CALLBACK (Span_bar,center_on_spanned_callback,2);
+MAKE_SCHEME_CALLBACK (Span_bar, center_on_spanned_callback, 1);
 
 SCM
-Span_bar::center_on_spanned_callback (SCM element_smob, SCM axis)
+Span_bar::center_on_spanned_callback (SCM smob)
 {
-  Grob *me = unsmob_grob (element_smob);
-  Axis a = (Axis) gh_scm2int (axis);
-  assert (a == Y_AXIS);
+  Grob *me = unsmob_grob (smob);
   Interval i (get_spanned_interval (me));
 
-  /* Bar_line::brew_molecule delivers a barline of y-extent (-h/2,h/2), so
-     we have to translate ourselves to be in the center of the 
+  /* Bar_line::print delivers a barline of y-extent (-h/2, h/2), so
+     we have to translate ourselves to be in the center of the
      interval that we span. */
-  if (i.empty_b ())
+  if (i.is_empty ())
     {
       me->suicide ();
-      return gh_double2scm (0.0);
+      return scm_from_double (0.0);
     }
-  
-  return gh_double2scm (i.center ());
-}
 
-void
-Span_bar::evaluate_empty (Grob*me)
-{
-  /* TODO: filter all hara-kiried out of ELEMENS list, and then
-     optionally do suicide. Call this cleanage function from
-     center_on_spanned_callback () as well. */
-  if (!gh_pair_p (me->get_grob_property ("elements")))
-    {
-      me->suicide ();
-    }
+  return scm_from_double (i.center ());
 }
 
-void
-Span_bar::evaluate_glyph (Grob*me)
+
+
+MAKE_SCHEME_CALLBACK(Span_bar, calc_glyph_name, 1);
+SCM
+Span_bar::calc_glyph_name (SCM smob)
 {
-  SCM elts = me->get_grob_property ("elements");
-  SCM glyph_symbol = ly_symbol2scm ("glyph");
+  Grob *me = unsmob_grob (smob);
+  extract_grob_set (me, "elements", elements);
   SCM gl = SCM_EOL;
+  for (vsize i = elements.size ();
+       i-- && !scm_is_string (gl);)
+    gl = elements[i]->get_property ("glyph-name");
 
-  while (gh_pair_p (elts))
-    {
-      gl = unsmob_grob (gh_car (elts))
-       ->internal_get_grob_property (glyph_symbol);
-      if (gh_string_p (gl))
-       break;
-      elts =gh_cdr (elts);
-    }
-
-  if (!gh_string_p (gl))
+  if (!scm_is_string (gl))
     {
       me->suicide ();
-      return;
-    }
-  
-  String type = ly_scm2string (gl);
-  if (type == "|:") 
-    {
-      type = ".|";
-    }
-  else if (type== ":|")
-    {
-      type = "|.";
-    }
-  else if (type== ":|:")
-    {
-      type = ".|.";
+      return SCM_UNSPECIFIED;
     }
 
-  gl = scm_makfrom0str (type.to_str0 ());
-  if (scm_equal_p (me->internal_get_grob_property (glyph_symbol), gl)
-      != SCM_BOOL_T)
-    me->internal_set_grob_property (glyph_symbol, gl);
+  string type = ly_scm2string (gl);
+  if (type == "|:")
+    type = ".|";
+  else if (type == ":|")
+    type = "|.";
+  else if (type == ":|:")
+    type = ".|.";
+  else if (type == ":|.|:")
+    type = "|.|";
+  else if (type == ":|.:")
+    type = "|.";
+
+  return ly_string2scm (type);
 }
 
 Interval
-Span_bar::get_spanned_interval (Grob*me) 
+Span_bar::get_spanned_interval (Grob *me)
 {
-  return ly_scm2interval (Axis_group_interface::group_extent_callback
-                         (me->self_scm (), gh_int2scm (Y_AXIS))); 
+  return ly_scm2interval (Axis_group_interface::generic_group_extent (me, Y_AXIS));
 }
 
-
-MAKE_SCHEME_CALLBACK (Span_bar,get_bar_size,1);
+MAKE_SCHEME_CALLBACK (Span_bar, calc_bar_size, 1);
 SCM
-Span_bar::get_bar_size (SCM smob)
+Span_bar::calc_bar_size (SCM smob)
 {
-  Grob* me =  unsmob_grob (smob);
+  Grob *me = unsmob_grob (smob);
   Interval iv (get_spanned_interval (me));
-  if (iv.empty_b ())
+  if (iv.is_empty ())
     {
       /* This happens if the bars are hara-kiried from under us. */
       me->suicide ();
-      return gh_double2scm (-1);
+      return scm_from_double (-1);
     }
-  return gh_double2scm (iv.length ());
+  return scm_from_double (iv.length ());
 }
 
+ADD_INTERFACE (Span_bar,
+              "A bar line that is spanned between other barlines.  This"
+              " interface is used for bar lines that connect different"
+              " staves.",
 
-
-ADD_INTERFACE (Span_bar,"span-bar-interface",
-  "A bar line that spans other barlines (typically used to get cross-staff barlines.",
-  "");
-
+              /* properties */
+              "glyph-name "
+              "elements "
+              );