/*
- rest.cc -- implement Rest
+ rest.cc -- implement Rest
source file of the GNU LilyPond music typesetter
- (c) 1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1997--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
*/
-#include "molecule.hh"
-#include "paper-def.hh"
-#include "font-interface.hh"
#include "rest.hh"
+
+#include "directional-element-interface.hh"
#include "dots.hh"
+#include "font-interface.hh"
+#include "international.hh"
+#include "output-def.hh"
#include "paper-score.hh"
#include "staff-symbol-referencer.hh"
+#include "stencil.hh"
+#include "grob.hh"
// -> offset callback
-MAKE_SCHEME_CALLBACK(Rest,after_line_breaking,1);
+MAKE_SCHEME_CALLBACK (Rest, y_offset_callback, 1);
SCM
-Rest::after_line_breaking (SCM smob)
+Rest::y_offset_callback (SCM smob)
{
Grob *me = unsmob_grob (smob);
- int bt = gh_scm2int (me->get_grob_property ("duration-log"));
- if (bt == 0)
- {
- me->translate_axis (Staff_symbol_referencer::staff_space (me) , Y_AXIS);
- }
+ int duration_log = scm_to_int (me->get_property ("duration-log"));
+ int line_count = Staff_symbol_referencer::line_count (me);
+ Real ss = Staff_symbol_referencer::staff_space (me);
- Grob * d = unsmob_grob (me->get_grob_property ("dot"));
- if (d && bt > 4) // UGH.
+ bool position_override = scm_is_number (me->get_property ("staff-position"));
+ Real amount = robust_scm2double (me->get_property ("staff-position"), 0)
+ * 0.5 * ss;
+
+ if (line_count % 2)
{
- d->set_grob_property ("staff-position",
- gh_int2scm ((bt == 7) ? 4 : 3));
+ if (duration_log == 0 && line_count > 1)
+ amount += ss;
}
+ else
+ amount += ss / 2;
- return SCM_UNSPECIFIED;
+ if (!position_override)
+ amount += 2 * ss * get_grob_direction (me);;
+
+ return scm_from_double (amount);
}
+/* A rest might lie under a beam, in which case it should be cross-staff if
+ the beam is cross-staff because the rest's position depends on the
+ formatting of the beam. */
+MAKE_SCHEME_CALLBACK (Rest, calc_cross_staff, 1);
+SCM
+Rest::calc_cross_staff (SCM smob)
+{
+ Grob *me = unsmob_grob (smob);
+ Grob *stem = unsmob_grob (me->get_object ("stem"));
-MAKE_SCHEME_CALLBACK(Rest,brew_molecule,1);
+ if (!stem)
+ return SCM_BOOL_F;
-SCM
-Rest::brew_internal_molecule (SCM smob)
+ return stem->get_property ("cross-staff");
+}
+
+/*
+ make this function easily usable in C++
+*/
+string
+Rest::glyph_name (Grob *me, int balltype, string style, bool try_ledgers)
{
- Grob* me = unsmob_grob (smob);
-
- bool ledger_b =false;
+ bool is_ledgered = false;
+ if (try_ledgers && (balltype == 0 || balltype == 1))
+ {
+ Real rad = Staff_symbol_referencer::staff_radius (me) * 2.0;
+ Real pos = Staff_symbol_referencer::get_position (me);
- SCM balltype = me->get_grob_property ("duration-log");
-
- if (balltype == gh_int2scm (0) || balltype == gh_int2scm (1))
+ /*
+ Figure out when the rest is far enough outside the staff. This
+ could bemore generic, but hey, we understand this even after
+ dinner.
+ */
+ is_ledgered |= (balltype == 0) && (pos >= +rad + 2 || pos < -rad);
+ is_ledgered |= (balltype == 1) && (pos <= -rad - 2 || pos > +rad);
+ }
+
+ string actual_style (style.c_str ());
+
+ if ((style == "mensural") || (style == "neomensural"))
{
- int sz = Staff_symbol_referencer::line_count (me);
- Real dif = abs(Staff_symbol_referencer::position_f (me) - (2* gh_scm2int (balltype) - 1));
- ledger_b = dif > sz;
+
+ /*
+ FIXME: Currently, ancient font does not provide ledgered rests;
+ hence the "o" suffix in the glyph name is bogus. But do we need
+ ledgered rests at all now that we can draw ledger lines with
+ variable width, length and blotdiameter? -- jr
+ */
+ is_ledgered = 0;
+
+ /*
+ There are no 32th/64th/128th mensural/neomensural rests. In
+ these cases, revert back to default style.
+ */
+ if (balltype > 4)
+ actual_style = "";
}
-
- String style;
- SCM style_sym =me->get_grob_property ("style");
- if (gh_scm2int (balltype) >= 2 && gh_symbol_p (style_sym))
+
+ if ((style == "classical") && (balltype != 2))
+ {
+ /*
+ classical style: revert back to default style for any rest other
+ than quarter rest
+ */
+ actual_style = "";
+ }
+
+ if (style == "default")
{
- style = ly_scm2string (scm_symbol_to_string (style_sym));
+ /*
+ Some parts of lily still prefer style "default" over "".
+ Correct this here. -- jr
+ */
+ actual_style = "";
}
- String idx = ("rests-") + to_str (gh_scm2int (balltype))
- + (ledger_b ? "o" : "") + style;
+ return ("rests." + to_string (balltype) + (is_ledgered ? "o" : "")
+ + actual_style);
+}
+
+MAKE_SCHEME_CALLBACK (Rest, print, 1);
+SCM
+Rest::brew_internal_stencil (Grob *me, bool ledgered)
+{
+ SCM balltype_scm = me->get_property ("duration-log");
+ if (!scm_is_number (balltype_scm))
+ return Stencil ().smobbed_copy ();
+
+ int balltype = scm_to_int (balltype_scm);
+
+ string style;
+ SCM style_scm = me->get_property ("style");
+ if (scm_is_symbol (style_scm))
+ style = ly_scm2string (scm_symbol_to_string (style_scm));
- return Font_interface::get_default_font (me)->find_by_name (idx).smobbed_copy();
+ Font_metric *fm = Font_interface::get_default_font (me);
+ string font_char = glyph_name (me, balltype, style, ledgered);
+ Stencil out = fm->find_by_name (font_char);
+ if (out.is_empty ())
+ me->warning (_f ("rest `%s' not found", font_char.c_str ()));
+
+ return out.smobbed_copy ();
}
-SCM
-Rest::brew_molecule (SCM smob)
+SCM
+Rest::print (SCM smob)
{
- return brew_internal_molecule (smob);
+ return brew_internal_stencil (unsmob_grob (smob), true);
}
-MAKE_SCHEME_CALLBACK(Rest,extent_callback,2);
+
+MAKE_SCHEME_CALLBACK (Rest, width, 1);
/*
- We need the callback. The real molecule has ledgers depending on
+ We need the callback. The real stencil has ledgers depending on
Y-position. The Y-position is known only after line breaking. */
SCM
-Rest::extent_callback (SCM smob, SCM ax)
+Rest::width (SCM smob)
{
- Axis a = (Axis) gh_scm2int (ax);
- SCM m = brew_internal_molecule (smob);
- return ly_interval2scm (unsmob_molecule (m)->extent (a));
+ return generic_extent_callback (unsmob_grob (smob), X_AXIS);
}
-bool
-Rest::has_interface (Grob*m)
+MAKE_SCHEME_CALLBACK (Rest, height, 1);
+SCM
+Rest::height (SCM smob)
{
- return m && m->has_interface (ly_symbol2scm ("rest-interface"));
+ return generic_extent_callback (unsmob_grob (smob), Y_AXIS);
}
+
+/*
+ We need the callback. The real stencil has ledgers depending on
+ Y-position. The Y-position is known only after line breaking. */
+SCM
+Rest::generic_extent_callback (Grob *me, Axis a)
+{
+ /*
+ Don't want ledgers: ledgers depend on Y position, which depends on
+ rest collision, which depends on stem size which depends on beam
+ slop of opposite note column.
+
+ consequence: we get too small extents and potential collisions
+ with ledgered rests.
+ */
+ SCM m = brew_internal_stencil (me, a != X_AXIS);
+ return ly_interval2scm (unsmob_stencil (m)->extent (a));
+}
+
+MAKE_SCHEME_CALLBACK (Rest, pure_height, 3);
+SCM
+Rest::pure_height (SCM smob, SCM start, SCM end)
+{
+ (void) start;
+ (void) end;
+
+ Grob *me = unsmob_grob (smob);
+ SCM m = brew_internal_stencil (me, false);
+ return ly_interval2scm (unsmob_stencil (m)->extent (Y_AXIS));
+}
+
+ADD_INTERFACE (Rest,
+ "A rest symbol. The property @code{style} can be"
+ " @code{default}, @code{mensural}, @code{neomensural} or"
+ " @code{classical}.",
+
+ /* properties */
+ "direction "
+ "minimum-distance "
+ "style "
+ );
+