lily/lyric-hyphen.cc

   1 /*
   2   hyphen-spanner.cc -- implement Hyphen_spanner
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2003--2005 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #include "lyric-hyphen.hh"
  10
  11
  12 #include "lookup.hh"
  13 #include "output-def.hh"
  14 #include "paper-column.hh"
  15 #include "moment.hh"
  16
  17 MAKE_SCHEME_CALLBACK (Hyphen_spanner, print, 1)
  18   SCM
  19 Hyphen_spanner::print (SCM smob)
  20 {
  21   Spanner *me = unsmob_spanner (smob);
  22   Drul_array<Item *> bounds (me->get_bound (LEFT),
  23                              me->get_bound (RIGHT));
  24
  25   if (bounds[LEFT]->break_status_dir ()
  26       && (Paper_column::when_mom (bounds[LEFT])
  27           == Paper_column::when_mom (bounds[RIGHT]->get_column ())))
  28     return SCM_EOL;
  29
  30   Grob *common = bounds[LEFT]->common_refpoint (bounds[RIGHT], X_AXIS);
  31
  32   Interval span_points;
  33   Direction d = LEFT;
  34   Drul_array<bool> broken;
  35   do
  36     {
  37       Interval iv = bounds[d]->extent (common, X_AXIS);
  38
  39       span_points[d] = iv.is_empty ()
  40         ? bounds[d]->relative_coordinate (common, X_AXIS)
  41         : iv[-d];
  42     }
  43   while (flip (&d) != LEFT);
  44
  45   Real lt = me->get_layout ()->get_dimension (ly_symbol2scm ("linethickness"));
  46   Real th = robust_scm2double (me->get_property ("thickness"), 1) * lt;
  47   Real h = robust_scm2double (me->get_property ("height"), 0.5);
  48
  49   // interval?
  50
  51   Real dash_period = robust_scm2double (me->get_property ("dash-period"), 1.0);
  52   Real dash_length = robust_scm2double (me->get_property ("length"), .5);
  53   Real padding = robust_scm2double (me->get_property ("padding"), 0.1);
  54
  55   if (dash_period < dash_length)
  56     dash_period = 1.5 * dash_length;
  57
  58   Real l = span_points.length ();
  59
  60   int n = int (ceil (l / dash_period - 0.5));
  61   if (n <= 0)
  62     n = 1;
  63
  64   if (l < dash_length + 2 * padding
  65       && !bounds[RIGHT]->break_status_dir ())
  66     {
  67       Real minimum_length = robust_scm2double (me->get_property ("minimum-length"), .3);
  68       dash_length = max ((l - 2 * padding), minimum_length);
  69     }
  70
  71   Real space_left = l - dash_length - (n - 1) * dash_period;
  72
  73   /*
  74     If there is not enough space, the hyphen should disappear, but not
  75     at the end of the line.
  76   */
  77   if (space_left < 0.0
  78       && !bounds[RIGHT]->break_status_dir ())
  79     return SCM_EOL;
  80
  81   space_left = max (space_left, 0.0);
  82
  83   Box b (Interval (0, dash_length), Interval (h, h + th));
  84   Stencil dash_mol (Lookup::round_filled_box (b, 0.8 * lt));
  85
  86   Stencil total;
  87   for (int i = 0; i < n; i++)
  88     {
  89       Stencil m (dash_mol);
  90       m.translate_axis (span_points[LEFT] + i * dash_period + space_left / 2, X_AXIS);
  91       total.add_stencil (m);
  92     }
  93
  94   total.translate_axis (-me->relative_coordinate (common, X_AXIS), X_AXIS);
  95   return total.smobbed_copy ();
  96 }
  97
  98 MAKE_SCHEME_CALLBACK (Hyphen_spanner, set_spacing_rods, 1);
  99 SCM
 100 Hyphen_spanner::set_spacing_rods (SCM smob)
 101 {
 102   Grob *me = unsmob_grob (smob);
 103
 104   Rod r;
 105   Spanner *sp = dynamic_cast<Spanner *> (me);
 106   r.distance_
 107     = robust_scm2double (me->get_property ("minimum-length"), 0);
 108
 109   if (r.distance_ > 0.0)
 110     {
 111       Real padding = robust_scm2double (me->get_property ("padding"), 0.1);
 112       r.distance_ += 2*padding;
 113       Direction d = LEFT;
 114       do
 115         {
 116           r.item_drul_[d] = sp->get_bound (d);
 117           if (r.item_drul_[d])
 118             r.distance_ += r.item_drul_[d]->extent (r.item_drul_[d], X_AXIS)[-d];
 119         }
 120       while (flip (&d) != LEFT);
 121
 122       if (r.item_drul_[LEFT]
 123           && r.item_drul_[RIGHT])
 124         r.add_to_cols ();
 125     }
 126
 127   return SCM_UNSPECIFIED;
 128 }
 129
 130 ADD_INTERFACE (Hyphen_spanner, "lyric-hyphen-interface",
 131                "A centred hyphen is a simple line between lyrics used to divide syllables",
 132                "padding thickness height dash-period minimum-length length");
 133