-/*
-staff-spacing.cc -- implement Staff_spacing
-
-source file of the GNU LilyPond music typesetter
+/*
+ staff-spacing.cc -- implement Staff_spacing
-(c) 2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ source file of the GNU LilyPond music typesetter
- */
+ (c) 2001--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
+*/
#include "staff-spacing.hh"
-#include "grob.hh"
-bool
-Staff_spacing::has_interface (Grob* g)
+#include <cstdio>
+using namespace std;
+
+#include "paper-column.hh"
+#include "separation-item.hh"
+#include "warn.hh"
+#include "bar-line.hh"
+#include "staff-symbol-referencer.hh"
+#include "note-column.hh"
+#include "stem.hh"
+#include "accidental-placement.hh"
+#include "pointer-group-interface.hh"
+#include "directional-element-interface.hh"
+
+/*
+ Insert some more space for the next note, in case it has a stem in
+ the wrong direction
+*/
+void
+Staff_spacing::next_note_correction (Grob *me,
+ Grob *g,
+ Interval bar_size,
+ Real current_space, Real current_fixed,
+ Real *space,
+ Real *fix,
+ int *wish_count)
{
- return g && g->has_interface (ly_symbol2scm ("staff-spacing-interface"));
+ (void) current_fixed;
+ if (!g || !Note_column::has_interface (g))
+ return ;
+
+ Item *col = dynamic_cast<Item *> (g)->get_column ();
+ Real left_stickout_correction = max (0., (- g->extent (col, X_AXIS)[LEFT]));
+
+ /* staff space -> positions */
+ bar_size *= 2;
+
+ /*
+ Duh. If this gets out of hand, we should invent something more generic.
+ */
+ Grob *accs = Note_column::accidentals (g);
+ if (accs)
+ {
+ Interval v;
+ if (Accidental_placement::has_interface (accs))
+ v = Accidental_placement::get_relevant_accidental_extent (accs, col, me);
+ else
+ v = accs->extent (col, X_AXIS);
+
+ left_stickout_correction = max (left_stickout_correction, (- v[LEFT]));
+ }
+ Grob *arpeggio = unsmob_grob (g->get_object ("arpeggio"));
+ if (arpeggio)
+ left_stickout_correction = max (left_stickout_correction, - arpeggio->extent (col, X_AXIS)[LEFT]);
+
+
+ /*
+ Let's decrease the space a little if the problem is not located
+ after a barline.
+ */
+ if (bar_size.is_empty ())
+ left_stickout_correction *= 0.75;
+
+ /*
+ We want 0.3 ss before the sticking-out object.
+
+ current_fixed/2 is our guess at (right side of left object + 0.3)
+ */
+ left_stickout_correction += current_fixed/2 - current_space;
+ left_stickout_correction = max (left_stickout_correction, 0.0);
+
+
+ Real optical_corr = 0.0;
+ Grob *stem = Note_column::get_stem (g);
+ if (!bar_size.is_empty ()
+ && !arpeggio
+ && !accs
+ && stem)
+ {
+ Direction d = get_grob_direction (stem);
+ if (Stem::is_normal_stem (stem) && d == DOWN)
+ {
+
+ /*
+ can't look at stem-end-position, since that triggers
+ beam slope computations.
+ */
+ Real stem_start = Stem::head_positions (stem) [d];
+ Real stem_end = stem_start +
+ d * robust_scm2double (stem->get_property ("length"), 7);
+
+ Interval stem_posns (min (stem_start, stem_end),
+ max (stem_end, stem_start));
+
+ stem_posns.intersect (bar_size);
+
+ optical_corr = min (abs (stem_posns.length () / 7.0), 1.0);
+ optical_corr *= robust_scm2double (me->get_property ("stem-spacing-correction"), 1);
+ }
+ }
+
+
+ Real correction = optical_corr + left_stickout_correction;
+ if (correction)
+ {
+ (*wish_count) ++;
+
+ /*
+ This minute adjustments don't make sense for widely spaced scores.
+ Hence, we need to keep the stretchable (that is, space - fix)
+ distance equal.
+ */
+ *space += correction;
+ *fix += correction;
+ }
}
+/*
+ Y-positions that are covered by BAR_GROB, in the case that it is a
+ barline. */
+Interval
+Staff_spacing::bar_y_positions (Grob *bar_grob)
+{
+ Interval bar_size;
+ bar_size.set_empty ();
+ if (Bar_line::has_interface (bar_grob))
+ {
+ SCM glyph = bar_grob->get_property ("glyph-name");
+ Grob *staff_sym = Staff_symbol_referencer::get_staff_symbol (bar_grob);
+ string glyph_string = scm_is_string (glyph) ? ly_scm2string (glyph) : "";
+ if (glyph_string.substr (0, 1) == "|"
+ || glyph_string.substr (0, 1) == ".")
+ {
+ Grob *common = bar_grob->common_refpoint (staff_sym, Y_AXIS);
+ bar_size = bar_grob->extent (common, Y_AXIS);
+ bar_size *= 1.0 / Staff_symbol_referencer::staff_space (bar_grob);
+ }
+ }
+ return bar_size;
+}
/*
-
- TODO: move computation of clef/key-sig/whatever to first-note
- distance here.
+ Do corrections for the following notes.
+ This is slightly convoluted, since the staffspacing grob gets
+ pointers to the separation-items, not the note-columns or
+ note-spacings.
*/
+
+void
+Staff_spacing::next_notes_correction (Grob *me, Grob *last_grob,
+ Real current_space, Real current_fixed,
+ Real *compound_space, Real *compound_fixed
+ )
+{
+ Interval bar_size = bar_y_positions (last_grob);
+
+ extract_grob_set (me, "right-items", right_items);
+
+ *compound_fixed = 0.0;
+ *compound_space = 0.0;
+ int wish_count = 0;
+
+ for (vsize i = right_items.size (); i--;)
+ {
+ Grob *g = right_items[i];
+ if (Note_column::has_interface (right_items[i]))
+ {
+ Grob *g = right_items[i];
+
+ Real space = 0.0;
+ Real fixed = 0.0;
+
+ next_note_correction (me, g, bar_size,
+ current_space, current_fixed,
+ &space, &fixed, &wish_count);
+
+ *compound_space += space;
+ *compound_fixed += fixed;
+ }
+ else
+ {
+ extract_grob_set (g, "elements", elts);
+ for (vsize j = elts.size (); j--;)
+ {
+ Real space = 0.0;
+ Real fixed = 0.0;
+ next_note_correction (me, elts[j], bar_size,
+ current_space, current_fixed,
+ &space, &fixed,
+ &wish_count);
+ *compound_fixed += fixed;
+ *compound_space += space;
+ }
+ }
+ }
+
+ if (wish_count > 1)
+ {
+ *compound_space /= wish_count;
+ *compound_fixed /= wish_count;
+ }
+}
+
+void
+Staff_spacing::get_spacing_params (Grob *me, Real *space, Real *fixed)
+{
+ *space = 1.0;
+ *fixed = 1.0;
+
+ Grob *separation_item = 0;
+ Item *me_item = dynamic_cast<Item *> (me);
+
+ extract_grob_set (me, "left-items", items);
+ for (vsize i = items.size (); i--;)
+ {
+ Grob *cand = items[i];
+ if (cand && Separation_item::has_interface (cand))
+ separation_item = cand;
+ }
+
+ // printf ("doing col %d\n" , Paper_column::get_rank (left_col));
+ if (!separation_item)
+ {
+ programming_error ("no sep item");
+ return;
+ }
+
+ Interval last_ext;
+ Grob *last_grob = Separation_item::extremal_break_aligned_grob (separation_item, RIGHT,
+ &last_ext);
+ if (!last_grob)
+ {
+ /*
+ TODO:
+
+ Should insert a adjustable space here? For excercises, you might want to
+ use a staff without a clef in the beginning.
+ */
+
+ /*
+ we used to have a warning here, but it generates a lot of
+ spurious error messages.
+ */
+ return;
+ }
+
+ *fixed = last_ext[RIGHT];
+ *space = *fixed + 1.0;
+
+ SCM alist = last_grob->get_property ("space-alist");
+ if (!scm_list_p (alist))
+ return;
+
+ SCM space_def = scm_sloppy_assq (ly_symbol2scm ("first-note"), alist);
+ if (me_item->break_status_dir () == CENTER)
+ {
+ SCM nndef = scm_sloppy_assq (ly_symbol2scm ("next-note"), alist);
+ if (scm_is_pair (nndef))
+ space_def = nndef;
+ }
+
+ if (!scm_is_pair (space_def))
+ {
+ programming_error ("unknown prefatory spacing");
+ return;
+ }
+
+ space_def = scm_cdr (space_def);
+ Real distance = scm_to_double (scm_cdr (space_def));
+ SCM type = scm_car (space_def);
+
+ *fixed = last_ext[RIGHT];
+ if (type == ly_symbol2scm ("fixed-space"))
+ {
+ *fixed += distance;
+ *space = *fixed;
+ }
+ else if (type == ly_symbol2scm ("extra-space"))
+ *space = *fixed + distance;
+ else if (type == ly_symbol2scm ("semi-fixed-space"))
+ {
+ *fixed += distance / 2;
+ *space = *fixed + distance / 2;
+ }
+ else if (type == ly_symbol2scm ("minimum-space"))
+ *space = last_ext[LEFT] + max (last_ext.length (), distance);
+ else if (type == ly_symbol2scm ("minimum-fixed-space"))
+ {
+ *space = last_ext[LEFT] + max (last_ext.length (), distance);
+ *fixed = *space;
+ }
+
+ Real correction_fixed = 0.0;
+ Real correction_space = 0.0;
+ next_notes_correction (me, last_grob,
+ *space, *fixed,
+ &correction_space, &correction_fixed );
+ *space += correction_space;
+ *fixed += correction_fixed;
+}
+
+ADD_INTERFACE (Staff_spacing,
+ "This object calculates spacing details from a "
+ " breakable symbol (left) to another object. For example, it takes care "
+ " of optical spacing from a bar lines to a note.",
+
+ /* properties */
+ "stem-spacing-correction "
+ "left-items "
+ "right-items "
+ );
projects / lilypond.git / blobdiff