X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;ds=sidebyside;f=lily%2Fgrob.cc;h=139a387989393209390a7704246c87402d0b3295;hb=47db9a3883d726ca53e2133a3b2298f78dd6a32e;hp=b43ed1540933baa9f742d38d713bff659e064b6d;hpb=0d3c78505a6adb958f9280509bb7fa170de54611;p=lilypond.git diff --git a/lily/grob.cc b/lily/grob.cc index b43ed15409..660a34d072 100644 --- a/lily/grob.cc +++ b/lily/grob.cc @@ -1,214 +1,124 @@ /* - grob.cc -- implement Grob + This file is part of LilyPond, the GNU music typesetter. - source file of the GNU LilyPond music typesetter + Copyright (C) 1997--2015 Han-Wen Nienhuys - (c) 1997--2005 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 "grob.hh" #include -#include +#include -#include "main.hh" -#include "input-smob.hh" -#include "warn.hh" -#include "pointer-group-interface.hh" -#include "misc.hh" -#include "paper-score.hh" -#include "stencil.hh" -#include "warn.hh" -#include "system.hh" +#include "align-interface.hh" +#include "axis-group-interface.hh" +#include "input.hh" +#include "international.hh" #include "item.hh" -#include "stencil.hh" +#include "main.hh" #include "misc.hh" #include "music.hh" -#include "item.hh" -#include "paper-score.hh" -#include "ly-smobs.icc" #include "output-def.hh" +#include "pointer-group-interface.hh" +#include "program-option.hh" +#include "stencil.hh" +#include "stream-event.hh" +#include "system.hh" +#include "unpure-pure-container.hh" +#include "warn.hh" + Grob * -Grob::clone (int count) const +Grob::clone () const { - return new Grob (*this, count); + return new Grob (*this); } -/* TODO: - -- remove dynamic_cast and put this code into respective -subclass. */ - -#define HASH_SIZE 3 -#define INFINITY_MSG "Infinity or NaN encountered" - -Grob::Grob (SCM basicprops, - Object_key const *key) +Grob::Grob (SCM basicprops) { - key_ = key; + /* FIXME: default should be no callback. */ - self_scm_ = SCM_EOL; - pscore_ = 0; - status_ = 0; + layout_ = 0; original_ = 0; interfaces_ = SCM_EOL; immutable_property_alist_ = basicprops; mutable_property_alist_ = SCM_EOL; object_alist_ = SCM_EOL; - /* We do smobify_self () as the first step. Since the object lives on the heap, none of its SCM variables are protected from GC. After smobify_self (), they are. */ smobify_self (); - /* - We always get a new key object for a new grob. - */ - if (key_) - { - ((Object_key*)key_)->unprotect (); - } SCM meta = get_property ("meta"); if (scm_is_pair (meta)) { - interfaces_ = scm_cdr (scm_assoc (ly_symbol2scm ("interfaces"), meta)); - } - - /* TODO: - - - destill this into a function, so we can re-init the immutable - properties with a new BASICPROPS value after - creation. Convenient eg. when using \override with - StaffSymbol. */ - - char const *onames[] = {"X-offset-callbacks", "Y-offset-callbacks"}; - char const *xnames[] = {"X-extent", "Y-extent"}; - char const *enames[] = {"X-extent-callback", "Y-extent-callback"}; - - for (int a = X_AXIS; a <= Y_AXIS; a++) - { - SCM l = get_property (onames[a]); - - if (scm_ilength (l) >= 0) - { - dim_cache_[a].offset_callbacks_ = l; - dim_cache_[a].offsets_left_ = scm_ilength (l); - } - else - programming_error ("[XY]-offset-callbacks must be a list"); - - SCM cb = get_property (enames[a]); - if (cb == SCM_BOOL_F) - { - dim_cache_[a].dimension_ = SCM_BOOL_F; - } - - SCM xt = get_property (xnames[a]); - if (is_number_pair (xt)) - { - dim_cache_[a].dimension_ = xt; - } - else if (ly_is_procedure (cb)) - { - dim_cache_[a].dimension_callback_ = cb; - } - else if (cb == SCM_EOL - && ly_is_procedure (get_property ("print-function"))) - dim_cache_[a].dimension_callback_ = stencil_extent_proc; + interfaces_ = scm_cdr (scm_assq (ly_symbol2scm ("interfaces"), meta)); + + SCM object_cbs = scm_assq (ly_symbol2scm ("object-callbacks"), meta); + if (scm_is_pair (object_cbs)) + { + for (SCM s = scm_cdr (object_cbs); scm_is_pair (s); s = scm_cdr (s)) + set_object (scm_caar (s), scm_cdar (s)); + } } -} -Grob::Grob (Grob const &s, int copy_index) - : dim_cache_ (s.dim_cache_) + if (get_property_data ("X-extent") == SCM_EOL) + set_property ("X-extent", Grob::stencil_width_proc); + if (get_property_data ("Y-extent") == SCM_EOL) + set_property ("Y-extent", + Unpure_pure_container::make_smob (Grob::stencil_height_proc, + Grob::pure_stencil_height_proc)); + if (get_property_data ("vertical-skylines") == SCM_EOL) + set_property ("vertical-skylines", + Unpure_pure_container::make_smob (Grob::simple_vertical_skylines_from_extents_proc, + Grob::pure_simple_vertical_skylines_from_extents_proc)); + if (get_property_data ("horizontal-skylines") == SCM_EOL) + set_property ("horizontal-skylines", + Unpure_pure_container::make_smob (Grob::simple_horizontal_skylines_from_extents_proc, + Grob::pure_simple_horizontal_skylines_from_extents_proc)); +} + +Grob::Grob (Grob const &s) + : Smob () { - key_ = (use_object_keys) ? new Copied_key (s.key_, copy_index) : 0; original_ = (Grob *) & s; - self_scm_ = SCM_EOL; immutable_property_alist_ = s.immutable_property_alist_; - mutable_property_alist_ = ly_deep_copy (s.mutable_property_alist_); - interfaces_ = s.interfaces_; - object_alist_ = SCM_EOL; - - /* No properties are copied. That is the job of - handle_broken_dependencies. */ - status_ = s.status_; - pscore_ = 0; - - smobify_self (); - if (key_) - { - ((Object_key*)key_)->unprotect (); - } -} + mutable_property_alist_ = SCM_EOL; -Grob::~Grob () -{ -} + for (Axis a = X_AXIS; a < NO_AXES; incr (a)) + dim_cache_ [a] = s.dim_cache_ [a]; -MAKE_SCHEME_CALLBACK (Grob, stencil_extent, 2); -SCM -Grob::stencil_extent (SCM element_smob, SCM scm_axis) -{ - Grob *s = unsmob_grob (element_smob); - Axis a = (Axis) scm_to_int (scm_axis); + interfaces_ = s.interfaces_; + object_alist_ = SCM_EOL; - Stencil *m = s->get_stencil (); - Interval e; - if (m) - e = m->extent (a); - return ly_interval2scm (e); -} + layout_ = 0; -Interval -robust_relative_extent (Grob *me, Grob *refp, Axis a) -{ - Interval ext = me->extent (refp, a); - if (ext.is_empty ()) - { - ext.add_point (me->relative_coordinate (refp, a)); - } + smobify_self (); - return ext; -} + mutable_property_alist_ = ly_deep_copy (s.mutable_property_alist_); -Output_def * -Grob::get_layout () const -{ - return pscore_ ? pscore_->layout () : 0; } -/* Recursively track all dependencies of this Grob. The status_ field - is used as a mark-field. It is marked with BUSY during execution - of this function, and marked with FINAL when finished. - - FUNCPTR is the function to call to update this element. */ -void -Grob::calculate_dependencies (int final, int busy, SCM funcname) +Grob::~Grob () { - if (status_ >= final) - return; - - if (status_ == busy) - { - programming_error ("element is busy, come back later"); - return; - } - - status_ = busy; - - extract_grob_set (this, "dependencies", deps); - for (int i = 0; i < deps.size (); i++) - deps[i]->calculate_dependencies (final, busy, funcname); - - SCM proc = internal_get_property (funcname); - if (ly_is_procedure (proc)) - scm_call_1 (proc, this->self_scm ()); - - status_ = final; } +/**************************************************************** + STENCILS +****************************************************************/ Stencil * Grob::get_stencil () const @@ -217,85 +127,113 @@ Grob::get_stencil () const return 0; SCM stil = get_property ("stencil"); - if (unsmob_stencil (stil)) - return unsmob_stencil (stil); - - stil = get_uncached_stencil (); - if (is_live ()) - { - Grob *me = (Grob *) this; - me->set_property ("stencil", stil); - } - - return unsmob_stencil (stil); + return Stencil::unsmob (stil); } -SCM -Grob::get_uncached_stencil () const +Stencil +Grob::get_print_stencil () const { - SCM proc = get_property ("print-function"); - - SCM stil = SCM_EOL; - if (ly_is_procedure (proc)) - stil = scm_apply_0 (proc, scm_list_n (this->self_scm (), SCM_UNDEFINED)); + SCM stil = get_property ("stencil"); - if (Stencil *m = unsmob_stencil (stil)) + Stencil retval; + if (Stencil *m = Stencil::unsmob (stil)) { - if (to_boolean (get_property ("transparent"))) - stil = Stencil (m->extent_box (), SCM_EOL).smobbed_copy (); + retval = *m; + bool transparent = to_boolean (get_property ("transparent")); + + if (transparent) + retval = Stencil (m->extent_box (), SCM_EOL); else - { - SCM expr = m->expr (); - if (point_and_click_global) - expr = scm_list_3 (ly_symbol2scm ("grob-cause"), self_scm (), expr); - - stil = Stencil (m->extent_box (), expr).smobbed_copy (); - } + { + SCM expr = m->expr (); + expr = scm_list_3 (ly_symbol2scm ("grob-cause"), + self_scm (), expr); + + retval = Stencil (m->extent_box (), expr); + } + + SCM rot = get_property ("rotation"); + if (scm_is_pair (rot)) + { + Real angle = scm_to_double (scm_car (rot)); + Real x = scm_to_double (scm_cadr (rot)); + Real y = scm_to_double (scm_caddr (rot)); + + retval.rotate_degrees (angle, Offset (x, y)); + } /* color support... see interpret_stencil_expression () for more... */ SCM color = get_property ("color"); - if (color != SCM_EOL) - { - m = unsmob_stencil (stil); - SCM expr = scm_list_3 (ly_symbol2scm ("color"), - color, - m->expr ()); - - stil = Stencil (m->extent_box (), expr).smobbed_copy (); - } + if (scm_is_pair (color)) + { + SCM expr = scm_list_3 (ly_symbol2scm ("color"), + color, + retval.expr ()); + + retval = Stencil (retval.extent_box (), expr); + } + + /* process whiteout */ + /* a grob has to be visible, otherwise the whiteout property has no effect */ + if (!transparent && to_boolean (get_property ("whiteout"))) + { + /* Call the scheme procedure stencil-whiteout in scm/stencils.scm */ + /* to add a round-filled-box stencil to the stencil list */ + retval + = *Stencil::unsmob (scm_call_1 (ly_lily_module_constant ("stencil-whiteout"), + retval.smobbed_copy ())); + } + + SCM id = get_property ("id"); + if (scm_is_string (id)) + { + SCM expr = scm_list_3 (ly_symbol2scm ("id"), + id, + retval.expr ()); + + retval = Stencil (retval.extent_box (), expr); + } + } - return stil; + return retval; } -/* +/**************************************************************** VIRTUAL STUBS -*/ +****************************************************************/ void Grob::do_break_processing () { } +void +Grob::discretionary_processing () +{ +} + System * Grob::get_system () const { return 0; } -void -Grob::add_dependency (Grob *e) +/* This version of get_system is more reliable than this->get_system () + before line-breaking has been done, at which point there is only + one system in the whole score and we can find it just by following + parent pointers. */ +System * +Grob::get_system (Grob *me) { - if (e) - Pointer_group_interface::add_grob (this, ly_symbol2scm ("dependencies"), e); - else - programming_error ("null dependency added"); + Grob *p = me->get_parent (X_AXIS); + return p ? get_system (p) : dynamic_cast(me); } void Grob::handle_broken_dependencies () { Spanner *sp = dynamic_cast (this); - if (original_ && sp) + if (original () && sp) return; if (sp) @@ -304,8 +242,7 @@ Grob::handle_broken_dependencies () properties, and a special function fixes FOO */ { for (SCM s = object_alist_; scm_is_pair (s); s = scm_cdr (s)) - sp->substitute_one_mutable_property (scm_caar (s), scm_cdar (s)); - + sp->substitute_one_mutable_property (scm_caar (s), scm_cdar (s)); } System *system = get_system (); @@ -336,22 +273,13 @@ Grob::suicide () if (!is_live ()) return; + for (int a = X_AXIS; a < NO_AXES; a++) + dim_cache_[a].clear (); + mutable_property_alist_ = SCM_EOL; object_alist_ = SCM_EOL; immutable_property_alist_ = SCM_EOL; interfaces_ = SCM_EOL; - - set_extent (SCM_EOL, Y_AXIS); - set_extent (SCM_EOL, X_AXIS); - - set_extent_callback (SCM_EOL, Y_AXIS); - set_extent_callback (SCM_EOL, X_AXIS); - - for (int a = X_AXIS; a <= Y_AXIS; a++) - { - dim_cache_[a].offset_callbacks_ = SCM_EOL; - dim_cache_[a].offsets_left_ = 0; - } } void @@ -359,11 +287,11 @@ Grob::handle_prebroken_dependencies () { /* Don't do this in the derived method, since we want to keep access to object_alist_ centralized. */ - if (original_) + if (original ()) { Item *it = dynamic_cast (this); - substitute_object_links (scm_int2num (it->break_status_dir ()), - original_->object_alist_); + substitute_object_links (scm_from_int (it->break_status_dir ()), + original ()->object_alist_); } } @@ -373,14 +301,23 @@ Grob::find_broken_piece (System *) const return 0; } -/* Translate in one direction. */ +/**************************************************************** + OFFSETS +****************************************************************/ + void Grob::translate_axis (Real y, Axis a) { if (isinf (y) || isnan (y)) - programming_error (_ (INFINITY_MSG)); + { + programming_error ("Infinity or NaN encountered"); + return; + } + + if (!dim_cache_[a].offset_) + dim_cache_[a].offset_ = new Real (y); else - dim_cache_[a].offset_ += y; + *dim_cache_[a].offset_ += y; } /* Find the offset relative to D. If D equals THIS, then it is 0. @@ -390,340 +327,685 @@ Grob::translate_axis (Real y, Axis a) Real Grob::relative_coordinate (Grob const *refp, Axis a) const { - if (refp == this) + /* eaa - hmmm, should we do a programming_error() here? */ + if ((this == NULL) || (refp == this)) return 0.0; /* We catch PARENT_L_ == nil case with this, but we crash if we did not ask for the absolute coordinate (ie. REFP == nil.) */ + Real off = get_offset (a); if (refp == dim_cache_[a].parent_) - return get_offset (a); + return off; + + off += dim_cache_[a].parent_->relative_coordinate (refp, a); + + return off; +} + +Real +Grob::pure_relative_y_coordinate (Grob const *refp, int start, int end) +{ + if (refp == this) + return 0.0; + + Real off = 0; + + if (dim_cache_[Y_AXIS].offset_) + { + if (to_boolean (get_property ("pure-Y-offset-in-progress"))) + programming_error ("cyclic chain in pure-Y-offset callbacks"); - return get_offset (a) + dim_cache_[a].parent_->relative_coordinate (refp, a); + off = *dim_cache_[Y_AXIS].offset_; + } + else + { + SCM proc = get_property_data ("Y-offset"); + + dim_cache_[Y_AXIS].offset_ = new Real (0.0); + set_property ("pure-Y-offset-in-progress", SCM_BOOL_T); + off = robust_scm2double (call_pure_function (proc, + scm_list_1 (self_scm ()), + start, end), + 0.0); + del_property ("pure-Y-offset-in-progress"); + delete dim_cache_[Y_AXIS].offset_; + dim_cache_[Y_AXIS].offset_ = 0; + } + + /* we simulate positioning-done if we are the child of a VerticalAlignment, + but only if we don't have a cached offset. If we do have a cached offset, + it probably means that the Alignment was fixed and it has already been + calculated. + */ + if (Grob *p = get_parent (Y_AXIS)) + { + Real trans = 0; + if (Align_interface::has_interface (p) && !dim_cache_[Y_AXIS].offset_) + trans = Align_interface::get_pure_child_y_translation (p, this, start, end); + + return off + trans + p->pure_relative_y_coordinate (refp, start, end); + } + return off; } /* Invoke callbacks to get offset relative to parent. */ Real Grob::get_offset (Axis a) const { + if (dim_cache_[a].offset_) + return *dim_cache_[a].offset_; + Grob *me = (Grob *) this; - while (dim_cache_[a].offsets_left_) + + SCM sym = axis_offset_symbol (a); + me->dim_cache_[a].offset_ = new Real (0.0); + + /* + UGH: can't fold next 2 statements together. Apparently GCC thinks + dim_cache_[a].offset_ is unaliased. + */ + Real off = robust_scm2double (get_property (sym), 0.0); + if (me->dim_cache_[a].offset_) { - int l = --me->dim_cache_[a].offsets_left_; - SCM cb = scm_list_ref (dim_cache_[a].offset_callbacks_, scm_int2num (l)); - SCM retval = scm_call_2 (cb, self_scm (), scm_int2num (a)); - - Real r = scm_to_double (retval); - if (isinf (r) || isnan (r)) - { - programming_error (INFINITY_MSG); - r = 0.0; - } - me->dim_cache_[a].offset_ += r; + *me->dim_cache_[a].offset_ += off; + me->del_property (sym); + return *me->dim_cache_[a].offset_; } - return dim_cache_[a].offset_; + else + return 0.0; } -bool -Grob::is_empty (Axis a) const +Real +Grob::maybe_pure_coordinate (Grob const *refp, Axis a, bool pure, int start, int end) { - return !(scm_is_pair (dim_cache_[a].dimension_) - || ly_is_procedure (dim_cache_[a].dimension_callback_)); + if (pure && a != Y_AXIS) + programming_error ("tried to get pure X-offset"); + return (pure && a == Y_AXIS) ? pure_relative_y_coordinate (refp, start, end) + : relative_coordinate (refp, a); } +/**************************************************************** + extents +****************************************************************/ + void Grob::flush_extent_cache (Axis axis) { - Dimension_cache *d = &dim_cache_[axis]; - if (ly_is_procedure (d->dimension_callback_) - && scm_is_pair (d->dimension_)) + if (dim_cache_[axis].extent_) { - d->dimension_ = SCM_EOL; - + /* + Ugh, this is not accurate; will flush property, causing + callback to be called if. + */ + del_property ((axis == X_AXIS) ? ly_symbol2scm ("X-extent") : ly_symbol2scm ("Y-extent")); + delete dim_cache_[axis].extent_; + dim_cache_[axis].extent_ = 0; if (get_parent (axis)) - get_parent (axis)->flush_extent_cache (axis); + get_parent (axis)->flush_extent_cache (axis); } } Interval Grob::extent (Grob *refp, Axis a) const { - Real x = relative_coordinate (refp, a); + Real offset = relative_coordinate (refp, a); + Interval real_ext; + if (dim_cache_[a].extent_) + { + real_ext = *dim_cache_[a].extent_; + } + else + { + /* + Order is significant: ?-extent may trigger suicide. + */ + SCM ext = (a == X_AXIS) + ? get_property ("X-extent") + : get_property ("Y-extent"); + if (is_number_pair (ext)) + real_ext.unite (ly_scm2interval (ext)); + + SCM min_ext = (a == X_AXIS) + ? get_property ("minimum-X-extent") + : get_property ("minimum-Y-extent"); + if (is_number_pair (min_ext)) + real_ext.unite (ly_scm2interval (min_ext)); + + ((Grob *)this)->dim_cache_[a].extent_ = new Interval (real_ext); + } - Dimension_cache *d = (Dimension_cache *) & dim_cache_[a]; - Interval ext; + // We never want nan, so we avoid shifting infinite values. + if(!isinf (offset)) + real_ext.translate(offset); + else + this->warning(_f ("ignored infinite %s-offset", + a == X_AXIS ? "X" : "Y")); - SCM dimpair = d->dimension_; - if (scm_is_pair (dimpair)) - ; - else if (ly_is_procedure (d->dimension_callback_) - && d->dimension_ == SCM_EOL) - d->dimension_ = scm_call_2 (d->dimension_callback_, self_scm (), scm_int2num (a)); - else - return ext; + return real_ext; +} - if (!scm_is_pair (d->dimension_)) - return ext; +Interval +Grob::pure_height (Grob *refp, int start, int end) +{ + SCM iv_scm = get_pure_property ("Y-extent", start, end); + Interval iv = robust_scm2interval (iv_scm, Interval ()); + Real offset = pure_relative_y_coordinate (refp, start, end); - ext = ly_scm2interval (d->dimension_); + SCM min_ext = get_property ("minimum-Y-extent"); - SCM extra = get_property (a == X_AXIS - ? "extra-X-extent" - : "extra-Y-extent"); + /* we don't add minimum-Y-extent if the extent is empty. This solves + a problem with Hara-kiri spanners. They would request_suicide and + return empty extents, but we would force them here to be large. */ + if (!iv.is_empty () && is_number_pair (min_ext)) + iv.unite (ly_scm2interval (min_ext)); - /* Signs ? */ - if (scm_is_pair (extra)) - { - ext[BIGGER] += scm_to_double (scm_cdr (extra)); - ext[SMALLER] += scm_to_double (scm_car (extra)); - } + if (!iv.is_empty ()) + iv.translate (offset); + return iv; +} - extra = get_property (a == X_AXIS - ? "minimum-X-extent" - : "minimum-Y-extent"); - if (scm_is_pair (extra)) - ext.unite (Interval (scm_to_double (scm_car (extra)), - scm_to_double (scm_cdr (extra)))); +Interval +Grob::maybe_pure_extent (Grob *refp, Axis a, bool pure, int start, int end) +{ + return (pure && a == Y_AXIS) ? pure_height (refp, start, end) : extent (refp, a); +} - ext.translate (x); +Interval_t +Grob::spanned_rank_interval () const +{ + return Interval_t (-1, 0); +} - return ext; +bool +Grob::pure_is_visible (int /* start */, int /* end */) const +{ + return true; } +/* Sort grobs according to their starting column. */ +bool +Grob::less (Grob *g1, Grob *g2) +{ + return g1->spanned_rank_interval ()[LEFT] < g2->spanned_rank_interval ()[LEFT]; +} + +/**************************************************************** + REFPOINTS +****************************************************************/ + /* Find the group-element which has both #this# and #s# */ Grob * Grob::common_refpoint (Grob const *s, Axis a) const { - /* I don't like the quadratic aspect of this code, but I see no - other way. The largest chain of parents might be 10 high or so, - so it shouldn't be a real issue. */ - for (Grob const *c = this; c; c = c->dim_cache_[a].parent_) - for (Grob const *d = s; d; d = d->dim_cache_[a].parent_) - if (d == c) - return (Grob *) d; - return 0; -} + /* Catching the trivial cases is likely costlier than just running + through: one can't avoid going to the respective chain ends + anyway. We might save the second run through when the chain ends + differ, but keeping track of the ends makes the loop more costly. + */ -Grob * -common_refpoint_of_list (SCM elist, Grob *common, Axis a) -{ - for (; scm_is_pair (elist); elist = scm_cdr (elist)) - if (Grob *s = unsmob_grob (scm_car (elist))) - { - if (common) - common = common->common_refpoint (s, a); - else - common = s; - } + int balance = 0; + Grob const *c; + Grob const *d; - return common; + for (c = this; c; ++balance) + c = c->dim_cache_[a].parent_; + + for (d = s; d; --balance) + d = d->dim_cache_[a].parent_; + + /* Cut down ancestry to same size */ + + for (c = this; balance > 0; --balance) + c = c->dim_cache_[a].parent_; + + for (d = s; balance < 0; ++balance) + d = d->dim_cache_[a].parent_; + + /* Now find point where our lineages converge */ + while (c != d) + { + c = c->dim_cache_[a].parent_; + d = d->dim_cache_[a].parent_; + } + + return (Grob *) c; } -Grob * -common_refpoint_of_array (Link_array const &arr, Grob *common, Axis a) +void +Grob::set_parent (Grob *g, Axis a) { - for (int i = arr.size (); i--;) - if (Grob *s = arr[i]) - { - if (common) - common = common->common_refpoint (s, a); - else - common = s; - } - - return common; + dim_cache_[a].parent_ = g; } -String -Grob::name () const +Grob * +Grob::get_parent (Axis a) const { - SCM meta = get_property ("meta"); - SCM nm = scm_assoc (ly_symbol2scm ("name"), meta); - nm = (scm_is_pair (nm)) ? scm_cdr (nm) : SCM_EOL; - return scm_is_symbol (nm) ? ly_symbol2string (nm) : classname (this); + return dim_cache_[a].parent_; } void -Grob::add_offset_callback (SCM cb, Axis a) +Grob::fixup_refpoint () { - if (!has_offset_callback (cb, a)) + for (int a = X_AXIS; a < NO_AXES; a++) { - dim_cache_[a].offset_callbacks_ - = scm_cons (cb, dim_cache_[a].offset_callbacks_); - dim_cache_[a].offsets_left_++; + Axis ax = (Axis)a; + Grob *parent = get_parent (ax); + + if (!parent) + continue; + + if (parent->get_system () != get_system () && get_system ()) + { + Grob *newparent = parent->find_broken_piece (get_system ()); + set_parent (newparent, ax); + } + + if (Item *i = dynamic_cast (this)) + { + Item *parenti = dynamic_cast (parent); + + if (parenti && i) + { + Direction my_dir = i->break_status_dir (); + if (my_dir != parenti->break_status_dir ()) + { + Item *newparent = parenti->find_prebroken_piece (my_dir); + set_parent (newparent, ax); + } + } + } } } -bool -Grob::has_extent_callback (SCM cb, Axis a) const +/**************************************************************** + VERTICAL ORDERING +****************************************************************/ + +Grob * +get_maybe_root_vertical_alignment (Grob *g, Grob *maybe) { - return scm_equal_p (cb, dim_cache_[a].dimension_callback_) == SCM_BOOL_T; + if (!g) + return maybe; + if (Align_interface::has_interface (g)) + return get_maybe_root_vertical_alignment (g->get_parent (Y_AXIS), g); + return get_maybe_root_vertical_alignment (g->get_parent (Y_AXIS), maybe); + } -bool -Grob::has_offset_callback (SCM cb, Axis a) const +Grob * +Grob::get_root_vertical_alignment (Grob *g) { - return scm_c_memq (cb, dim_cache_[a].offset_callbacks_) != SCM_BOOL_F; + return get_maybe_root_vertical_alignment (g, 0); } -void -Grob::set_extent (SCM dc, Axis a) +Grob * +Grob::get_vertical_axis_group (Grob *g) { - dim_cache_[a].dimension_ = dc; + if (!g) + return 0; + if (!g->get_parent (Y_AXIS)) + return 0; + if (Axis_group_interface::has_interface (g) + && Align_interface::has_interface (g->get_parent (Y_AXIS))) + return g; + return get_vertical_axis_group (g->get_parent (Y_AXIS)); + } -void -Grob::set_extent_callback (SCM dc, Axis a) +int +Grob::get_vertical_axis_group_index (Grob *g) { - dim_cache_[a].dimension_callback_ = dc; + Grob *val = get_root_vertical_alignment (g); + if (!val) + return -1; + Grob *vax = get_vertical_axis_group (g); + extract_grob_set (val, "elements", elts); + for (vsize i = 0; i < elts.size (); i++) + if (elts[i] == vax) + return (int) i; + g->programming_error ("could not find this grob's vertical axis group in the vertical alignment"); + return -1; } -void -Grob::set_parent (Grob *g, Axis a) +bool +Grob::vertical_less (Grob *g1, Grob *g2) { - dim_cache_[a].parent_ = g; + return internal_vertical_less (g1, g2, false); } -void -Grob::fixup_refpoint () +bool +Grob::pure_vertical_less (Grob *g1, Grob *g2) { - for (int a = X_AXIS; a < NO_AXES; a++) + return internal_vertical_less (g1, g2, true); +} + +bool +Grob::internal_vertical_less (Grob *g1, Grob *g2, bool pure) +{ + Grob *vag = get_root_vertical_alignment (g1); + if (!vag) { - Axis ax = (Axis)a; - Grob *parent = get_parent (ax); + g1->programming_error ("grob does not belong to a VerticalAlignment?"); + return false; + } - if (!parent) - continue; + Grob *ag1 = get_vertical_axis_group (g1); + Grob *ag2 = get_vertical_axis_group (g2); - if (parent->get_system () != get_system () && get_system ()) - { - Grob *newparent = parent->find_broken_piece (get_system ()); - set_parent (newparent, ax); - } + extract_grob_set (vag, "elements", elts); - if (Item *i = dynamic_cast (this)) - { - Item *parenti = dynamic_cast (parent); - - if (parenti && i) - { - Direction my_dir = i->break_status_dir (); - if (my_dir != parenti->break_status_dir ()) - { - Item *newparent = parenti->find_prebroken_piece (my_dir); - set_parent (newparent, ax); - } - } - } + if (ag1 == ag2 && !pure) + { + Grob *common = g1->common_refpoint (g2, Y_AXIS); + return g1->relative_coordinate (common, Y_AXIS) > g2->relative_coordinate (common, Y_AXIS); } + + for (vsize i = 0; i < elts.size (); i++) + { + if (elts[i] == ag1) + return true; + if (elts[i] == ag2) + return false; + } + + g1->programming_error ("could not place this grob in its axis group"); + return false; } +/**************************************************************** + MESSAGES +****************************************************************/ void -Grob::warning (String s) const +Grob::programming_error (const string &s) const { SCM cause = self_scm (); - while (Grob *g = unsmob_grob (cause)) + while (Grob *g = Grob::unsmob (cause)) cause = g->get_property ("cause"); - if (Music *m = unsmob_music (cause)) + /* ES TODO: cause can't be Music*/ + if (Music *m = Music::unsmob (cause)) + m->origin ()->programming_error (s); + else if (Stream_event *ev = Stream_event::unsmob (cause)) + ev->origin ()->programming_error (s); + else + ::programming_error (s); +} + +void +Grob::warning (const string &s) const +{ + SCM cause = self_scm (); + while (Grob *g = Grob::unsmob (cause)) + cause = g->get_property ("cause"); + + /* ES TODO: cause can't be Music*/ + if (Music *m = Music::unsmob (cause)) m->origin ()->warning (s); + else if (Stream_event *ev = Stream_event::unsmob (cause)) + ev->origin ()->warning (s); else ::warning (s); } -void -Grob::programming_error (String s) const +string +Grob::name () const { - s = _f ("programming error: %s", s); - message (s); + SCM meta = get_property ("meta"); + SCM nm = scm_assq (ly_symbol2scm ("name"), meta); + nm = (scm_is_pair (nm)) ? scm_cdr (nm) : SCM_EOL; + return scm_is_symbol (nm) ? ly_symbol2string (nm) : this->class_name (); +} + +ADD_INTERFACE (Grob, + "A grob represents a piece of music notation.\n" + "\n" + "All grobs have an X and Y@tie{}position on the page. These" + " X and Y@tie{}positions are stored in a relative format, thus" + " they can easily be combined by stacking them, hanging one" + " grob to the side of another, or coupling them into grouping" + " objects.\n" + "\n" + "Each grob has a reference point (a.k.a.@: parent): The" + " position of a grob is stored relative to that reference" + " point. For example, the X@tie{}reference point of a staccato" + " dot usually is the note head that it applies to. When the" + " note head is moved, the staccato dot moves along" + " automatically.\n" + "\n" + "A grob is often associated with a symbol, but some grobs do" + " not print any symbols. They take care of grouping objects." + " For example, there is a separate grob that stacks staves" + " vertically. The @ref{NoteCollision} object is also an" + " abstract grob: It only moves around chords, but doesn't print" + " anything.\n" + "\n" + "Grobs have properties (Scheme variables) that can be read and" + " set. Two types of them exist: immutable and mutable." + " Immutable variables define the default style and behavior." + " They are shared between many objects. They can be changed" + " using @code{\\override} and @code{\\revert}. Mutable" + " properties are variables that are specific to one grob." + " Typically, lists of other objects, or results from" + " computations are stored in mutable properties. In" + " particular, every call to @code{ly:grob-set-property!}" + " (or its C++ equivalent) sets a mutable property.\n" + "\n" + "The properties @code{after-line-breaking} and" + " @code{before-line-breaking} are dummies that are not" + " user-serviceable.", + + /* properties */ + "X-extent " + "X-offset " + "Y-extent " + "Y-offset " + "after-line-breaking " + "avoid-slur " + "axis-group-parent-X " + "axis-group-parent-Y " + "before-line-breaking " + "cause " + "color " + "cross-staff " + "id " + "extra-offset " + "footnote-music " + "forced-spacing " + "horizontal-skylines " + "interfaces " + "layer " + "meta " + "minimum-X-extent " + "minimum-Y-extent " + "pure-Y-offset-in-progress " + "rotation " + "skyline-horizontal-padding " + "springs-and-rods " + "staff-symbol " + "stencil " + "transparent " + "vertical-skylines " + "whiteout " + ); + +/**************************************************************** + CALLBACKS +****************************************************************/ + +static SCM +grob_stencil_extent (Grob *me, Axis a) +{ + Stencil *m = me->get_stencil (); + Interval e; + if (m) + e = m->extent (a); + return ly_interval2scm (e); } -void -Grob::discretionary_processing () + +MAKE_SCHEME_CALLBACK (Grob, stencil_height, 1); +SCM +Grob::stencil_height (SCM smob) { - + Grob *me = Grob::unsmob (smob); + return grob_stencil_extent (me, Y_AXIS); } -bool -Grob::internal_has_interface (SCM k) +MAKE_SCHEME_CALLBACK (Grob, pure_stencil_height, 3); +SCM +Grob::pure_stencil_height (SCM smob, SCM /* beg */, SCM /* end */) { - return scm_c_memq (k, interfaces_) != SCM_BOOL_F; + Grob *me = Grob::unsmob (smob); + if (Stencil::is_smob (me->get_property_data ("stencil"))) + return grob_stencil_extent (me, Y_AXIS); + + return ly_interval2scm (Interval ()); + +} + +MAKE_SCHEME_CALLBACK (Grob, y_parent_positioning, 1); +SCM +Grob::y_parent_positioning (SCM smob) +{ + Grob *me = Grob::unsmob (smob); + Grob *par = me->get_parent (Y_AXIS); + if (par) + (void) par->get_property ("positioning-done"); + + return scm_from_double (0.0); +} + +MAKE_SCHEME_CALLBACK (Grob, x_parent_positioning, 1); +SCM +Grob::x_parent_positioning (SCM smob) +{ + Grob *me = Grob::unsmob (smob); + + Grob *par = me->get_parent (X_AXIS); + if (par) + (void) par->get_property ("positioning-done"); + + return scm_from_double (0.0); +} + +MAKE_SCHEME_CALLBACK (Grob, stencil_width, 1); +SCM +Grob::stencil_width (SCM smob) +{ + Grob *me = Grob::unsmob (smob); + return grob_stencil_extent (me, X_AXIS); } Grob * -Grob::get_parent (Axis a) const +common_refpoint_of_list (SCM elist, Grob *common, Axis a) { - return dim_cache_[a].parent_; + for (; scm_is_pair (elist); elist = scm_cdr (elist)) + if (Grob *s = Grob::unsmob (scm_car (elist))) + { + if (common) + common = common->common_refpoint (s, a); + else + common = s; + } + + return common; } -/** Return Array of Grobs in SCM list LST */ -Link_array -ly_scm2grobs (SCM lst) +Grob * +common_refpoint_of_array (vector const &arr, Grob *common, Axis a) { - Link_array arr; + for (vsize i = 0; i < arr.size (); i++) + if (common) + common = common->common_refpoint (arr[i], a); + else + common = arr[i]; - for (SCM s = lst; scm_is_pair (s); s = scm_cdr (s)) - { - SCM e = scm_car (s); - arr.push (unsmob_grob (e)); - } + return common; +} - arr.reverse (); - return arr; +Grob * +common_refpoint_of_array (set const &arr, Grob *common, Axis a) +{ + set::iterator it; + + for (it = arr.begin (); it != arr.end (); it++) + if (common) + common = common->common_refpoint (*it, a); + else + common = *it; + + return common; } -Object_key const * -Grob::get_key () const +Interval +robust_relative_extent (Grob *me, Grob *refpoint, Axis a) { - return key_; + Interval ext = me->extent (refpoint, a); + if (ext.is_empty ()) + ext.add_point (me->relative_coordinate (refpoint, a)); + + return ext; } -/** Return SCM list of Grob array A */ -SCM -ly_grobs2scm (Link_array a) -{ - SCM s = SCM_EOL; - for (int i = a.size (); i; i--) - s = scm_cons (a[i - 1]->self_scm (), s); - - return s; -} - -ADD_INTERFACE (Grob, "grob-interface", - "A grob represents a piece of music notation\n" - "\n" - "All grobs have an X and Y-position on the page. These X and Y positions\n" - "are stored in a relative format, so they can easily be combined by\n" - "stacking them, hanging one grob to the side of another, and coupling\n" - "them into a grouping objects.\n" - "\n" - "Each grob has a reference point (a.k.a. parent): the position of a grob\n" - "is stored relative to that reference point. For example the X-reference\n" - "point of a staccato dot usually is the note head that it applies\n" - "to. When the note head is moved, the staccato dot moves along\n" - "automatically.\n" - "\n" - "A grob is often associated with a symbol, but some grobs do not print\n" - "any symbols. They take care of grouping objects. For example, there is a\n" - "separate grob that stacks staves vertically. The @ref{NoteCollision}\n" - "is also an abstract grob: it only moves around chords, but doesn't print\n" - "anything.\n" - "\n" - "Grobs have a properties: Scheme variables, that can be read and set. " - "They have two types. Immutable variables " - "define the default style and behavior. They are shared between many objects. " - "They can be changed using @code{\\override} and @code{\\revert}. " - "\n\n" - "Mutable properties are variables that are specific to one grob. Typically, " - "lists of other objects, or results from computations are stored in" - "mutable properties: every call to set-grob-property (or its C++ equivalent) " - "sets a mutable property. ", - "X-offset-callbacks Y-offset-callbacks X-extent-callback stencil cause " - "Y-extent-callback print-function extra-offset spacing-procedure " - "context staff-symbol interfaces dependencies X-extent Y-extent extra-X-extent " - "meta layer before-line-breaking-callback " - "color " - "axis-group-parent-X " - "axis-group-parent-Y " - "after-line-breaking-callback extra-Y-extent minimum-X-extent " - "minimum-Y-extent transparent"); +// Checks whether there is a vertical alignment in the chain of +// parents between this and commony. +bool +Grob::check_cross_staff (Grob *commony) +{ + if (Align_interface::has_interface (commony)) + return true; + + for (Grob *g = this; g && g != commony; g = g->get_parent (Y_AXIS)) + if (Align_interface::has_interface (g)) + return true; + + return false; +} + +static +bool +indirect_less (Grob **a, Grob **b) +{ + // Use original order as tie breaker. That gives us a stable sort + // at the lower price tag of an unstable one, and we want a stable + // sort in order to reliably retain the first instance of a grob + // pointer. + return *a < *b || (*a == *b && a < b); +} + +static +bool +indirect_eq (Grob **a, Grob **b) +{ + return *a == *b; +} + +static +bool +direct_less (Grob **a, Grob **b) +{ + return a < b; +} + +// uniquify uniquifies on the memory addresses of the Grobs, but then +// uses the original order. This makes results independent from the +// memory allocation of Grobs. +void +uniquify (vector & grobs) +{ + vector vec (grobs.size ()); + for (vsize i = 0; i < grobs.size (); i++) + vec[i] = &grobs[i]; + vector_sort (vec, indirect_less); + vec.erase (unique (vec.begin (), vec.end (), indirect_eq), vec.end ()); + vector_sort (vec, direct_less); + + // Since the output is a sorted copy of the input with some elements + // removed, we can fill in the vector in-place if we do it starting + // from the front. + for (vsize i = 0; i < vec.size (); i++) + grobs[i] = *vec[i]; + grobs.erase (grobs.begin () + vec.size (), grobs.end ()); + return; +}