2 slur.cc -- implement external interface for Slur
4 source file of the GNU LilyPond music typesetter
6 (c) 1996--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
7 Jan Nieuwenhuizen <janneke@gnu.org>
15 #include "directional-element-interface.hh"
16 #include "font-interface.hh"
17 #include "pointer-group-interface.hh"
19 #include "main.hh" // DEBUG_SLUR_SCORING
20 #include "note-column.hh"
21 #include "output-def.hh"
23 #include "staff-symbol-referencer.hh"
24 #include "staff-symbol.hh"
26 #include "text-interface.hh"
29 #include "slur-scoring.hh"
31 #include "script-interface.hh"
35 MAKE_SCHEME_CALLBACK(Slur, calc_direction, 1)
37 Slur::calc_direction (SCM smob)
39 Grob *me = unsmob_grob (smob);
40 extract_grob_set (me, "note-columns", encompasses);
42 if (encompasses.empty ())
49 for (vsize i = 0; i < encompasses.size (); i++)
51 if (Note_column::dir (encompasses[i]) < 0)
57 return scm_from_int (d);
60 MAKE_SCHEME_CALLBACK (Slur, height, 1);
62 Slur::height (SCM smob)
64 Grob *me = unsmob_grob (smob);
67 Stencil *m = me->get_stencil ();
68 return m ? ly_interval2scm (m->extent (Y_AXIS))
69 : ly_interval2scm (Interval ());
73 Ugh should have dash-length + dash-period
75 MAKE_SCHEME_CALLBACK (Slur, print, 1);
77 Slur::print (SCM smob)
79 Grob *me = unsmob_grob (smob);
80 extract_grob_set (me, "note-columns", encompasses);
81 if (encompasses.empty ())
87 Real staff_thick = Staff_symbol_referencer::line_thickness (me);
88 Real base_thick = staff_thick
89 * robust_scm2double (me->get_property ("thickness"), 1);
90 Real line_thick = staff_thick
91 * robust_scm2double (me->get_property ("line-thickness"), 1);
93 Bezier one = get_curve (me);
97 TODO: replace dashed with generic property.
99 SCM p = me->get_property ("dash-period");
100 SCM f = me->get_property ("dash-fraction");
101 if (scm_is_number (p) && scm_is_number (f))
102 a = Lookup::dashed_slur (one, line_thick, robust_scm2double (p, 1.0),
103 robust_scm2double (f, 0));
105 a = Lookup::slur (one,
106 get_grob_direction (me) * base_thick,
109 #if DEBUG_SLUR_SCORING
110 SCM quant_score = me->get_property ("quant-score");
112 if (to_boolean (me->layout ()
113 ->lookup_variable (ly_symbol2scm ("debug-slur-scoring")))
114 && scm_is_string (quant_score))
117 SCM properties = Font_interface::text_font_alist_chain (me);
120 if (!scm_is_number (me->get_property ("font-size")))
121 properties = scm_cons (scm_acons (ly_symbol2scm ("font-size"), scm_from_int (-6), SCM_EOL),
124 Stencil tm = *unsmob_stencil (Text_interface::interpret_markup
125 (me->layout ()->self_scm (), properties,
127 a.add_at_edge (Y_AXIS, get_grob_direction (me), tm, 1.0, 0);
131 return a.smobbed_copy ();
135 Slur::get_curve (Grob *me)
139 for (SCM s = me->get_property ("control-points"); s != SCM_EOL;
141 b.control_[i++] = ly_scm2offset (scm_car (s));
147 Slur::add_column (Grob *me, Grob *n)
149 Pointer_group_interface::add_grob (me, ly_symbol2scm ("note-columns"), n);
150 add_bound_item (dynamic_cast<Spanner *> (me), dynamic_cast<Item *> (n));
154 Slur::add_extra_encompass (Grob *me, Grob *n)
156 Pointer_group_interface::add_grob (me, ly_symbol2scm ("encompass-objects"), n);
160 MAKE_SCHEME_CALLBACK (Slur, outside_slur_callback, 2);
162 Slur::outside_slur_callback (SCM grob, SCM offset_scm)
164 Grob *script = unsmob_grob (grob);
165 Grob *slur = unsmob_grob (script->get_object ("slur"));
170 SCM avoid = script->get_property ("avoid-slur");
171 if (avoid != ly_symbol2scm ("outside")
172 && avoid != ly_symbol2scm ("around"))
175 Direction dir = get_grob_direction (script);
179 Grob *cx = script->common_refpoint (slur, X_AXIS);
180 Grob *cy = script->common_refpoint (slur, Y_AXIS);
182 Bezier curve = Slur::get_curve (slur);
184 curve.translate (Offset (slur->relative_coordinate (cx, X_AXIS),
185 slur->relative_coordinate (cy, Y_AXIS)));
187 Interval yext = robust_relative_extent (script, cy, Y_AXIS);
188 Interval xext = robust_relative_extent (script, cx, X_AXIS);
190 yext.translate (robust_scm2double (offset_scm, 0));
193 /* FIXME: slur property, script property? */
194 Real slur_padding = robust_scm2double (script->get_property ("slur-padding"),
196 yext.widen (slur_padding);
199 Interval bezext (curve.control_[0][X_AXIS], curve.control_[3][X_AXIS]);
200 bool consider[] = { false, false, false };
201 Real ys[] = {0, 0, 0};
202 bool do_shift = false;
204 for (int d = LEFT, k = 0; d <= RIGHT; d++, k++)
206 Real x = xext.linear_combination ((Direction) d);
207 consider[k] = bezext.contains (x);
212 = (fabs (bezext[LEFT] - x) < EPS)
213 ? curve.control_[0][Y_AXIS]
214 : ((fabs (bezext[RIGHT] - x) < EPS)
215 ? curve.control_[3][Y_AXIS]
216 : curve.get_other_coordinate (X_AXIS, x));
218 /* Request shift if slur is contained script's Y, or if
219 script is inside slur and avoid == outside. */
220 if (yext.contains (ys[k])
221 || (dir * ys[k] > dir * yext[-dir] && avoid == ly_symbol2scm ("outside")))
226 Real avoidance_offset = 0.0;
227 for (int d = LEFT, k = 0; d <= RIGHT; d++, k++)
229 avoidance_offset = dir * (max (dir * avoidance_offset,
230 dir * (ys[k] - yext[-dir] + dir * slur_padding)));
232 return scm_from_double (scm_to_double (offset_scm) + avoidance_offset);
236 * Used by Slur_engraver:: and Phrasing_slur_engraver::
239 Slur::auxiliary_acknowledge_extra_object (Grob_info info,
240 vector<Grob*>& slurs, vector<Grob*>& end_slurs)
242 if (slurs.empty () && end_slurs.empty ())
245 Grob *e = info.grob ();
246 SCM avoid = e->get_property ("avoid-slur");
247 if (Tie::has_interface (e)
248 || avoid == ly_symbol2scm ("inside"))
250 for (vsize i = slurs.size (); i--;)
251 add_extra_encompass (slurs[i], e);
252 for (vsize i = end_slurs.size (); i--;)
253 add_extra_encompass (end_slurs[i], e);
255 else if (avoid == ly_symbol2scm ("outside")
256 || avoid == ly_symbol2scm ("around"))
259 if (end_slurs.size () && !slurs.size ())
266 chain_offset_callback (e, outside_slur_callback_proc, Y_AXIS);
267 e->set_object ("slur", slur->self_scm ());
271 e->warning ("Ignoring grob for slur. avoid-slur not set?");
275 ADD_INTERFACE (Slur, "slur-interface",
280 "avoid-slur " /* UGH. */