]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/staff-symbol-referencer.cc
Issue 5167/6: Changes: show \markup xxx = ... \etc assignments
[lilypond.git] / lily / staff-symbol-referencer.cc
index ba6d15a7d8b75a838164a87960442bcf0c85be49..09b3d2856ec5405162e50f58e817a2e784933cce 100644 (file)
-/*   
-  staff-symbol-referencer.cc -- implement Staff_symbol_referencer
-  
-  source file of the GNU LilyPond music typesetter
-  
-  (c) 1999--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
- */
+/*
+  This file is part of LilyPond, the GNU music typesetter.
+
+  Copyright (C) 1999--2015 Han-Wen Nienhuys <hanwen@xs4all.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.
 
-#include <math.h>
+  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 "staff-symbol.hh"
-#include "paper-def.hh"
-#include "dimension-cache.hh"
+#include "grob.hh"
+#include "output-def.hh"
+#include "libc-extension.hh"
 
-Staff_symbol_referencer_interface::Staff_symbol_referencer_interface (Score_element const *sc)
+int
+Staff_symbol_referencer::line_count (Grob *me)
 {
-  elt_l_ = (Score_element*)sc;
+  Grob *st = get_staff_symbol (me);
+  return st ? Staff_symbol::line_count (st) : 0;
 }
 
-void
-Staff_symbol_referencer_interface::set_interface ()
+bool
+Staff_symbol_referencer::on_line (Grob *me, int pos)
 {
-  if (!gh_number_p (elt_l_->get_elt_property ("staff-position")))
-      elt_l_->set_elt_property ("staff-position", gh_double2scm (0.0));
-      
-  elt_l_->add_offset_callback (callback, Y_AXIS);
+  Grob *st = get_staff_symbol (me);
+  return st ? Staff_symbol::on_line (st, pos) : false;
 }
 
 bool
-Staff_symbol_referencer_interface::has_interface_b ()
+Staff_symbol_referencer::on_staff_line (Grob *me, int pos)
 {
-  return unsmob_element (elt_l_->get_elt_pointer ("staff-symbol"))
-    || gh_number_p (elt_l_->get_elt_property ("staff-position"));
+  Grob *st = get_staff_symbol (me);
+  return st ? Staff_symbol::on_line (st, pos, false) : false;
 }
 
-
-int
-Staff_symbol_referencer_interface::line_count () const
+Grob *
+Staff_symbol_referencer::get_staff_symbol (Grob *me)
 {
-  Staff_symbol *st = staff_symbol_l ();
-  return st  ?  st->line_count () : 0;
+  if (has_interface<Staff_symbol> (me))
+    return me;
+
+  SCM st = me->get_object ("staff-symbol");
+  return unsmob<Grob> (st);
 }
 
-Staff_symbol*
-Staff_symbol_referencer_interface::staff_symbol_l () const
+Real
+Staff_symbol_referencer::staff_space (Grob *me)
 {
-  SCM st = elt_l_->get_elt_pointer ("staff-symbol");
-  return dynamic_cast<Staff_symbol* > (unsmob_element(st));
+  Grob *st = get_staff_symbol (me);
+  if (st)
+    return Staff_symbol::staff_space (st);
+  return 1.0;
 }
 
 Real
-Staff_symbol_referencer_interface::staff_space () const
+Staff_symbol_referencer::line_thickness (Grob *me)
 {
-  Staff_symbol * st = staff_symbol_l ();
+  Grob *st = get_staff_symbol (me);
   if (st)
-    return st->staff_space ();
-  else if (elt_l_->pscore_l_ && elt_l_->paper_l ())
-    return elt_l_->paper_l ()->get_var ("interline");
-  return 0.0;
+    return Staff_symbol::get_line_thickness (st);
+  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_interface::position_f () const
+Staff_symbol_referencer::internal_get_position (Grob *me, bool pure)
 {
-  Real p =0.0;
-  Staff_symbol * st = staff_symbol_l ();
-  Score_element * c = st ? elt_l_->common_refpoint (st, Y_AXIS) : 0;
+  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 = elt_l_->relative_coordinate (c, Y_AXIS)
-       - st->relative_coordinate (c, Y_AXIS);
-
-      p += 2.0 * y / st->staff_space ();
+      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
+  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)
     {
-      SCM pos = elt_l_->get_elt_property ("staff-position");
-      if (gh_number_p (pos))
-       return gh_scm2double (pos);
+      retval = me->extent (c, Y_AXIS)
+               - st->relative_coordinate (c, Y_AXIS);
     }
-  
-  return  p;
+
+  return retval;
 }
 
+int
+Staff_symbol_referencer::get_rounded_position (Grob *me)
+{
+  return int (rint (get_position (me)));
+}
 
+int
+Staff_symbol_referencer::pure_get_rounded_position (Grob *me)
+{
+  return int (rint (pure_get_position (me)));
+}
 
-/*
-  should use offset callback!
- */
-Real
-Staff_symbol_referencer_interface::callback (Score_element const* sc,Axis )
+MAKE_SCHEME_CALLBACK (Staff_symbol_referencer, callback, 1);
+SCM
+Staff_symbol_referencer::callback (SCM smob)
 {
-  Score_element* me = (Score_element*)sc; // UGH.
-  
-  SCM pos = sc->get_elt_property ("staff-position");
-  Real off =0.0;
-  if (gh_number_p (pos))
+  Grob *me = unsmob<Grob> (smob);
+
+  SCM pos = me->get_property ("staff-position");
+  Real off = 0.0;
+  if (scm_is_number (pos))
     {
-      Real space = staff_symbol_referencer (sc).staff_space ();
-      off = gh_scm2double (pos) * space/2.0;
+      Real space = Staff_symbol_referencer::staff_space (me);
+      off = scm_to_double (pos) * space / 2.0;
     }
 
-  me->set_elt_property ("staff-position", gh_double2scm (0.0));
-
-  return off;
+  return scm_from_double (off);
 }
 
