lily/staff-symbol.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include "staff-symbol.hh"
  21
  22 #include "lookup.hh"
  23 #include "dimensions.hh"
  24 #include "output-def.hh"
  25 #include "warn.hh"
  26 #include "item.hh"
  27 #include "staff-symbol-referencer.hh"
  28 #include "spanner.hh"
  29
  30 MAKE_SCHEME_CALLBACK (Staff_symbol, print, 1);
  31
  32 SCM
  33 Staff_symbol::print (SCM smob)
  34 {
  35   Grob *me = unsmob_grob (smob);
  36   Spanner *sp = dynamic_cast<Spanner *> (me);
  37   Grob *common
  38     = sp->get_bound (LEFT)->common_refpoint (sp->get_bound (RIGHT), X_AXIS);
  39
  40   Interval span_points (0, 0);
  41
  42   /*
  43     For raggedright without ragged staves, simply set width to the linewidth.
  44
  45     (ok -- lousy UI, since width is in staff spaces)
  46
  47     --hwn.
  48   */
  49   Real t = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
  50   t *= robust_scm2double (me->get_property ("thickness"), 1.0);
  51
  52   Direction d = LEFT;
  53   do
  54     {
  55       SCM width_scm = me->get_property ("width");
  56       if (d == RIGHT && scm_is_number (width_scm))
  57         {
  58           /*
  59             don't multiply by Staff_symbol_referencer::staff_space (me),
  60             since that would make aligning staff symbols of different sizes to
  61             one right margin hell.
  62           */
  63           span_points[RIGHT] = scm_to_double (width_scm);
  64         }
  65       else
  66         {
  67           Item *x = sp->get_bound (d);
  68
  69           span_points[d] = x->relative_coordinate (common, X_AXIS);
  70           if (!x->break_status_dir ()
  71               && !x->extent (x, X_AXIS).is_empty ())
  72             span_points[d] += x->extent (x, X_AXIS)[d];
  73         }
  74
  75       span_points[d] -= d * t / 2;
  76     }
  77   while (flip (&d) != LEFT);
  78
  79   Stencil m;
  80
  81   vector<Real> line_positions = Staff_symbol::line_positions (me);
  82   int line_count = line_positions.size ();
  83
  84   Stencil line
  85     = Lookup::horizontal_line (span_points
  86                                - me->relative_coordinate (common, X_AXIS),
  87                                t);
  88
  89   Real space = staff_space (me);
  90   for (int i = 0; i < line_count; i++)
  91     {
  92       Stencil b (line);
  93       b.translate_axis (line_positions[i] * 0.5 * space, Y_AXIS);
  94       m.add_stencil (b);
  95     }
  96   return m.smobbed_copy ();
  97 }
  98
  99 vector<Real>
 100 Staff_symbol::line_positions (Grob *me)
 101 {
 102   SCM line_positions = me->get_property ("line-positions");
 103   if (scm_is_pair (line_positions))
 104     {
 105       int line_count = scm_ilength (line_positions);
 106       vector<Real> values (line_count);
 107       int i = 0;
 108       for (SCM s = line_positions; scm_is_pair (s);
 109            s = scm_cdr (s))
 110         {
 111           values[i++] = scm_to_double (scm_car (s));
 112         }
 113       return values;
 114     }
 115   else
 116     {
 117       int line_count = Staff_symbol::line_count (me);
 118       Real height = line_count - 1;
 119       vector<Real> values (line_count);
 120       for (int i = 0; i < line_count; i++)
 121         {
 122           values[i] = height - i * 2;
 123         }
 124       return values;
 125     }
 126 }
 127
 128 vector<Real>
 129 Staff_symbol::ledger_positions (Grob *me, int pos)
 130 {
 131   SCM ledger_positions = me->get_property ("ledger-positions");
 132   Real ledger_extra = robust_scm2double (me->get_property ("ledger-extra"), 0);
 133   vector<Real> line_positions = Staff_symbol::line_positions (me);
 134   vector<Real> values;
 135
 136   if (line_positions.empty ())
 137     return values;
 138
 139   int line_count = line_positions.size ();
 140
 141   // find the staff line nearest to note position
 142   Real nearest_line = line_positions[0];
 143   Real line_dist = abs (line_positions[0] - pos);
 144   for (int i = 1; i < line_count; i++)
 145     {
 146       if (abs (line_positions[i] - pos) < line_dist)
 147         {
 148           nearest_line = line_positions[i];
 149           line_dist = abs (line_positions[i] - pos);
 150         }
 151     }
 152
 153   if (line_dist < .5)
 154     return values;
 155
 156   Direction dir = (Direction)sign (pos - nearest_line);
 157
 158   if (scm_is_pair (ledger_positions))
 159     {
 160       Real min_pos = HUGE_VAL;
 161       Real max_pos = -HUGE_VAL;
 162       SCM s2;
 163
 164       // find the extent of the ledger pattern
 165       for (SCM s = ledger_positions; scm_is_pair (s); s = scm_cdr (s))
 166         {
 167           s2 = scm_car (s);
 168           if (!scm_is_number (s2))
 169             s2 = scm_car (s2);
 170           Real current_ledger = scm_to_double (s2);
 171           if (current_ledger > max_pos)
 172             max_pos = current_ledger;
 173           if (current_ledger < min_pos)
 174             min_pos = current_ledger;
 175         }
 176
 177       Real cycle = max_pos - min_pos;
 178
 179       Interval ledger_fill;
 180       ledger_fill.add_point (nearest_line + 0.5 * dir);
 181       ledger_fill.add_point (pos + 0.5 * dir + ledger_extra * dir);
 182
 183       // fill the Interval ledger_fill with ledger lines
 184       int n = floor ((ledger_fill[DOWN] - min_pos) / cycle);
 185       Real current;
 186       SCM s = scm_cdr (ledger_positions);
 187       do
 188         {
 189           s2 = scm_car (s);
 190           if (scm_is_number (s2))
 191             {
 192               current = scm_to_double (s2) + n * cycle;
 193               if (ledger_fill.contains (current))
 194                 values.push_back (current);
 195             }
 196           else
 197             // grouped ledger lines, either add all or none
 198             {
 199               do
 200                 {
 201                   current = scm_to_double (scm_car (s2)) + n * cycle;
 202                   if (ledger_fill.contains (current))
 203                     {
 204                       s2 = scm_car (s);
 205                       do
 206                         {
 207                           current = scm_to_double (scm_car (s2)) + n * cycle;
 208                           values.push_back (current);
 209                           s2 = scm_cdr (s2);
 210                         }
 211                       while (scm_is_pair (s2));
 212                     }
 213                   else
 214                     s2 = scm_cdr (s2);
 215                 }
 216               while (scm_is_pair (s2));
 217             }
 218           s = scm_cdr (s);
 219           if (!scm_is_pair (s))
 220             {
 221               s = scm_cdr (ledger_positions);
 222               n++;
 223             }
 224         }
 225       while (current <= ledger_fill[UP]);
 226     }
 227   else
 228     {
 229       int ledger_count = floor ((abs (nearest_line - pos) + ledger_extra) / 2);
 230       values.resize (ledger_count);
 231       for (int i = 0; i < ledger_count; i++)
 232         {
 233           values[i] = nearest_line + dir * (ledger_count - i) * 2;
 234         }
 235     }
 236   return values;
 237 }
 238
 239 int
 240 Staff_symbol::line_count (Grob *me)
 241 {
 242   SCM line_positions = me->get_property ("line-positions");
 243   if (scm_is_pair (line_positions))
 244     return scm_ilength (line_positions);
 245   else
 246     return robust_scm2int (me->get_property ("line-count"), 0);
 247 }
 248
 249 Real
 250 Staff_symbol::staff_space (Grob *me)
 251 {
 252   return robust_scm2double (me->get_property ("staff-space"), 1.0);
 253 }
 254
 255 Real
 256 Staff_symbol::get_line_thickness (Grob *me)
 257 {
 258   Real lt = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
 259
 260   return robust_scm2double (me->get_property ("thickness"), 1.0) * lt;
 261 }
 262
 263 Real
 264 Staff_symbol::get_ledger_line_thickness (Grob *me)
 265 {
 266   SCM lt_pair = me->get_property ("ledger-line-thickness");
 267   Offset z = robust_scm2offset (lt_pair, Offset (1.0, 0.1));
 268
 269   return z[X_AXIS] * get_line_thickness (me) + z[Y_AXIS] * staff_space (me);
 270 }
 271
 272 MAKE_SCHEME_CALLBACK (Staff_symbol, height, 1);
 273 SCM
 274 Staff_symbol::height (SCM smob)
 275 {
 276   Grob *me = unsmob_grob (smob);
 277   Real t = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
 278   t *= robust_scm2double (me->get_property ("thickness"), 1.0);
 279
 280   SCM line_positions = me->get_property ("line-positions");
 281
 282   Interval y_ext;
 283   Real space = staff_space (me);
 284   if (scm_is_pair (line_positions))
 285     {
 286       for (SCM s = line_positions; scm_is_pair (s);
 287            s = scm_cdr (s))
 288         y_ext.add_point (scm_to_double (scm_car (s)) * 0.5 * space);
 289     }
 290   else
 291     {
 292       int l = Staff_symbol::line_count (me);
 293       Real height = (l - 1) * staff_space (me) / 2;
 294       y_ext = Interval (-height, height);
 295     }
 296   y_ext.widen (t / 2);
 297   return ly_interval2scm (y_ext);
 298 }
 299
 300 bool
 301 Staff_symbol::on_line (Grob *me, int pos)
 302 {
 303   SCM line_positions = me->get_property ("line-positions");
 304   if (scm_is_pair (line_positions))
 305     {
 306       Real min_line = HUGE_VAL;
 307       Real max_line = -HUGE_VAL;
 308       for (SCM s = line_positions; scm_is_pair (s); s = scm_cdr (s))
 309         {
 310           Real current_line = scm_to_double (scm_car (s));
 311           if (pos == current_line)
 312             return true;
 313           if (current_line > max_line)
 314             max_line = current_line;
 315           if (current_line < min_line)
 316             min_line = current_line;
 317
 318         }
 319       if (pos < min_line)
 320         return (( (int) (rint (pos - min_line)) % 2) == 0);
 321       if (pos > max_line)
 322         return (( (int) (rint (pos - max_line)) % 2) == 0);
 323
 324       return false;
 325     }
 326   else
 327     return ((abs (pos + line_count (me)) % 2) == 1);
 328 }
 329
 330 Interval
 331 Staff_symbol::line_span (Grob *me)
 332 {
 333   SCM line_positions = me->get_property ("line-positions");
 334   Interval iv;
 335
 336   if (scm_is_pair (line_positions))
 337     for (SCM s = line_positions; scm_is_pair (s); s = scm_cdr (s))
 338       iv.add_point (scm_to_double (scm_car (s)));
 339   else
 340     {
 341       int count = line_count (me);
 342       return Interval (-count + 1, count - 1);
 343     }
 344
 345   return iv;
 346 }
 347
 348 ADD_INTERFACE (Staff_symbol,
 349                "This spanner draws the lines of a staff.  A staff symbol"
 350                " defines a vertical unit, the @emph{staff space}.  Quantities"
 351                " that go by a half staff space are called @emph{positions}."
 352                "  The center (i.e., middle line or space) is position@tie{}0."
 353                " The length of the symbol may be set by hand through the"
 354                " @code{width} property.",
 355
 356                /* properties */
 357                "ledger-extra "
 358                "ledger-line-thickness "
 359                "ledger-positions "
 360                "line-count "
 361                "line-positions "
 362                "staff-space "
 363                "thickness "
 364                "width "
 365               );