/*
- separation-item.cc -- implement Separation_item
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
+ Copyright (C) 1998--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
- (c) 1998--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
+ 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 <http://www.gnu.org/licenses/>.
*/
#include "separation-item.hh"
-#include "skyline.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 "warn.hh"
#include "pointer-group-interface.hh"
-#include "accidental-placement.hh"
+#include "skyline-pair.hh"
+#include "stencil.hh"
+#include "warn.hh"
void
Separation_item::add_item (Grob *s, Item *i)
Pointer_group_interface::add_grob (me, ly_symbol2scm ("conditional-elements"), e);
}
-void
-Separation_item::set_skyline_distance (Drul_array<Item *> items,
- Real padding)
+Real
+Separation_item::set_distance (Item *l, Item *r, Real padding)
{
- Drul_array<Skyline_pair*> lines (Skyline_pair::unsmob (items[LEFT]->get_property ("skylines")),
- Skyline_pair::unsmob (items[RIGHT]->get_property ("skylines")));
+ Drul_array<Skyline_pair *> lines (unsmob<Skyline_pair> (l->get_property ("horizontal-skylines")),
+ unsmob<Skyline_pair> (r->get_property ("horizontal-skylines")));
+ Skyline right = conditional_skyline (r, l);
+ right.merge ((*lines[RIGHT])[LEFT]);
- Real dist = padding + (*lines[LEFT])[RIGHT].distance ((*lines[RIGHT])[LEFT]);
+ Real dist = padding + (*lines[LEFT])[RIGHT].distance (right);
if (dist > 0)
{
Rod rod;
- rod.item_drul_ = items;
+ rod.item_drul_ = Drul_array<Item *> (l, r);
rod.distance_ = dist;
rod.add_to_cols ();
- }
+ }
+
+ return max (dist, 0.0);
}
bool
-Separation_item::set_distance (Drul_array<Item *> items,
- Real padding)
+Separation_item::is_empty (Grob *me)
{
- if (!Item::is_non_musical (items[LEFT])
- && !Item::is_non_musical (items[RIGHT]))
- {
- set_skyline_distance (items, padding);
- return true;
- }
-
- Interval li (Separation_item::width (items[LEFT]));
- Interval ri (Separation_item::conditional_width (items[RIGHT], items[LEFT]));
- if (!li.is_empty () && !ri.is_empty ())
- {
- Rod rod;
-
- rod.item_drul_ = items;
-
- rod.distance_ = li[RIGHT] - ri[LEFT] + padding;
-
- if (rod.distance_ > 0)
- rod.add_to_cols ();
- return true;
- }
- return false;
+ Skyline_pair *sky = unsmob<Skyline_pair> (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.
*/
-Interval
-Separation_item::conditional_width (Grob *me, Grob *left)
+Skyline
+Separation_item::conditional_skyline (Grob *me, Grob *left)
{
- Interval w = width (me);
-
- Item *item = dynamic_cast<Item *> (me);
- Paper_column *pc = item->get_column ();
-
- extract_grob_set (me, "conditional-elements", elts);
- for (vsize i = 0; i < elts.size (); i++)
- {
- Item *il = dynamic_cast<Item *> (elts[i]);
- if (pc != il->get_column ())
- {
- programming_error ("Separation_item element from wrong column");
- continue;
- }
-
- if (to_boolean (il->get_property ("no-spacing-rods")))
- continue;
-
- if (Accidental_placement::has_interface (il))
- w.unite (Accidental_placement::get_relevant_accidental_extent (il, pc, left));
- }
-
- SCM pad = me->get_property ("padding");
-
- w.widen (robust_scm2double (pad, 0.0));
- return w;
+ vector<Box> bs = boxes (me, left);
+ return Skyline (bs, Y_AXIS, LEFT);
}
-
-MAKE_SCHEME_CALLBACK(Separation_item,calc_skylines,1);
+MAKE_SCHEME_CALLBACK (Separation_item, calc_skylines, 1);
SCM
Separation_item::calc_skylines (SCM smob)
{
- Item *me = unsmob_item (smob);
- vector<Box> bs = boxes (me);
- /* todo: the horizon_padding is somewhat arbitrary */
- return Skyline_pair (bs, 0.1, Y_AXIS).smobbed_copy ();
+ Item *me = unsmob<Item> (smob);
+ vector<Box> 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<Box>
-Separation_item::boxes (Grob *me)
+Separation_item::boxes (Grob *me, Grob *left)
{
Item *item = dynamic_cast<Item *> (me);
int very_large = INT_MAX;
Paper_column *pc = item->get_column ();
vector<Box> out;
- extract_grob_set (me, "elements", elts);
+ extract_grob_set (me, left ? "conditional-elements" : "elements", read_only_elts);
+ vector<Grob *> elts;
- Grob *ycommon = common_refpoint_of_array (elts, me, Y_AXIS);
-
- for (vsize i = 0; i < elts.size (); i++)
+ if (left)
{
- Item *il = dynamic_cast<Item *> (elts[i]);
- if (pc != il->get_column ())
- {
- continue;
- }
-
- if (to_boolean (il->get_property ("no-spacing-rods")))
- continue;
-
- Interval y (il->pure_height (ycommon, 0, very_large));
- Box b (il->extent (pc, X_AXIS), y);
-
- out.push_back (b);
+ vector<Grob *> accidental_elts;
+ vector<Grob *> other_elts; // for now only arpeggios
+ for (vsize i = 0; i < read_only_elts.size (); i++)
+ {
+ if (has_interface<Accidental_placement> (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;
- return out;
-}
-
-Interval
-Separation_item::width (Grob *me)
-{
- SCM sw = me->get_property ("X-extent");
- if (is_number_pair (sw))
- return ly_scm2interval (sw);
-
- Item *item = dynamic_cast<Item *> (me);
- Paper_column *pc = item->get_column ();
- Interval w;
+ Grob *ycommon = common_refpoint_of_array (elts, me, Y_AXIS);
- extract_grob_set (me, "elements", elts);
for (vsize i = 0; i < elts.size (); i++)
{
Item *il = dynamic_cast<Item *> (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_property ("no-spacing-rods")))
- continue;
-
- Interval iv (il->extent (pc, X_AXIS));
- if (!iv.is_empty ())
- 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 (has_interface<Axis_group_interface> (il)
+ && !has_interface<Note_head> (il))
+ continue;
+
+ Interval y (il->pure_y_extent (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_property ("padding");
-
- w.widen (robust_scm2double (pad, 0.0));
-
- me->set_property ("X-extent", ly_interval2scm (w));
-
- return w;
-}
-
-Interval
-Separation_item::relative_width (Grob *me, Grob *common)
-{
- Interval iv = width (me);
-
- return dynamic_cast<Item *> (me)->get_column ()->relative_coordinate (common, X_AXIS) + iv;
+ return out;
}
-/*
- Try to find the break-aligned symbol in SEPARATION_ITEM that is
- sticking out at direction D. The x size is put in LAST_EXT
-*/
-Grob *
-Separation_item::extremal_break_aligned_grob (Grob *me,
- Direction d,
- Interval *last_ext)
+MAKE_DOCUMENTED_SCHEME_CALLBACK (Separation_item, print, 1,
+ "Optional stencil for @code{PaperColumn} or"
+ "@code{NonMusicalPaperColumn}.\n"
+ "Draws the @code{horizontal-skylines} of each"
+ " @code{PaperColumn}, showing the shapes used"
+ " to determine the minimum distances between"
+ " @code{PaperColumns} at the note-spacing step,"
+ " before staves have been spaced (vertically)"
+ " on the page.")
+SCM
+Separation_item::print (SCM smob)
{
- Grob *col = dynamic_cast<Item *> (me)->get_column ();
- last_ext->set_empty ();
- Grob *last_grob = 0;
+ if (!debug_skylines)
+ return SCM_BOOL_F;
- extract_grob_set (me, "elements", elts);
- for (vsize i = elts.size (); i--;)
+ Grob *me = unsmob<Grob> (smob);
+ Stencil ret;
+ if (Skyline_pair *s = unsmob<Skyline_pair> (me->get_property ("horizontal-skylines")))
{
- Grob *break_item = elts[i];
- if (!scm_is_symbol (break_item->get_property ("break-align-symbol")))
- continue;
-
- if (!scm_is_pair (break_item->get_property ("space-alist")))
- continue;
-
- Interval ext = break_item->extent (col, X_AXIS);
-
- if (ext.is_empty ())
- continue;
-
- if (!last_grob
- || (last_grob && d * (ext[d]- (*last_ext)[d]) > 0))
- {
- *last_ext = ext;
- last_grob = break_item;
- }
+ 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 last_grob;
+ return ret.smobbed_copy ();
}
ADD_INTERFACE (Separation_item,
- "Item that computes widths to generate spacing rods. "
- "This is done in concert with @ref{separating-group-spanner-interface}.",
-
- "X-extent "
- "conditional-elements "
- "elements "
- "padding "
- "skylines "
- );
+ "Item that computes widths to generate spacing rods.",
+
+ /* properties */
+ "X-extent "
+ "conditional-elements "
+ "elements "
+ "padding "
+ "horizontal-skylines "
+ "skyline-vertical-padding "
+ );
projects / lilypond.git / blobdiff