]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/staff-symbol-referencer.cc
Run grand-replace (issue 3765)
[lilypond.git] / lily / staff-symbol-referencer.cc
index 20c0b50b1be4963eb538ecb44d618dec2a06187e..ffad2e6fdd4c7bd07e8f0d69c76025a650a496cb 100644 (file)
@@ -1,50 +1,57 @@
 /*
-  staff-symbol-referencer.cc -- implement Staff_symbol_referencer
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 1999--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 1999--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  LilyPond is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  LilyPond is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #include "staff-symbol-referencer.hh"
 
-#include <math.h>
-
 #include "staff-symbol.hh"
+#include "grob.hh"
 #include "output-def.hh"
 #include "libc-extension.hh"
 
 int
 Staff_symbol_referencer::line_count (Grob *me)
 {
- Grob *st = get_staff_symbol (me);
- return st ? Staff_symbol::line_count (st) : 0;
 Grob *st = get_staff_symbol (me);
 return st ? Staff_symbol::line_count (st) : 0;
 }
 
 bool
-Staff_symbol_referencer::on_staffline (Grob *me)
+Staff_symbol_referencer::on_line (Grob *me, int pos)
 {
-  return on_staffline (me, (int) rint (get_position (me)));
+  Grob *st = get_staff_symbol (me);
+  return st ? Staff_symbol::on_line (st, pos) : false;
 }
 
-/*
-  This does not take size into account.
-  maybe rename: on_virtual_staffline, on_staff_or_ledger_line?
- */
 bool
-Staff_symbol_referencer::on_staffline (Grob *me, int pos)
+Staff_symbol_referencer::on_staff_line (Grob *me, int pos)
 {
-  int sz = line_count (me) - 1;
-  return ((pos + sz) % 2) == 0;
+  Grob *st = get_staff_symbol (me);
+  return st ? Staff_symbol::on_line (st, pos, false) : false;
 }
 
-Grob*
+Grob *
 Staff_symbol_referencer::get_staff_symbol (Grob *me)
 {
   if (Staff_symbol::has_interface (me))
     return me;
-  
-  SCM st = me->get_property ("staff-symbol");
+
+  SCM st = me->get_object ("staff-symbol");
   return unsmob_grob (st);
 }
 
@@ -63,58 +70,75 @@ Staff_symbol_referencer::line_thickness (Grob *me)
   Grob *st = get_staff_symbol (me);
   if (st)
     return Staff_symbol::get_line_thickness (st);
-  return me->get_layout ()->get_dimension (ly_symbol2scm ("linethickness"));
+  return me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
 }
 
 Real
 Staff_symbol_referencer::get_position (Grob *me)
+{
+  return internal_get_position (me, false);
+}
+
+Real
+Staff_symbol_referencer::pure_get_position (Grob *me)
+{
+  return internal_get_position (me, true);
+}
+
+Real
+Staff_symbol_referencer::internal_get_position (Grob *me, bool pure)
 {
   Real p = 0.0;
   Grob *st = get_staff_symbol (me);
   Grob *c = st ? me->common_refpoint (st, Y_AXIS) : 0;
   if (st && c)
     {
-      Real y = me->relative_coordinate (c, Y_AXIS)
-       - st->relative_coordinate (c, Y_AXIS);
-
-      p += 2.0 * y / Staff_symbol::staff_space (st);
+      Real y = (pure
+                ? me->pure_relative_y_coordinate (c, 0, INT_MAX)
+                : me->relative_coordinate (c, Y_AXIS))
+               - st->relative_coordinate (c, Y_AXIS);
+      Real space = Staff_symbol::staff_space (st);
+      p = (space == 0) ? 0 : 2.0 * y / space;
       return p;
     }
   else if (!st)
+    return me->relative_coordinate (me->get_parent (Y_AXIS), Y_AXIS) * 2;
+  return robust_scm2double (me->get_property ("staff-position"), p);
+}
+
+Interval
+Staff_symbol_referencer::extent_in_staff (Grob *me)
+{
+  Grob *st = get_staff_symbol (me);
+  Grob *c = st ? me->common_refpoint (st, Y_AXIS) : 0;
+
+  Interval retval;
+  if (st && c)
     {
-      return me->relative_coordinate (me->get_parent (Y_AXIS), Y_AXIS) * 2;
+      retval = me->extent (c, Y_AXIS)
+               - st->relative_coordinate (c, Y_AXIS);
     }
-  return robust_scm2double (me->get_property ("staff-position"), p);
+
+  return retval;
 }
 
 int
-Staff_symbol_referencer::get_rounded_position (Grob*me)
+Staff_symbol_referencer::get_rounded_position (Grob *me)
 {
   return int (rint (get_position (me)));
 }
 
