2 rest.cc -- implement Rest
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
11 #include "directional-element-interface.hh"
13 #include "font-interface.hh"
14 #include "international.hh"
15 #include "output-def.hh"
16 #include "paper-score.hh"
17 #include "staff-symbol-referencer.hh"
21 MAKE_SCHEME_CALLBACK (Rest, y_offset_callback, 1);
23 Rest::y_offset_callback (SCM smob)
25 Grob *me = unsmob_grob (smob);
26 int duration_log = scm_to_int (me->get_property ("duration-log"));
27 int line_count = Staff_symbol_referencer::line_count (me);
28 Real ss = Staff_symbol_referencer::staff_space (me);
30 Real amount = robust_scm2double (me->get_property ("staff-position"), 0)
34 if (duration_log == 0 && line_count > 1)
40 Grob *dot = unsmob_grob (me->get_object ("dot"));
41 if (dot && duration_log > 4) // UGH.
43 dot->set_property ("staff-position",
44 scm_from_int ((duration_log == 7) ? 4 : 3));
46 if (dot && duration_log >= -1 && duration_log <= 1) // UGH again.
48 dot->set_property ("staff-position",
49 scm_from_int ((duration_log == 0) ? -1 : 1));
52 amount += 2 * ss * get_grob_direction (me);;
54 return scm_from_double (amount);
58 make this function easily usable in C++
61 Rest::glyph_name (Grob *me, int balltype, std::string style, bool try_ledgers)
63 bool is_ledgered = false;
64 if (try_ledgers && (balltype == 0 || balltype == 1))
66 Real rad = Staff_symbol_referencer::staff_radius (me) * 2.0;
67 Real pos = Staff_symbol_referencer::get_position (me);
70 Figure out when the rest is far enough outside the staff. This
71 could bemore generic, but hey, we understand this even after
74 is_ledgered |= (balltype == 0) && (pos >= +rad + 2 || pos < -rad);
75 is_ledgered |= (balltype == 1) && (pos <= -rad - 2 || pos > +rad);
78 std::string actual_style (style.c_str ());
80 if ((style == "mensural") || (style == "neomensural"))
84 FIXME: Currently, ancient font does not provide ledgered rests;
85 hence the "o" suffix in the glyph name is bogus. But do we need
86 ledgered rests at all now that we can draw ledger lines with
87 variable width, length and blotdiameter? -- jr
92 There are no 32th/64th/128th mensural/neomensural rests. In
93 these cases, revert back to default style.
99 if ((style == "classical") && (balltype != 2))
102 classical style: revert back to default style for any rest other
108 if (style == "default")
111 Some parts of lily still prefer style "default" over "".
112 Correct this here. -- jr
117 return ("rests." + to_string (balltype) + (is_ledgered ? "o" : "")
121 MAKE_SCHEME_CALLBACK (Rest, print, 1);
123 Rest::brew_internal_stencil (Grob *me, bool ledgered)
125 SCM balltype_scm = me->get_property ("duration-log");
126 if (!scm_is_number (balltype_scm))
127 return Stencil ().smobbed_copy ();
129 int balltype = scm_to_int (balltype_scm);
132 SCM style_scm = me->get_property ("style");
133 if (scm_is_symbol (style_scm))
134 style = ly_scm2string (scm_symbol_to_string (style_scm));
136 Font_metric *fm = Font_interface::get_default_font (me);
137 std::string font_char = glyph_name (me, balltype, style, ledgered);
138 Stencil out = fm->find_by_name (font_char);
140 me->warning (_f ("rest `%s' not found", font_char.c_str ()));
142 return out.smobbed_copy ();
146 Rest::print (SCM smob)
148 return brew_internal_stencil (unsmob_grob (smob), true);
151 MAKE_SCHEME_CALLBACK (Rest, width, 1);
153 We need the callback. The real stencil has ledgers depending on
154 Y-position. The Y-position is known only after line breaking. */
156 Rest::width (SCM smob)
158 return generic_extent_callback (unsmob_grob (smob), X_AXIS);
161 MAKE_SCHEME_CALLBACK (Rest, height, 1);
163 Rest::height (SCM smob)
165 return generic_extent_callback (unsmob_grob (smob), Y_AXIS);
169 We need the callback. The real stencil has ledgers depending on
170 Y-position. The Y-position is known only after line breaking. */
172 Rest::generic_extent_callback (Grob *me, Axis a)
175 Don't want ledgers: ledgers depend on Y position, which depends on
176 rest collision, which depends on stem size which depends on beam
177 slop of opposite note column.
179 consequence: we get too small extents and potential collisions
182 SCM m = brew_internal_stencil (me, a != X_AXIS);
183 return ly_interval2scm (unsmob_stencil (m)->extent (a));
186 ADD_INTERFACE (Rest, "rest-interface",