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, pure_height, 3);
62 Slur::pure_height (SCM smob, SCM start_scm, SCM end_scm)
64 Grob *me = unsmob_grob (smob);
65 int start = scm_to_int (start_scm);
66 int end = scm_to_int (end_scm);
67 Real height = robust_scm2double (me->get_property ("height-limit"), 2.0);
69 extract_grob_set (me, "note-columns", encompasses);
72 Grob *parent = me->get_parent (Y_AXIS);
73 if (common_refpoint_of_array (encompasses, me, Y_AXIS) != parent)
74 /* this could happen if, for example, we are a cross-staff slur.
75 in this case, we want to be ignored */
76 return ly_interval2scm (Interval ());
78 for (vsize i = 0; i < encompasses.size (); i++)
80 Interval d = encompasses[i]->pure_height (parent, start, end);
85 ret.widen (height * 0.5);
86 return ly_interval2scm (ret);
89 MAKE_SCHEME_CALLBACK (Slur, height, 1);
91 Slur::height (SCM smob)
93 Grob *me = unsmob_grob (smob);
96 Stencil *m = me->get_stencil ();
97 return m ? ly_interval2scm (m->extent (Y_AXIS))
98 : ly_interval2scm (Interval ());
102 Ugh should have dash-length + dash-period
104 MAKE_SCHEME_CALLBACK (Slur, print, 1);
106 Slur::print (SCM smob)
108 Grob *me = unsmob_grob (smob);
109 extract_grob_set (me, "note-columns", encompasses);
110 if (encompasses.empty ())
116 Real staff_thick = Staff_symbol_referencer::line_thickness (me);
117 Real base_thick = staff_thick
118 * robust_scm2double (me->get_property ("thickness"), 1);
119 Real line_thick = staff_thick
120 * robust_scm2double (me->get_property ("line-thickness"), 1);
122 Bezier one = get_curve (me);
126 TODO: replace dashed with generic property.
128 SCM p = me->get_property ("dash-period");
129 SCM f = me->get_property ("dash-fraction");
130 if (scm_is_number (p) && scm_is_number (f))
131 a = Lookup::dashed_slur (one, line_thick, robust_scm2double (p, 1.0),
132 robust_scm2double (f, 0));
134 a = Lookup::slur (one,
135 get_grob_direction (me) * base_thick,
138 #if DEBUG_SLUR_SCORING
139 SCM quant_score = me->get_property ("quant-score");
141 if (to_boolean (me->layout ()
142 ->lookup_variable (ly_symbol2scm ("debug-slur-scoring")))
143 && scm_is_string (quant_score))
146 SCM properties = Font_interface::text_font_alist_chain (me);
149 if (!scm_is_number (me->get_property ("font-size")))
150 properties = scm_cons (scm_acons (ly_symbol2scm ("font-size"), scm_from_int (-6), SCM_EOL),
153 Stencil tm = *unsmob_stencil (Text_interface::interpret_markup
154 (me->layout ()->self_scm (), properties,
156 a.add_at_edge (Y_AXIS, get_grob_direction (me), tm, 1.0, 0);
160 return a.smobbed_copy ();
164 Slur::get_curve (Grob *me)
168 for (SCM s = me->get_property ("control-points"); scm_is_pair (s);
170 b.control_[i++] = ly_scm2offset (scm_car (s));
176 Slur::add_column (Grob *me, Grob *n)
178 Pointer_group_interface::add_grob (me, ly_symbol2scm ("note-columns"), n);
179 add_bound_item (dynamic_cast<Spanner *> (me), dynamic_cast<Item *> (n));
183 Slur::add_extra_encompass (Grob *me, Grob *n)
185 Pointer_group_interface::add_grob (me, ly_symbol2scm ("encompass-objects"), n);
188 MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Slur, pure_outside_slur_callback, 4, 1);
190 Slur::pure_outside_slur_callback (SCM grob, SCM start_scm, SCM end_scm, SCM offset_scm)
192 int start = robust_scm2int (start_scm, 0);
193 int end = robust_scm2int (end_scm, 0);
194 Grob *script = unsmob_grob (grob);
195 Grob *slur = unsmob_grob (script->get_object ("slur"));
199 SCM avoid = script->get_property ("avoid-slur");
200 if (avoid != ly_symbol2scm ("outside") && avoid != ly_symbol2scm ("around"))
203 Real offset = robust_scm2double (offset_scm, 0.0);
204 Direction dir = get_grob_direction (script);
205 return scm_from_double (offset + dir * slur->pure_height (slur, start, end).length () / 4);
208 MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Slur, outside_slur_callback, 2, 1);
210 Slur::outside_slur_callback (SCM grob, SCM offset_scm)
212 Grob *script = unsmob_grob (grob);
213 Grob *slur = unsmob_grob (script->get_object ("slur"));
218 SCM avoid = script->get_property ("avoid-slur");
219 if (avoid != ly_symbol2scm ("outside")
220 && avoid != ly_symbol2scm ("around"))
223 Direction dir = get_grob_direction (script);
227 Grob *cx = script->common_refpoint (slur, X_AXIS);
228 Grob *cy = script->common_refpoint (slur, Y_AXIS);
230 Bezier curve = Slur::get_curve (slur);
232 curve.translate (Offset (slur->relative_coordinate (cx, X_AXIS),
233 slur->relative_coordinate (cy, Y_AXIS)));
235 Interval yext = robust_relative_extent (script, cy, Y_AXIS);
236 Interval xext = robust_relative_extent (script, cx, X_AXIS);
238 Real offset = robust_scm2double (offset_scm, 0);
239 yext.translate (offset);
241 /* FIXME: slur property, script property? */
242 Real slur_padding = robust_scm2double (script->get_property ("slur-padding"),
244 yext.widen (slur_padding);
247 Interval bezext (curve.control_[0][X_AXIS], curve.control_[3][X_AXIS]);
248 bool consider[] = { false, false, false };
249 Real ys[] = {0, 0, 0};
250 bool do_shift = false;
252 for (int d = LEFT, k = 0; d <= RIGHT; d++, k++)
254 Real x = xext.linear_combination ((Direction) d);
255 consider[k] = bezext.contains (x);
260 = (fabs (bezext[LEFT] - x) < EPS)
261 ? curve.control_[0][Y_AXIS]
262 : ((fabs (bezext[RIGHT] - x) < EPS)
263 ? curve.control_[3][Y_AXIS]
264 : curve.get_other_coordinate (X_AXIS, x));
266 /* Request shift if slur is contained script's Y, or if
267 script is inside slur and avoid == outside. */
268 if (yext.contains (ys[k])
269 || (dir * ys[k] > dir * yext[-dir] && avoid == ly_symbol2scm ("outside")))
274 Real avoidance_offset = 0.0;
275 for (int d = LEFT, k = 0; d <= RIGHT; d++, k++)
277 avoidance_offset = dir * (max (dir * avoidance_offset,
278 dir * (ys[k] - yext[-dir] + dir * slur_padding)));
280 return scm_from_double (offset + avoidance_offset);
284 * Used by Slur_engraver:: and Phrasing_slur_engraver::
287 Slur::auxiliary_acknowledge_extra_object (Grob_info info,
288 vector<Grob*> &slurs,
289 vector<Grob*> &end_slurs)
291 if (slurs.empty () && end_slurs.empty ())
294 Grob *e = info.grob ();
295 SCM avoid = e->get_property ("avoid-slur");
296 if (Tie::has_interface (e)
297 || avoid == ly_symbol2scm ("inside"))
299 for (vsize i = slurs.size (); i--;)
300 add_extra_encompass (slurs[i], e);
301 for (vsize i = end_slurs.size (); i--;)
302 add_extra_encompass (end_slurs[i], e);
304 else if (avoid == ly_symbol2scm ("outside")
305 || avoid == ly_symbol2scm ("around"))
308 if (end_slurs.size () && !slurs.size ())
315 chain_offset_callback (e, outside_slur_callback_proc, Y_AXIS);
316 e->set_object ("slur", slur->self_scm ());
320 e->warning ("Ignoring grob for slur. avoid-slur not set?");
324 ADD_INTERFACE (Slur, "slur-interface",
329 "avoid-slur " /* UGH. */