2 lookup.cc -- implement simple Lookup methods.
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
8 Jan Nieuwenhuizen <janneke@gnu.org>
17 #include "dimensions.hh"
19 #include "string-convert.hh"
20 #include "file-path.hh"
22 #include "lily-guile.hh"
23 #include "molecule.hh"
25 #include "font-metric.hh"
26 #include "interval.hh"
29 Lookup::dot (Offset p, Real radius)
31 SCM at = (scm_list_n (ly_symbol2scm ("dot"),
32 gh_double2scm (p[X_AXIS]),
33 gh_double2scm (p[Y_AXIS]),
34 gh_double2scm (radius),
37 box.add_point (p - Offset (radius, radius));
38 box.add_point (p + Offset (radius, radius));
39 return Molecule (box, at);
43 Lookup::beam (Real slope, Real width, Real thick)
45 Real height = slope * width;
46 Real min_y = (0 <? height) - thick/2;
47 Real max_y = (0 >? height) + thick/2;
51 Box b (Interval (0, width),
52 Interval (min_y, max_y));
55 SCM at = scm_list_n (ly_symbol2scm ("beam"),
56 gh_double2scm (width),
57 gh_double2scm (slope),
58 gh_double2scm (thick),
60 return Molecule (b, at);
64 Lookup::dashed_slur (Bezier b, Real thick, Real dash)
68 for (int i= 4; i -- ;)
70 l = gh_cons (ly_offset2scm (b.control_[i]), l);
73 SCM at = (scm_list_n (ly_symbol2scm ("dashed-slur"),
74 gh_double2scm (thick),
79 Box box (Interval (0,0),Interval (0,0));
80 return Molecule (box, at);
84 Lookup::line (Real th, Offset from, Offset to)
86 SCM at = scm_list_n (ly_symbol2scm ("draw-line"),
88 gh_double2scm (from[X_AXIS]),
89 gh_double2scm (from[Y_AXIS]),
90 gh_double2scm (to[X_AXIS]),
91 gh_double2scm (to[Y_AXIS]),
98 box[X_AXIS].widen (th/2);
99 box[Y_AXIS].widen (th/2);
101 return Molecule (box, at);
105 Lookup::dashed_line (Real thick, Offset from, Offset to,
106 Real dash_period, Real dash_fraction)
108 dash_fraction = (dash_fraction >? 0) <? 1.0;
109 Real on = dash_fraction * dash_period + thick;
110 Real off = dash_period - on;
112 SCM at = scm_list_n (ly_symbol2scm ("dashed-line"),
113 gh_double2scm (thick),
116 gh_double2scm (to[X_AXIS] - from[X_AXIS]),
117 gh_double2scm (to[Y_AXIS] - from[Y_AXIS]),
121 box.add_point (Offset (0,0));
122 box.add_point (to - from);
124 box[X_AXIS].widen (thick/2);
125 box[Y_AXIS].widen (thick/2);
127 Molecule m = Molecule (box, at);
133 Lookup::horizontal_line (Interval w, Real th)
135 SCM at = scm_list_n (ly_symbol2scm ("horizontal-line"),
136 gh_double2scm (w[LEFT]),
137 gh_double2scm (w[RIGHT]),
144 box[Y_AXIS] = Interval (-th/2,th/2);
146 return Molecule (box, at);
151 Lookup::blank (Box b)
153 return Molecule (b, scm_makfrom0str (""));
157 Lookup::filledbox (Box b)
159 SCM at = (scm_list_n (ly_symbol2scm ("filledbox"),
160 gh_double2scm (-b[X_AXIS][LEFT]),
161 gh_double2scm (b[X_AXIS][RIGHT]),
162 gh_double2scm (-b[Y_AXIS][DOWN]),
163 gh_double2scm (b[Y_AXIS][UP]),
166 return Molecule (b,at);
172 * __________________________________
177 * |\ _ _ / v \ _ _ /| |
180 * | <------>| | extent
181 * | blot | | (Y_AXIS)
189 * x\_____/______________\_____/|_____v
193 * |<-------------------------->|
197 Lookup::round_filled_box (Box b, Real blotdiameter)
199 if (b.x ().length () < blotdiameter)
201 programming_error (_f ("round filled box horizontal extent smaller than blot; decreasing blot"));
202 blotdiameter = b.x ().length ();
204 if (b.y ().length () < blotdiameter)
206 programming_error (_f ("round filled box vertical extent smaller than blot; decreasing blot"));
207 blotdiameter = b.y ().length ();
210 SCM at = (scm_list_n (ly_symbol2scm ("round-filled-box"),
211 gh_double2scm (-b[X_AXIS][LEFT]),
212 gh_double2scm (b[X_AXIS][RIGHT]),
213 gh_double2scm (-b[Y_AXIS][DOWN]),
214 gh_double2scm (b[Y_AXIS][UP]),
215 gh_double2scm (blotdiameter),
218 return Molecule (b,at);
224 * Create Molecule that represents a filled polygon with round edges.
228 * (a) Only outer (convex) edges are rounded.
230 * (b) This algorithm works as expected only for polygons whose edges
231 * do not intersect. For example, the polygon ((0, 0), (q, 0), (0,
232 * q), (q, q)) has an intersection at point (q/2, q/2) and therefore
233 * will give a strange result. Even non-adjacent edges that just
234 * touch each other will in general not work as expected for non-null
237 * (c) Given a polygon ((x0, y0), (x1, y1), ... , (x(n-1), y(n-1))),
238 * if there is a natural number k such that blotdiameter is greater
239 * than the maximum of { | (x(k mod n), y(k mod n)) - (x((k+1) mod n),
240 * y((k+1) mod n)) |, | (x(k mod n), y(k mod n)) - (x((k+2) mod n),
241 * y((k+2) mod n)) |, | (x((k+1) mod n), y((k+1) mod n)) - (x((k+2)
242 * mod n), y((k+2) mod n)) | }, then the outline of the rounded
243 * polygon will exceed the outline of the core polygon. In other
244 * words: Do not draw rounded polygons that have a leg smaller or
245 * thinner than blotdiameter (or set blotdiameter to a sufficiently
246 * small value -- maybe even 0.0)!
248 * NOTE: Limitations (b) and (c) arise from the fact that round edges
249 * are made by moulding sharp edges to round ones rather than adding
250 * to a core filled polygon. For details of these two different
251 * approaches, see the thread upon the ledger lines patch that started
252 * on March 25, 2002 on the devel mailing list. The below version of
253 * round_filled_polygon() sticks to the moulding model, which the
254 * majority of the list participants finally voted for. This,
255 * however, results in the above limitations and a much increased
256 * complexity of the algorithm, since it has to compute a shrinked
257 * polygon -- which is not trivial define precisely and unambigously.
258 * With the other approach, one simply could move a circle of size
259 * blotdiameter along all edges of the polygon (which is what the
260 * postscript routine in the backend effectively does, but on the
261 * shrinked polygon). --jr
264 Lookup::round_filled_polygon (Array<Offset> points, Real blotdiameter)
266 /* TODO: Maybe print a warning if one of the above limitations
267 applies to the given polygon. However, this is quite complicated
270 /* remove consecutive duplicate points */
271 const Real epsilon = 0.01;
272 for (int i = 0; i < points.size ();)
274 int next_i = (i + 1) % points.size ();
275 Real d = (points[i] - points[next_i]).length ();
282 /* special cases: degenerated polygons */
283 if (points.size () == 0)
285 if (points.size () == 1)
286 return dot (points[0], 0.5 * blotdiameter);
287 if (points.size () == 2)
288 return line (blotdiameter, points[0], points[1]);
290 /* shrink polygon in size by 0.5 * blotdiameter */
291 Array<Offset> shrinked_points;
292 shrinked_points.set_size (points.size ());
293 bool ccw = 1; // true, if three adjacent points are counterclockwise ordered
294 for (int i = 0; i < points.size (); i++)
297 int i1 = (i + 1) % points.size ();
298 int i2 = (i + 2) % points.size ();
299 Offset p0 = points[i0];
300 Offset p1 = points[i1];
301 Offset p2 = points[i2];
302 Offset p10 = p0 - p1;
303 Offset p12 = p2 - p1;
304 if (p10.length () != 0.0)
306 Real phi = p10.arg ();
307 // rotate (p2 - p0) by (-phi)
308 Offset q = complex_multiply (p2 - p0, complex_exp (Offset (1.0, -phi)));
312 else if (q[Y_AXIS] < 0)
314 else {} // keep ccw unchanged
316 else {} // keep ccw unchanged
317 Offset p10n = (1.0 / p10.length ()) * p10; // normalize length to 1.0
318 Offset p12n = (1.0 / p12.length ()) * p12;
319 Offset p13n = 0.5 * (p10n + p12n);
320 Offset p14n = 0.5 * (p10n - p12n);
322 Real d = p13n.length () * p14n.length (); // distance p3n to line(p1..p0)
324 // special case: p0, p1, p2 are on a single line => build
325 // vector orthogonal to (p2-p0) of length 0.5 blotdiameter
327 p13[X_AXIS] = p10[Y_AXIS];
328 p13[Y_AXIS] = -p10[X_AXIS];
329 p13 = (0.5 * blotdiameter / p13.length ()) * p13;
332 p13 = (0.5 * blotdiameter / d) * p13n;
333 shrinked_points[i1] = p1 + ((ccw) ? p13 : -p13);
336 /* build scm expression and bounding box */
337 SCM shrinked_points_scm = SCM_EOL;
339 for (int i = 0; i < shrinked_points.size (); i++)
341 SCM x = gh_double2scm (shrinked_points[i][X_AXIS]);
342 SCM y = gh_double2scm (shrinked_points[i][Y_AXIS]);
343 shrinked_points_scm = gh_cons (x, gh_cons (y, shrinked_points_scm));
344 box.add_point (points[i]);
346 SCM polygon_scm = scm_list_n (ly_symbol2scm ("polygon"),
347 ly_quote_scm (shrinked_points_scm),
348 gh_double2scm (blotdiameter),
351 Molecule polygon = Molecule (box, polygon_scm);
352 shrinked_points.clear ();
357 Lookup::frame (Box b, Real thick)
361 for (Axis a = X_AXIS; a < NO_AXES; a = Axis (a + 1))
363 Axis o = Axis ((a+1)%NO_AXES);
367 edges[a] = b[a][d] + 0.5 * thick * Interval (-1, 1);
368 edges[o][DOWN] = b[o][DOWN] - thick/2;
369 edges[o][UP] = b[o][UP] + thick/2;
371 m.add_molecule (filledbox (edges));
373 while (flip (&d) != LEFT);
380 Make a smooth curve along the points
383 Lookup::slur (Bezier curve, Real curvethick, Real linethick)
385 Real alpha = (curve.control_[3] - curve.control_[0]).arg ();
387 Offset perp = curvethick * complex_exp (Offset (0, alpha + M_PI/2)) * 0.5;
389 back.control_[1] += perp;
390 back.control_[2] += perp;
392 curve.control_[1] -= perp;
393 curve.control_[2] -= perp;
398 scontrols[ i ] = ly_offset2scm (back.control_[i]);
400 scontrols[i+4] = ly_offset2scm (curve.control_[i]);
403 Need the weird order b.o. the way PS want its arguments
405 int indices[]= {5, 6, 7, 4, 1, 2, 3, 0};
409 list = gh_cons (scontrols[indices[i]], list);
413 SCM at = (scm_list_n (ly_symbol2scm ("bezier-sandwich"),
415 gh_double2scm (linethick),
417 Box b(curve.extent (X_AXIS),
418 curve.extent (Y_AXIS));
420 b[X_AXIS].unite (back.extent (X_AXIS));
421 b[Y_AXIS].unite (back.extent (Y_AXIS));
423 return Molecule (b, at);
450 Lookup::bezier_sandwich (Bezier top_curve, Bezier bottom_curve)
453 Need the weird order b.o. the way PS want its arguments
456 list = gh_cons (ly_offset2scm (bottom_curve.control_[3]), list);
457 list = gh_cons (ly_offset2scm (bottom_curve.control_[0]), list);
458 list = gh_cons (ly_offset2scm (bottom_curve.control_[1]), list);
459 list = gh_cons (ly_offset2scm (bottom_curve.control_[2]), list);
460 list = gh_cons (ly_offset2scm (top_curve.control_[0]), list);
461 list = gh_cons (ly_offset2scm (top_curve.control_[3]), list);
462 list = gh_cons (ly_offset2scm (top_curve.control_[2]), list);
463 list = gh_cons (ly_offset2scm (top_curve.control_[1]), list);
465 SCM horizontal_bend = scm_list_n (ly_symbol2scm ("bezier-sandwich"),
470 Interval x_extent = top_curve.extent (X_AXIS);
471 x_extent.unite (bottom_curve.extent (X_AXIS));
472 Interval y_extent = top_curve.extent (Y_AXIS);
473 y_extent.unite (bottom_curve.extent (Y_AXIS));
474 Box b (x_extent, y_extent);
476 return Molecule (b, horizontal_bend);
489 * (0,0) x /slope=dy/dx
497 Lookup::horizontal_slope (Real width, Real slope, Real height)
499 SCM width_scm = gh_double2scm (width);
500 SCM slope_scm = gh_double2scm (slope);
501 SCM height_scm = gh_double2scm (height);
502 SCM horizontal_slope = scm_list_n (ly_symbol2scm ("beam"),
503 width_scm, slope_scm,
504 height_scm, SCM_UNDEFINED);
505 Box b (Interval (0, width),
506 Interval (-height/2, height/2 + width*slope));
507 return Molecule (b, horizontal_slope);
514 Lookup::accordion (SCM s, Real staff_space, Font_metric *fm)
517 String sym = ly_scm2string (ly_car (s));
518 String reg = ly_scm2string (ly_car (ly_cdr (s)));
520 if (sym == "Discant")
522 Molecule r = fm->find_by_name ("accordion-accDiscant");
524 if (reg.left_string (1) == "F")
526 Molecule d = fm->find_by_name ("accordion-accDot");
527 d.translate_axis (staff_space * 2.5 PT, Y_AXIS);
529 reg = reg.right_string (reg.length ()-1);
532 if (reg.left_string (3) == "EEE")
535 reg = reg.right_string (reg.length ()-3);
537 else if (reg.left_string (2) == "EE")
540 reg = reg.right_string (reg.length ()-2);
542 else if (reg.left_string (2) == "Eh")
545 reg = reg.right_string (reg.length ()-2);
547 else if (reg.left_string (1) == "E")
550 reg = reg.right_string (reg.length ()-1);
554 Molecule d = fm->find_by_name ("accordion-accDot");
555 d.translate_axis (staff_space * 1.5 PT, Y_AXIS);
560 Molecule d = fm->find_by_name ("accordion-accDot");
561 d.translate_axis (staff_space * 1.5 PT, Y_AXIS);
562 d.translate_axis (0.8 * staff_space PT, X_AXIS);
567 Molecule d = fm->find_by_name ("accordion-accDot");
568 d.translate_axis (staff_space * 1.5 PT, Y_AXIS);
569 d.translate_axis (-0.8 * staff_space PT, X_AXIS);
572 if (reg.left_string (2) == "SS")
574 Molecule d = fm->find_by_name ("accordion-accDot");
575 d.translate_axis (0.5 * staff_space PT, Y_AXIS);
576 d.translate_axis (0.4 * staff_space PT, X_AXIS);
578 d.translate_axis (-0.8 * staff_space PT, X_AXIS);
580 reg = reg.right_string (reg.length ()-2);
582 if (reg.left_string (1) == "S")
584 Molecule d = fm->find_by_name ("accordion-accDot");
585 d.translate_axis (0.5 * staff_space PT, Y_AXIS);
587 reg = reg.right_string (reg.length ()-1);
590 else if (sym == "Freebase")
592 Molecule r = fm->find_by_name ("accordion-accFreebase");
594 if (reg.left_string (1) == "F")
596 Molecule d = fm->find_by_name ("accordion-accDot");
597 d.translate_axis (staff_space * 1.5 PT, Y_AXIS);
599 reg = reg.right_string (reg.length ()-1);
603 Molecule d = fm->find_by_name ("accordion-accDot");
604 d.translate_axis (staff_space * 0.5 PT, Y_AXIS);
608 else if (sym == "Bayanbase")
610 Molecule r = fm->find_by_name ("accordion-accBayanbase");
612 if (reg.left_string (1) == "T")
614 Molecule d = fm->find_by_name ("accordion-accDot");
615 d.translate_axis (staff_space * 2.5 PT, Y_AXIS);
617 reg = reg.right_string (reg.length ()-1);
619 /* include 4' reed just for completeness. You don't want to use this. */
620 if (reg.left_string (1) == "F")
622 Molecule d = fm->find_by_name ("accordion-accDot");
623 d.translate_axis (staff_space * 1.5 PT, Y_AXIS);
625 reg = reg.right_string (reg.length ()-1);
627 if (reg.left_string (2) == "EE")
629 Molecule d = fm->find_by_name ("accordion-accDot");
630 d.translate_axis (staff_space * 0.5 PT, Y_AXIS);
631 d.translate_axis (0.4 * staff_space PT, X_AXIS);
633 d.translate_axis (-0.8 * staff_space PT, X_AXIS);
635 reg = reg.right_string (reg.length ()-2);
637 if (reg.left_string (1) == "E")
639 Molecule d = fm->find_by_name ("accordion-accDot");
640 d.translate_axis (staff_space * 0.5 PT, Y_AXIS);
642 reg = reg.right_string (reg.length ()-1);
645 else if (sym == "Stdbase")
647 Molecule r = fm->find_by_name ("accordion-accStdbase");
649 if (reg.left_string (1) == "T")
651 Molecule d = fm->find_by_name ("accordion-accDot");
652 d.translate_axis (staff_space * 3.5 PT, Y_AXIS);
654 reg = reg.right_string (reg.length ()-1);
656 if (reg.left_string (1) == "F")
658 Molecule d = fm->find_by_name ("accordion-accDot");
659 d.translate_axis (staff_space * 2.5 PT, Y_AXIS);
661 reg = reg.right_string (reg.length ()-1);
663 if (reg.left_string (1) == "M")
665 Molecule d = fm->find_by_name ("accordion-accDot");
666 d.translate_axis (staff_space * 2 PT, Y_AXIS);
667 d.translate_axis (staff_space PT, X_AXIS);
669 reg = reg.right_string (reg.length ()-1);
671 if (reg.left_string (1) == "E")
673 Molecule d = fm->find_by_name ("accordion-accDot");
674 d.translate_axis (staff_space * 1.5 PT, Y_AXIS);
676 reg = reg.right_string (reg.length ()-1);
678 if (reg.left_string (1) == "S")
680 Molecule d = fm->find_by_name ("accordion-accDot");
681 d.translate_axis (staff_space * 0.5 PT, Y_AXIS);
683 reg = reg.right_string (reg.length ()-1);
686 /* ugh maybe try to use regular font for S.B. and B.B and only use one font
688 else if (sym == "SB")
690 Molecule r = fm->find_by_name ("accordion-accSB");
693 else if (sym == "BB")
695 Molecule r = fm->find_by_name ("accordion-accBB");
698 else if (sym == "OldEE")
700 Molecule r = fm->find_by_name ("accordion-accOldEE");
703 else if (sym == "OldEES")
705 Molecule r = fm->find_by_name ("accordion-accOldEES");
712 Lookup::repeat_slash (Real w, Real s, Real t)
714 SCM wid = gh_double2scm (w);
715 SCM sl = gh_double2scm (s);
716 SCM thick = gh_double2scm (t);
717 SCM slashnodot = scm_list_n (ly_symbol2scm ("repeat-slash"),
718 wid, sl, thick, SCM_UNDEFINED);
720 Box b (Interval (0, w + sqrt (sqr(t/s) + sqr (t))),
721 Interval (0, w * s));
723 return Molecule (b, slashnodot); // http://slashnodot.org
727 Lookup::bracket (Axis a, Interval iv, Real thick, Real protude)
730 Axis other = Axis((a+1)%2);
732 b[other] = Interval(-1, 1) * thick * 0.5;
734 Molecule m = filledbox (b);
736 b[a] = Interval (iv[UP] - thick, iv[UP]);
737 Interval oi = Interval (-thick/2, thick/2 + fabs (protude)) ;
738 oi *= sign (protude);
740 m.add_molecule (filledbox (b));
741 b[a] = Interval (iv[DOWN], iv[DOWN] +thick);
742 m.add_molecule (filledbox(b));
748 Lookup::triangle (Interval iv, Real thick, Real protude)
752 b[Y_AXIS] = Interval (0 <? protude , 0 >? protude);
754 SCM s = scm_list_n (ly_symbol2scm ("symmetric-x-triangle"),
755 gh_double2scm (thick),
756 gh_double2scm (iv.length()),
757 gh_double2scm (protude), SCM_UNDEFINED);
759 return Molecule (b, s);
764 TODO: use rounded boxes.
766 LY_DEFINE(ly_bracket ,"ly:bracket",
768 (SCM a, SCM iv, SCM t, SCM p),
769 "Make a bracket in direction @var{a}. The extent of the bracket is "
770 "given by @var{iv}. The wings protude by an amount of @var{p}, which "
771 "may be negative. The thickness is given by @var{t}.")
773 SCM_ASSERT_TYPE(is_axis (a), a, SCM_ARG1, __FUNCTION__, "axis") ;
774 SCM_ASSERT_TYPE(is_number_pair (iv), iv, SCM_ARG2, __FUNCTION__, "number pair") ;
775 SCM_ASSERT_TYPE(gh_number_p (t), a, SCM_ARG3, __FUNCTION__, "number") ;
776 SCM_ASSERT_TYPE(gh_number_p (p), a, SCM_ARG4, __FUNCTION__, "number") ;
779 return Lookup::bracket ((Axis)gh_scm2int (a), ly_scm2interval (iv),
781 gh_scm2double (p)).smobbed_copy ();
786 LY_DEFINE(ly_filled_box ,"ly:round-filled-box",
788 (SCM xext, SCM yext, SCM blot),
789 "Make a filled-box of dimensions @var{xext}, @var{yext} and roundness @var{blot}.")
791 SCM_ASSERT_TYPE(is_number_pair (xext), xext, SCM_ARG1, __FUNCTION__, "number pair") ;
792 SCM_ASSERT_TYPE(is_number_pair (yext), yext, SCM_ARG2, __FUNCTION__, "number pair") ;
793 SCM_ASSERT_TYPE(gh_number_p (blot), blot, SCM_ARG3, __FUNCTION__, "number") ;
795 return Lookup::round_filled_box (Box (ly_scm2interval (xext), ly_scm2interval (yext)),
796 gh_scm2double (blot)).smobbed_copy ();