]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/span-bar.cc
* lily/default-actions.cc (Module): new file. default
[lilypond.git] / lily / span-bar.cc
index 80e7d136a77ed8c036330a49f12f5fd5cbdc8331..548961d8efe7e398ce09787c7fc47d12cdd9072d 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.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.hh"
+#include "bar-line.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);
+  Pointer_group_interface::add_grob (me, ly_symbol2scm ("elements"), b);
 
   me->add_dependency (b);
 }
 
-MAKE_SCHEME_CALLBACK (Span_bar,brew_molecule,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.
- *
- * (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.
- */
+MAKE_SCHEME_CALLBACK (Span_bar, print, 1);
 
-/*
-  This routine was originally by Juergen Reuter, but it was a on the
-  bulky side. Rewritten by Han-Wen. 
- */
+/* Limitations/Bugs:
+
+(1) Elements from 'me->get_property ("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. */
+
+/* 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");
+  SCM elements = me->get_property ("elements");
 
-  // compute common refpoint of elements
-  Grob *refp = me;
-  for (SCM elts = first_elt; gh_pair_p (elts); elts = ly_cdr (elts))
+  Grob *refp = common_refpoint_of_list (elements, me, Y_AXIS);
+  Span_bar::evaluate_glyph (me);
+  SCM glyph = me->get_property ("glyph");
+
+  /* glyph may not be a string, when ME is killed by Hara Kiri in
+     between. */
+  if (!scm_is_string (glyph))
+    return SCM_EOL;
+
+  String glyph_string = ly_scm2string (glyph);
+
+  /* compose span_bar_mol */
+  Array<Interval> extents;
+  Grob *model_bar = 0;
+  for (SCM elts = elements; scm_is_pair (elts); elts = scm_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);
-    }
+      Grob *bar = unsmob_grob (scm_car (elts));
+      Interval ext = bar->extent (refp, Y_AXIS);
+      if (ext.is_empty ())
+       continue;
 
-  Span_bar::evaluate_glyph(me);
-  SCM glyph = me->get_grob_property ("glyph");
+      extents.push (ext);
+      model_bar = bar;
+    }
 
-  /*
-    glyph may not be a string, when ME is killed by Hara Kiri in
-    between.
-  */
-  if (!gh_string_p (glyph))
-    return SCM_EOL;
+  if (!model_bar)
+    model_bar = me;
   
-  String glyph_str = ly_scm2string (glyph);
-
-  // compose span_bar_mol
-  Molecule span_bar_mol;
+  extents.sort (&Interval::left_comparison);
 
