lilypond-1.3.12
[lilypond.git] / lily / lookup.cc
blob7f98f45965b1e7e33f48f72c155b898a0ee10b92
1 /*
2 lookup.cc -- implement simple Lookup methods.
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
8 Jan Nieuwenhuizen <janneke@gnu.org>
10 TODO
11 Glissando
13 #include <math.h>
14 #include <ctype.h>
15 #include "lookup.hh"
16 #include "debug.hh"
17 #include "dimensions.hh"
19 #include "paper-def.hh"
20 #include "string-convert.hh"
21 #include "file-path.hh"
22 #include "main.hh"
23 #include "lily-guile.hh"
24 #include "all-font-metrics.hh"
25 #include "afm.hh"
26 #include "scope.hh"
27 #include "molecule.hh"
28 #include "atom.hh"
29 #include "lily-guile.hh"
32 Lookup::Lookup ()
34 afm_l_ = 0;
37 Lookup::Lookup (Lookup const& s)
39 font_name_ = s.font_name_;
40 afm_l_ = 0;
45 build a ledger line for small pieces.
47 Molecule
48 Lookup::ledger_line (Interval xwid) const
50 Drul_array<Molecule> endings;
51 endings[LEFT] = afm_find ("noteheads-ledgerending");
52 Molecule * e = &endings[LEFT];
53 endings[RIGHT] = *e;
55 Real thick = e->dim_[Y_AXIS].length();
56 Real len = e->dim_[X_AXIS].length () - thick;
58 Molecule total;
59 Direction d = LEFT;
60 do {
61 endings[d].translate_axis (xwid[d] - endings[d].dim_[X_AXIS][d], X_AXIS);
62 total.add_molecule (endings[d]);
63 } while ((flip(&d)) != LEFT);
65 Real xpos = xwid [LEFT] + len;
67 while (xpos + len + thick /2 <= xwid[RIGHT])
69 e->translate_axis (len, X_AXIS);
70 total.add_molecule (*e);
71 xpos += len;
74 return total;
80 Molecule
81 Lookup::afm_find (String s, bool warn) const
83 if (!afm_l_)
85 Lookup * me = (Lookup*)(this);
86 me->afm_l_ = all_fonts_global_p->find_afm (font_name_);
87 if (!me->afm_l_)
89 warning (_f ("Can't find font: `%s'", font_name_));
90 warning (_f ("(search path: `%s')", global_path.str ().ch_C()));
91 error (_ ("Aborting"));
94 Adobe_font_char_metric cm = afm_l_->find_char (s, warn);
95 Molecule m;
96 if (cm.code () < 0)
99 don't want people relying on this kind of dimension.
101 m.set_empty (false);
102 return m;
105 Atom at (gh_list (ly_symbol2scm ("char"),
106 gh_int2scm (cm.code ()),
107 SCM_UNDEFINED));
109 at.fontify (afm_l_);
110 m.dim_ = cm.dimensions();
111 m.add_atom (&at);
112 return m;
115 Molecule
116 Lookup::simple_bar (String type, Real h, Paper_def* paper_l) const
118 SCM thick = ly_symbol2scm (("barthick_" + type).ch_C());
119 Real w = 0.0;
121 if (paper_l->scope_p_->elem_b (thick))
123 w = paper_l->get_realvar (thick);
125 else
127 programming_error ("No bar thickness set ! ");
128 w = 1 PT;
130 return filledbox (Box (Interval(0,w), Interval(-h/2, h/2)));
134 Molecule
135 Lookup::bar (String str, Real h, Paper_def *paper_l) const
137 if (str == "bracket")
138 return staff_bracket (h, paper_l);
139 else if (str == "brace")
141 Real staffht = paper_l->get_var ("staffheight");
142 return staff_brace (h,staffht);
144 Real kern = paper_l->get_var ("bar_kern");
145 Real thinkern = paper_l->get_var ("bar_thinkern");
147 Molecule thin = simple_bar ("thin", h, paper_l);
148 Molecule thick = simple_bar ("thick", h, paper_l);
149 Molecule colon = afm_find ("dots-repeatcolon", paper_l);
151 Molecule m;
153 if (str == "")
155 return fill (Box (Interval(0, 0), Interval (-h/2, h/2)));
157 if (str == "scorepostbreak")
159 return simple_bar ("score", h, paper_l);
161 else if (str == "|")
163 return thin;
165 else if (str == "|.")
167 m.add_at_edge (X_AXIS, LEFT, thick, 0);
168 m.add_at_edge (X_AXIS, LEFT, thin, kern);
170 else if (str == ".|")
172 m.add_at_edge (X_AXIS, RIGHT, thick, 0);
173 m.add_at_edge (X_AXIS, RIGHT, thin, kern);
175 else if (str == ":|")
177 m.add_at_edge (X_AXIS, LEFT, thick, 0);
178 m.add_at_edge (X_AXIS, LEFT, thin, kern);
179 m.add_at_edge (X_AXIS, LEFT, colon, kern);
181 else if (str == "|:")
183 m.add_at_edge (X_AXIS, RIGHT, thick, 0);
184 m.add_at_edge (X_AXIS, RIGHT, thin, kern);
185 m.add_at_edge (X_AXIS, RIGHT, colon, kern);
187 else if (str == ":|:")
189 m.add_at_edge (X_AXIS, LEFT, thick, thinkern);
190 m.add_at_edge (X_AXIS, LEFT, colon, kern);
191 m.add_at_edge (X_AXIS, RIGHT, thick, kern);
192 m.add_at_edge (X_AXIS, RIGHT, colon, kern);
194 else if (str == ".|.")
196 m.add_at_edge (X_AXIS, LEFT, thick, thinkern);
197 m.add_at_edge (X_AXIS, RIGHT, thick, kern);
199 else if (str == "||")
201 m.add_at_edge (X_AXIS, RIGHT, thin, 0);
202 m.add_at_edge (X_AXIS, RIGHT, thin, thinkern);
205 return m;
208 Molecule
209 Lookup::beam (Real slope, Real width, Real thick) const
211 Real height = slope * width;
212 Real min_y = (0 <? height) - thick/2;
213 Real max_y = (0 >? height) + thick/2;
216 Molecule m;
217 Atom at
218 (gh_list (ly_symbol2scm ("beam"),
219 gh_double2scm (width),
220 gh_double2scm (slope),
221 gh_double2scm (thick),
222 SCM_UNDEFINED));
224 m.dim_[X_AXIS] = Interval (0, width);
225 m.dim_[Y_AXIS] = Interval (min_y, max_y);
226 m.add_atom (&at);
227 return m;
231 offset2scm (Offset o)
233 return gh_list (gh_double2scm (o[X_AXIS]), gh_double2scm(o[Y_AXIS]),
234 SCM_UNDEFINED);
237 Molecule
238 Lookup::dashed_slur (Array<Offset> controls, Real thick, Real dash) const
240 assert (controls.size () == 8);
241 Offset d = controls[3] - controls[0];
243 Real dx = d[X_AXIS];
244 Real dy = d[Y_AXIS];
246 Molecule m;
249 m.dim_[X_AXIS] = Interval (0, dx);
250 m.dim_[Y_AXIS] = Interval (0 <? dy, 0 >? dy);
252 SCM sc[4];
253 for (int i=0; i< 4; i++)
255 sc[i] = offset2scm (controls[i]);
258 Atom at
259 (gh_list (ly_symbol2scm ("dashed-slur"),
260 gh_double2scm (thick),
261 gh_double2scm (dash),
262 ly_quote_scm (array_to_list (sc, 4)),
263 SCM_UNDEFINED));
266 m.add_atom (&at);
267 return m;
273 Molecule
274 Lookup::fill (Box b) const
276 Molecule m;
277 m.dim_ = b;
278 return m;
283 Molecule
284 Lookup::special_time_signature (String s, int n, int d, Paper_def*pap) const
286 // First guess: s contains only the signature style
287 String symbolname = "timesig-" + s + to_str (n) + "/" + to_str (d);
289 Molecule m = afm_find (symbolname, false);
290 if (!m.empty_b())
291 return m;
293 // Second guess: s contains the full signature name
294 m = afm_find ("timesig-"+s, false);
295 if (!m.empty_b ())
296 return m;
298 // Resort to default layout with numbers
299 return time_signature (n,d,pap);
302 Molecule
303 Lookup::filledbox (Box b ) const
305 Molecule m;
307 Atom at (gh_list (ly_symbol2scm ("filledbox"),
308 gh_double2scm (-b[X_AXIS][LEFT]),
309 gh_double2scm (b[X_AXIS][RIGHT]),
310 gh_double2scm (-b[Y_AXIS][DOWN]),
311 gh_double2scm (b[Y_AXIS][UP]),
312 SCM_UNDEFINED));
314 m.dim_ = b;
315 m.add_atom (&at);
316 return m;
320 TODO: THIS IS UGLY. Since the user has direct access to TeX
321 strings, we try some halfbaked attempt to detect TeX trickery.
323 String
324 sanitise_TeX_string (String text)
326 int brace_count =0;
327 for (int i= 0; i < text.length_i (); i++)
329 if (text[i] == '\\')
330 continue;
332 if (text[i] == '{')
333 brace_count ++;
334 else if (text[i] == '}')
335 brace_count --;
338 if(brace_count)
340 warning (_f ("Non-matching braces in text `%s', adding braces", text.ch_C()));
342 if (brace_count < 0)
344 text = to_str ('{', -brace_count) + text;
346 else
348 text = text + to_str ('}', brace_count);
352 return text;
356 TODO!
358 String
359 sanitise_PS_string (String t)
361 return t;
367 Molecule
368 Lookup::text (String style, String text, Paper_def *paper_l) const
370 Molecule m;
371 if (style.empty_b ())
372 style = "roman";
374 int font_mag = 0;
375 Real font_h = paper_l->get_var ("font_normal");
376 if (paper_l->scope_p_->elem_b ("font_" + style))
378 font_h = paper_l->get_var ("font_" + style);
382 if (paper_l->scope_p_->elem_b ("magnification_" + style))
384 font_mag = (int)paper_l->get_var ("magnification_" + style);
388 UGH.
390 SCM l = ly_eval_str (("(style-to-cmr \"" + style + "\")").ch_C());
391 if (l != SCM_BOOL_F)
393 style = ly_scm2string (gh_cdr(l)) +to_str ((int)font_h);
398 Font_metric* metric_l = 0;
400 if (font_mag)
401 metric_l = all_fonts_global_p->find_scaled (style, font_mag);
402 else
403 metric_l = all_fonts_global_p->find_font (style);
406 if (output_global_ch == "tex")
407 text = sanitise_TeX_string (text);
408 else if (output_global_ch == "ps")
409 text = sanitise_PS_string (text);
411 m.dim_ = metric_l->text_dimension (text);
413 Atom at (gh_list (ly_symbol2scm ("text"),
414 ly_str02scm (text.ch_C()),
415 SCM_UNDEFINED));
416 at.fontify (metric_l);
418 m.add_atom (&at);
419 return m;
425 Molecule
426 Lookup::time_signature (int num, int den, Paper_def *paper_l) const
428 String sty = "number";
429 Molecule n (text (sty, to_str (num), paper_l));
430 Molecule d (text (sty, to_str (den), paper_l));
431 n.align_to (X_AXIS, CENTER);
432 d.align_to (X_AXIS, CENTER);
433 Molecule m;
434 if (den)
436 m.add_at_edge (Y_AXIS, UP, n, 0.0);
437 m.add_at_edge (Y_AXIS, DOWN, d, 0.0);
439 else
441 m = n;
442 m.align_to (Y_AXIS, CENTER);
444 return m;
447 Molecule
448 Lookup::staff_brace (Real y, int staff_size) const
450 Molecule m;
452 Real step = 1.0;
453 int minht = 2 * staff_size;
454 int maxht = 7 * minht;
455 int idx = int (((maxht - step) <? y - minht) / step);
456 idx = idx >? 0;
459 String nm = String ("feta-braces" + to_str (staff_size));
460 SCM e =gh_list (ly_symbol2scm ("char"), gh_int2scm (idx), SCM_UNDEFINED);
461 Atom at (e);
463 at.fontify (all_fonts_global_p->find_font (nm));
465 m.dim_[Y_AXIS] = Interval (-y/2,y/2);
466 m.dim_[X_AXIS] = Interval (0,0);
467 m.add_atom (&at);
468 return m;
471 Molecule
472 Lookup::hairpin (Real width, Real height, Real thick, bool decresc, bool continued) const
474 Molecule m;
476 const char* hairpin = decresc ? "decrescendo" : "crescendo";
477 Atom at (gh_list (ly_symbol2scm (hairpin),
478 gh_double2scm (thick),
479 gh_double2scm (width),
480 gh_double2scm (height),
481 gh_double2scm (continued ? height/2 : 0.0),
482 SCM_UNDEFINED));
483 m.dim_.x () = Interval (0, width);
484 m.dim_.y () = Interval (-2*height, 2*height);
486 m.add_atom (&at);
487 return m;
490 Molecule
491 Lookup::tuplet_bracket (Real dy , Real dx, Real thick, Real gap,
492 Real height, Direction dir) const
494 Molecule m;
496 Atom at (gh_list(ly_symbol2scm ("tuplet"),
497 gh_double2scm (height),
498 gh_double2scm (gap),
499 gh_double2scm (dx),
500 gh_double2scm (dy),
501 gh_double2scm (thick),
502 gh_int2scm (dir),
503 SCM_UNDEFINED));
504 m.add_atom (&at);
506 return m;
510 Make a smooth curve along the points
512 Molecule
513 Lookup::slur (Array<Offset> controls, Real linethick) const
515 Offset delta_off = controls[3]- controls[0];
516 Molecule m;
518 SCM scontrols [8];
519 int indices[] = {5,6,7,4,1,2,3,0};
521 for (int i= 0; i < 8; i++)
522 scontrols[i] = offset2scm (controls[indices[i]]);
525 Atom at (gh_list (ly_symbol2scm ("bezier-sandwich"),
526 ly_quote_scm (array_to_list (scontrols, 8)),
527 gh_double2scm (linethick),
528 SCM_UNDEFINED));
530 m.dim_[X_AXIS] = Interval (0, delta_off[X_AXIS]);
531 m.dim_[Y_AXIS] = Interval (0 <? delta_off[Y_AXIS], 0 >? delta_off[Y_AXIS]);
532 m.add_atom (&at);
533 return m;
536 Molecule
537 Lookup::staff_bracket (Real height, Paper_def* paper_l) const
539 Molecule m;
540 Atom at ( gh_list (ly_symbol2scm ("bracket"),
541 gh_double2scm (paper_l->get_var("bracket_arch_angle")),
542 gh_double2scm (paper_l->get_var("bracket_arch_width")),
543 gh_double2scm (paper_l->get_var("bracket_arch_height")),
544 gh_double2scm (paper_l->get_var("bracket_width")),
545 gh_double2scm (height),
546 gh_double2scm (paper_l->get_var("bracket_arch_thick")),
547 gh_double2scm (paper_l->get_var("bracket_thick")),
548 SCM_UNDEFINED));
550 m.add_atom (&at);
551 m.dim_[Y_AXIS] = Interval (-height/2,height/2);
552 m.dim_[X_AXIS] = Interval (0,4 PT);
554 m.translate_axis (- 4. / 3. * m.dim_[X_AXIS].length (), X_AXIS);
555 return m;
558 Molecule
559 Lookup::volta (Real h, Real w, Real thick, bool vert_start, bool vert_end) const
561 Molecule m;
563 Atom at (gh_list (ly_symbol2scm ("volta"),
564 gh_double2scm (h),
565 gh_double2scm (w),
566 gh_double2scm (thick),
567 gh_int2scm (vert_start),
568 gh_int2scm (vert_end),
569 SCM_UNDEFINED));
571 m.dim_[Y_AXIS] = Interval (- h/2, h/2);
572 m.dim_[X_AXIS] = Interval (0, w);
574 m.add_atom (&at);
575 return m;
578 Molecule
579 Lookup::accordion (SCM s, Real interline_f) const
581 Molecule m;
582 String sym = ly_scm2string(SCM_CAR(s));
583 String reg = ly_scm2string(SCM_CAR(SCM_CDR(s)));
585 if (sym == "Discant")
587 Molecule r = afm_find("scripts-accDiscant");
588 m.add_molecule(r);
589 if (reg.left_str(1) == "F")
591 Molecule d = afm_find("scripts-accDot");
592 d.translate_axis(interline_f * 2.5 PT, Y_AXIS);
593 m.add_molecule(d);
594 reg = reg.right_str(reg.length_i()-1);
596 int eflag = 0x00;
597 if (reg.left_str(3) == "EEE")
599 eflag = 0x07;
600 reg = reg.right_str(reg.length_i()-3);
602 else if (reg.left_str(2) == "EE")
604 eflag = 0x05;
605 reg = reg.right_str(reg.length_i()-2);
607 else if (reg.left_str(2) == "Eh")
609 eflag = 0x04;
610 reg = reg.right_str(reg.length_i()-2);
612 else if (reg.left_str(1) == "E")
614 eflag = 0x02;
615 reg = reg.right_str(reg.length_i()-1);
617 if (eflag & 0x02)
619 Molecule d = afm_find("scripts-accDot");
620 d.translate_axis(interline_f * 1.5 PT, Y_AXIS);
621 m.add_molecule(d);
623 if (eflag & 0x04)
625 Molecule d = afm_find("scripts-accDot");
626 d.translate_axis(interline_f * 1.5 PT, Y_AXIS);
627 d.translate_axis(0.8 * interline_f PT, X_AXIS);
628 m.add_molecule(d);
630 if (eflag & 0x01)
632 Molecule d = afm_find("scripts-accDot");
633 d.translate_axis(interline_f * 1.5 PT, Y_AXIS);
634 d.translate_axis(-0.8 * interline_f PT, X_AXIS);
635 m.add_molecule(d);
637 if (reg.left_str(2) == "SS")
639 Molecule d = afm_find("scripts-accDot");
640 d.translate_axis(0.5 * interline_f PT, Y_AXIS);
641 d.translate_axis(0.4 * interline_f PT, X_AXIS);
642 m.add_molecule(d);
643 d.translate_axis(-0.8 * interline_f PT, X_AXIS);
644 m.add_molecule(d);
645 reg = reg.right_str(reg.length_i()-2);
647 if (reg.left_str(1) == "S")
649 Molecule d = afm_find("scripts-accDot");
650 d.translate_axis(0.5 * interline_f PT, Y_AXIS);
651 m.add_molecule(d);
652 reg = reg.right_str(reg.length_i()-1);
655 else if (sym == "Freebase")
657 Molecule r = afm_find("scripts-accFreebase");
658 m.add_molecule(r);
659 if (reg.left_str(1) == "F")
661 Molecule d = afm_find("scripts-accDot");
662 d.translate_axis(interline_f * 1.5 PT, Y_AXIS);
663 m.add_molecule(d);
664 reg = reg.right_str(reg.length_i()-1);
666 if (reg == "E")
668 Molecule d = afm_find("scripts-accDot");
669 d.translate_axis(interline_f * 0.5 PT, Y_AXIS);
670 m.add_molecule(d);
673 else if (sym == "Bayanbase")
675 Molecule r = afm_find("scripts-accBayanbase");
676 m.add_molecule(r);
677 if (reg.left_str(1) == "T")
679 Molecule d = afm_find("scripts-accDot");
680 d.translate_axis(interline_f * 2.5 PT, Y_AXIS);
681 m.add_molecule(d);
682 reg = reg.right_str(reg.length_i()-1);
684 /* include 4' reed just for completeness. You don't want to use this. */
685 if (reg.left_str(1) == "F")
687 Molecule d = afm_find("scripts-accDot");
688 d.translate_axis(interline_f * 1.5 PT, Y_AXIS);
689 m.add_molecule(d);
690 reg = reg.right_str(reg.length_i()-1);
692 if (reg.left_str(2) == "EE")
694 Molecule d = afm_find("scripts-accDot");
695 d.translate_axis(interline_f * 0.5 PT, Y_AXIS);
696 d.translate_axis(0.4 * interline_f PT, X_AXIS);
697 m.add_molecule(d);
698 d.translate_axis(-0.8 * interline_f PT, X_AXIS);
699 m.add_molecule(d);
700 reg = reg.right_str(reg.length_i()-2);
702 if (reg.left_str(1) == "E")
704 Molecule d = afm_find("scripts-accDot");
705 d.translate_axis(interline_f * 0.5 PT, Y_AXIS);
706 m.add_molecule(d);
707 reg = reg.right_str(reg.length_i()-1);
710 else if (sym == "Stdbase")
712 Molecule r = afm_find("scripts-accStdbase");
713 m.add_molecule(r);
714 if (reg.left_str(1) == "T")
716 Molecule d = afm_find("scripts-accDot");
717 d.translate_axis(interline_f * 3.5 PT, Y_AXIS);
718 m.add_molecule(d);
719 reg = reg.right_str(reg.length_i()-1);
721 if (reg.left_str(1) == "F")
723 Molecule d = afm_find("scripts-accDot");
724 d.translate_axis(interline_f * 2.5 PT, Y_AXIS);
725 m.add_molecule(d);
726 reg = reg.right_str(reg.length_i()-1);
728 if (reg.left_str(1) == "M")
730 Molecule d = afm_find("scripts-accDot");
731 d.translate_axis(interline_f * 2 PT, Y_AXIS);
732 d.translate_axis(interline_f PT, X_AXIS);
733 m.add_molecule(d);
734 reg = reg.right_str(reg.length_i()-1);
736 if (reg.left_str(1) == "E")
738 Molecule d = afm_find("scripts-accDot");
739 d.translate_axis(interline_f * 1.5 PT, Y_AXIS);
740 m.add_molecule(d);
741 reg = reg.right_str(reg.length_i()-1);
743 if (reg.left_str(1) == "S")
745 Molecule d = afm_find("scripts-accDot");
746 d.translate_axis(interline_f * 0.5 PT, Y_AXIS);
747 m.add_molecule(d);
748 reg = reg.right_str(reg.length_i()-1);
751 /* ugh maybe try to use regular font for S.B. and B.B and only use one font
752 for the rectangle */
753 else if (sym == "SB")
755 Molecule r = afm_find("scripts-accSB");
756 m.add_molecule(r);
758 else if (sym == "BB")
760 Molecule r = afm_find("scripts-accBB");
761 m.add_molecule(r);
763 else if (sym == "OldEE")
765 Molecule r = afm_find("scripts-accOldEE");
766 m.add_molecule(r);
768 else if (sym == "OldEES")
770 Molecule r = afm_find("scripts-accOldEES");
771 m.add_molecule(r);
773 return m;