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--2004 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 "output-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 /*
  31   This does not take size into account.
  32   maybe rename: on_virtual_staffline, on_staff_or_ledger_line?
  33  */
  34 bool
  35 Staff_symbol_referencer::on_staffline (Grob *me, int pos)
  36 {
  37   int sz = line_count (me) - 1;
  38   return ((pos + sz) % 2) == 0;
  39 }
  40
  41 Grob*
  42 Staff_symbol_referencer::get_staff_symbol (Grob *me)
  43 {
  44   if (Staff_symbol::has_interface (me))
  45     return me;
  46
  47   SCM st = me->get_property ("staff-symbol");
  48   return unsmob_grob (st);
  49 }
  50
  51 Real
  52 Staff_symbol_referencer::staff_space (Grob *me)
  53 {
  54   Grob *st = get_staff_symbol (me);
  55   if (st)
  56     return Staff_symbol::staff_space (st);
  57   return 1.0;
  58 }
  59
  60 Real
  61 Staff_symbol_referencer::line_thickness (Grob *me)
  62 {
  63   Grob *st = get_staff_symbol (me);
  64   if (st)
  65     return Staff_symbol::get_line_thickness (st);
  66   return me->get_layout ()->get_dimension (ly_symbol2scm ("linethickness"));
  67 }
  68
  69 Real
  70 Staff_symbol_referencer::get_position (Grob *me)
  71 {
  72   Real p = 0.0;
  73   Grob *st = get_staff_symbol (me);
  74   Grob *c = st ? me->common_refpoint (st, Y_AXIS) : 0;
  75   if (st && c)
  76     {
  77       Real y = me->relative_coordinate (c, Y_AXIS)
  78         - st->relative_coordinate (c, Y_AXIS);
  79
  80       p += 2.0 * y / Staff_symbol::staff_space (st);
  81       return p;
  82     }
  83   else if (!st)
  84     {
  85       return me->relative_coordinate (me->get_parent (Y_AXIS), Y_AXIS) * 2;
  86     }
  87   return robust_scm2double (me->get_property ("staff-position"), p);
  88 }
  89
  90 int
  91 Staff_symbol_referencer::get_rounded_position (Grob*me)
  92 {
  93   return int (rint (get_position (me)));
  94 }
  95
  96 LY_DEFINE (ly_grob_staff_position, "ly:grob-staff-position",
  97            1, 0,0, (SCM sg),
  98            "Return the Y-position of @var{sg} relative to the staff.")
  99 {
 100   Grob *g = unsmob_grob (sg);
 101
 102   SCM_ASSERT_TYPE (g, sg, SCM_ARG1, __FUNCTION__, "grob");
 103   Real pos = Staff_symbol_referencer::get_position (g);
 104
 105   if (fabs (rint (pos) -pos) < 1e-6) // ugh.
 106     return scm_int2num ((int) my_round (pos));
 107   else
 108     return scm_make_real (pos);
 109 }
 110
 111
 112 /* should use offset callback!  */
 113 MAKE_SCHEME_CALLBACK (Staff_symbol_referencer,callback,2);
 114 SCM
 115 Staff_symbol_referencer::callback (SCM element_smob, SCM)
 116 {
 117   Grob *me = unsmob_grob (element_smob);
 118
 119   SCM pos = me->get_property ("staff-position");
 120   Real off = 0.0;
 121   if (scm_is_number (pos))
 122     {
 123       Real space = Staff_symbol_referencer::staff_space (me);
 124       off = scm_to_double (pos) * space / 2.0;
 125       me->set_property ("staff-position", scm_int2num (0));
 126     }
 127
 128   return scm_make_real (off);
 129 }
 130
 131 /*  This sets the position relative to the center of the staff symbol.
 132
 133 The function is hairy, because it can be called in two situations:
 134
 135 1. There is no staff yet; we must set staff-position
 136
 137 2. There is a staff, and perhaps someone even applied a
 138 translate_axis (). Then we must compensate for the translation
 139
 140 In either case, we set a callback to be sure that our new position
 141 will be extracted from staff-position */
 142
 143 void
 144 Staff_symbol_referencer::set_position (Grob *me, Real p)
 145 {
 146   Grob *st = get_staff_symbol (me);
 147   if (st && me->common_refpoint (st, Y_AXIS))
 148     {
 149       Real oldpos = get_position (me);
 150       me->set_property ("staff-position", scm_make_real (p - oldpos));
 151     }
 152   else
 153     me->set_property ("staff-position", scm_make_real (p));
 154
 155   me->add_offset_callback (Staff_symbol_referencer::callback_proc, Y_AXIS);
 156 }
 157
 158 /* Half of the height, in staff space, i.e. 2.0 for a normal staff. */
 159 Real
 160 Staff_symbol_referencer::staff_radius (Grob *me)
 161 {
 162   return (line_count (me) - 1) / 2.0;
 163 }
 164
 165 int
 166 compare_position (Grob *const &a, Grob *const &b)
 167 {
 168   return sign (Staff_symbol_referencer::get_position ((Grob*)a)
 169                - Staff_symbol_referencer::get_position ((Grob*) b));
 170 }
 171
 172 ADD_INTERFACE (Staff_symbol_referencer,"staff-symbol-referencer-interface",
 173                "An object whose Y position is meant relative to a staff "
 174                "symbol. "
 175                "These usually have @code{Staff_symbol_referencer::callback} "
 176                "in their @code{Y-offset-callbacks}. "
 177                ,
 178                "staff-position");
 179