]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/staff-symbol-referencer.cc
Web-de: fix linkage for manuals
[lilypond.git] / lily / staff-symbol-referencer.cc
index 813d8a8b17abd21335f0272724aa0d96dbf1f0e5..2939e0c0614fdb035fe5a62409c4708f7bbf03ee 100644 (file)
-/*   
-  staff-symbol-referencer.cc -- implement Staff_symbol_referencer
-  
-  source file of the GNU LilyPond music typesetter
-  
-  (c) 1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
- */
+/*
+  This file is part of LilyPond, the GNU music typesetter.
 
-#include <math.h>
+  Copyright (C) 1999--2011 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.
+
+  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::Staff_symbol_referencer ()
+int
+Staff_symbol_referencer::line_count (Grob *me)
 {
-  staff_sym_l_ =0;
+  Grob *st = get_staff_symbol (me);
+  return st ? Staff_symbol::line_count (st) : 0;
 }
 
-void
-Staff_symbol_referencer::do_substitute_element_pointer (Score_element *o, Score_element*n)
+bool
+Staff_symbol_referencer::on_line (Grob *me, int pos)
+{
+  Grob *st = get_staff_symbol (me);
+  return st ? Staff_symbol::on_line (st, pos) : false;
+}
+
+bool
+Staff_symbol_referencer::on_staff_line (Grob *me, int pos)
 {
-  if (staff_sym_l_ == o)
+  return on_line (me, pos) && abs (pos) <= 2 * staff_radius (me);
+}
+
+Grob *
+Staff_symbol_referencer::get_staff_symbol (Grob *me)
+{
+  if (Staff_symbol::has_interface (me))
+    return me;
+
+  SCM st = me->get_object ("staff-symbol");
+  return unsmob_grob (st);
+}
+
+Real
+Staff_symbol_referencer::staff_space (Grob *me)
+{
+  Grob *st = get_staff_symbol (me);
+  if (st)
+    return Staff_symbol::staff_space (st);
+  return 1.0;
+}
+
+Real
+Staff_symbol_referencer::line_thickness (Grob *me)
+{
+  Grob *st = get_staff_symbol (me);
+  if (st)
+    return Staff_symbol::get_line_thickness (st);
+  return me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
+}
+
+Real
+Staff_symbol_referencer::get_position (Grob *me)
+{
+  Real p = 0.0;
+  Grob *st = get_staff_symbol (me);
+  Grob *c = st ? me->common_refpoint (st, Y_AXIS) : 0;
+  if (st && c)
     {
-      staff_sym_l_ = dynamic_cast<Staff_symbol*> (n);
+      Real y = 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);
 }
 
-int
-Staff_symbol_referencer::lines_i () const
+
+Interval
+Staff_symbol_referencer::extent_in_staff (Grob *me)
 {
-  return (staff_sym_l_) ?  staff_sym_l_->no_lines_i_ : 5;
+  Grob *st = get_staff_symbol (me);
+  Grob *c = st ? me->common_refpoint (st, Y_AXIS) : 0;
+
+  Interval retval;
+  if (st && c)
+    {
+      retval  = me->extent (c, Y_AXIS)
+       - st->relative_coordinate (c, Y_AXIS);
+    }
+
+  return retval;
 }
 
-void
-Staff_symbol_referencer::set_staff_symbol (Staff_symbol*s)
+int
+Staff_symbol_referencer::get_rounded_position (Grob *me)
 {
-  staff_sym_l_ =s;
-  add_dependency (s);
+  return int (rint (get_position (me)));
 }
 
-Staff_symbol*
-Staff_symbol_referencer::staff_symbol_l () const
+MAKE_SCHEME_CALLBACK (Staff_symbol_referencer, callback, 1);
+SCM
+Staff_symbol_referencer::callback (SCM smob)
 {
-  return staff_sym_l_;
+  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::staff_space (me);
+      off = scm_to_double (pos) * space / 2.0;
+    }
+
+  return scm_from_double (off);
 }
 
-Real
-Staff_symbol_referencer::staff_line_leading_f () const
+/*  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
+
+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::set_position (Grob *me, Real p)
 {
-  return (staff_sym_l_) ? staff_sym_l_->staff_line_leading_f_ : paper_l ()->get_realvar (interline_scm_sym);
+  Grob *st = get_staff_symbol (me);
+  Real oldpos = 0.0;
+  if (st && me->common_refpoint (st, Y_AXIS))
+    {
+      oldpos = get_position (me);
+    }
+
+  Real ss = Staff_symbol_referencer::staff_space (me);
+  me->translate_axis ((p  - oldpos) * ss * 0.5, Y_AXIS);
 }
 
+/* Half of the height, in staff space, i.e. 2.0 for a normal staff. */
 Real
-Staff_symbol_referencer::position_f () const
+Staff_symbol_referencer::staff_radius (Grob *me)
 {
-  if (!staff_sym_l_ )
-    return 0;
+  return (line_count (me) - 1) / 2.0;
+}
 
-  Graphical_element * c = common_refpoint (staff_sym_l_, Y_AXIS);
-  Real y = relative_coordinate (c, Y_AXIS) - staff_sym_l_->relative_coordinate (c, Y_AXIS);
+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 2.0 * y / staff_line_leading_f ();
+bool
+position_less (Grob *const &a, Grob *const &b)
+{
+  return Staff_symbol_referencer::get_position (a)
+    < Staff_symbol_referencer::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 "
+              );