X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fgrob.cc;h=15eb1f9212b80da980ffbdcd8707e09de6a789e1;hb=089079b71577d7e435c70f9cfa8f1833169872b7;hp=b43ed1540933baa9f742d38d713bff659e064b6d;hpb=0d3c78505a6adb958f9280509bb7fa170de54611;p=lilypond.git diff --git a/lily/grob.cc b/lily/grob.cc index b43ed15409..15eb1f9212 100644 --- a/lily/grob.cc +++ b/lily/grob.cc @@ -3,31 +3,26 @@ source file of the GNU LilyPond music typesetter - (c) 1997--2005 Han-Wen Nienhuys + (c) 1997--2006 Han-Wen Nienhuys */ #include "grob.hh" #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 "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 "stencil.hh" +#include "system.hh" +#include "warn.hh" + +#include "ly-smobs.icc" Grob * Grob::clone (int count) const @@ -35,28 +30,18 @@ Grob::clone (int count) const return new Grob (*this, count); } -/* 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) { 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 @@ -67,57 +52,16 @@ Grob::Grob (SCM basicprops, We always get a new key object for a new grob. */ if (key_) - { - ((Object_key*)key_)->unprotect (); - } + ((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)); + + if (get_property_data (ly_symbol2scm ("X-extent")) == SCM_EOL) + set_property ("X-extent", Grob::stencil_width_proc); + if (get_property_data (ly_symbol2scm ("Y-extent")) == SCM_EOL) + set_property ("Y-extent", Grob::stencil_height_proc); } Grob::Grob (Grob const &s, int copy_index) @@ -131,84 +75,20 @@ Grob::Grob (Grob const &s, int copy_index) 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; + + layout_ = 0; smobify_self (); if (key_) - { - ((Object_key*)key_)->unprotect (); - } + ((Object_key *)key_)->unprotect (); } Grob::~Grob () { } - -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); - - Stencil *m = s->get_stencil (); - Interval e; - if (m) - e = m->extent (a); - return ly_interval2scm (e); -} - -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)); - } - - return ext; -} - -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) -{ - 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,39 +97,36 @@ 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); } -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"); + Stencil retval; if (Stencil *m = unsmob_stencil (stil)) { + retval = *m; if (to_boolean (get_property ("transparent"))) - stil = Stencil (m->extent_box (), SCM_EOL).smobbed_copy (); + 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 (); + 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 (angle, Offset (x, y)); } /* color support... see interpret_stencil_expression () for more... */ @@ -261,41 +138,39 @@ Grob::get_uncached_stencil () const color, m->expr ()); - stil = Stencil (m->extent_box (), expr).smobbed_copy (); + retval = Stencil (m->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) -{ - if (e) - Pointer_group_interface::add_grob (this, ly_symbol2scm ("dependencies"), e); - else - programming_error ("null dependency added"); -} void Grob::handle_broken_dependencies () { Spanner *sp = dynamic_cast (this); - if (original_ && sp) + if (original () && sp) return; if (sp) @@ -305,7 +180,6 @@ Grob::handle_broken_dependencies () { for (SCM s = object_alist_; scm_is_pair (s); s = scm_cdr (s)) sp->substitute_one_mutable_property (scm_caar (s), scm_cdar (s)); - } System *system = get_system (); @@ -336,22 +210,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 +224,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 +238,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. @@ -395,100 +269,108 @@ Grob::relative_coordinate (Grob const *refp, Axis a) const /* 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 get_offset (a) + dim_cache_[a].parent_->relative_coordinate (refp, a); + 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_) - { - 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; + 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 (internal_get_property (sym), 0.0); + if (me->dim_cache_[a].offset_) + { + *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 -{ - return !(scm_is_pair (dim_cache_[a].dimension_) - || ly_is_procedure (dim_cache_[a].dimension_callback_)); -} + +/**************************************************************** + 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); } } + Interval Grob::extent (Grob *refp, Axis a) const { - Real x = relative_coordinate (refp, a); - - Dimension_cache *d = (Dimension_cache *) & dim_cache_[a]; - Interval ext; - - 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)); + Real offset = relative_coordinate (refp, a); + Interval real_ext; + if (dim_cache_[a].extent_) + { + real_ext = *dim_cache_[a].extent_; + } else - return ext; - - if (!scm_is_pair (d->dimension_)) - return ext; - - ext = ly_scm2interval (d->dimension_); - - SCM extra = get_property (a == X_AXIS - ? "extra-X-extent" - : "extra-Y-extent"); - - /* Signs ? */ - if (scm_is_pair (extra)) { - ext[BIGGER] += scm_to_double (scm_cdr (extra)); - ext[SMALLER] += scm_to_double (scm_car (extra)); + /* + Order is significant: ?-extent may trigger suicide. + */ + SCM ext_sym = + (a == X_AXIS) + ? ly_symbol2scm ("X-extent") + : ly_symbol2scm ("Y-extent"); + + SCM ext = internal_get_property (ext_sym); + if (is_number_pair (ext)) + real_ext.unite (ly_scm2interval (ext)); + + SCM min_ext_sym = + (a == X_AXIS) + ? ly_symbol2scm ("minimum-X-extent") + : ly_symbol2scm ("minimum-Y-extent"); + SCM min_ext = internal_get_property (min_ext_sym); + if (is_number_pair (min_ext)) + real_ext.unite (ly_scm2interval (min_ext)); + ((Grob*)this)->del_property (ext_sym); + ((Grob*)this)->dim_cache_[a].extent_ = new Interval (real_ext); } - - 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)))); - - ext.translate (x); - - return ext; + + real_ext.translate (offset); + + return real_ext; } +/**************************************************************** + REFPOINTS +****************************************************************/ + /* Find the group-element which has both #this# and #s# */ Grob * Grob::common_refpoint (Grob const *s, Axis a) const @@ -504,85 +386,18 @@ Grob::common_refpoint (Grob const *s, Axis a) const return 0; } -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; - } - - return common; -} - -Grob * -common_refpoint_of_array (Link_array const &arr, Grob *common, 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; -} - -String -Grob::name () 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); -} - -void -Grob::add_offset_callback (SCM cb, Axis a) -{ - if (!has_offset_callback (cb, a)) - { - dim_cache_[a].offset_callbacks_ - = scm_cons (cb, dim_cache_[a].offset_callbacks_); - dim_cache_[a].offsets_left_++; - } -} - -bool -Grob::has_extent_callback (SCM cb, Axis a) const -{ - return scm_equal_p (cb, dim_cache_[a].dimension_callback_) == SCM_BOOL_T; -} - -bool -Grob::has_offset_callback (SCM cb, Axis a) const -{ - return scm_c_memq (cb, dim_cache_[a].offset_callbacks_) != SCM_BOOL_F; -} - void -Grob::set_extent (SCM dc, Axis a) +Grob::set_parent (Grob *g, Axis a) { - dim_cache_[a].dimension_ = dc; + dim_cache_[a].parent_ = g; } -void -Grob::set_extent_callback (SCM dc, Axis a) +Grob * +Grob::get_parent (Axis a) const { - dim_cache_[a].dimension_callback_ = dc; + return dim_cache_[a].parent_; } -void -Grob::set_parent (Grob *g, Axis a) -{ - dim_cache_[a].parent_ = g; -} void Grob::fixup_refpoint () @@ -618,8 +433,12 @@ Grob::fixup_refpoint () } } + +/**************************************************************** + MESSAGES +****************************************************************/ void -Grob::warning (String s) const +Grob::warning (string s) const { SCM cause = self_scm (); while (Grob *g = unsmob_grob (cause)) @@ -631,62 +450,31 @@ Grob::warning (String s) const ::warning (s); } -void -Grob::programming_error (String s) const -{ - s = _f ("programming error: %s", s); - message (s); -} -void -Grob::discretionary_processing () -{ - -} - -bool -Grob::internal_has_interface (SCM k) -{ - return scm_c_memq (k, interfaces_) != SCM_BOOL_F; -} -Grob * -Grob::get_parent (Axis a) const +string +Grob::name () const { - return dim_cache_[a].parent_; + 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 (); } -/** Return Array of Grobs in SCM list LST */ -Link_array -ly_scm2grobs (SCM lst) +void +Grob::programming_error (string s) const { - Link_array arr; - - for (SCM s = lst; scm_is_pair (s); s = scm_cdr (s)) - { - SCM e = scm_car (s); - arr.push (unsmob_grob (e)); - } + SCM cause = self_scm (); + while (Grob *g = unsmob_grob (cause)) + cause = g->get_property ("cause"); - arr.reverse (); - return arr; -} + s = _f ("programming error: %s", s); -Object_key const * -Grob::get_key () const -{ - return key_; + if (Music *m = unsmob_music (cause)) + m->origin ()->message (s); + else + ::message (s); } -/** 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" @@ -716,14 +504,140 @@ ADD_INTERFACE (Grob, "grob-interface", "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 " + "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 " "axis-group-parent-X " "axis-group-parent-Y " - "after-line-breaking-callback extra-Y-extent minimum-X-extent " - "minimum-Y-extent transparent"); + "before-line-breaking " + "cause " + "color " + "extra-X-extent " + "extra-Y-extent " + "extra-offset " + "interfaces " + "layer " + "meta " + "minimum-X-extent " + "minimum-Y-extent " + "rotation " + "springs-and-rods " + "staff-symbol " + "stencil " + "transparent " + ); + + + + + +/**************************************************************** + 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); +} + + +MAKE_SCHEME_CALLBACK (Grob, stencil_height, 1); +SCM +Grob::stencil_height (SCM smob) +{ + Grob *me = unsmob_grob (smob); + return grob_stencil_extent (me, Y_AXIS); +} + +MAKE_SCHEME_CALLBACK(Grob, y_parent_positioning, 1); +SCM +Grob::y_parent_positioning (SCM smob) +{ + Grob *me = unsmob_grob (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 = unsmob_grob (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 = unsmob_grob (smob); + return grob_stencil_extent (me, X_AXIS); +} + + + +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; + } + + return common; +} + +Grob * +common_refpoint_of_array (vector const &arr, Grob *common, Axis a) +{ + for (vsize i = arr.size (); i--;) + if (Grob *s = arr[i]) + { + if (common) + common = common->common_refpoint (s, a); + else + common = s; + } + + return common; +} + +Interval +robust_relative_extent (Grob *me, Grob *refpoint, Axis a) +{ + Interval ext = me->extent (refpoint, a); + if (ext.is_empty ()) + ext.add_point (me->relative_coordinate (refpoint, a)); + + return ext; +}