-  Interval prev_extent;
-  for (SCM elts = first_elt; gh_pair_p (elts); elts = ly_cdr (elts))
+  Stencil span_bar;
+  for (int 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]);
-
-         Molecule interbar
-           = Bar::compound_barline (staff_bar, glyph_str, l.length());
-         interbar.translate_axis (l.center (), Y_AXIS);
-         span_bar_mol.add_molecule (interbar);
+         Interval l (prev_extent [UP],
+                     ext[DOWN]);
+
+         if (l.is_empty ())
+           {
+             /* There is overlap between the bar lines.  Do nothing. */
+           }
+         else
+           {
+             Stencil interbar = Bar_line::compound_barline (model_bar,
+                                                            glyph_string,
+                                                            l.length (),
+                                                            false);
+             interbar.translate_axis (l.center (), Y_AXIS);
+             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_callback, 2);
 SCM
 Span_bar::width_callback (SCM element_smob, SCM scm_axis)
 {
   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"));
+  (void) scm_axis;
+
+  assert ( (Axis) scm_to_int (scm_axis) == X_AXIS);
+  String gl = ly_scm2string (se->get_property ("glyph"));
 
   /*
     urg.
   */
-  Molecule m = Bar::compound_barline (se, gl, 40 PT);
-  
+  Stencil m = Bar_line::compound_barline (se, 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 *g = unsmob_grob (smob);
+  evaluate_empty (g);
+  evaluate_glyph (g);
 
-  /*
-    no need to call   Bar::before_line_breaking (), because the info
-    in ELEMENTS already has been procced by Bar::before_line_breaking ().
-  */
+  /* 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, 2);
 
 SCM
 Span_bar::center_on_spanned_callback (SCM element_smob, SCM axis)
 {
   Grob *me = unsmob_grob (element_smob);
-  Axis a = (Axis) gh_scm2int (axis);
-  assert (a == Y_AXIS);
+  (void) axis;
+  assert (scm_to_int (axis) == Y_AXIS);
   Interval i (get_spanned_interval (me));
 
-  /*
-    Bar::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 
-    interval that we span.  */
-  if (i.empty_b ())
+  /* 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.is_empty ())
     {
       me->suicide ();
-      return gh_double2scm (0.0);
+      return scm_make_real (0.0);
     }
-  
-  return gh_double2scm (i.center ());
+
+  return scm_make_real (i.center ());
 }
 
 void
-Span_bar::evaluate_empty (Grob*me)
+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")))
+  /* 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 (!scm_is_pair (me->get_property ("elements")))
     {
       me->suicide ();
     }
 }
 
 void
-Span_bar::evaluate_glyph (Grob*me)
+Span_bar::evaluate_glyph (Grob *me)
 {
-  SCM elts = me->get_grob_property ("elements");
-  SCM glyph_symbol = ly_symbol2scm ("glyph");
-  SCM gl = SCM_EOL;
+  SCM gl = me->get_property ("glyph");
+
+  if (scm_is_string (gl))
+    return;
 
-  while (gh_pair_p (elts))
+  for (SCM s = me->get_property ("elements");
+       !scm_is_string (gl) && scm_is_pair (s); s = scm_cdr (s))
     {
-      gl =  unsmob_grob (gh_car (elts))->internal_get_grob_property (glyph_symbol);
-      if (gh_string_p (gl))
-       break;
-      elts =gh_cdr (elts);
+      gl = unsmob_grob (scm_car (s))
+       ->get_property ("glyph");
     }
 
-  if (!gh_string_p (gl))
+  if (!scm_is_string (gl))
     {
       me->suicide ();
       return;
     }
-  
+
   String type = ly_scm2string (gl);
-  if (type == "|:") 
+  if (type == "|:")
     {
       type = ".|";
     }
-  else if (type== ":|")
+  else if (type == ":|")
     {
       type = "|.";
     }
-  else if (type== ":|:")
+  else if (type == ":|:")
     {
       type = ".|.";
     }
 
-  gl = ly_str02scm (type.ch_C ());
-  if (scm_equal_p (me->internal_get_grob_property (glyph_symbol), gl) != SCM_BOOL_T)
-    me->internal_set_grob_property (glyph_symbol, gl);
+  gl = scm_makfrom0str (type.to_str0 ());
+  if (scm_equal_p (me->get_property ("glyph"), gl)
+      != SCM_BOOL_T)
+    me->set_property ("glyph", gl);
 }
 
 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::group_extent_callback
+                         (me->self_scm (), scm_int2num (Y_AXIS)));
 }
 
-
-MAKE_SCHEME_CALLBACK (Span_bar,get_bar_size,1);
+MAKE_SCHEME_CALLBACK (Span_bar, get_bar_size, 1);
 SCM
 Span_bar::get_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.
-      */
+      /* This happens if the bars are hara-kiried from under us. */
       me->suicide ();
-      return gh_double2scm (-1);
+      return scm_make_real (-1);
     }
-  return gh_double2scm (iv.length ());
+  return scm_make_real (iv.length ());
 }
 
-void
-Span_bar::set_interface (Grob *me)
-{
-  Bar::set_interface (me);
-  
-  me->set_interface (ly_symbol2scm ("span-bar-interface"));
-  me->set_extent_callback (SCM_EOL, Y_AXIS);
-}
+ADD_INTERFACE (Span_bar, "span-bar-interface",
+              "A bar line that spanned between other barlines. This interface is "
+              " used for  bar lines that connect different staves.",
+              "elements");
 
-bool
-Span_bar::has_interface (Grob*m)
-{
-  return m && m->has_interface (ly_symbol2scm ("span-bar-interface"));
-}