2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2003--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
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.
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.
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/>.
20 #include "lyric-hyphen.hh"
23 #include "output-def.hh"
24 #include "paper-column.hh"
29 TODO: should extract hyphen dimensions or hyphen glyph from the
33 MAKE_SCHEME_CALLBACK (Lyric_hyphen, print, 1);
35 Lyric_hyphen::print (SCM smob)
37 Spanner *me = unsmob_spanner (smob);
38 Drul_array<Item *> bounds (me->get_bound (LEFT),
39 me->get_bound (RIGHT));
41 if (bounds[LEFT]->break_status_dir ()
42 && (Paper_column::when_mom (bounds[LEFT])
43 == Paper_column::when_mom (bounds[RIGHT]->get_column ())))
46 Grob *common = bounds[LEFT]->common_refpoint (bounds[RIGHT], X_AXIS);
50 Drul_array<bool> broken;
53 Interval iv = bounds[d]->extent (common, X_AXIS);
55 span_points[d] = iv.is_empty ()
56 ? bounds[d]->relative_coordinate (common, X_AXIS)
59 while (flip (&d) != LEFT);
61 Real lt = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
62 Real th = robust_scm2double (me->get_property ("thickness"), 1) * lt;
63 Real font_size_step = robust_scm2double (me->get_property ("font-size"), 0.0);
64 Real h = robust_scm2double (me->get_property ("height"), 0.5)
65 * pow (2.0, font_size_step / 6.0);
69 Real dash_period = robust_scm2double (me->get_property ("dash-period"), 1.0);
70 Real dash_length = robust_scm2double (me->get_property ("length"), .5);
71 Real padding = robust_scm2double (me->get_property ("padding"), 0.1);
73 if (dash_period < dash_length)
74 dash_period = 1.5 * dash_length;
76 Real l = span_points.length ();
78 int n = int (ceil (l / dash_period - 0.5));
82 if (l < dash_length + 2 * padding
83 && !bounds[RIGHT]->break_status_dir ())
85 Real minimum_length = robust_scm2double (me->get_property ("minimum-length"), .3);
86 dash_length = max ((l - 2 * padding), minimum_length);
89 Real space_left = l - dash_length - (n - 1) * dash_period;
92 If there is not enough space, the hyphen should disappear, but not
93 at the end of the line.
96 && !bounds[RIGHT]->break_status_dir ())
99 space_left = max (space_left, 0.0);
101 Box b (Interval (0, dash_length), Interval (h, h + th));
102 Stencil dash_mol (Lookup::round_filled_box (b, 0.8 * lt));
105 for (int i = 0; i < n; i++)
107 Stencil m (dash_mol);
108 m.translate_axis (span_points[LEFT] + i * dash_period + space_left / 2, X_AXIS);
109 total.add_stencil (m);
112 total.translate_axis (-me->relative_coordinate (common, X_AXIS), X_AXIS);
113 return total.smobbed_copy ();
116 MAKE_SCHEME_CALLBACK (Lyric_hyphen, set_spacing_rods, 1);
118 Lyric_hyphen::set_spacing_rods (SCM smob)
120 Grob *me = unsmob_grob (smob);
123 Spanner *sp = dynamic_cast<Spanner *> (me);
125 r.distance_ = robust_scm2double (me->get_property ("minimum-distance"), 0);
129 r.item_drul_[d] = sp->get_bound (d);
131 r.distance_ += -d * r.item_drul_[d]->extent (r.item_drul_[d], X_AXIS)[-d];
133 while (flip (&d) != LEFT);
135 if (r.item_drul_[LEFT]
136 && r.item_drul_[RIGHT])
139 return SCM_UNSPECIFIED;
142 ADD_INTERFACE (Lyric_hyphen,
143 "A centered hyphen is simply a line between lyrics used to"
144 " divide syllables.",