X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fseparation-item.cc;h=0e3a075100402c3fba1432e5a8097171b8c1eef0;hb=9e781b7dc83b60a543ce218aa1a5f139f74c760f;hp=5255b65c028a1db675347246dc4d72aa8794a908;hpb=6e272a116fe402adc5e4f572688d02d1adda66f2;p=lilypond.git diff --git a/lily/separation-item.cc b/lily/separation-item.cc index 5255b65c02..0699b362c8 100644 --- a/lily/separation-item.cc +++ b/lily/separation-item.cc @@ -1,139 +1,216 @@ -/* - separation-item.cc -- implement Separation_item - - source file of the GNU LilyPond music typesetter - - (c) 1998--2003 Han-Wen Nienhuys - - */ +/* + This file is part of LilyPond, the GNU music typesetter. + + Copyright (C) 1998--2014 Han-Wen Nienhuys + + LilyPond is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + LilyPond is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with LilyPond. If not, see . +*/ #include "separation-item.hh" + +#include "accidental-placement.hh" +#include "axis-group-interface.hh" +#include "lookup.hh" +#include "note-column.hh" +#include "note-head.hh" #include "paper-column.hh" +#include "pointer-group-interface.hh" +#include "skyline-pair.hh" +#include "stencil.hh" #include "warn.hh" -#include "group-interface.hh" -#include "accidental-placement.hh" void -Separation_item::add_item (Grob*s,Item* i) +Separation_item::add_item (Grob *s, Item *i) { assert (i); - Pointer_group_interface::add_grob (s, ly_symbol2scm ("elements"),i); - s->add_dependency (i); + Pointer_group_interface::add_grob (s, ly_symbol2scm ("elements"), i); } void -Separation_item::add_conditional_item (Grob* me , Grob *e) +Separation_item::add_conditional_item (Grob *me, Grob *e) { Pointer_group_interface::add_grob (me, ly_symbol2scm ("conditional-elements"), e); } -/* - Return the width of ME given that we are considering the object on - the LEFT. - */ -Interval -Separation_item::conditional_width (Grob * me, Grob * left) +Real +Separation_item::set_distance (Item *l, Item *r, Real padding) { - Interval w = width (me); - - Item *item = dynamic_cast (me); - Paper_column * pc = item->get_column (); - - - for (SCM s = me->get_grob_property ("conditional-elements"); gh_pair_p (s); s = ly_cdr (s)) + Drul_array lines (Skyline_pair::unsmob (l->get_property ("horizontal-skylines")), + Skyline_pair::unsmob (r->get_property ("horizontal-skylines"))); + Skyline right = conditional_skyline (r, l); + right.merge ((*lines[RIGHT])[LEFT]); + + Real dist = padding + (*lines[LEFT])[RIGHT].distance (right); + if (dist > 0) { - SCM elt = ly_car (s); - if (!unsmob_grob (elt)) - continue; - - Item *il = unsmob_item (elt); - if (pc != il->get_column ()) - { - /* this shouldn't happen, but let's continue anyway. */ - programming_error (_ ("Separation_item: I've been drinking too much")); - continue; /*UGH UGH*/ - } - - if (to_boolean (il->get_grob_property ("no-spacing-rods"))) - { - continue; - } - - if (Accidental_placement::has_interface (il)) - { - w.unite (Accidental_placement::get_relevant_accidental_extent (il, pc, left)); - } - } + Rod rod; - SCM pad = me->get_grob_property ("padding"); + rod.item_drul_ = Drul_array (l, r); - if (gh_number_p (pad)) - { - w[RIGHT] += gh_scm2double (pad)/2; - w[LEFT] -= gh_scm2double (pad)/2; + rod.distance_ = dist; + rod.add_to_cols (); } - return w; + + return max (dist, 0.0); } -Interval -Separation_item::width (Grob *me) +bool +Separation_item::is_empty (Grob *me) { - SCM sw = me->get_grob_property ("X-extent"); - if (ly_number_pair_p (sw)) + Skyline_pair *sky = Skyline_pair::unsmob (me->get_property ("horizontal-skylines")); + return (!sky || sky->is_empty ()); +} + +/* + Return the width of ME given that we are considering the object on + the LEFT. +*/ +Skyline +Separation_item::conditional_skyline (Grob *me, Grob *left) +{ + vector bs = boxes (me, left); + return Skyline (bs, Y_AXIS, LEFT); +} + +MAKE_SCHEME_CALLBACK (Separation_item, calc_skylines, 1); +SCM +Separation_item::calc_skylines (SCM smob) +{ + Item *me = unsmob_item (smob); + vector bs = boxes (me, 0); + Skyline_pair sp (bs, Y_AXIS); + /* + TODO: We need to decide if padding is 'intrinsic' + to a skyline or if it is something that is only added on in + distance calculations. Here, we make it intrinsic, which copies + the behavior from the old code but no longer corresponds to how + vertical skylines are handled (where padding is not built into + the skyline). + */ + Real vp = robust_scm2double (me->get_property ("skyline-vertical-padding"), 0.0); + sp[LEFT] = sp[LEFT].padded (vp); + sp[RIGHT] = sp[RIGHT].padded (vp); + return sp.smobbed_copy (); +} + +/* + If left is non-NULL, get the boxes corresponding to the + conditional-elements (conditioned on the grob LEFT). + Conditional elements are, for now, arpeggios and accidental + placements. Based on the left grob, the accidentals will + be printed or not, so we filter using + Accidental_placement::get_relevant_accidentals. +*/ +vector +Separation_item::boxes (Grob *me, Grob *left) +{ + Item *item = dynamic_cast (me); + + int very_large = INT_MAX; + Paper_column *pc = item->get_column (); + vector out; + extract_grob_set (me, left ? "conditional-elements" : "elements", read_only_elts); + vector elts; + + if (left) { - return ly_scm2interval (sw); + vector accidental_elts; + vector other_elts; // for now only arpeggios + for (vsize i = 0; i < read_only_elts.size (); i++) + { + if (Accidental_placement::has_interface (read_only_elts[i])) + accidental_elts.push_back (read_only_elts[i]); + else + other_elts.push_back (read_only_elts[i]); + } + elts = Accidental_placement::get_relevant_accidentals (accidental_elts, left); + elts.insert (elts.end (), other_elts.begin (), other_elts.end ()); } + else + elts = read_only_elts; - Item *item = dynamic_cast (me); - Paper_column * pc = item->get_column (); - Interval w; - - for (SCM s = me->get_grob_property ("elements"); gh_pair_p (s); s = ly_cdr (s)) - { - SCM elt = ly_car (s); - if (!unsmob_grob (elt)) - continue; + Grob *ycommon = common_refpoint_of_array (elts, me, Y_AXIS); - Item *il = unsmob_item (elt); + for (vsize i = 0; i < elts.size (); i++) + { + Item *il = dynamic_cast (elts[i]); if (pc != il->get_column ()) - { - /* this shouldn't happen, but let's continue anyway. */ - programming_error (_ ("Separation_item: I've been drinking too much")); - continue; /*UGH UGH*/ - } - - if (to_boolean (il->get_grob_property ("no-spacing-rods"))) - { - continue; - } - - Interval iv (il->extent (pc, X_AXIS)); - if (!iv.empty_b ()) - { - w.unite (iv); - } + continue; + + /* ugh. We want to exclude groups of grobs (so that we insert each grob + individually into the skyline instead of adding a single box that + bounds all of them). However, we can't exclude an axis-group that + adds to its childrens' stencil. Currently, this is just TrillPitchGroup; + hence the check for note-head-interface. */ + if (Axis_group_interface::has_interface (il) + && !Note_head::has_interface (il)) + continue; + + Interval y (il->pure_height (ycommon, 0, very_large)); + Interval x (il->extent (pc, X_AXIS)); + + Interval extra_width = robust_scm2interval (elts[i]->get_property ("extra-spacing-width"), + Interval (-0.1, 0.1)); + Interval extra_height = robust_scm2interval (elts[i]->get_property ("extra-spacing-height"), + Interval (0.0, 0.0)); + + // The conventional empty extent is (+inf.0 . -inf.0) + // but (-inf.0 . +inf.0) is used as extra-spacing-height + // on items that must not overlap other note-columns. + // If these two uses of inf combine, leave the empty extent. + + if (!isinf (x[LEFT])) + x[LEFT] += extra_width[LEFT]; + if (!isinf (x[RIGHT])) + x[RIGHT] += extra_width[RIGHT]; + if (!isinf (y[DOWN])) + y[DOWN] += extra_height[DOWN]; + if (!isinf (y[UP])) + y[UP] += extra_height[UP]; + + if (!x.is_empty () && !y.is_empty ()) + out.push_back (Box (x, y)); } - SCM pad = me->get_grob_property ("padding"); - - if (gh_number_p (pad)) - { - w[RIGHT] += gh_scm2double (pad)/2; - w[LEFT] -= gh_scm2double (pad)/2; - } - - me->set_grob_property ("X-extent", ly_interval2scm (w)); - - return w; + return out; } +MAKE_SCHEME_CALLBACK (Separation_item, print, 1) +SCM +Separation_item::print (SCM smob) +{ + if (!debug_skylines) + return SCM_BOOL_F; + Grob *me = unsmob_grob (smob); + Stencil ret; + if (Skyline_pair *s = Skyline_pair::unsmob (me->get_property ("horizontal-skylines"))) + { + ret.add_stencil (Lookup::points_to_line_stencil (0.1, (*s)[LEFT].to_points (Y_AXIS)).in_color (255, 255, 0)); + ret.add_stencil (Lookup::points_to_line_stencil (0.1, (*s)[RIGHT].to_points (Y_AXIS)).in_color (0, 255, 255)); + } + return ret.smobbed_copy (); +} - - -ADD_INTERFACE (Separation_item,"separation-item-interface", - "Item that computes widths to generate spacing rods.\n" -"\n" -"Calculate dimensions for the Separating_group_spanner; this has to be " -"an item to get dependencies correct. " - "padding X-extent conditional-elements elements"); +ADD_INTERFACE (Separation_item, + "Item that computes widths to generate spacing rods.", + + /* properties */ + "X-extent " + "conditional-elements " + "elements " + "padding " + "horizontal-skylines " + "skyline-vertical-padding " + );