X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fstem.cc;h=fc21f2d6b9597929ee24dd4c888d1a1f7824d027;hb=9e69cb84d6ee5b0a861cd97869b10e3bdf0c833c;hp=7a07ac749b366c3d1549c57a0e56e9ed09ae57f5;hpb=28976d28a04cfb9abe97af7214d7dce11f732604;p=lilypond.git diff --git a/lily/stem.cc b/lily/stem.cc index 7a07ac749b..fc21f2d6b9 100644 --- a/lily/stem.cc +++ b/lily/stem.cc @@ -3,8 +3,8 @@ source file of the GNU LilyPond music typesetter - (c) 1996--2004 Han-Wen Nienhuys - Jan Nieuwenhuizen + (c) 1996--2006 Han-Wen Nienhuys + Jan Nieuwenhuizen TODO: This is way too hairy @@ -13,391 +13,292 @@ Stem-end, chord-start, etc. is all confusing naming. */ -#include // rint +#include "stem.hh" +#include "spanner.hh" -#include "lookup.hh" +#include // rint +using namespace std; + +#include "beam.hh" #include "directional-element-interface.hh" -#include "note-head.hh" -#include "stem.hh" -#include "warn.hh" -#include "paper-def.hh" -#include "rhythmic-head.hh" +#include "dot-column.hh" #include "font-interface.hh" -#include "stencil.hh" -#include "paper-column.hh" +#include "international.hh" +#include "lookup.hh" #include "misc.hh" -#include "beam.hh" +#include "note-head.hh" +#include "output-def.hh" +#include "paper-column.hh" +#include "pointer-group-interface.hh" #include "rest.hh" -#include "group-interface.hh" -#include "staff-symbol-referencer.hh" -#include "spanner.hh" +#include "rhythmic-head.hh" #include "side-position-interface.hh" -#include "dot-column.hh" +#include "staff-symbol-referencer.hh" #include "stem-tremolo.hh" +#include "warn.hh" void -Stem::set_beaming (Grob*me, int beam_count, Direction d) +Stem::set_beaming (Grob *me, int beam_count, Direction d) { SCM pair = me->get_property ("beaming"); - - if (!is_pair (pair)) + + if (!scm_is_pair (pair)) { pair = scm_cons (SCM_EOL, SCM_EOL); me->set_property ("beaming", pair); } - SCM l = index_get_cell (pair, d); - for (int i = 0; i< beam_count; i++) - { - l = scm_cons (scm_int2num (i), l); - } - index_set_cell (pair, d, l); + SCM lst = index_get_cell (pair, d); + if (beam_count) + for (int i = 0; i < beam_count; i++) + lst = scm_cons (scm_from_int (i), lst); + else + lst = SCM_BOOL_F; + + index_set_cell (pair, d, lst); } - -Interval -Stem::head_positions (Grob*me) +int +Stem::get_beaming (Grob *me, Direction d) { - 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])); -} + SCM pair = me->get_property ("beaming"); + if (!scm_is_pair (pair)) + return 0; + SCM lst = index_get_cell (pair, d); -Real -Stem::chord_start_y (Grob*me) -{ - return head_positions (me)[get_direction (me)] - * Staff_symbol_referencer::staff_space (me)/2.0; + int len = scm_ilength (lst); + return max (len, 0); } -Real -Stem::stem_end_position (Grob*me) +Interval +Stem::head_positions (Grob *me) { - SCM p =me->get_property ("stem-end-position"); - Real pos; - if (!is_number (p)) + if (head_count (me)) { - pos = get_default_stem_end_position (me); - me->set_property ("stem-end-position", scm_make_real (pos)); + Drul_array e (extremal_heads (me)); + return Interval (Staff_symbol_referencer::get_position (e[DOWN]), + Staff_symbol_referencer::get_position (e[UP])); } - else - pos = ly_scm2double (p); - - return pos; + return Interval (); } -Direction -Stem::get_direction (Grob*me) +Real +Stem::chord_start_y (Grob *me) { - Direction d = get_grob_direction (me); - - if (!d) - { - d = get_default_dir (me); - // urg, AAARGH! - set_grob_direction (me, d); - } - return d ; + 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; } + void -Stem::set_stemend (Grob*me, Real se) +Stem::set_stemend (Grob *me, Real se) { // 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")); - - me->set_property ("stem-end-position", scm_make_real (se)); -} + Direction d = get_grob_direction (me); + if (d && d * head_positions (me)[get_grob_direction (me)] >= se * d) + me->warning (_ ("weird stem size, check for narrow beams")); -/* - Note head that determines hshift for upstems + me->set_property ("stem-end-position", scm_from_double (se)); +} - WARNING: triggers direction -*/ -Grob* -Stem::support_head (Grob*me) +/* Note head that determines hshift for upstems + WARNING: triggers direction */ +Grob * +Stem::support_head (Grob *me) { - if (head_count (me) == 1) - { - /* - UGH. - */ - - return unsmob_grob (ly_car (me->get_property ("note-heads"))); - } - else - return first_head (me); -} + extract_grob_set (me, "note-heads", heads); + if (heads.size () == 1) + return heads[0]; + return first_head (me); +} int -Stem::head_count (Grob*me) +Stem::head_count (Grob *me) { - return Pointer_group_interface::count (me, "note-heads"); + return Pointer_group_interface::count (me, ly_symbol2scm ("note-heads")); } -/* - The note head which forms one end of the stem. - - WARNING: triggers direction -*/ -Grob* -Stem::first_head (Grob*me) +/* The note head which forms one end of the stem. + WARNING: triggers direction */ +Grob * +Stem::first_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; } -/* - The note head opposite to the first head. - */ -Grob* -Stem::last_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_property ("note-heads"); is_pair (s); s = ly_cdr (s)) - { - Grob * n = unsmob_grob (ly_car (s)); + extpos[UP] = -inf; - + Drul_array exthead (0, 0); + extract_grob_set (me, "note-heads", heads); + + for (vsize 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) -{ - return a-b; -} - -/* - The positions, in ascending order. - */ -Array +/* The positions, in ascending order. */ +vector Stem::note_head_positions (Grob *me) { - Array ps ; - for (SCM s = me->get_property ("note-heads"); is_pair (s); s = ly_cdr (s)) + vector ps; + extract_grob_set (me, "note-heads", heads); + + for (vsize i = heads.size (); i--;) { - Grob * n = unsmob_grob (ly_car (s)); + Grob *n = heads[i]; int p = Staff_symbol_referencer::get_rounded_position (n); - ps.push (p); + ps.push_back (p); } - - ps.sort (icmp); - return ps; -} + vector_sort (ps, less ()); + return ps; +} void -Stem::add_head (Grob*me, Grob *n) +Stem::add_head (Grob *me, Grob *n) { - n->set_property ("stem", me->self_scm ()); - n->add_dependency (me); + n->set_object ("stem", me->self_scm ()); - /* - TODO: why not store Rest pointers? - */ 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::is_invisible (Grob*me) +Stem::is_invisible (Grob *me) { - return ! (head_count (me) - && ly_scm2int (me->get_property ("duration-log")) >= 1); + Real stemlet_length = robust_scm2double (me->get_property ("stemlet-length"), + 0.0); + + return !((head_count (me) + || stemlet_length > 0.0) + && scm_to_int (me->get_property ("duration-log")) >= 1); } -Direction -Stem::get_default_dir (Grob*me) +MAKE_SCHEME_CALLBACK (Stem, pure_height, 3) +SCM +Stem::pure_height (SCM smob, SCM start, SCM end) { - int staff_center = 0; - Interval hp = head_positions (me); - if (hp.is_empty ()) - { - return CENTER; - } + (void) start; + (void) end; - 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)); + Grob *me = unsmob_grob (smob); + Real ss = Staff_symbol_referencer::staff_space (me); + Real len = scm_to_double (calc_length (smob)) * ss / 2; + Direction dir = get_grob_direction (me); - return to_dir (me->get_property ("neutral-direction")); + Interval iv; + Interval hp = head_positions (me); + if (dir == UP) + iv = Interval (0, len); + else + iv = Interval (-len, 0); + + if (!hp.is_empty ()) + iv.translate (hp[dir] * ss / 2); + + return ly_interval2scm (iv); } -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) { - Real ss = Staff_symbol_referencer::staff_space (me); + Grob *me = unsmob_grob (smob); - int durlog = duration_log (me); - - SCM s; - Array a; - - - Real length = 7; // WARNING: IN HALF SPACES - SCM scm_len = me->get_property ("length"); - if (is_number (scm_len)) - { - length = ly_scm2double (scm_len); - } - else - { - s = me->get_property ("lengths"); - if (is_pair (s)) - { - length = 2* ly_scm2double (robust_list_ref (durlog -2, s)); - } - } + if (!head_count (me)) + return scm_from_double (0.0); - /* URGURGURG - 'set-default-stemlen' sets direction too - */ - Direction dir = get_direction (me); - if (!dir) + if (Grob *beam = get_beam (me)) { - dir = get_default_dir (me); - set_grob_direction (me, dir); + (void) beam->get_property ("quantized-positions"); + return me->get_property ("stem-end-position"); } - - /* stems in unnatural (forced) direction should be shortened, - according to [Roush & Gourlay] */ - if (dir * head_positions (me)[dir] >= 0) - { - SCM sshorten = me->get_property ("stem-shorten"); - SCM scm_shorten = is_pair (sshorten) ? - robust_list_ref ((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; - } + Real ss = Staff_symbol_referencer::staff_space (me); + int durlog = duration_log (me); + vector a; - /* - Tremolo stuff: - */ - Grob * trem = unsmob_grob (me->get_property ("tremolo-flag")); - if (trem && !unsmob_grob (me->get_property ("beam"))) - { - /* - Crude hack: add extra space if tremolo flag is there. + /* WARNING: IN HALF SPACES */ + Real length = robust_scm2double (me->get_property ("length"), 7); - 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 (trem).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 = length >? (minlen + 1.0); - } - - Interval hp = head_positions (me); - Real st = hp[dir] + dir * length; + Direction dir = get_grob_direction (me); + Interval hp = head_positions (me); + Real stem_end = dir ? hp[dir] + dir * length : 0; - /* - TODO: change name to extend-stems to staff/center/'() - */ + /* TODO: change name to extend-stems to staff/center/'() */ bool no_extend_b = to_boolean (me->get_property ("no-stem-extend")); - if (!no_extend_b && dir * st < 0) // junkme? - st = 0.0; + if (!no_extend_b && dir * stem_end < 0) + stem_end = 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. - - */ + + /* 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::get_dots (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::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 * (st + flagy - dp) < 0.5) + Interval flag_yext = flag (me).extent (Y_AXIS) * (2 / ss) + stem_end; + + /* Very gory: add myself to the X-support of the parent, + which should be a dot-column. */ + + if (flag_yext.distance (dp) < 0.5) { Grob *par = dots->get_parent (X_AXIS); @@ -405,191 +306,312 @@ 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 * t_flag->extent (t_flag, Y_AXIS).length () + / ss; + + /* We don't want to add the whole extent of the flag because the trem + and the flag can overlap partly. beam_translation gives a good + approximation */ + if (durlog >= 3) + { + Real beam_trans = Stem_tremolo::get_beam_translation (t_flag); + /* the obvious choice is (durlog - 2) here, but we need a bit more space. */ + minlen += 2 * (durlog - 1.5) * beam_trans; + + /* up-stems need even a little more space to avoid collisions. This + needs to be in sync with the tremolo positioning code in + Stem_tremolo::print */ + if (dir == UP) + minlen += beam_trans; + } + 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_property ("duration-log"); - return (is_number (s)) ? ly_scm2int (s) : 2; + 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; - heads.sort (compare_position); - Direction dir =get_direction (me); - - if (dir < 0) - heads.reverse (); + extract_grob_set (me, "note-heads", ro_heads); + vector heads (ro_heads); + vector_sort (heads, position_less); + Direction dir = get_grob_direction (me); + if (dir < 0) + reverse (heads); 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; + + bool is_harmonic_centered = false; + for (vsize i = 0; i < heads.size (); i++) + is_harmonic_centered = is_harmonic_centered + || heads[i]->get_property ("style") == ly_symbol2scm ("harmonic"); + is_harmonic_centered = is_harmonic_centered && is_invisible (me); + + Real w = hed->extent (hed, X_AXIS)[dir]; + for (vsize i = 0; i < heads.size (); i++) + { + Real amount = w - heads[i]->extent (heads[i], X_AXIS)[dir]; + + if (is_harmonic_centered) + amount = + hed->extent (hed, X_AXIS).linear_combination (CENTER) + - heads[i]->extent (heads[i], X_AXIS).linear_combination (CENTER); + + heads[i]->translate_axis (amount, X_AXIS); + } + bool parity = true; Real lastpos = Real (Staff_symbol_referencer::get_position (heads[0])); - for (int i=1; i < heads.size (); i ++) + for (vsize i = 1; i < heads.size (); i++) { Real p = Staff_symbol_referencer::get_position (heads[i]); - Real dy =fabs (lastpos- p); + Real dy = fabs (lastpos- p); /* - dy should always be 0.5, 0.0, 1.0, but provide safety margin - for rounding errors. + dy should always be 0.5, 0.0, 1.0, but provide safety margin + for rounding errors. */ - if (dy < 1.1) + 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_direction (me); + Direction d = get_grob_direction (me); /* - Reversed head should be shifted l-thickness, but this - looks too crowded, so we only shift l-0.5*thickness. + 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 ((l-thick*reverse_overlap) * d, X_AXIS); + Real reverse_overlap = 0.5; + heads[i]->translate_axis ((ell - thick * reverse_overlap) * d, + X_AXIS); if (is_invisible (me)) - heads[i]->translate_axis (-thick*(2 - reverse_overlap) * d , X_AXIS); + heads[i]->translate_axis (-thick * (2 - reverse_overlap) * 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->set_property ("print-function", SCM_EOL); + 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)ly_scm2int (ax); - Grob * me = unsmob_grob (smob); - assert (a == Y_AXIS); + Grob *me = unsmob_grob (smob); - SCM mol = me->get_uncached_stencil (); - Interval iv; - if (mol != SCM_EOL) - iv = unsmob_stencil (mol)->extent (a); - if (Grob *b =get_beam (me)) + Direction dir = CENTER; + int staff_center = 0; + Interval hp = head_positions (me); + if (!hp.is_empty ()) { - Direction d = get_direction (me); - iv[d] += d * Beam::get_thickness (b) /2.0 ; + int udistance = (int) (UP * hp[UP] - staff_center); + int ddistance = (int) (DOWN * hp[DOWN] - staff_center); + + dir = Direction (sign (ddistance - udistance)); } - - return ly_interval2scm (iv); + + return scm_from_int (dir); } -Stencil -Stem::flag (Grob*me) +MAKE_SCHEME_CALLBACK (Stem, height, 1); +SCM +Stem::height (SCM smob) { - /* 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; + Grob *me = unsmob_grob (smob); + + Direction dir = get_grob_direction (me); - SCM flag_style_scm = me->get_property ("flag-style"); - if (is_symbol (flag_style_scm)) + /* Trigger callback. + + UGH. Should be automatic + */ + Grob *beam = get_beam (me); + if (beam) { - flag_style = ly_symbol2string (flag_style_scm); + /* trigger set-stem-lengths. */ + beam->get_property ("quantized-positions"); } - if (flag_style == "no-flag") + /* + 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) { - return Stencil (); + if (dir == CENTER) + { + programming_error ("no stem direction"); + dir = UP; + } + iv[dir] += dir * Beam::get_thickness (beam) * 0.5; } + 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) + string staffline_offs; + if (flag_style == "mensural") /* 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, @@ -599,399 +621,428 @@ 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. - */ - int p = Staff_symbol_referencer::get_rounded_position (me); - staffline_offs = Staff_symbol_referencer::on_staffline (me, p) ? - "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 = ""; - } + staffline_offs = ""; - char dir = (get_direction (me) == UP) ? 'u' : 'd'; - String font_char = - flag_style + to_string (dir) + staffline_offs + to_string (duration_log (me)); + 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); + Stencil flag = fm->find_by_name ("flags." + font_char); if (flag.is_empty ()) - { - me->warning (_f ("flag `%s' not found", font_char)); - } + me->warning (_f ("flag `%s' not found", font_char)); SCM stroke_style_scm = me->get_property ("stroke-style"); - if (is_string (stroke_style_scm)) + if (scm_is_string (stroke_style_scm)) { - String stroke_style = ly_scm2string (stroke_style_scm); - if (!stroke_style.is_empty ()) + 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); + 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)); - } + me->warning (_f ("flag stroke `%s' not found", font_char)); else - { - flag.add_stencil (stroke); - } + flag.add_stencil (stroke); } } return flag; } -MAKE_SCHEME_CALLBACK (Stem,dim_callback,2); +MAKE_SCHEME_CALLBACK (Stem, width, 1); SCM -Stem::dim_callback (SCM e, SCM ax) +Stem::width (SCM e) { - Axis a = (Axis) ly_scm2int (ax); - assert (a == X_AXIS); Grob *me = unsmob_grob (e); - Interval r (0, 0); - if (unsmob_grob (me->get_property ("beam")) || abs (duration_log (me)) <= 2) - ; // TODO! + + 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 (me).extent (X_AXIS) - + thickness (me)/2; + r = Interval (-1, 1) * thickness (me) * 0.5; + r.unite (flag (me).extent (X_AXIS)); } return ly_interval2scm (r); } - + Real -Stem::thickness (Grob* me) +Stem::thickness (Grob *me) { - return ly_scm2double (me->get_property ("thickness")) + return scm_to_double (me->get_property ("thickness")) * Staff_symbol_referencer::line_thickness (me); } -MAKE_SCHEME_CALLBACK (Stem,print,1); - +MAKE_SCHEME_CALLBACK (Stem, print, 1); SCM -Stem::print (SCM smob) +Stem::print (SCM smob) { - Grob*me = unsmob_grob (smob); + Grob *me = unsmob_grob (smob); + Grob *beam = get_beam (me); + Stencil mol; - Direction d = get_direction (me); - - /* - TODO: make the stem start a direction ? + Direction d = get_grob_direction (me); - This is required to avoid stems passing in tablature chords... - */ - Grob *lh = to_boolean (me->get_property ("avoid-note-head")) - ? last_head (me) : lh = first_head (me); + Real stemlet_length = robust_scm2double (me->get_property ("stemlet-length"), + 0.0); + bool stemlet = stemlet_length > 0.0; - if (!lh) + /* 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); + + if (!lh && !stemlet) + return SCM_EOL; + + if (!lh && stemlet && !beam) return SCM_EOL; if (is_invisible (me)) return SCM_EOL; - - Real y1 = Staff_symbol_referencer::get_position (lh); - Real y2 = stem_end_position (me); - - Interval stem_y (y1 ? y1); - - // 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 (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 *hed = support_head (me)) + 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; + stem_y[Direction (-d)] += d * y_attach / half_space; } - // URG Real stem_width = thickness (me); - Real blot = - me->get_paper ()->get_dimension (ly_symbol2scm ("blotdiameter")); - - Box b = Box (Interval (-stem_width/2, stem_width/2), - Interval (stem_y[DOWN]*dy, stem_y[UP]*dy)); + Real blot + = me->layout ()->get_dimension (ly_symbol2scm ("blot-diameter")); + + 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); - if (!get_beam (me) && abs (duration_log (me)) > 2) - { - Stencil fl = flag (me); - fl.translate_axis (stem_y[d]*dy - d * blot/2, Y_AXIS); - fl.translate_axis (stem_width/2, X_AXIS); - mol.add_stencil (fl); - } + 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 ("blot-diameter")); + 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) - { - return scm_make_real (0.0); - } - - if (Grob * f = first_head (me)) + 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 (is_invisible (me)) - { - attach = 0.0; - } + attach = 0.0; else attach = Note_head::stem_attachment_coordinate (f, X_AXIS); - Direction d = get_direction (me); - + 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 - = thickness (me); - - r += - d * rule_thick * 0.5; + Real rule_thick = thickness (me); + r += -d * rule_thick * 0.5; } } - return scm_make_real (r); + else + { + extract_grob_set (me, "rests", rests); + if (rests.size ()) + { + Grob *rest = rests.back (); + r = rest->extent (rest, X_AXIS).center (); + } + } + return scm_from_double (r); } - -Grob* -Stem::get_beam (Grob*me) +Spanner * +Stem::get_beam (Grob *me) { - SCM b= me->get_property ("beam"); - return unsmob_grob (b); + SCM b = me->get_object ("beam"); + return dynamic_cast (unsmob_grob (b)); } Stem_info Stem::get_stem_info (Grob *me) { - /* Return cached info if available */ - SCM scm_info = me->get_property ("stem-info"); - if (!is_pair (scm_info)) - { - calc_stem_info (me); - scm_info = me->get_property ("stem-info"); - } - Stem_info si; - si.dir_ = get_grob_direction (me); - si.ideal_y_ = ly_scm2double (ly_car (scm_info)); - si.shortest_y_ = ly_scm2double (ly_cadr (scm_info)); + 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; } - -/* - TODO: add extra space for tremolos! - */ -void -Stem::calc_stem_info (Grob *me) +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); if (!my_dir) { - programming_error ("No stem dir set?"); - my_dir = UP; + programming_error ("no stem dir set"); + my_dir = UP; } - + Real staff_space = Staff_symbol_referencer::staff_space (me); Grob *beam = get_beam (me); + + if (beam) + { + (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 lengths = me->get_property ("beamed-lengths"); - Real ideal_length = - ly_scm2double (robust_list_ref (beam_count - 1,lengths)) - + 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 - /* stem only extends to center of beam */ + * length_fraction + + /* stem only extends to center of beam + */ - 0.5 * beam_thickness; - + /* Condition: sane minimum free stem length (chord to beams) */ - lengths = me->get_property ("beamed-minimum-free-lengths"); - Real ideal_minimum_free = - ly_scm2double (robust_list_ref (beam_count - 1, lengths)) - * staff_space; - + lengths = scm_cdr (scm_assq (ly_symbol2scm ("beamed-minimum-free-lengths"), details)); + + Real ideal_minimum_free + = scm_to_double (robust_list_ref (beam_count - 1, lengths)) + * staff_space + * length_fraction; + + Real height_of_my_trem = 0.0; + Grob *trem = unsmob_grob (me->get_object ("tremolo-flag")); + if (trem) + height_of_my_trem = trem->extent (trem, Y_AXIS).length () + /* hack a bit of space around the trem. */ + + beam_translation; /* UGH It seems that also for ideal minimum length, we must use the maximum beam count (for this direction): - + \score{ \notes\relative c''{ [a8 a32] }} - + 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 + + height_of_my_trem /* stem only extends to center of beam */ - 0.5 * beam_thickness; - ideal_length = ideal_length >? ideal_minimum_length; + ideal_length = max (ideal_length, ideal_minimum_length); - /* Convert to Y position, calculate for dir == UP */ - Real note_start = - /* staff positions */ + Real note_start + = /* staff positions */ head_positions (me)[my_dir] * 0.5 * my_dir * staff_space; Real ideal_y = note_start + ideal_length; - /* Conditions for Y position */ /* Lowest beam of (UP) beam must never be lower than second staffline - - Reference? - - Although this (additional) rule is probably correct, - I expect that highest beam (UP) should also never be lower - than middle staffline, just as normal stems. - - Reference? - - Obviously not for grace beams. - - Also, not for knees. Seems to be a good thing. */ + + Reference? + + Although this (additional) rule is probably correct, + I expect that highest beam (UP) should also never be lower + than middle staffline, just as normal stems. + + Reference? + + Obviously not for grace beams. + + 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) { /* Highest beam of (UP) beam must never be lower than middle staffline */ - ideal_y = ideal_y >? 0; + ideal_y = max (ideal_y, 0.0); /* Lowest beam of (UP) beam must never be lower than second staffline */ - ideal_y = ideal_y >? (-staff_space - - beam_thickness + height_of_my_beams); + ideal_y = max (ideal_y, (-staff_space + - beam_thickness + height_of_my_beams)); } - ideal_y -= robust_scm2double (beam->get_property ("shorten"), 0); - Real minimum_free = - ly_scm2double (robust_list_ref - (beam_count - 1, - me->get_property - ("beamed-extreme-minimum-free-lengths"))) - * staff_space; + SCM bemfl = scm_cdr (scm_assq (ly_symbol2scm ("beamed-extreme-minimum-free-lengths"), + details)); + + Real minimum_free + = scm_to_double (robust_list_ref (beam_count - 1, bemfl)) + * staff_space + * length_fraction; - Real minimum_length = minimum_free + Real minimum_length = max (minimum_free, height_of_my_trem) + height_of_my_beams /* stem only extends to center of beam */ - 0.5 * beam_thickness; - Real minimum_y = note_start + minimum_length; - - ideal_y *= my_dir; - Real shortest_y = minimum_y * my_dir; - - me->set_property ("stem-info", - scm_list_n (scm_make_real (ideal_y), - scm_make_real (shortest_y), - SCM_UNDEFINED)); + 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)); } Slice Stem::beam_multiplicity (Grob *stem) { - SCM beaming= stem->get_property ("beaming"); - Slice l = int_list_to_slice (ly_car (beaming)); - Slice r = int_list_to_slice (ly_cdr (beaming)); - l.unite (r); - - return l; + 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; } - -/* - these are too many props. - */ -ADD_INTERFACE (Stem,"stem-interface", - "The stem represent the graphical stem. " - " In addition, it internally connects note heads, beams, tremolos. Rests " - " and whole notes have invisible stems." - -, - - "tremolo-flag french-beaming " - "avoid-note-head thickness " - "stem-info beamed-lengths beamed-minimum-free-lengths " - "beamed-extreme-minimum-free-lengths lengths beam stem-shorten " - "duration-log beaming neutral-direction stem-end-position " - "note-heads direction length flag-style " - "no-stem-extend stroke-style"); - - +/* FIXME: Too many properties */ +ADD_INTERFACE (Stem, + "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 " + "max-beam-connect " + "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; + ideal_y_ = shortest_y_ = 0; dir_ = CENTER; }