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 "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_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   return 1.0;
  51 }
  52
  53 Real
  54 Staff_symbol_referencer::line_thickness (Grob *me)
  55 {
  56   Grob *st = get_staff_symbol (me);
  57   if (st)
  58     return Staff_symbol::get_line_thickness (st);
  59   return me->get_paper ()->get_realvar (ly_symbol2scm ("linethickness"));
  60 }
  61
  62 Real
  63 Staff_symbol_referencer::get_position (Grob *me)
  64 {
  65   Real p = 0.0;
  66   Grob *st = get_staff_symbol (me);
  67   Grob *c = st ? me->common_refpoint (st, Y_AXIS) : 0;
  68   if (st && c)
  69     {
  70       Real y = me->relative_coordinate (c, Y_AXIS)
  71         - st->relative_coordinate (c, Y_AXIS);
  72
  73       p += 2.0 * y / Staff_symbol::staff_space (st);
  74       return p;
  75     }
  76
  77   return robust_scm2double (me->get_property ("staff-position"), p);
  78 }
  79
  80
  81 LY_DEFINE (ly_grob_staff_position, "ly:grob-staff-position",
  82            1, 0,0, (SCM sg),
  83            "Return the Y-position of this grob relative to the staff.")
  84 {
  85   Grob *g = unsmob_grob (sg);
  86
  87   SCM_ASSERT_TYPE (g, sg, SCM_ARG1, __FUNCTION__, "grob");
  88   Real pos = Staff_symbol_referencer::get_position (g);
  89
  90   if (fabs (rint (pos) -pos) < 1e-6) // ugh.
  91     return gh_int2scm ((int) my_round (pos));
  92   else
  93     return gh_double2scm (pos);
  94 }
  95
  96
  97 /* should use offset callback!  */
  98 MAKE_SCHEME_CALLBACK (Staff_symbol_referencer,callback,2);
  99 SCM
 100 Staff_symbol_referencer::callback (SCM element_smob, SCM)
 101 {
 102   Grob *me = unsmob_grob (element_smob);
 103
 104   SCM pos = me->get_property ("staff-position");
 105   Real off = 0.0;
 106   if (gh_number_p (pos))
 107     {
 108       Real space = Staff_symbol_referencer::staff_space (me);
 109       off = gh_scm2double (pos) * space / 2.0;
 110       me->set_property ("staff-position", gh_int2scm (0));
 111     }
 112
 113   return gh_double2scm (off);
 114 }
 115
 116 /*  This sets the position relative to the center of the staff symbol.
 117
 118 The function is hairy, because it can be callled in two situations:
 119
 120 1. There is no staff yet; we must set staff-position
 121
 122 2. There is a staff, and perhaps someone even applied a
 123 translate_axis (). Then we must compensate for the translation
 124
 125 In either case, we set a callback to be sure that our new position
 126 will be extracted from staff-position */
 127
 128 void
 129 Staff_symbol_referencer::set_position (Grob *me, Real p)
 130 {
 131   Grob *st = get_staff_symbol (me);
 132   if (st && me->common_refpoint (st, Y_AXIS))
 133     {
 134       Real oldpos = get_position (me);
 135       me->set_property ("staff-position", gh_double2scm (p - oldpos));
 136     }
 137   else
 138     me->set_property ("staff-position", gh_double2scm (p));
 139
 140   if (!me->has_offset_callback (Staff_symbol_referencer::callback_proc,
 141                                 Y_AXIS))
 142     me->add_offset_callback (Staff_symbol_referencer::callback_proc, Y_AXIS);
 143 }
 144
 145 /* Half of the height, in staff space, i.e. 2.0 for a normal staff. */
 146 Real
 147 Staff_symbol_referencer::staff_radius (Grob *me)
 148 {
 149   return (line_count (me) - 1) / 2.0;
 150 }
 151
 152 int
 153 compare_position (Grob *const &a, Grob *const &b)
 154 {
 155   return sign (Staff_symbol_referencer::get_position ((Grob*)a)
 156                - Staff_symbol_referencer::get_position ((Grob*) b));
 157 }
 158
 159 ADD_INTERFACE (Staff_symbol_referencer,"staff-symbol-referencer-interface",
 160                "An object whose Y position is meant relative to a staff "
 161                "symbol. "
 162                "These usually have @code{Staff_symbol_referencer::callback} "
 163                "in their @code{Y-offset-callbacks}. "
 164                ,
 165                "staff-position");