-/*
-  
-  This sets the position relative to the center of the staff symbol.
+/*  This sets the position relative to the center of the staff symbol.
+
+The function is hairy, because it can be called in two situations:
+
+1. There is no staff yet; we must set staff-position
 
-  The function is hairy, because it can be callled in two situations:
+2. There is a staff, and perhaps someone even applied a
+translate_axis (). Then we must compensate for the translation
 
-  1.  There is no staff yet; we must set staff-position
+In either case, we set a callback to be sure that our new position
+will be extracted from staff-position */
 
-  2.  There is a staff, and perhaps someone even applied a
-  translate_axis (). Then we must compensate for the translation
-  
-  In either case, we set a callback to be sure that our new position
-  will be extracted from staff-position
-  
- */
 void
-Staff_symbol_referencer_interface::set_position (Real p)
+Staff_symbol_referencer::set_position (Grob *me, Real p)
 {
-  Staff_symbol * st = staff_symbol_l ();
-  if (st && elt_l_->common_refpoint(st, Y_AXIS))
-    {
-      Real oldpos = position_f ();
-      elt_l_->set_elt_property ("staff-position", gh_double2scm (p - oldpos));
-    }
-  else
-    {
-      elt_l_->set_elt_property ("staff-position",
-                               gh_double2scm (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))
+    {
+      oldpos = pure ? pure_get_position (me) : get_position (me);
     }
 
-  if (elt_l_->has_offset_callback_b (callback, Y_AXIS))
-    return ; 
+  Real ss = Staff_symbol_referencer::staff_space (me);
+  me->translate_axis ((p - oldpos) * ss * 0.5, Y_AXIS);
+}
 
-  elt_l_->add_offset_callback (callback, 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;
 }
 
-Staff_symbol_referencer_interface
-staff_symbol_referencer (Score_element const*e)
+Real
+Staff_symbol_referencer::staff_radius (Grob *me)
 {
-  return e;                    // gee, I'm so smart!
+  /*
+    line_span is measured in pitch steps, not in staff spaces
+  */
+  return staff_span (me).length () / 4.0;
 }
 
 int
-compare_position (Score_element *const  &a, Score_element * const &b)
+compare_position (Grob *const &a, Grob *const &b)
 {
-  Staff_symbol_referencer_interface s1(a);
-  Staff_symbol_referencer_interface s2(b);      
+  return sign (Staff_symbol_referencer::get_position ((Grob *)a)
+               - Staff_symbol_referencer::get_position ((Grob *) b));
+}
 
-  return sign(s1.position_f () - s2.position_f ());
+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,
+               "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 "
+              );