lily/staff-symbol-referencer.cc

   1 /*
   2   staff-symbol-referencer.cc -- implement Staff_symbol_referencer
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1999--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7  */
   8
   9 #include <math.h>
  10
  11 #include "staff-symbol-referencer.hh"
  12 #include "staff-symbol.hh"
  13 #include "paper-def.hh"
  14 #include "libc-extension.hh"
  15
  16
  17 int
  18 Staff_symbol_referencer::line_count (Grob*me)
  19 {
  20   Grob *st = get_staff_symbol (me);
  21   return st  ?  Staff_symbol::line_count (st) : 0;
  22 }
  23
  24 bool
  25 Staff_symbol_referencer::on_staffline (Grob*me)
  26 {
  27   return on_staffline (me, (int) rint (get_position (me)));
  28 }
  29
  30 bool
  31 Staff_symbol_referencer::on_staffline (Grob*me, int pos)
  32 {
  33   int sz = line_count (me)-1;
  34   return ((pos + sz) % 2) == 0;
  35 }
  36
  37 Grob*
  38 Staff_symbol_referencer::get_staff_symbol (Grob*me)
  39 {
  40   SCM st = me->get_grob_property ("staff-symbol");
  41   return unsmob_grob (st);
  42 }
  43
  44 Real
  45 Staff_symbol_referencer::staff_space (Grob*me)
  46 {
  47   Grob * st = get_staff_symbol (me);
  48   if (st)
  49     return Staff_symbol::staff_space (st);
  50
  51   return 1.0;
  52 }
  53
  54 Real
  55 Staff_symbol_referencer::get_position (Grob*me)
  56 {
  57   Real p =0.0;
  58   Grob * st = get_staff_symbol (me);
  59   Grob * c = st ? me->common_refpoint (st, Y_AXIS) : 0;
  60   if (st && c)
  61     {
  62       Real y = me->relative_coordinate (c, Y_AXIS)
  63         - st->relative_coordinate (c, Y_AXIS);
  64
  65       p += 2.0 * y / Staff_symbol::staff_space (st);
  66       return p;
  67     }
  68
  69   return robust_scm2double ( me->get_grob_property ("staff-position"), p);
  70 }
  71
  72
  73 LY_DEFINE(ly_grob_staff_position,
  74           "ly:grob-staff-position",
  75           1, 0,0, (SCM sg),
  76           "Return the Y-position of this grob relative to the staff.")
  77 {
  78   Grob * g = unsmob_grob (sg);
  79
  80   SCM_ASSERT_TYPE (g, sg, SCM_ARG1, __FUNCTION__, "grob");
  81   Real pos = Staff_symbol_referencer::get_position (g);
  82
  83   if (fabs (rint (pos) -pos) < 1e-6) // ugh.
  84     return gh_int2scm ((int) my_round (pos));
  85   else
  86     return gh_double2scm (pos);
  87 }
  88
  89
  90 /*
  91   should use offset callback!
  92  */
  93 MAKE_SCHEME_CALLBACK (Staff_symbol_referencer,callback,2);
  94 SCM
  95 Staff_symbol_referencer::callback (SCM element_smob, SCM)
  96 {
  97   Grob *me = unsmob_grob (element_smob);
  98
  99   SCM pos = me->get_grob_property ("staff-position");
 100   Real off =0.0;
 101   if (gh_number_p (pos))
 102     {
 103       Real space = Staff_symbol_referencer::staff_space (me);
 104       off = gh_scm2double (pos) * space/2.0;
 105       me->set_grob_property ("staff-position", gh_int2scm (0));
 106     }
 107
 108   return gh_double2scm (off);
 109 }
 110
 111  /*
 112
 113   This sets the position relative to the center of the staff symbol.
 114
 115   The function is hairy, because it can be callled in two situations:
 116
 117   1.  There is no staff yet; we must set staff-position
 118
 119   2.  There is a staff, and perhaps someone even applied a
 120   translate_axis (). Then we must compensate for the translation
 121
 122   In either case, we set a callback to be sure that our new position
 123   will be extracted from staff-position
 124
 125  */
 126 void
 127 Staff_symbol_referencer::set_position (Grob*me,Real p)
 128 {
 129   Grob * st = get_staff_symbol (me);
 130   if (st && me->common_refpoint (st, Y_AXIS))
 131     {
 132       Real oldpos = get_position (me);
 133       me->set_grob_property ("staff-position", gh_double2scm (p - oldpos));
 134     }
 135   else
 136     {
 137       me->set_grob_property ("staff-position",
 138                             gh_double2scm (p));
 139
 140     }
 141
 142   if (me->has_offset_callback_b (Staff_symbol_referencer::callback_proc, Y_AXIS))
 143     return ;
 144
 145   me->add_offset_callback (Staff_symbol_referencer::callback_proc, Y_AXIS);
 146 }
 147
 148 /*
 149   Half of the height, in staff space, i.e. 2.0 for a normal staff.
 150 */
 151 Real
 152 Staff_symbol_referencer::staff_radius (Grob*me)
 153 {
 154   return (line_count (me) -1) / 2.0;
 155 }
 156
 157
 158 int
 159 compare_position (Grob *const  &a, Grob * const &b)
 160 {
 161   return sign (Staff_symbol_referencer::get_position ((Grob*)a) -
 162     Staff_symbol_referencer::get_position ((Grob*)b));
 163 }
 164
 165 ADD_INTERFACE (Staff_symbol_referencer,"staff-symbol-referencer-interface",
 166   "Object whose Y position is meaning with reference to a staff "
 167 "symbol. Objects that have this interface should include "
 168 "Staff_symbol_referencer::callback in their Y-offset-callback. "
 169 ,
 170   "staff-position");