X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fstem.cc;h=efbdcd1b774dcb21cf6994c19c035a003863b8a2;hb=8a719f6eec1bd84269a55d1ec99adb3f17c04e64;hp=7b8db24062a4917260c107045fb029fd571139f5;hpb=93606217722859703474dcf46937a7c5d6b405a4;p=lilypond.git diff --git a/lily/stem.cc b/lily/stem.cc index 7b8db24062..6829af1a35 100644 --- a/lily/stem.cc +++ b/lily/stem.cc @@ -3,349 +3,268 @@ source file of the GNU LilyPond music typesetter - (c) 1996--2002 Han-Wen Nienhuys - Jan Nieuwenhuizen + (c) 1996--2006 Han-Wen Nienhuys + Jan Nieuwenhuizen TODO: This is way too hairy + + TODO: fix naming. + + Stem-end, chord-start, etc. is all confusing naming. */ -#include // rint +#include "stem.hh" + +#include // rint +using namespace std; #include "lookup.hh" #include "directional-element-interface.hh" #include "note-head.hh" -#include "stem.hh" -#include "debug.hh" -#include "paper-def.hh" +#include "warn.hh" +#include "output-def.hh" #include "rhythmic-head.hh" #include "font-interface.hh" -#include "molecule.hh" #include "paper-column.hh" #include "misc.hh" #include "beam.hh" #include "rest.hh" -#include "group-interface.hh" +#include "pointer-group-interface.hh" #include "staff-symbol-referencer.hh" -#include "spanner.hh" #include "side-position-interface.hh" #include "dot-column.hh" +#include "stem-tremolo.hh" void -Stem::set_beaming (Grob*me ,int i, Direction d) +Stem::set_beaming (Grob *me, int beam_count, Direction d) { - SCM pair = me->get_grob_property ("beaming"); - - if (!gh_pair_p (pair)) + SCM pair = me->get_property ("beaming"); + + if (!scm_is_pair (pair)) { - pair = gh_cons (gh_int2scm (-1),gh_int2scm (-1)); - me-> set_grob_property ("beaming", pair); + pair = scm_cons (SCM_EOL, SCM_EOL); + me->set_property ("beaming", pair); } - index_set_cell (pair, d, gh_int2scm (i)); + + SCM lst = index_get_cell (pair, d); + for (int i = 0; i < beam_count; i++) + lst = scm_cons (scm_from_int (i), lst); + index_set_cell (pair, d, lst); } int -Stem::beam_count (Grob*me,Direction d) +Stem::get_beaming (Grob *me, Direction d) { - SCM p=me->get_grob_property ("beaming"); - if (gh_pair_p (p)) - return gh_scm2int (index_cell (p,d)); - else - return -1; + SCM pair = me->get_property ("beaming"); + if (!scm_is_pair (pair)) + return 0; + + SCM lst = index_get_cell (pair, d); + return scm_ilength (lst); } Interval -Stem::head_positions (Grob*me) +Stem::head_positions (Grob *me) { - if (!head_count (me)) + if (head_count (me)) { - Interval iv; - return iv; + Drul_array e (extremal_heads (me)); + return Interval (Staff_symbol_referencer::get_position (e[DOWN]), + Staff_symbol_referencer::get_position (e[UP])); } - - Drul_array e (extremal_heads (me)); - - return Interval (Staff_symbol_referencer::position_f (e[DOWN]), - Staff_symbol_referencer::position_f (e[UP])); + return Interval (); } - Real -Stem::chord_start_f (Grob*me) +Stem::chord_start_y (Grob *me) { - return head_positions (me)[get_direction (me)] - * Staff_symbol_referencer::staff_space (me)/2.0; + Interval hp = head_positions (me); + if (!hp.is_empty ()) + return hp[get_grob_direction (me)] * Staff_symbol_referencer::staff_space (me) + * 0.5; + return 0; } -Real -Stem::stem_end_position (Grob*me) -{ - SCM p =me->get_grob_property ("stem-end-position"); - Real pos; - if (!gh_number_p (p)) - { - pos = get_default_stem_end_position (me); - me->set_grob_property ("stem-end-position", gh_double2scm (pos)); - } - else - pos = gh_scm2double (p); - return pos; -} -Direction -Stem::get_direction (Grob*me) +void +Stem::set_stemend (Grob *me, Real se) { - Direction d = Directional_element_interface::get (me); + // todo: margins + Direction d = get_grob_direction (me); - if (!d) - { - d = get_default_dir (me); - // urg, AAARGH! - Directional_element_interface::set (me, d); - } - return d ; -} + if (d && d * head_positions (me)[get_grob_direction (me)] >= se * d) + me->warning (_ ("weird stem size, check for narrow beams")); + me->set_property ("stem-end-position", scm_from_double (se)); +} -void -Stem::set_stemend (Grob*me, Real se) +/* Note head that determines hshift for upstems + WARNING: triggers direction */ +Grob * +Stem::support_head (Grob *me) { - // todo: margins - Direction d= get_direction (me); - - if (d && d * head_positions (me)[get_direction (me)] >= se*d) - me->warning (_ ("Weird stem size; check for narrow beams")); + extract_grob_set (me, "note-heads", heads); + if (heads.size () == 1) + return heads[0]; - me->set_grob_property ("stem-end-position", gh_double2scm (se)); + return first_head (me); } int -Stem::type_i (Grob*me) +Stem::head_count (Grob *me) { - return first_head (me) ? Rhythmic_head::balltype_i (first_head (me)) : 2; + return Pointer_group_interface::count (me, ly_symbol2scm ("note-heads")); } -/* - Note head that determines hshift for upstems - */ -Grob* -Stem::support_head (Grob*me) -{ - SCM h = me->get_grob_property ("support-head"); - Grob * nh = unsmob_grob (h); - if (nh) - return nh; - else if (head_count (me) == 1) - { - /* - UGH. - */ - - return unsmob_grob (ly_car (me->get_grob_property ("note-heads"))); - } - else - return first_head (me); -} - - -int -Stem::head_count (Grob*me) +/* The note head which forms one end of the stem. + WARNING: triggers direction */ +Grob * +Stem::first_head (Grob *me) { - return Pointer_group_interface::count (me, "note-heads"); + Direction d = get_grob_direction (me); + if (d) + return extremal_heads (me)[-d]; + return 0; } -/* - The note head which forms one end of the stem. - */ -Grob* -Stem::first_head (Grob*me) +/* The note head opposite to the first head. */ +Grob * +Stem::last_head (Grob *me) { - Direction d = get_direction (me); - if (!d) - return 0; - return extremal_heads (me)[-d]; + Direction d = get_grob_direction (me); + if (d) + return extremal_heads (me)[d]; + return 0; } /* - START is part where stem reaches `last' head. - */ -Drul_array -Stem::extremal_heads (Grob*me) + START is part where stem reaches `last' head. + + This function returns a drul with (bottom-head, top-head). +*/ +Drul_array +Stem::extremal_heads (Grob *me) { const int inf = 1000000; Drul_array extpos; extpos[DOWN] = inf; - extpos[UP] = -inf; - - Drul_array exthead; - exthead[LEFT] = exthead[RIGHT] =0; - - for (SCM s = me->get_grob_property ("note-heads"); gh_pair_p (s); s = ly_cdr (s)) - { - Grob * n = unsmob_grob (ly_car (s)); + extpos[UP] = -inf; - - int p = int (Staff_symbol_referencer::position_f (n)); + Drul_array exthead (0, 0); + extract_grob_set (me, "note-heads", heads); + + for (int i = heads.size (); i--;) + { + Grob *n = heads[i]; + int p = Staff_symbol_referencer::get_rounded_position (n); Direction d = LEFT; - do { - if (d* p > d* extpos[d]) + do { - exthead[d] = n; - extpos[d] = p; + if (d * p > d * extpos[d]) + { + exthead[d] = n; + extpos[d] = p; + } } - } while (flip (&d) != DOWN); + while (flip (&d) != DOWN); } - return exthead; } static int -icmp (int const &a, int const &b) +integer_compare (int const &a, int const &b) { - return a-b; + return a - b; } +/* The positions, in ascending order. */ Array Stem::note_head_positions (Grob *me) { - Array ps ; - for (SCM s = me->get_grob_property ("note-heads"); gh_pair_p (s); s = ly_cdr (s)) + Array ps; + extract_grob_set (me, "note-heads", heads); + + for (int i = heads.size (); i--;) { - Grob * n = unsmob_grob (ly_car (s)); - int p = int (Staff_symbol_referencer::position_f (n)); + Grob *n = heads[i]; + int p = Staff_symbol_referencer::get_rounded_position (n); ps.push (p); } - ps.sort (icmp); - return ps; + ps.sort (integer_compare); + return ps; } - void -Stem::add_head (Grob*me, Grob *n) +Stem::add_head (Grob *me, Grob *n) { - n->set_grob_property ("stem", me->self_scm ()); - n->add_dependency (me); + n->set_object ("stem", me->self_scm ()); if (Note_head::has_interface (n)) - { - Pointer_group_interface::add_grob (me, ly_symbol2scm ("note-heads"), n); - } + Pointer_group_interface::add_grob (me, ly_symbol2scm ("note-heads"), n); + else if (Rest::has_interface (n)) + Pointer_group_interface::add_grob (me, ly_symbol2scm ("rests"), n); } bool -Stem::invisible_b (Grob*me) +Stem::is_invisible (Grob *me) { - return ! (head_count (me) && Rhythmic_head::balltype_i (support_head (me)) >= 1); -} + Real stemlet_length = robust_scm2double (me->get_property ("stemlet-length"), + 0.0); -Direction -Stem::get_default_dir (Grob*me) -{ - int staff_center = 0; - Interval hp = head_positions (me); - if (hp.empty_b()) - { - return CENTER; - } - - int udistance = (int) (UP * hp[UP] - staff_center); - int ddistance = (int) (DOWN* hp[DOWN] - staff_center); - - if (sign (ddistance - udistance)) - return Direction (sign (ddistance -udistance)); - - return to_dir (me->get_grob_property ("neutral-direction")); + return !((head_count (me) + || stemlet_length > 0.0) + && scm_to_int (me->get_property ("duration-log")) >= 1); } -Real -Stem::get_default_stem_end_position (Grob*me) +MAKE_SCHEME_CALLBACK (Stem, calc_stem_end_position, 1) +SCM +Stem::calc_stem_end_position (SCM smob) { - bool grace_b = to_boolean (me->get_grob_property ("grace")); - SCM s; - Array a; + Grob *me = unsmob_grob (smob); - Real length_f = 0.; - SCM scm_len = me->get_grob_property ("length"); - if (gh_number_p (scm_len)) - { - length_f = gh_scm2double (scm_len); - } - else - { - s = me->get_grob_property ("lengths"); - for (SCM q = s; q != SCM_EOL; q = ly_cdr (q)) - a.push (gh_scm2double (ly_car (q))); - - // stem uses half-spaces - length_f = a[ ((duration_log (me) - 2) >? 0) get_grob_property ("stem-shorten"); - for (SCM q = s; gh_pair_p (q); q = ly_cdr (q)) - a.push (gh_scm2double (ly_car (q))); + if (!head_count (me)) + return scm_from_double (0.0); + + Real ss = Staff_symbol_referencer::staff_space (me); + int durlog = duration_log (me); + Array a; - // stem uses half-spaces + /* WARNING: IN HALF SPACES */ + Real length = robust_scm2double (me->get_property ("length"), 7); - // fixme: use scm_list_n_ref () iso. array[] - Real shorten_f = a[ ((duration_log (me) - 2) >? 0) get_property ("no-stem-extend")); + if (!no_extend_b && dir * stem_end < 0) + stem_end = 0.0; - /* URGURGURG - 'set-default-stemlen' sets direction too - */ - Direction dir = get_direction (me); - if (!dir) - { - dir = get_default_dir (me); - Directional_element_interface::set (me, dir); - } - /* stems in unnatural (forced) direction should be shortened, - according to [Roush & Gourlay] */ - if (chord_start_f (me) - && (get_direction (me) != get_default_dir (me))) - length_f -= shorten_f; - - Interval hp = head_positions (me); - Real st = hp[dir] + dir * length_f; - - bool no_extend_b = to_boolean (me->get_grob_property ("no-stem-extend")); - if (!grace_b && !no_extend_b && dir * st < 0) // junkme? - st = 0.0; - - /* - Make a little room if we have a upflag and there is a dot. - previous approach was to lengthen the stem. This is not - good typesetting practice. - - */ - if (!beam_l (me) && dir == UP - && duration_log (me) > 2) + /* Make a little room if we have a upflag and there is a dot. + previous approach was to lengthen the stem. This is not + good typesetting practice. */ + if (!get_beam (me) && dir == UP + && durlog > 2) { - Grob * closest_to_flag = extremal_heads (me)[dir]; - Grob * dots = closest_to_flag - ? Rhythmic_head::dots_l (closest_to_flag ) : 0; + Grob *closest_to_flag = extremal_heads (me)[dir]; + Grob *dots = closest_to_flag + ? Rhythmic_head::get_dots (closest_to_flag) : 0; if (dots) { - Real dp = Staff_symbol_referencer::position_f (dots); - Real flagy = flag (me).extent (Y_AXIS)[-dir] * 2 - / Staff_symbol_referencer::staff_space (me); - - /* - Very gory: add myself to the X-support of the parent, - which should be a dot-column. - */ - if (dir * (st + flagy - dp) < 0.5) + Real dp = Staff_symbol_referencer::get_position (dots); + Real flagy = flag (me).extent (Y_AXIS)[-dir] * 2 / ss; + + /* Very gory: add myself to the X-support of the parent, + which should be a dot-column. */ + if (dir * (stem_end + flagy - dp) < 0.5) { Grob *par = dots->get_parent (X_AXIS); @@ -353,178 +272,294 @@ Stem::get_default_stem_end_position (Grob*me) { Side_position_interface::add_support (par, me); - /* - TODO: apply some better logic here. The flag is - curved inwards, so this will typically be too - much. - */ + /* TODO: apply some better logic here. The flag is + curved inwards, so this will typically be too + much. */ } } } } - - return st; + return scm_from_double (stem_end); } +MAKE_SCHEME_CALLBACK (Stem, calc_length, 1) +SCM +Stem::calc_length (SCM smob) +{ + Grob *me = unsmob_grob (smob); + + SCM details = me->get_property ("details"); + int durlog = duration_log (me); -/* + Real ss = Staff_symbol_referencer::staff_space (me); + Real length = 7; + SCM s = scm_cdr (scm_assq (ly_symbol2scm ("lengths"), details)); + if (scm_is_pair (s)) + length = 2 * scm_to_double (robust_list_ref (durlog - 2, s)); + + Direction dir = get_grob_direction (me); + + /* Stems in unnatural (forced) direction should be shortened, + according to [Roush & Gourlay] */ + Interval hp = head_positions (me); + if (dir && dir * hp[dir] >= 0) + { + SCM sshorten = scm_cdr (scm_assq (ly_symbol2scm ("stem-shorten"), details)); + SCM scm_shorten = scm_is_pair (sshorten) + ? robust_list_ref (max (duration_log (me) - 2, 0), sshorten) : SCM_EOL; + Real shorten = 2* robust_scm2double (scm_shorten, 0); + + /* On boundary: shorten only half */ + if (abs (head_positions (me)[dir]) <= 1) + shorten *= 0.5; + + length -= shorten; + } + + length *= robust_scm2double (me->get_property ("length-fraction"), 1.0); + + /* Tremolo stuff. */ + Grob *t_flag = unsmob_grob (me->get_object ("tremolo-flag")); + if (t_flag && !unsmob_grob (me->get_object ("beam"))) + { + /* Crude hack: add extra space if tremolo flag is there. + + We can't do this for the beam, since we get into a loop + (Stem_tremolo::raw_stencil () looks at the beam.) --hwn */ + + Real minlen = 1.0 + + 2 * Stem_tremolo::raw_stencil (t_flag).extent (Y_AXIS).length () + / ss; + + if (durlog >= 3) + { + Interval flag_ext = flag (me).extent (Y_AXIS); + if (!flag_ext.is_empty ()) + minlen += 2 * flag_ext.length () / ss; + + /* The clash is smaller for down stems (since the tremolo is + angled up.) */ + if (dir == DOWN) + minlen -= 1.0; + } + length = max (length, minlen + 1.0); + } - the log of the duration (Number of hooks on the flag minus two) - */ + return scm_from_double (length); +} +/* The log of the duration (Number of hooks on the flag minus two) */ int -Stem::duration_log (Grob*me) +Stem::duration_log (Grob *me) { - SCM s = me->get_grob_property ("duration-log"); - return (gh_number_p (s)) ? gh_scm2int (s) : 2; + SCM s = me->get_property ("duration-log"); + return (scm_is_number (s)) ? scm_to_int (s) : 2; } -void -Stem::position_noteheads (Grob*me) +MAKE_SCHEME_CALLBACK(Stem, calc_positioning_done, 1); +SCM +Stem::calc_positioning_done (SCM smob) { + Grob *me = unsmob_grob (smob); if (!head_count (me)) - return; - - Link_array heads = - Pointer_group_interface__extract_grobs (me, (Grob*)0, "note-heads"); + return SCM_BOOL_T; + extract_grob_set (me, "note-heads", ro_heads); + Link_array heads (ro_heads); heads.sort (compare_position); - Direction dir =get_direction (me); - + Direction dir = get_grob_direction (me); + if (dir < 0) heads.reverse (); - - bool invisible = invisible_b (me); - Real thick = 0.0; - if (invisible) - thick = gh_scm2double (me->get_grob_property ("thickness")) - * me->paper_l ()->get_var ("linethickness"); - + Real thick = thickness (me); Grob *hed = support_head (me); - Real w = Note_head::head_extent (hed,X_AXIS)[dir]; - for (int i=0; i < heads.size (); i++) + if (!dir) { - heads[i]->translate_axis (w - Note_head::head_extent (heads[i],X_AXIS)[dir], - X_AXIS); + programming_error ("Stem dir must be up or down."); + dir = UP; + set_grob_direction (me, dir); } - bool parity= true; // todo: make me settable. - int lastpos = int (Staff_symbol_referencer::position_f (heads[0])); - for (int i=1; i < heads.size (); i ++) + Real w = hed->extent (hed, X_AXIS)[dir]; + for (int i = 0; i < heads.size (); i++) + heads[i]->translate_axis (w - heads[i]->extent (heads[i], X_AXIS)[dir], + X_AXIS); + + bool parity = true; + Real lastpos = Real (Staff_symbol_referencer::get_position (heads[0])); + for (int i = 1; i < heads.size (); i++) { - Real p = Staff_symbol_referencer::position_f (heads[i]); - int dy =abs (lastpos- (int)p); + Real p = Staff_symbol_referencer::get_position (heads[i]); + Real dy = fabs (lastpos- p); - if (dy <= 1) + /* + dy should always be 0.5, 0.0, 1.0, but provide safety margin + for rounding errors. + */ + if (dy < 1.1) { if (parity) { - Real l = Note_head::head_extent (heads[i], X_AXIS).length (); + Real ell = heads[i]->extent (heads[i], X_AXIS).length (); + + Direction d = get_grob_direction (me); + /* + Reversed head should be shifted ell-thickness, but this + looks too crowded, so we only shift ell-0.5*thickness. + + This leads to assymetry: Normal heads overlap the + stem 100% whereas reversed heads only overlaps the + stem 50% + */ + + Real reverse_overlap = 0.5; + heads[i]->translate_axis ((ell - thick * reverse_overlap) * d, + X_AXIS); - Direction d = get_direction (me); - heads[i]->translate_axis (l * d, X_AXIS); + if (is_invisible (me)) + heads[i]->translate_axis (-thick * (2 - reverse_overlap) * d, + X_AXIS); - if (invisible_b(me)) - heads[i]->translate_axis (-thick *2* d , X_AXIS); + /* TODO: - - /* TODO: - For some cases we should kern some more: when the - distance between the next or prev note is too large, we'd + distance between the next or prev note is too large, we'd get large white gaps, eg. - - | + + | X| - |X <- kern this. - | + |X <- kern this. + | X - + */ } parity = !parity; } else parity = true; - + lastpos = int (p); } + + return SCM_BOOL_T; } -MAKE_SCHEME_CALLBACK (Stem,before_line_breaking,1); +MAKE_SCHEME_CALLBACK(Stem, calc_direction, 1); SCM -Stem::before_line_breaking (SCM smob) +Stem::calc_direction (SCM smob) { - Grob*me = unsmob_grob (smob); - - - /* - Do the calculations for visible stems, but also for invisible stems - with note heads (i.e. half notes.) - */ - if (head_count (me)) + Grob *me = unsmob_grob (smob); + Direction dir = CENTER; + if (Grob *beam = unsmob_grob (me->get_object ("beam"))) { - stem_end_position (me); // ugh. Trigger direction calc. - position_noteheads (me); + SCM ignore_me = beam->get_property ("direction"); + (void) ignore_me; + dir = get_grob_direction (me); } else { - me->remove_grob_property ("molecule-callback"); + SCM dd = me->get_property ("default-direction"); + dir = to_dir (dd); + if (!dir) + return me->get_property ("neutral-direction"); } - return SCM_UNSPECIFIED; + return scm_from_int (dir); } -/* - ugh. - When in a beam with tuplet brackets, brew_mol is called early, - caching a wrong value. - */ -MAKE_SCHEME_CALLBACK (Stem, height, 2); +MAKE_SCHEME_CALLBACK(Stem, calc_default_direction, 1); SCM -Stem::height (SCM smob, SCM ax) +Stem::calc_default_direction (SCM smob) { - Axis a = (Axis)gh_scm2int (ax); - Grob * me = unsmob_grob (smob); - assert (a == Y_AXIS); + Grob *me = unsmob_grob (smob); - SCM mol = me->get_uncached_molecule (); - Interval iv; - if (mol != SCM_EOL) - iv = unsmob_molecule (mol)->extent (a); - return ly_interval2scm (iv); + Direction dir = CENTER; + int staff_center = 0; + Interval hp = head_positions (me); + if (!hp.is_empty ()) + { + int udistance = (int) (UP * hp[UP] - staff_center); + int ddistance = (int) (DOWN * hp[DOWN] - staff_center); + + dir = Direction (sign (ddistance - udistance)); + } + + return scm_from_int (dir); } -Molecule -Stem::flag (Grob*me) +MAKE_SCHEME_CALLBACK (Stem, height, 1); +SCM +Stem::height (SCM smob) { - /* TODO: rename flag-style into something more appropriate, - e.g. "stroke-style", maybe with values "" (i.e. no stroke), - "single" and "double". Needs more discussion. + Grob *me = unsmob_grob (smob); + + Direction dir = get_grob_direction (me); + + /* Trigger callback. + + UGH. Should be automatic */ - String style, fstyle, staffline_offs; - SCM fst = me->get_grob_property ("flag-style"); - if (gh_string_p (fst)) + Grob *beam = get_beam (me); + if (beam) { - fstyle = ly_scm2string (fst); + beam->get_property ("positions"); } - SCM st = me->get_grob_property ("style"); - if (gh_symbol_p (st)) - { - style = (ly_scm2string (scm_symbol_to_string (st))); - } - else + /* + Can't get_stencil(), since that would cache stencils too early. + This causes problems with beams. + */ + Stencil *stencil = unsmob_stencil (print (smob)); + Interval iv = stencil ? stencil->extent (Y_AXIS) : Interval(); + if (beam) { - style = ""; + if (dir == CENTER) + { + programming_error ("no stem direction"); + dir = UP; + } + iv[dir] += dir * Beam::get_thickness (beam) * 0.5; } - bool adjust = to_boolean (me->get_grob_property ("adjust-if-on-staffline")); - if (String::compare_i (style, "mensural") == 0) + return ly_interval2scm (iv); +} + +Real +Stem::stem_end_position (Grob *me) +{ + return robust_scm2double (me->get_property ("stem-end-position"), 0); +} + +Stencil +Stem::flag (Grob *me) +{ + int log = duration_log (me); + if (log < 3 + || unsmob_grob (me->get_object ("beam"))) + return Stencil (); + + /* + TODO: maybe property stroke-style should take different values, + e.g. "" (i.e. no stroke), "single" and "double" (currently, it's + '() or "grace"). */ + String flag_style; + + SCM flag_style_scm = me->get_property ("flag-style"); + if (scm_is_symbol (flag_style_scm)) + flag_style = ly_symbol2string (flag_style_scm); + + if (flag_style == "no-flag") + return Stencil (); + + bool adjust = true; + + String staffline_offs; + if (String::compare (flag_style, "mensural") == 0) /* Mensural notation: For notes on staff lines, use different flags than for notes between staff lines. The idea is that flags are always vertically aligned with the staff lines, @@ -534,330 +569,432 @@ Stem::flag (Grob*me) */ { if (adjust) - { - /* Urrgh! We have to detect wether this stem ends on a staff - line or between two staff lines. But we can not call - stem_end_position(me) or get_default_stem_end_position(me), - since this encounters the flag and hence results in an - infinite recursion. However, in pure mensural notation, - there are no multiple note heads attached to a single stem, - neither is there usually need for using the stem_shorten - property (except for 32th and 64th notes, but that is not a - problem since the stem length in this case is augmented by - an integral multiple of staff_space). Hence, it should be - sufficient to just take the first note head, assume it's - the only one, look if it's on a staff line, and select the - flag's shape accordingly. In the worst case, the shape - looks slightly misplaced, but that will usually be the - programmer's fault (e.g. when trying to attach multiple - note heads to a single stem in mensural notation). */ - - /* - perhaps the detection whether this correction is needed should - happen in a different place to avoid the recursion. - - --hwn. - */ - Grob *first = first_head(me); - int sz = Staff_symbol_referencer::line_count (me)-1; - int p = (int)rint (Staff_symbol_referencer::position_f (first)); - staffline_offs = (((p ^ sz) & 0x1) == 0) ? "1" : "0"; + { + int p = (int) (rint (stem_end_position (me))); + staffline_offs + = Staff_symbol_referencer::on_line (me, p) ? "0" : "1"; } else - { - staffline_offs = "2"; - } + staffline_offs = "2"; } else + staffline_offs = ""; + + char dir = (get_grob_direction (me) == UP) ? 'u' : 'd'; + String font_char = flag_style + + to_string (dir) + staffline_offs + to_string (log); + Font_metric *fm = Font_interface::get_default_font (me); + Stencil flag = fm->find_by_name ("flags." + font_char); + if (flag.is_empty ()) + me->warning (_f ("flag `%s' not found", font_char)); + + SCM stroke_style_scm = me->get_property ("stroke-style"); + if (scm_is_string (stroke_style_scm)) { - staffline_offs = ""; + String stroke_style = ly_scm2string (stroke_style_scm); + if (!stroke_style.empty ()) + { + String font_char = to_string (dir) + stroke_style; + Stencil stroke = fm->find_by_name ("flags." + font_char); + if (stroke.is_empty ()) + me->warning (_f ("flag stroke `%s' not found", font_char)); + else + flag.add_stencil (stroke); + } } - char c = (get_direction (me) == UP) ? 'u' : 'd'; - String index_str - = String ("flags-") + style + to_str (c) + staffline_offs + to_str (duration_log (me)); - Molecule m - = Font_interface::get_default_font (me)->find_by_name (index_str); - if (!fstyle.empty_b ()) - m.add_molecule (Font_interface::get_default_font (me)->find_by_name (String ("flags-") + to_str (c) + fstyle)); - return m; + + return flag; } -MAKE_SCHEME_CALLBACK (Stem,dim_callback,2); +MAKE_SCHEME_CALLBACK (Stem, width, 1); SCM -Stem::dim_callback (SCM e, SCM ax) -{ - Axis a = (Axis) gh_scm2int (ax); - assert (a == X_AXIS); - Grob *se = unsmob_grob (e); - Interval r (0, 0); - if (unsmob_grob (se->get_grob_property ("beam")) || abs (duration_log (se)) <= 2) - ; // TODO! +Stem::width (SCM e) +{ + Grob *me = unsmob_grob (e); + + Interval r; + + if (is_invisible (me)) + r.set_empty (); + else if (unsmob_grob (me->get_object ("beam")) + || abs (duration_log (me)) <= 2) + { + r = Interval (-1, 1); + r *= thickness (me) / 2; + } else { - r = flag (se).extent (X_AXIS); + r = Interval (-1, 1) * thickness (me) * 0.5; + r.unite (flag (me).extent (X_AXIS)); } return ly_interval2scm (r); } - +Real +Stem::thickness (Grob *me) +{ + return scm_to_double (me->get_property ("thickness")) + * Staff_symbol_referencer::line_thickness (me); +} -MAKE_SCHEME_CALLBACK (Stem,brew_molecule,1); - +MAKE_SCHEME_CALLBACK (Stem, print, 1); SCM -Stem::brew_molecule (SCM smob) +Stem::print (SCM smob) { - Grob*me = unsmob_grob (smob); - Molecule mol; - Direction d = get_direction (me); - - - Real y1 = Staff_symbol_referencer::position_f (first_head (me)); - Real y2 = stem_end_position (me); - - Interval stem_y (y1 ? y1); + Grob *me = unsmob_grob (smob); + Stencil mol; + Direction d = get_grob_direction (me); + + Real stemlet_length = robust_scm2double (me->get_property ("stemlet-length"), + 0.0); + bool stemlet = stemlet_length > 0.0; + + /* TODO: make the stem start a direction ? + This is required to avoid stems passing in tablature chords. */ + Grob *lh + = to_boolean (me->get_property ("avoid-note-head")) + ? last_head (me) + : first_head (me); + Grob *beam = get_beam (me); + + if (!lh && !stemlet) + return SCM_EOL; + + if (!lh && stemlet && !beam) + return SCM_EOL; + if (is_invisible (me)) + return SCM_EOL; - // dy? - Real dy = Staff_symbol_referencer::staff_space (me) * 0.5; + Real y2 = robust_scm2double (me->get_property ("stem-end-position"), 0.0); + Real y1 = y2; + Real half_space = Staff_symbol_referencer::staff_space (me) * 0.5; - if (Grob *hed = support_head (me)) + if (lh) + y2 = Staff_symbol_referencer::get_position (lh); + else if (stemlet) + { + Real beam_translation = Beam::get_beam_translation (beam); + Real beam_thickness = Beam::get_thickness (beam); + int beam_count = beam_multiplicity (me).length () + 1; + + y2 -= d + * (0.5 * beam_thickness + + beam_translation * max (0, (beam_count - 1)) + + stemlet_length) / half_space; + } + + Interval stem_y (min (y1, y2), max (y2, y1)); + + if (Grob *head = support_head (me)) { /* must not take ledgers into account. - */ - Interval head_height = Note_head::head_extent (hed,Y_AXIS); - Real y_attach = Note_head::stem_attachment_coordinate ( hed, Y_AXIS); + */ + Interval head_height = head->extent (head, Y_AXIS); + Real y_attach = Note_head::stem_attachment_coordinate (head, Y_AXIS); y_attach = head_height.linear_combination (y_attach); - stem_y[Direction (-d)] += d * y_attach/dy; - } - - if (!invisible_b (me)) - { - Real stem_width = gh_scm2double (me->get_grob_property ("thickness")) - // URG - * me->paper_l ()->get_var ("linethickness"); - - Molecule ss =Lookup::filledbox (Box (Interval (-stem_width/2, stem_width/2), - Interval (stem_y[DOWN]*dy, stem_y[UP]*dy))); - mol.add_molecule (ss); + stem_y[Direction (-d)] += d * y_attach / half_space; } - if (!beam_l (me) && abs (duration_log (me)) > 2) - { - Molecule fl = flag (me); - fl.translate_axis (stem_y[d]*dy, Y_AXIS); - mol.add_molecule (fl); - } + // URG + Real stem_width = thickness (me); + Real blot + = me->layout ()->get_dimension (ly_symbol2scm ("blotdiameter")); + + Box b = Box (Interval (-stem_width / 2, stem_width / 2), + Interval (stem_y[DOWN] * half_space, stem_y[UP] * half_space)); + + Stencil ss = Lookup::round_filled_box (b, blot); + mol.add_stencil (ss); + + mol.add_stencil (get_translated_flag (me)); return mol.smobbed_copy (); } +Stencil +Stem::get_translated_flag (Grob *me) +{ + Stencil fl = flag (me); + if (!fl.is_empty ()) + { + Direction d = get_grob_direction (me); + Real blot + = me->layout ()->get_dimension (ly_symbol2scm ("blotdiameter")); + Real stem_width = thickness (me); + Real half_space = Staff_symbol_referencer::staff_space (me) * 0.5; + Real y2 = robust_scm2double (me->get_property ("stem-end-position"), 0.0); + fl.translate_axis (y2 * half_space - d * blot / 2, Y_AXIS); + fl.translate_axis (stem_width / 2, X_AXIS); + } + return fl; +} + + /* move the stem to right of the notehead if it is up. - */ -MAKE_SCHEME_CALLBACK (Stem,off_callback,2); +*/ +MAKE_SCHEME_CALLBACK (Stem, offset_callback, 1); SCM -Stem::off_callback (SCM element_smob, SCM) +Stem::offset_callback (SCM smob) { - Grob *me = unsmob_grob (element_smob); - - Real r=0; + Grob *me = unsmob_grob (smob); + Real r = 0.0; - if (head_count (me) == 0) + if (Grob *f = first_head (me)) { - return gh_double2scm (0.0); - } - - if (Grob * f = first_head (me)) - { - Interval head_wid = Note_head::head_extent(f, X_AXIS); - - - Real attach =0.0; + Interval head_wid = f->extent (f, X_AXIS); + Real attach = 0.0; - if (invisible_b (me)) - { - attach = 0.0; - } + if (is_invisible (me)) + attach = 0.0; else - attach = Note_head::stem_attachment_coordinate(f, X_AXIS); - - Direction d = get_direction (me); + attach = Note_head::stem_attachment_coordinate (f, X_AXIS); + Direction d = get_grob_direction (me); Real real_attach = head_wid.linear_combination (d * attach); - r = real_attach; - /* - If not centered: correct for stem thickness. - */ + /* If not centered: correct for stem thickness. */ if (attach) { - Real rule_thick - = gh_scm2double (me->get_grob_property ("thickness")) - * me->paper_l ()->get_var ("linethickness"); - - - r += - d * rule_thick * 0.5; + Real rule_thick = thickness (me); + r += -d * rule_thick * 0.5; + } + } + else + { + extract_grob_set (me, "rests", rests); + if (rests.size ()) + { + Grob *rest = rests.top (); + r = rest->extent (rest, X_AXIS).center (); } } - return gh_double2scm (r); + return scm_from_double (r); } - - -Grob* -Stem::beam_l (Grob*me) +Spanner * +Stem::get_beam (Grob *me) { - SCM b= me->get_grob_property ("beam"); - return unsmob_grob (b); + SCM b = me->get_object ("beam"); + return dynamic_cast (unsmob_grob (b)); } - -// ugh still very long. Stem_info -Stem::calc_stem_info (Grob*me) +Stem::get_stem_info (Grob *me) { - SCM scm_info = me->get_grob_property ("stem-info"); - - if (gh_pair_p (scm_info )) - { - Stem_info si ; + Stem_info si; + si.dir_ = get_grob_direction (me); + + SCM scm_info = me->get_property ("stem-info"); + si.ideal_y_ = scm_to_double (scm_car (scm_info)); + si.shortest_y_ = scm_to_double (scm_cadr (scm_info)); + return si; +} - si.ideal_y = gh_scm2double (gh_car (scm_info)); - si.max_y = gh_scm2double (gh_cadr (scm_info)); - si.min_y = gh_scm2double (gh_caddr (scm_info)); +/* TODO: add extra space for tremolos! */ +MAKE_SCHEME_CALLBACK(Stem, calc_stem_info, 1); +SCM +Stem::calc_stem_info (SCM smob) +{ + Grob *me = unsmob_grob (smob); + Direction my_dir = get_grob_direction (me); - return si; + if (!my_dir) + { + programming_error ("no stem dir set"); + my_dir = UP; } - - Grob * beam = beam_l (me); - Direction beam_dir = Directional_element_interface::get (beam); - if (!beam_dir) + Real staff_space = Staff_symbol_referencer::staff_space (me); + Grob *beam = get_beam (me); + + if (beam) { - programming_error ("Beam dir not set."); - beam_dir = UP; + (void) beam->get_property ("beaming"); } + + Real beam_translation = Beam::get_beam_translation (beam); + Real beam_thickness = Beam::get_thickness (beam); + int beam_count = Beam::get_direction_beam_count (beam, my_dir); + Real length_fraction + = robust_scm2double (me->get_property ("length-fraction"), 1.0); + + /* Simple standard stem length */ + SCM details = me->get_property ("details"); + SCM lengths = scm_cdr (scm_assq (ly_symbol2scm ("beamed-lengths"), details)); + + Real ideal_length + = scm_to_double (robust_list_ref (beam_count - 1, lengths)) + * staff_space + * length_fraction + /* stem only extends to center of beam + */ + - 0.5 * beam_thickness; - Real staff_space = Staff_symbol_referencer::staff_space (me); - Real half_space = staff_space / 2; - - int multiplicity = Beam::get_multiplicity (beam); - Real interbeam_f = Beam::get_interbeam (beam); + /* Condition: sane minimum free stem length (chord to beams) */ + lengths = scm_cdr (scm_assq (ly_symbol2scm ("beamed-minimum-free-lengths"), details)); - Real thick = gh_scm2double (beam->get_grob_property ("thickness")); - Stem_info info; - info.ideal_y = chord_start_f (me); + Real ideal_minimum_free + = scm_to_double (robust_list_ref (beam_count - 1, lengths)) + * staff_space + * length_fraction; - // for simplicity, we calculate as if dir == UP + /* UGH + It seems that also for ideal minimum length, we must use + the maximum beam count (for this direction): - /* - UGH. This confuses issues more. fixme. --hwn - */ - info.ideal_y *= beam_dir; - SCM grace_prop = me->get_grob_property ("grace"); + \score{ \notes\relative c''{ [a8 a32] }} - bool grace_b = to_boolean (grace_prop); - - Array a; - SCM s; - - s = me->get_grob_property ("beamed-minimum-lengths"); - a.clear (); - for (SCM q = s; q != SCM_EOL; q = ly_cdr (q)) - a.push (gh_scm2double (ly_car (q))); + must be horizontal. */ + Real height_of_my_beams = beam_thickness + + (beam_count - 1) * beam_translation; + Real ideal_minimum_length = ideal_minimum_free + + height_of_my_beams + /* stem only extends to center of beam */ + - 0.5 * beam_thickness; - Real minimum_length = a[multiplicity get_grob_property ("beamed-lengths"); + ideal_length = max (ideal_length, ideal_minimum_length); - a.clear (); - for (SCM q = s; q != SCM_EOL; q = ly_cdr (q)) - a.push (gh_scm2double (ly_car (q))); + /* Convert to Y position, calculate for dir == UP */ + Real note_start + = /* staff positions */ + head_positions (me)[my_dir] * 0.5 + * my_dir * staff_space; + Real ideal_y = note_start + ideal_length; - Real stem_length = a[multiplicity get_grob_property ("no-stem-extend")); - if (!grace_b && !no_extend_b) - { - /* highest beam of (UP) beam must never be lower than middle - staffline - lowest beam of (UP) beam must never be lower than second staffline - */ - info.min_y = - info.min_y >? 0 - >? (- 2 * half_space - thick - + (multiplicity > 0) * thick - + interbeam_f * (multiplicity - 1)); - } - } - else - /* knee */ + Also, not for knees. Seems to be a good thing. */ + bool no_extend_b = to_boolean (me->get_property ("no-stem-extend")); + bool is_knee = to_boolean (beam->get_property ("knee")); + if (!no_extend_b && !is_knee) { - info.ideal_y -= thick + stem_length; - info.max_y = info.ideal_y - minimum_length; - - /* - We shouldn't invert the stems, so we set minimum at 0. - */ - info.min_y = 0.5; + /* Highest beam of (UP) beam must never be lower than middle + staffline */ + ideal_y = max (ideal_y, 0.0); + /* Lowest beam of (UP) beam must never be lower than second staffline */ + ideal_y = max (ideal_y, (-staff_space + - beam_thickness + height_of_my_beams)); } - - info.ideal_y = (info.max_y ? info.min_y; - s = beam->get_grob_property ("shorten"); - if (gh_number_p (s)) - info.ideal_y -= gh_scm2double (s); + ideal_y -= robust_scm2double (beam->get_property ("shorten"), 0); - Grob *common = me->common_refpoint (beam, Y_AXIS); - Real interstaff_f = beam_dir * - (me->relative_coordinate (common, Y_AXIS) - - beam->relative_coordinate (common, Y_AXIS)); - - info.ideal_y += interstaff_f; - info.min_y += interstaff_f; - info.max_y += interstaff_f ; - - me->set_grob_property ("stem-info", - scm_list_n (gh_double2scm (info.ideal_y), - gh_double2scm (info.max_y), - gh_double2scm (info.min_y), - SCM_UNDEFINED)); + SCM bemfl = scm_cdr (scm_assq (ly_symbol2scm ("beamed-extreme-minimum-free-lengths"), + details)); - return info; + Real minimum_free + = scm_to_double (robust_list_ref (beam_count - 1, bemfl)) + * staff_space + * length_fraction; + + Real minimum_length = minimum_free + + height_of_my_beams + /* stem only extends to center of beam */ + - 0.5 * beam_thickness; + + if (Grob *tremolo = unsmob_grob (me->get_object ("tremolo-flag"))) + { + Interval y_ext = tremolo->extent (tremolo, Y_AXIS); + y_ext.widen (0.5); // FIXME. Should be tunable? + minimum_length = max (minimum_length, y_ext.length ()); + } + + ideal_y *= my_dir; + Real minimum_y = note_start + minimum_length; + Real shortest_y = minimum_y * my_dir; + + return scm_list_2 (scm_from_double (ideal_y), + scm_from_double (shortest_y)); } -ADD_INTERFACE (Stem,"stem-interface", - "A stem", - "adjust-if-on-staffline thickness stem-info beamed-lengths beamed-minimum-lengths lengths beam stem-shorten duration-log beaming neutral-direction stem-end-position support-head note-heads direction length style no-stem-extend flag-style dir-forced"); +Slice +Stem::beam_multiplicity (Grob *stem) +{ + SCM beaming = stem->get_property ("beaming"); + Slice le = int_list_to_slice (scm_car (beaming)); + Slice ri = int_list_to_slice (scm_cdr (beaming)); + le.unite (ri); + return le; +} + +/* FIXME: Too many properties */ +ADD_INTERFACE (Stem, "stem-interface", + "The stem represent the graphical stem. " + "In addition, it internally connects note heads, beams and" + "tremolos. " + "Rests and whole notes have invisible stems." + + "\n\nThe following properties may be set in the details list." + "@table @code\n" + "@item beamed-lengths \n" + "list of stem lengths given beam multiplicity. \n" + "@item beamed-minimum-free-lengths \n" + "list of normal minimum free stem lengths (chord to beams) given beam multiplicity.\n" + "@item beamed-extreme-minimum-free-lengths\n" + "list of extreme minimum free stem lengths (chord to beams) given beam multiplicity.\n" + "@item lengths\n" + "Default stem lengths. The list gives a length for each flag-count.\n" + "@item stem-shorten\n" + "How much a stem in a forced direction " + "should be shortened. The list gives an amount depending on the number " + "of flags/beams." + "@end table\n" + , + + /* properties */ + "avoid-note-head " + "beam " + "beaming " + "default-direction " + "details " + "direction " + "duration-log " + "flag-style " + "french-beaming " + "length " + "length-fraction " + "neutral-direction " + "no-stem-extend " + "note-heads " + "positioning-done " + "rests " + "stem-end-position " + "stem-info " + "stemlet-length " + "stroke-style " + "thickness " + "tremolo-flag " + ); + +/****************************************************************/ + +Stem_info::Stem_info () +{ + ideal_y_ = shortest_y_ = 0; + dir_ = CENTER; +} +void +Stem_info::scale (Real x) +{ + ideal_y_ *= x; + shortest_y_ *= x; +}