2 hyphen-spanner.cc -- implement Hyphen_spanner
4 source file of the GNU LilyPond music typesetter
6 (c) 2003--2006 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 dimensions or hyphen glyph from the
22 MAKE_SCHEME_CALLBACK (Hyphen_spanner, print, 1);
24 Hyphen_spanner::print (SCM smob)
26 Spanner *me = unsmob_spanner (smob);
27 Drul_array<Item *> bounds (me->get_bound (LEFT),
28 me->get_bound (RIGHT));
30 if (bounds[LEFT]->break_status_dir ()
31 && (Paper_column::when_mom (bounds[LEFT])
32 == Paper_column::when_mom (bounds[RIGHT]->get_column ())))
35 Grob *common = bounds[LEFT]->common_refpoint (bounds[RIGHT], X_AXIS);
39 Drul_array<bool> broken;
42 Interval iv = bounds[d]->extent (common, X_AXIS);
44 span_points[d] = iv.is_empty ()
45 ? bounds[d]->relative_coordinate (common, X_AXIS)
48 while (flip (&d) != LEFT);
50 Real lt = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
51 Real th = robust_scm2double (me->get_property ("thickness"), 1) * lt;
52 Real font_size_step = robust_scm2double (me->get_property ("font-size"), 0.0);
53 Real h = robust_scm2double (me->get_property ("height"), 0.5)
54 * pow (2.0, font_size_step / 6.0);
58 Real dash_period = robust_scm2double (me->get_property ("dash-period"), 1.0);
59 Real dash_length = robust_scm2double (me->get_property ("length"), .5);
60 Real padding = robust_scm2double (me->get_property ("padding"), 0.1);
62 if (dash_period < dash_length)
63 dash_period = 1.5 * dash_length;
65 Real l = span_points.length ();
67 int n = int (ceil (l / dash_period - 0.5));
71 if (l < dash_length + 2 * padding
72 && !bounds[RIGHT]->break_status_dir ())
74 Real minimum_length = robust_scm2double (me->get_property ("minimum-length"), .3);
75 dash_length = max ((l - 2 * padding), minimum_length);
78 Real space_left = l - dash_length - (n - 1) * dash_period;
81 If there is not enough space, the hyphen should disappear, but not
82 at the end of the line.
85 && !bounds[RIGHT]->break_status_dir ())
88 space_left = max (space_left, 0.0);
90 Box b (Interval (0, dash_length), Interval (h, h + th));
91 Stencil dash_mol (Lookup::round_filled_box (b, 0.8 * lt));
94 for (int i = 0; i < n; i++)
97 m.translate_axis (span_points[LEFT] + i * dash_period + space_left / 2, X_AXIS);
98 total.add_stencil (m);
101 total.translate_axis (-me->relative_coordinate (common, X_AXIS), X_AXIS);
102 return total.smobbed_copy ();
105 MAKE_SCHEME_CALLBACK (Hyphen_spanner, set_spacing_rods, 1);
107 Hyphen_spanner::set_spacing_rods (SCM smob)
109 Grob *me = unsmob_grob (smob);
112 Spanner *sp = dynamic_cast<Spanner *> (me);
114 r.distance_ = robust_scm2double (me->get_property ("minimum-distance"), 0);
118 r.item_drul_[d] = sp->get_bound (d);
120 r.distance_ += -d * r.item_drul_[d]->extent (r.item_drul_[d], X_AXIS)[-d];
122 while (flip (&d) != LEFT);
124 if (r.item_drul_[LEFT]
125 && r.item_drul_[RIGHT])
128 return SCM_UNSPECIFIED;
131 ADD_INTERFACE (Hyphen_spanner,
133 "lyric-hyphen-interface",
135 "A centered hyphen is a simple line between "
136 "lyrics used to divide syllables",