2 hyphen-spanner.cc -- implement Hyphen_spanner
4 source file of the GNU LilyPond music typesetter
6 (c) 2003--2005 Han-Wen Nienhuys <hanwen@xs4all.nl>
9 #include "lyric-hyphen.hh"
13 #include "output-def.hh"
14 #include "paper-column.hh"
18 TODO: should extract hyphen from the font.
20 MAKE_SCHEME_CALLBACK (Hyphen_spanner, print, 1);
22 Hyphen_spanner::print (SCM smob)
24 Spanner *me = unsmob_spanner (smob);
25 Drul_array<Item *> bounds (me->get_bound (LEFT),
26 me->get_bound (RIGHT));
28 if (bounds[LEFT]->break_status_dir ()
29 && (Paper_column::when_mom (bounds[LEFT])
30 == Paper_column::when_mom (bounds[RIGHT]->get_column ())))
33 Grob *common = bounds[LEFT]->common_refpoint (bounds[RIGHT], X_AXIS);
37 Drul_array<bool> broken;
40 Interval iv = bounds[d]->extent (common, X_AXIS);
42 span_points[d] = iv.is_empty ()
43 ? bounds[d]->relative_coordinate (common, X_AXIS)
46 while (flip (&d) != LEFT);
48 Real lt = me->get_layout ()->get_dimension (ly_symbol2scm ("linethickness"));
49 Real th = robust_scm2double (me->get_property ("thickness"), 1) * lt;
50 Real h = robust_scm2double (me->get_property ("height"), 0.5);
54 Real dash_period = robust_scm2double (me->get_property ("dash-period"), 1.0);
55 Real dash_length = robust_scm2double (me->get_property ("length"), .5);
56 Real padding = robust_scm2double (me->get_property ("padding"), 0.1);
58 if (dash_period < dash_length)
59 dash_period = 1.5 * dash_length;
61 Real l = span_points.length ();
63 int n = int (ceil (l / dash_period - 0.5));
67 if (l < dash_length + 2 * padding
68 && !bounds[RIGHT]->break_status_dir ())
70 Real minimum_length = robust_scm2double (me->get_property ("minimum-length"), .3);
71 dash_length = max ((l - 2 * padding), minimum_length);
74 Real space_left = l - dash_length - (n - 1) * dash_period;
77 If there is not enough space, the hyphen should disappear, but not
78 at the end of the line.
81 && !bounds[RIGHT]->break_status_dir ())
84 space_left = max (space_left, 0.0);
86 Box b (Interval (0, dash_length), Interval (h, h + th));
87 Stencil dash_mol (Lookup::round_filled_box (b, 0.8 * lt));
90 for (int i = 0; i < n; i++)
93 m.translate_axis (span_points[LEFT] + i * dash_period + space_left / 2, X_AXIS);
94 total.add_stencil (m);
97 total.translate_axis (-me->relative_coordinate (common, X_AXIS), X_AXIS);
98 return total.smobbed_copy ();
101 MAKE_SCHEME_CALLBACK (Hyphen_spanner, set_spacing_rods, 1);
103 Hyphen_spanner::set_spacing_rods (SCM smob)
105 Grob *me = unsmob_grob (smob);
108 Spanner *sp = dynamic_cast<Spanner *> (me);
110 = robust_scm2double (me->get_property ("minimum-length"), 0);
112 if (r.distance_ > 0.0)
114 Real padding = robust_scm2double (me->get_property ("padding"), 0.1);
115 r.distance_ += 2*padding;
119 r.item_drul_[d] = sp->get_bound (d);
121 r.distance_ += r.item_drul_[d]->extent (r.item_drul_[d], X_AXIS)[-d];
123 while (flip (&d) != LEFT);
125 if (r.item_drul_[LEFT]
126 && r.item_drul_[RIGHT])
130 return SCM_UNSPECIFIED;
133 ADD_INTERFACE (Hyphen_spanner, "lyric-hyphen-interface",
134 "A centered hyphen is a simple line between lyrics used to divide syllables",