]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/staff-symbol.cc
Fix potential NULL dereference in Staff_symbol::on_line().
[lilypond.git] / lily / staff-symbol.cc
index 7ba3c9e235f6503aa9f12d0034afefde93e87dd7..6fefc48010750e7daa9b2f9ed0078305047eff4b 100644 (file)
 /*
-  staffsym.cc -- implement Staff_symbol
+  staff-symbol.cc -- implement Staff_symbol
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
+
 #include "staff-symbol.hh"
+
 #include "lookup.hh"
 #include "dimensions.hh"
-#include "paper-def.hh"
-#include "molecule.hh"
-#include "debug.hh"
+#include "output-def.hh"
+#include "warn.hh"
 #include "item.hh"
+#include "staff-symbol-referencer.hh"
+#include "spanner.hh"
 
+MAKE_SCHEME_CALLBACK (Staff_symbol, print, 1);
 
-Staff_symbol::Staff_symbol ()
+SCM
+Staff_symbol::print (SCM smob)
 {
-  no_lines_i_ = 5;
-  staff_space_ = 5.0 PT;
-}
+  Grob *me = unsmob_grob (smob);
+  Spanner *sp = dynamic_cast<Spanner *> (me);
+  Grob *common
+    = sp->get_bound (LEFT)->common_refpoint (sp->get_bound (RIGHT), X_AXIS);
 
-void
-Staff_symbol::do_print() const
-{
-#ifndef NPRINT
-  Spanner::do_print();
-  DEBUG_OUT << "lines: " << no_lines_i_;
-#endif
-}
+  Interval span_points (0, 0);
 
+  /*
+    For raggedright without ragged staves, simply set width to the linewidth.
 
-Molecule*
-Staff_symbol::do_brew_molecule_p() const
-{
-  Score_element * common
-    = spanned_drul_[LEFT]->common_refpoint (spanned_drul_[RIGHT], X_AXIS);
+    (ok -- lousy UI, since width is in staff spaces)
 
-#if 0
-  Interval r =  spanned_drul_[RIGHT]->extent (X_AXIS);
-  Interval l =  spanned_drul_[LEFT]->extent (X_AXIS);
-  
-  Real left_shift =l.empty_b () ? 0.0: l[LEFT];
-  Real right_shift =r.empty_b () ? 0.0: r[RIGHT];  
-#endif
-  Real width =
-    // right_shift     - left_shift
-    + spanned_drul_[RIGHT]->relative_coordinate (common , X_AXIS)
-    - spanned_drul_[LEFT]->relative_coordinate (common, X_AXIS)
-    ;
-
-  Real t = paper_l ()->get_var ("stafflinethickness");
-  Molecule rule  = lookup_l ()->filledbox (Box (Interval (0,width),
-                                               Interval (-t/2, t/2)));
-
-  Real height = (no_lines_i_-1) * staff_space_ /2;
-  Molecule * m = new Molecule;
-  for (int i=0; i < no_lines_i_; i++)
+    --hwn.
+  */
+  Real t = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
+  t *= robust_scm2double (me->get_property ("thickness"), 1.0);
+
+  Direction d = LEFT;
+  do
     {
-      Molecule a (rule);
-      a.translate_axis (height - i * staff_space_, Y_AXIS);
-      m->add_molecule (a);
+      SCM width_scm = me->get_property ("width");
+      if (d == RIGHT && scm_is_number (width_scm))
+       {
+         /*
+           don't multiply by Staff_symbol_referencer::staff_space (me),
+           since that would make aligning staff symbols of different sizes to
+           one right margin hell.
+         */
+         span_points[RIGHT] = scm_to_double (width_scm);
+       }
+      else
+       {
+         Item *x = sp->get_bound (d);
+
+         span_points[d] = x->relative_coordinate (common, X_AXIS);
+         if (!x->break_status_dir ()
+             && !x->extent (x, X_AXIS).is_empty ())
+           span_points[d] += x->extent (x, X_AXIS)[d];
+       }
+
+      span_points[d] -= d* t / 2;
     }
+  while (flip (&d) != LEFT);
+
+  Stencil m;
+
+  SCM line_positions = me->get_property ("line-positions");
+  Stencil line
+    = Lookup::horizontal_line (span_points
+                              -me->relative_coordinate (common, X_AXIS),
+                              t);
 
