2 lookup.cc -- implement simple Lookup methods.
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
8 Jan Nieuwenhuizen <janneke@gnu.org>
16 #include "line-interface.hh"
18 #include "dimensions.hh"
20 #include "string-convert.hh"
21 #include "file-path.hh"
23 #include "lily-guile.hh"
24 #include "font-metric.hh"
27 Lookup::dot (Offset p, Real radius)
29 SCM at = (scm_list_n (ly_symbol2scm ("dot"),
30 scm_from_double (p[X_AXIS]),
31 scm_from_double (p[Y_AXIS]),
32 scm_from_double (radius),
35 box.add_point (p - Offset (radius, radius));
36 box.add_point (p + Offset (radius, radius));
37 return Stencil (box, at);
41 Lookup::beam (Real slope, Real width, Real thick, Real blot)
47 p = Offset (0, thick / 2);
49 p += Offset (1, -1) * (blot / 2);
53 points = scm_cons (scm_from_double (p[X_AXIS]),
54 scm_cons (scm_from_double (p[Y_AXIS]),
57 p = Offset (0, -thick / 2);
59 p += Offset (1, 1) * (blot / 2);
61 points = scm_cons (scm_from_double (p[X_AXIS]),
62 scm_cons (scm_from_double (p[Y_AXIS]),
65 p = Offset (width, width * slope - thick / 2);
67 p += Offset (-1, 1) * (blot / 2);
69 points = scm_cons (scm_from_double (p[X_AXIS]),
70 scm_cons (scm_from_double (p[Y_AXIS]),
73 p = Offset (width, width * slope + thick / 2);
75 p += Offset (-1, -1) * (blot / 2);
77 points = scm_cons (scm_from_double (p[X_AXIS]),
78 scm_cons (scm_from_double (p[Y_AXIS]),
81 SCM expr = scm_list_n (ly_symbol2scm ("polygon"),
82 ly_quote_scm (points),
83 scm_from_double (blot),
87 return Stencil (b, expr);
91 Lookup::dashed_slur (Bezier b, Real thick, Real dash_period, Real dash_fraction)
95 Real on = dash_fraction * dash_period;
96 Real off = dash_period - on;
100 l = scm_cons (ly_offset2scm (b.control_[i]), l);
103 SCM at = (scm_list_n (ly_symbol2scm ("dashed-slur"),
104 scm_from_double (thick),
105 scm_from_double (on),
106 scm_from_double (off),
110 Box box (Interval (0, 0), Interval (0, 0));
111 return Stencil (box, at);
115 Lookup::horizontal_line (Interval w, Real th)
117 SCM at = scm_list_n (ly_symbol2scm ("draw-line"),
118 scm_from_double (th),
119 scm_from_double (w[LEFT]),
121 scm_from_double (w[RIGHT]),
127 box[Y_AXIS] = Interval (-th / 2, th / 2);
129 return Stencil (box, at);
133 Lookup::blank (Box b)
135 return Stencil (b, scm_makfrom0str (""));
139 Lookup::filled_box (Box b)
141 return round_filled_box (b, 0.0);
147 * __________________________________
152 * |\ _ _ / v \ _ _ /| |
155 * | <------>| | extent
156 * | blot | | (Y_AXIS)
164 * x\_____/______________\_____/|_____v
168 * |<-------------------------->|
169 * Box extent (X_AXIS)
172 Lookup::round_filled_box (Box b, Real blotdiameter)
174 if (b.x ().length () < blotdiameter)
176 blotdiameter = b.x ().length ();
178 if (b.y ().length () < blotdiameter)
180 blotdiameter = b.y ().length ();
183 SCM at = (scm_list_n (ly_symbol2scm ("round-filled-box"),
184 scm_from_double (-b[X_AXIS][LEFT]),
185 scm_from_double (b[X_AXIS][RIGHT]),
186 scm_from_double (-b[Y_AXIS][DOWN]),
187 scm_from_double (b[Y_AXIS][UP]),
188 scm_from_double (blotdiameter),
191 return Stencil (b, at);
195 * Create Stencil that represents a filled polygon with round edges.
199 * (a) Only outer (convex) edges are rounded.
201 * (b) This algorithm works as expected only for polygons whose edges
202 * do not intersect. For example, the polygon ((0, 0), (q, 0), (0,
203 * q), (q, q)) has an intersection at point (q/2, q/2) and therefore
204 * will give a strange result. Even non-adjacent edges that just
205 * touch each other will in general not work as expected for non-null
208 * (c) Given a polygon ((x0, y0), (x1, y1), ... , (x (n-1), y (n-1))),
209 * if there is a natural number k such that blotdiameter is greater
210 * than the maximum of { | (x (k mod n), y (k mod n)) - (x ((k+1) mod n),
211 * y ((k+1) mod n)) |, | (x (k mod n), y (k mod n)) - (x ((k+2) mod n),
212 * y ((k+2) mod n)) |, | (x ((k+1) mod n), y ((k+1) mod n)) - (x ((k+2)
213 * mod n), y ((k+2) mod n)) | }, then the outline of the rounded
214 * polygon will exceed the outline of the core polygon. In other
215 * words: Do not draw rounded polygons that have a leg smaller or
216 * thinner than blotdiameter (or set blotdiameter to a sufficiently
217 * small value -- maybe even 0.0)!
219 * NOTE: Limitations (b) and (c) arise from the fact that round edges
220 * are made by moulding sharp edges to round ones rather than adding
221 * to a core filled polygon. For details of these two different
222 * approaches, see the thread upon the ledger lines patch that started
223 * on March 25, 2002 on the devel mailing list. The below version of
224 * round_filled_polygon () sticks to the moulding model, which the
225 * majority of the list participants finally voted for. This,
226 * however, results in the above limitations and a much increased
227 * complexity of the algorithm, since it has to compute a shrinked
228 * polygon -- which is not trivial define precisely and unambigously.
229 * With the other approach, one simply could move a circle of size
230 * blotdiameter along all edges of the polygon (which is what the
231 * postscript routine in the backend effectively does, but on the
232 * shrinked polygon). --jr
235 Lookup::round_filled_polygon (Array<Offset> const &points,
238 /* TODO: Maybe print a warning if one of the above limitations
239 applies to the given polygon. However, this is quite complicated
242 const Real epsilon = 0.01;
245 /* remove consecutive duplicate points */
246 for (int i = 0; i < points.size (); i++)
248 int next_i = (i + 1) % points.size ();
249 Real d = (points[i] - points[next_i]).length ();
251 programming_error ("Polygon should not have duplicate points");
255 /* special cases: degenerated polygons */
256 if (points.size () == 0)
258 if (points.size () == 1)
259 return dot (points[0], 0.5 * blotdiameter);
260 if (points.size () == 2)
261 return Line_interface::make_line (blotdiameter, points[0], points[1]);
263 /* shrink polygon in size by 0.5 * blotdiameter */
264 Array<Offset> shrunk_points;
265 shrunk_points.set_size (points.size ());
266 bool ccw = 1; // true, if three adjacent points are counterclockwise ordered
267 for (int i = 0; i < points.size (); i++)
270 int i1 = (i + 1) % points.size ();
271 int i2 = (i + 2) % points.size ();
272 Offset p0 = points[i0];
273 Offset p1 = points[i1];
274 Offset p2 = points[i2];
275 Offset p10 = p0 - p1;
276 Offset p12 = p2 - p1;
277 if (p10.length () != 0.0)
279 Real phi = p10.arg ();
280 // rotate (p2 - p0) by (-phi)
281 Offset q = complex_multiply (p2 - p0, complex_exp (Offset (1.0, -phi)));
285 else if (q[Y_AXIS] < 0)
287 else {} // keep ccw unchanged
289 else {} // keep ccw unchanged
290 Offset p10n = (1.0 / p10.length ()) * p10; // normalize length to 1.0
291 Offset p12n = (1.0 / p12.length ()) * p12;
292 Offset p13n = 0.5 * (p10n + p12n);
293 Offset p14n = 0.5 * (p10n - p12n);
295 Real d = p13n.length () * p14n.length (); // distance p3n to line (p1..p0)
297 // special case: p0, p1, p2 are on a single line => build
298 // vector orthogonal to (p2-p0) of length 0.5 blotdiameter
300 p13[X_AXIS] = p10[Y_AXIS];
301 p13[Y_AXIS] = -p10[X_AXIS];
302 p13 = (0.5 * blotdiameter / p13.length ()) * p13;
305 p13 = (0.5 * blotdiameter / d) * p13n;
306 shrunk_points[i1] = p1 + ((ccw) ? p13 : -p13);
309 /* build scm expression and bounding box */
310 SCM shrunk_points_scm = SCM_EOL;
312 for (int i = 0; i < shrunk_points.size (); i++)
314 SCM x = scm_from_double (shrunk_points[i][X_AXIS]);
315 SCM y = scm_from_double (shrunk_points[i][Y_AXIS]);
316 shrunk_points_scm = scm_cons (x, scm_cons (y, shrunk_points_scm));
317 box.add_point (points[i]);
319 SCM polygon_scm = scm_list_n (ly_symbol2scm ("polygon"),
320 ly_quote_scm (shrunk_points_scm),
321 scm_from_double (blotdiameter),
325 Stencil polygon = Stencil (box, polygon_scm);
326 shrunk_points.clear ();
334 Lookup::frame (Box b, Real thick, Real blot)
338 for (Axis a = X_AXIS; a < NO_AXES; a = Axis (a + 1))
340 Axis o = Axis ((a + 1)%NO_AXES);
344 edges[a] = b[a][d] + 0.5 * thick * Interval (-1, 1);
345 edges[o][DOWN] = b[o][DOWN] - thick / 2;
346 edges[o][UP] = b[o][UP] + thick / 2;
348 m.add_stencil (round_filled_box (edges, blot));
350 while (flip (&d) != LEFT);
356 Make a smooth curve along the points
359 Lookup::slur (Bezier curve, Real curvethick, Real linethick)
361 Real alpha = (curve.control_[3] - curve.control_[0]).arg ();
363 Offset perp = curvethick * complex_exp (Offset (0, alpha + M_PI / 2)) * 0.5;
365 back.control_[1] += perp;
366 back.control_[2] += perp;
368 curve.control_[1] -= perp;
369 curve.control_[2] -= perp;
373 for (int i = 4; i--;)
374 scontrols[ i ] = ly_offset2scm (back.control_[i]);
375 for (int i = 4; i--;)
376 scontrols[i + 4] = ly_offset2scm (curve.control_[i]);
379 Need the weird order b.o. the way PS want its arguments
381 int indices[] = {5, 6, 7, 4, 1, 2, 3, 0};
383 for (int i = 8; i--;)
385 list = scm_cons (scontrols[indices[i]], list);
388 SCM at = (scm_list_n (ly_symbol2scm ("bezier-sandwich"),
390 scm_from_double (linethick),
392 Box b (curve.extent (X_AXIS),
393 curve.extent (Y_AXIS));
395 b[X_AXIS].unite (back.extent (X_AXIS));
396 b[Y_AXIS].unite (back.extent (Y_AXIS));
398 return Stencil (b, at);
425 Lookup::bezier_sandwich (Bezier top_curve, Bezier bottom_curve)
428 Need the weird order b.o. the way PS want its arguments
431 list = scm_cons (ly_offset2scm (bottom_curve.control_[3]), list);
432 list = scm_cons (ly_offset2scm (bottom_curve.control_[0]), list);
433 list = scm_cons (ly_offset2scm (bottom_curve.control_[1]), list);
434 list = scm_cons (ly_offset2scm (bottom_curve.control_[2]), list);
435 list = scm_cons (ly_offset2scm (top_curve.control_[0]), list);
436 list = scm_cons (ly_offset2scm (top_curve.control_[3]), list);
437 list = scm_cons (ly_offset2scm (top_curve.control_[2]), list);
438 list = scm_cons (ly_offset2scm (top_curve.control_[1]), list);
440 SCM horizontal_bend = scm_list_n (ly_symbol2scm ("bezier-sandwich"),
442 scm_from_double (0.0),
445 Interval x_extent = top_curve.extent (X_AXIS);
446 x_extent.unite (bottom_curve.extent (X_AXIS));
447 Interval y_extent = top_curve.extent (Y_AXIS);
448 y_extent.unite (bottom_curve.extent (Y_AXIS));
449 Box b (x_extent, y_extent);
451 return Stencil (b, horizontal_bend);
458 Lookup::accordion (SCM s, Real staff_space, Font_metric *fm)
461 String sym = ly_scm2string (scm_car (s));
462 String reg = ly_scm2string (scm_car (scm_cdr (s)));
464 if (sym == "Discant")
466 Stencil r = fm->find_by_name ("accordion.accDiscant");
468 if (reg.left_string (1) == "F")
470 Stencil d = fm->find_by_name ("accordion.accDot");
471 d.translate_axis (staff_space * 2.5 PT, Y_AXIS);
473 reg = reg.right_string (reg.length () - 1);
476 if (reg.left_string (3) == "EEE")
479 reg = reg.right_string (reg.length () - 3);
481 else if (reg.left_string (2) == "EE")
484 reg = reg.right_string (reg.length () - 2);
486 else if (reg.left_string (2) == "Eh")
489 reg = reg.right_string (reg.length () - 2);
491 else if (reg.left_string (1) == "E")
494 reg = reg.right_string (reg.length () - 1);
498 Stencil d = fm->find_by_name ("accordion.accDot");
499 d.translate_axis (staff_space * 1.5 PT, Y_AXIS);
504 Stencil d = fm->find_by_name ("accordion.accDot");
505 d.translate_axis (staff_space * 1.5 PT, Y_AXIS);
506 d.translate_axis (0.8 * staff_space PT, X_AXIS);
511 Stencil d = fm->find_by_name ("accordion.accDot");
512 d.translate_axis (staff_space * 1.5 PT, Y_AXIS);
513 d.translate_axis (-0.8 * staff_space PT, X_AXIS);
516 if (reg.left_string (2) == "SS")
518 Stencil d = fm->find_by_name ("accordion.accDot");
519 d.translate_axis (0.5 * staff_space PT, Y_AXIS);
520 d.translate_axis (0.4 * staff_space PT, X_AXIS);
522 d.translate_axis (-0.8 * staff_space PT, X_AXIS);
524 reg = reg.right_string (reg.length () - 2);
526 if (reg.left_string (1) == "S")
528 Stencil d = fm->find_by_name ("accordion.accDot");
529 d.translate_axis (0.5 * staff_space PT, Y_AXIS);
531 reg = reg.right_string (reg.length () - 1);
534 else if (sym == "Freebase")
536 Stencil r = fm->find_by_name ("accordion.accFreebase");
538 if (reg.left_string (1) == "F")
540 Stencil d = fm->find_by_name ("accordion.accDot");
541 d.translate_axis (staff_space * 1.5 PT, Y_AXIS);
543 reg = reg.right_string (reg.length () - 1);
547 Stencil d = fm->find_by_name ("accordion.accDot");
548 d.translate_axis (staff_space * 0.5 PT, Y_AXIS);
552 else if (sym == "Bayanbase")
554 Stencil r = fm->find_by_name ("accordion.accBayanbase");
556 if (reg.left_string (1) == "T")
558 Stencil d = fm->find_by_name ("accordion.accDot");
559 d.translate_axis (staff_space * 2.5 PT, Y_AXIS);
561 reg = reg.right_string (reg.length () - 1);
563 /* include 4' reed just for completeness. You don't want to use this. */
564 if (reg.left_string (1) == "F")
566 Stencil d = fm->find_by_name ("accordion.accDot");
567 d.translate_axis (staff_space * 1.5 PT, Y_AXIS);
569 reg = reg.right_string (reg.length () - 1);
571 if (reg.left_string (2) == "EE")
573 Stencil d = fm->find_by_name ("accordion.accDot");
574 d.translate_axis (staff_space * 0.5 PT, Y_AXIS);
575 d.translate_axis (0.4 * staff_space PT, X_AXIS);
577 d.translate_axis (-0.8 * staff_space PT, X_AXIS);
579 reg = reg.right_string (reg.length () - 2);
581 if (reg.left_string (1) == "E")
583 Stencil d = fm->find_by_name ("accordion.accDot");
584 d.translate_axis (staff_space * 0.5 PT, Y_AXIS);
586 reg = reg.right_string (reg.length () - 1);
589 else if (sym == "Stdbase")
591 Stencil r = fm->find_by_name ("accordion.accStdbase");
593 if (reg.left_string (1) == "T")
595 Stencil d = fm->find_by_name ("accordion.accDot");
596 d.translate_axis (staff_space * 3.5 PT, Y_AXIS);
598 reg = reg.right_string (reg.length () - 1);
600 if (reg.left_string (1) == "F")
602 Stencil d = fm->find_by_name ("accordion.accDot");
603 d.translate_axis (staff_space * 2.5 PT, Y_AXIS);
605 reg = reg.right_string (reg.length () - 1);
607 if (reg.left_string (1) == "M")
609 Stencil d = fm->find_by_name ("accordion.accDot");
610 d.translate_axis (staff_space * 2 PT, Y_AXIS);
611 d.translate_axis (staff_space PT, X_AXIS);
613 reg = reg.right_string (reg.length () - 1);
615 if (reg.left_string (1) == "E")
617 Stencil d = fm->find_by_name ("accordion.accDot");
618 d.translate_axis (staff_space * 1.5 PT, Y_AXIS);
620 reg = reg.right_string (reg.length () - 1);
622 if (reg.left_string (1) == "S")
624 Stencil d = fm->find_by_name ("accordion.accDot");
625 d.translate_axis (staff_space * 0.5 PT, Y_AXIS);
627 reg = reg.right_string (reg.length () - 1);
630 /* ugh maybe try to use regular font for S.B. and B.B and only use one font
632 else if (sym == "SB")
634 Stencil r = fm->find_by_name ("accordion.accSB");
637 else if (sym == "BB")
639 Stencil r = fm->find_by_name ("accordion.accBB");
642 else if (sym == "OldEE")
644 Stencil r = fm->find_by_name ("accordion.accOldEE");
647 else if (sym == "OldEES")
649 Stencil r = fm->find_by_name ("accordion.accOldEES");
656 Lookup::repeat_slash (Real w, Real s, Real t)
659 Array<Offset> points;
660 Real blotdiameter = 0.0;
663 Offset p2 (w, w * s);
666 return Lookup::round_filled_polygon (points, blotdiameter);
669 SCM wid = scm_from_double (w);
670 SCM sl = scm_from_double (s);
671 SCM thick = scm_from_double (t);
672 SCM slashnodot = scm_list_n (ly_symbol2scm ("repeat-slash"),
673 wid, sl, thick, SCM_UNDEFINED);
675 Box b (Interval (0, w + sqrt (sqr (t / s) + sqr (t))),
676 Interval (0, w * s));
678 return Stencil (b, slashnodot); // http://slashnodot.org
682 Lookup::bracket (Axis a, Interval iv, Real thick, Real protude, Real blot)
685 Axis other = Axis ((a + 1)%2);
687 b[other] = Interval (-1, 1) * thick * 0.5;
689 Stencil m = round_filled_box (b, blot);
691 b[a] = Interval (iv[UP] - thick, iv[UP]);
692 Interval oi = Interval (-thick / 2, thick / 2 + fabs (protude));
693 oi *= sign (protude);
695 m.add_stencil (round_filled_box (b, blot));
696 b[a] = Interval (iv[DOWN], iv[DOWN] + thick);
697 m.add_stencil (round_filled_box (b, blot));
703 Lookup::triangle (Interval iv, Real thick, Real protude)
706 b[X_AXIS] = Interval (0, iv.length ());
707 b[Y_AXIS] = Interval (min (0., protude), max (0.0, protude));
709 Offset z1 (iv[LEFT], 0);
710 Offset z2 (iv[RIGHT], 0);
711 Offset z3 ((z1 + z2)[X_AXIS] / 2, protude);
714 TODO: move Triangle to Line_interface ?
716 Stencil tri = Line_interface::make_line (thick, z1, z2);
717 tri.add_stencil (Line_interface::make_line (thick, z2, z3));
718 tri.add_stencil (Line_interface::make_line (thick, z3, z1));