2 hyphen-spanner.cc -- implement Hyphen_spanner
4 source file of the GNU LilyPond music typesetter
6 (c) 1999--2003 Glen Prideaux <glenprideaux@iname.com>
8 (adapted from lyric-extender)
15 #include "molecule.hh"
16 #include "paper-def.hh"
17 #include "hyphen-spanner.hh"
18 #include "paper-column.hh"
22 MAKE_SCHEME_CALLBACK (Hyphen_spanner,set_spacing_rods,1);
24 Hyphen_spanner::set_spacing_rods (SCM smob)
26 Grob*me = unsmob_grob (smob);
29 Spanner*sp = dynamic_cast<Spanner*> (me);
30 Item * l = sp->get_bound (LEFT);
31 Item * r = sp->get_bound (RIGHT);
32 rod.item_l_drul_[LEFT] = l;
33 rod.item_l_drul_[RIGHT] =r;
35 gh_scm2double (me->get_grob_property ("minimum-length"))
36 + l->extent (l, X_AXIS)[RIGHT]
37 - r->extent (r, X_AXIS)[LEFT];
40 return SCM_UNSPECIFIED;
43 MAKE_SCHEME_CALLBACK (Hyphen_spanner,brew_molecule,1)
45 Hyphen_spanner::brew_molecule (SCM smob)
47 Spanner * sp = unsmob_spanner (smob);
53 common = common->common_refpoint (sp->get_bound (d), X_AXIS);
55 while (flip (&d) != LEFT);
60 Interval iv = sp->get_bound (d)->extent (common, X_AXIS);
62 bounds[d] = iv.empty_b ()
63 ? sp->get_bound (d)->relative_coordinate (common, X_AXIS)
66 while (flip (&d) != LEFT);
68 Real lt = sp->get_paper ()->get_realvar (ly_symbol2scm ("linethickness"));
69 Real th = gh_scm2double (sp->get_grob_property ("thickness")) * lt ;
70 Real h = gh_scm2double (sp->get_grob_property ("height"));
73 Real x = gh_scm2double (sp->get_grob_property ("maximum-length"));
74 SCM space = sp->get_bound (LEFT)->get_grob_property ("word-space");
76 Real word_space = 1.0;
77 if (gh_number_p (space))
79 word_space = gh_scm2double (space);
83 We remove word space from the distance so it doesn't look like an extender.
86 Real l = (gh_scm2double (sp->get_grob_property ("minimum-length"))
87 - word_space ) >? word_space;
91 we should probably do something more intelligent when bounds is
92 empty, but at least this doesn't crash.
94 Real w = bounds.empty_b () ? 0 : bounds.length ();
96 /* for length, use a geometric mean of the available space and some minimum
106 /* OK, we have a problem. Usually this means that we're on the
107 first column, and we have a long lyric which extends to near
108 the offset for stuff */
109 /* This test for being on the first column has been shamelessly
110 ripped from spanner.cc */
111 Paper_column *sc = dynamic_cast<Paper_column*> (sp->get_bound (LEFT)->get_column ());
113 sc->break_status_dir () == RIGHT)
115 /* We are on the first column, so it's probably harmless to
116 get the minimum length back by extending leftwards into
117 the space under the clef/key sig/time sig */
118 bounds[LEFT] = bounds[RIGHT] - l;
122 /* We can't get the length desired. Maybe we should warn. */
126 Box b (Interval (-l/2,l/2), Interval (h,h+th));
127 Molecule mol (Lookup::filledbox (b));
128 Real ct = bounds.empty_b () ? 0 : bounds.center () ;
129 mol.translate_axis (ct -sp->relative_coordinate (common, X_AXIS), X_AXIS);
130 return mol.smobbed_copy ();
134 Hyphen_spanner::set_textitem (Direction d, Grob* b)
136 elt_->set_bound (d, b);
137 elt_->add_dependency (b);
140 Hyphen_spanner::Hyphen_spanner (Spanner*s)
147 ADD_INTERFACE (Hyphen_spanner, "lyric-hyphen-interface",
148 "A centred hyphen is a simple line between lyrics used to divide "
149 "syllables. The length of the hyphen line should stretch based on the "
150 "size of the gap between syllables.",
151 "thickness height minimum-length maximum-length word-space");