-LY_DEFINE (ly_grob_staff_position, "ly:grob-staff-position",
-          1, 0,0, (SCM sg),
-          "Return the Y-position of @var{sg} relative to the staff.")
+int
+Staff_symbol_referencer::pure_get_rounded_position (Grob *me)
 {
-  Grob *g = unsmob_grob (sg);
-
-  SCM_ASSERT_TYPE (g, sg, SCM_ARG1, __FUNCTION__, "grob");
-  Real pos = Staff_symbol_referencer::get_position (g);
-
-  if (fabs (rint (pos) -pos) < 1e-6) // ugh.
-    return scm_int2num ((int) my_round (pos));
-  else
-    return scm_make_real (pos);
+  return int (rint (pure_get_position (me)));
 }
 
-
-/* should use offset callback!  */
-MAKE_SCHEME_CALLBACK (Staff_symbol_referencer,callback,2);
+MAKE_SCHEME_CALLBACK (Staff_symbol_referencer, callback, 1);
 SCM
-Staff_symbol_referencer::callback (SCM element_smob, SCM)
+Staff_symbol_referencer::callback (SCM smob)
 {
-  Grob *me = unsmob_grob (element_smob);
+  Grob *me = unsmob_grob (smob);
 
   SCM pos = me->get_property ("staff-position");
   Real off = 0.0;
@@ -122,10 +146,9 @@ Staff_symbol_referencer::callback (SCM element_smob, SCM)
     {
       Real space = Staff_symbol_referencer::staff_space (me);
       off = scm_to_double (pos) * space / 2.0;
-      me->set_property ("staff-position", scm_int2num (0));
     }
 
-  return scm_make_real (off);
+  return scm_from_double (off);
 }
 
 /*  This sets the position relative to the center of the staff symbol.
@@ -142,38 +165,76 @@ will be extracted from staff-position */
 
 void
 Staff_symbol_referencer::set_position (Grob *me, Real p)
+{
+  internal_set_position (me, p, false);
+}
+
+void
+Staff_symbol_referencer::pure_set_position (Grob *me, Real p)
+{
+  internal_set_position (me, p, true);
+}
+
+void
+Staff_symbol_referencer::internal_set_position (Grob *me, Real p, bool pure)
 {
   Grob *st = get_staff_symbol (me);
+  Real oldpos = 0.0;
   if (st && me->common_refpoint (st, Y_AXIS))
     {
-      Real oldpos = get_position (me);
-      me->set_property ("staff-position", scm_make_real (p - oldpos));
+      oldpos = pure ? pure_get_position (me) : get_position (me);
     }
-  else
-    me->set_property ("staff-position", scm_make_real (p));
 
-  me->add_offset_callback (Staff_symbol_referencer::callback_proc, Y_AXIS);
+  Real ss = Staff_symbol_referencer::staff_space (me);
+  me->translate_axis ((p - oldpos) * ss * 0.5, Y_AXIS);
+}
+
+Interval
+Staff_symbol_referencer::staff_span (Grob *me)
+{
+  Interval result;
+  if (me)
+    if (Grob *symb = get_staff_symbol (me))
+      result = Staff_symbol::line_span (symb);
+  return result;
 }
 
-/* Half of the height, in staff space, i.e. 2.0 for a normal staff. */
 Real
 Staff_symbol_referencer::staff_radius (Grob *me)
 {
-  return (line_count (me) - 1) / 2.0;
+  /*
+    line_span is measured in pitch steps, not in staff spaces
+  */
+  return staff_span (me).length () / 4.0;
 }
 
 int
 compare_position (Grob *const &a, Grob *const &b)
 {
-  return sign (Staff_symbol_referencer::get_position ((Grob*)a)
-              - Staff_symbol_referencer::get_position ((Grob*) b));
+  return sign (Staff_symbol_referencer::get_position ((Grob *)a)
+               - Staff_symbol_referencer::get_position ((Grob *) b));
+}
+
+bool
+position_less (Grob *const &a, Grob *const &b)
+{
+  return Staff_symbol_referencer::get_position (a)
+         < Staff_symbol_referencer::get_position (b);
+}
+
+bool
+pure_position_less (Grob *const &a, Grob *const &b)
+{
+  return Staff_symbol_referencer::pure_get_position (a)
+         < Staff_symbol_referencer::pure_get_position (b);
 }
 
-ADD_INTERFACE (Staff_symbol_referencer,"staff-symbol-referencer-interface",
-              "An object whose Y position is meant relative to a staff "
-              "symbol. "
-              "These usually have @code{Staff_symbol_referencer::callback} "
-              "in their @code{Y-offset-callbacks}. "
-              ,
-              "staff-position");
+ADD_INTERFACE (Staff_symbol_referencer,
+               "An object whose Y@tie{}position is meant relative to a staff"
+               " symbol.  These usually"
+               " have @code{Staff_symbol_referencer::callback} in their"
+               " @code{Y-offset-callbacks}.",
 
+               /* properties */
+               "staff-position "
+              );