-  //  m->translate_axis (left_shift, X_AXIS);
-  return m;
+  Real space = staff_space (me);
+  if (scm_is_pair (line_positions))
+    {
+      for (SCM s = line_positions; scm_is_pair (s);
+          s = scm_cdr (s))
+       {
+         Stencil b (line);
+         b.translate_axis (scm_to_double (scm_car (s))
+                           * 0.5 * space, Y_AXIS);
+         m.add_stencil (b);
+       }
+    }
+  else
+    {
+      int l = Staff_symbol::line_count (me);
+      Real height = (l - 1) * staff_space (me) / 2;
+      for (int i = 0; i < l; i++)
+       {
+         Stencil b (line);
+         b.translate_axis (height - i * space, Y_AXIS);
+         m.add_stencil (b);
+       }
+    }
+  return m.smobbed_copy ();
 }
 
 
 int
-Staff_symbol::steps_i() const
+Staff_symbol::get_steps (Grob *me)
+{
+  return line_count (me) * 2;
+}
+
+int
+Staff_symbol::line_count (Grob *me)
+{
+  SCM c = me->get_property ("line-count");
+  if (scm_is_number (c))
+    return scm_to_int (c);
+  else
+    return 0;
+}
+
+Real
+Staff_symbol::staff_space (Grob *me)
 {
-  return no_lines_i_*2;
+  return robust_scm2double (me->get_property ("staff-space"), 1.0);
 }
+
+Real
+Staff_symbol::get_line_thickness (Grob *me)
+{
+  Real lt = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
+
+  return robust_scm2double (me->get_property ("thickness"), 1.0) * lt;
+}
+
 Real
-Staff_symbol::staff_space ()
+Staff_symbol::get_ledger_line_thickness (Grob *me)
+{
+  SCM lt_pair = me->get_property ("ledger-line-thickness");
+  Offset z = robust_scm2offset (lt_pair, Offset (1.0, 0.1));
+
+  return z[X_AXIS] * get_line_thickness (me) + z[Y_AXIS] * staff_space (me);
+}
+
+MAKE_SCHEME_CALLBACK (Staff_symbol, height,1);
+SCM
+Staff_symbol::height  (SCM smob)
+{
+  Grob *me = unsmob_grob (smob);
+  Real t = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
+  t *= robust_scm2double (me->get_property ("thickness"), 1.0);
+  
+  SCM line_positions = me->get_property ("line-positions");
+
+  Interval y_ext;
+  Real space = staff_space (me);
+  if (scm_is_pair (line_positions))
+    {
+      for (SCM s = line_positions; scm_is_pair (s);
+          s = scm_cdr (s))
+       y_ext.add_point (scm_to_double (scm_car (s)) * 0.5 * space);
+    }
+  else
+    {
+      int l = Staff_symbol::line_count (me);
+      Real height = (l - 1) * staff_space (me) / 2;
+      y_ext = Interval (-height, height);
+    }
+  y_ext.widen (t/2);
+  return ly_interval2scm (y_ext);
+}
+
+bool
+Staff_symbol::on_line (Grob *me, int pos)
 {
-  return staff_space_;
+  SCM line_positions = me->get_property ("line-positions");
+  if (scm_is_pair (line_positions))
+    {
+      Real min_line = HUGE_VAL;
+      Real max_line = -HUGE_VAL;
+      for (SCM s = line_positions; scm_is_pair (s); s = scm_cdr (s))
+       {
+         Real current_line = scm_to_double (scm_car (s));
+         if (pos == current_line)
+           return true;
+         if (current_line > max_line)
+           max_line = current_line;
+         if (current_line < min_line)
+           min_line = current_line;
+       
+       }
+      if (pos < min_line)
+       return (( (int) (rint (pos - min_line)) % 2) == 0);
+      if (pos > max_line)
+       return (( (int) (rint (pos - max_line)) % 2) == 0);
+
+      return false;
+    }
+  else
+    return ((abs (pos + line_count (me)) % 2) == 1);
 }
+
+ADD_INTERFACE (Staff_symbol,
+              "This spanner draws the lines of a staff.  A staff symbol"
+              " defines a vertical unit, the @emph{staff space}.  Quantities"
+              " that go by a half staff space are called @emph{positions}."
+              "  The center (i.e., middle line or space) is position@tie{}0."
+              " The length of the symbol may be set by hand through the"
+              " @code{width} property.",
+
+              /* properties */
+              "ledger-line-thickness "
+              "line-count "
+              "line-positions "
+              "staff-space "
+              "thickness "
+              "width "
+              );