X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fgrob.cc;h=fc49f16d4ddd7b5b6b67fc3da0629f5252d87d56;hb=6c9c8b25d51b3438b86e453be57f8e15ef856580;hp=0fd48933619f5d72a18d3105ca4bf4591665a320;hpb=31a3d86ea52318746f44600161e4dfad7db9366f;p=lilypond.git diff --git a/lily/grob.cc b/lily/grob.cc index 0fd4893361..fc49f16d4d 100644 --- a/lily/grob.cc +++ b/lily/grob.cc @@ -3,836 +3,632 @@ source file of the GNU LilyPond music typesetter - (c) 1997--2004 Han-Wen Nienhuys + (c) 1997--2006 Han-Wen Nienhuys */ +#include "grob.hh" -#include -#include +#include -#include "main.hh" #include "input-smob.hh" -#include "warn.hh" -#include "group-interface.hh" -#include "misc.hh" -#include "paper-score.hh" -#include "stencil.hh" -#include "grob.hh" -#include "warn.hh" -#include "spanner.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 "output-def.hh" +#include "pointer-group-interface.hh" +#include "stencil.hh" +#include "system.hh" +#include "warn.hh" #include "ly-smobs.icc" -/* -TODO: - -remove dynamic_cast and put this code into respective - subclass. -*/ - -//#define HASHING_FOR_MUTABLE_PROPS -#define HASH_SIZE 3 -#define INFINITY_MSG "Infinity or NaN encountered" +Grob * +Grob::clone (int count) const +{ + return new Grob (*this, count); +} -Grob::Grob (SCM basicprops) +Grob::Grob (SCM basicprops, + Object_key const *key) { - /* - fixme: default should be no callback. - */ + key_ = key; + /* FIXME: default should be no callback. */ self_scm_ = SCM_EOL; - pscore_=0; - status_ = 0; + layout_ = 0; original_ = 0; - immutable_property_alist_ = basicprops; + interfaces_ = SCM_EOL; + immutable_property_alist_ = basicprops; mutable_property_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 (); - - -#ifdef HASHING_FOR_MUTABLE_PROPS - mutable_property_alist_ = scm_c_make_hash_table (HASH_SIZE); -#endif + object_alist_ = SCM_EOL; - SCM meta = get_property ("meta"); - if (gh_pair_p (meta)) - { - SCM ifs = scm_assoc (ly_symbol2scm ("interfaces"), meta); + /* 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 (); - /* - Switch off interface checks for the moment. - */ - bool itc = internal_type_checking_global_b; - internal_type_checking_global_b = false; - internal_set_property (ly_symbol2scm ("interfaces"), gh_cdr (ifs)); - internal_type_checking_global_b = itc; - } - /* - TODO: + We always get a new key object for a new grob. + */ + if (key_) + ((Object_key *)key_)->unprotect (); - 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"}; + SCM meta = get_property ("meta"); + if (scm_is_pair (meta)) + interfaces_ = scm_cdr (scm_assq (ly_symbol2scm ("interfaces"), meta)); - 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]); - SCM xt = get_property (xnames[a]); - - /* - Should change default to empty? - */ - if (is_number_pair (xt)) - cb = xt; - else if (cb != SCM_BOOL_F - && !gh_procedure_p (cb) && !gh_pair_p (cb) - && gh_procedure_p (get_property ("print-function"))) - cb = stencil_extent_proc; - - dim_cache_[a].dimension_ = cb; - } - + 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) - : dim_cache_ (s.dim_cache_) +Grob::Grob (Grob const &s, int copy_index) + : dim_cache_ (s.dim_cache_) { - original_ = (Grob*) &s; + 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_ = SCM_EOL; - - /* - No properties are copied. That is the job of handle_broken_dependencies. - */ - - status_ = s.status_; - pscore_ = 0; + mutable_property_alist_ = ly_deep_copy (s.mutable_property_alist_); + interfaces_ = s.interfaces_; + object_alist_ = SCM_EOL; - smobify_self (); + layout_ = 0; -#ifdef HASHING_FOR_MUTABLE_PROPS - mutable_property_alist_ = scm_c_make_hash_table (HASH_SIZE); -#endif + smobify_self (); + if (key_) + ((Object_key *)key_)->unprotect (); } Grob::~Grob () { - /* - do nothing scm-ish and no unprotecting here. - */ } +/**************************************************************** + STENCILS +****************************************************************/ - -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) gh_scm2int (scm_axis); - - Stencil *m = s->get_stencil (); - Interval e ; - if (m) - e = m->extent (a); - return ly_interval2scm (e); -} - -Paper_def* -Grob::get_paper () const -{ - return pscore_ ? pscore_->paper_ : 0; -} - -void -Grob::calculate_dependencies (int final, int busy, SCM funcname) +Stencil * +Grob::get_stencil () const { - if (status_ >= final) - return; - - if (status_== busy) - { - programming_error ("Element is busy, come back later"); - return; - } - - status_= busy; + if (!is_live ()) + return 0; - for (SCM d = get_property ("dependencies"); gh_pair_p (d); - d = ly_cdr (d)) - { - unsmob_grob (ly_car (d)) - ->calculate_dependencies (final, busy, funcname); - } - - - SCM proc = internal_get_property (funcname); - if (gh_procedure_p (proc)) - gh_call1 (proc, this->self_scm ()); - - status_= final; + SCM stil = get_property ("stencil"); + return unsmob_stencil (stil); } -Stencil * -Grob::get_stencil () const +Stencil +Grob::get_print_stencil () const { - if (!live ()) - { - return 0; - } - - SCM mol = get_property ("stencil"); - if (unsmob_stencil (mol)) - return unsmob_stencil (mol); + SCM stil = get_property ("stencil"); - mol = get_uncached_stencil (); - - if (live ()) + Stencil retval; + if (Stencil *m = unsmob_stencil (stil)) { - Grob *me = (Grob*)this; - me->set_property ("stencil", mol); - } - - return unsmob_stencil (mol); -} + retval = *m; + if (to_boolean (get_property ("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); -SCM -Grob::get_uncached_stencil ()const -{ - SCM proc = get_property ("print-function"); + retval = Stencil (m->extent_box (), expr); + } - SCM mol = SCM_EOL; - if (gh_procedure_p (proc)) - mol = gh_apply (proc, scm_list_n (this->self_scm (), SCM_UNDEFINED)); - - Stencil *m = unsmob_stencil (mol); - - if (unsmob_stencil (mol)) - { - SCM origin = ly_symbol2scm ("no-origin"); - - if (store_locations_global_b) + /* color support... see interpret_stencil_expression () for more... */ + SCM color = get_property ("color"); + if (color != SCM_EOL) { - SCM cause = get_property ("cause"); - if (Music*m = unsmob_music (cause)) - { - SCM music_origin = m->get_property ("origin"); - if (unsmob_input (music_origin)) - origin = music_origin; - } - } + m = unsmob_stencil (stil); + SCM expr = scm_list_3 (ly_symbol2scm ("color"), + color, + m->expr ()); - // ugr. - - mol = Stencil (m->extent_box (), - scm_list_n (origin, m->get_expr (), SCM_UNDEFINED) - ). smobbed_copy (); + retval = Stencil (m->extent_box (), expr); + } - m = unsmob_stencil (mol); } - - /* - transparent retains dimensions of element. - */ - if (m && to_boolean (get_property ("transparent"))) - mol = Stencil (m->extent_box (), SCM_EOL).smobbed_copy (); - return mol; + return retval; } -/* - +/**************************************************************** VIRTUAL STUBS - - */ +****************************************************************/ void Grob::do_break_processing () { } -System * -Grob::get_system () const +void +Grob::discretionary_processing () { - return 0; } -void -Grob::add_dependency (Grob*e) +System * +Grob::get_system () const { - if (e) - { - Pointer_group_interface::add_grob (this, ly_symbol2scm ("dependencies"),e); - } - else - programming_error ("Null dependency added"); + return 0; } void Grob::handle_broken_dependencies () { - Spanner * sp = dynamic_cast (this); - if (original_ && sp) + Spanner *sp = dynamic_cast (this); + if (original () && sp) return; if (sp) + /* THIS, SP is the original spanner. We use a special function + because some Spanners have enormously long lists in their + properties, and a special function fixes FOO */ { - /* - This is the original spanner. We use a special function - because some Spanners have enormously long lists in their - properties. - */ - for (SCM s = mutable_property_alist_; gh_pair_p (s); - s = gh_cdr (s)) - { - sp->substitute_one_mutable_property (gh_caar (s), - gh_cdar (s)); - } + 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 (); - if (live () - && system && common_refpoint (system, X_AXIS) && common_refpoint (system, Y_AXIS)) - { - substitute_mutable_properties (system ? system->self_scm () : SCM_UNDEFINED, - mutable_property_alist_); - } - else if (dynamic_cast (this)) - { - substitute_mutable_properties (SCM_UNDEFINED, mutable_property_alist_); - } + if (is_live () + && system + && common_refpoint (system, X_AXIS) + && common_refpoint (system, Y_AXIS)) + substitute_object_links (system->self_scm (), object_alist_); + else if (dynamic_cast (this)) + substitute_object_links (SCM_UNDEFINED, object_alist_); else - { - /* - This element is `invalid'; it has been removed from all - dependencies, so let's junk the element itself. - - do not do this for System, since that would remove references - to the originals of score-grobs, which get then GC'd (a bad - thing.) - - */ - suicide (); - } + /* THIS element is `invalid'; it has been removed from all + dependencies, so let's junk the element itself. + + Do not do this for System, since that would remove references + to the originals of score-grobs, which get then GC'd (a bad + thing). */ + suicide (); } -/* - Note that we still want references to this element to be - rearranged, and not silently thrown away, so we keep pointers - like {broken_into_{drul,array}, original} +/* Note that we still want references to this element to be + rearranged, and not silently thrown away, so we keep pointers like + {broken_into_{drul, array}, original} */ void Grob::suicide () { - if (!live ()) - return; + if (!is_live ()) + return; + + for (int a = X_AXIS; a < NO_AXES; a++) + dim_cache_[a].clear (); -#if 0 // see below. - String nm = name (); -#endif - mutable_property_alist_ = SCM_EOL; + object_alist_ = SCM_EOL; immutable_property_alist_ = SCM_EOL; - - set_extent (SCM_EOL, Y_AXIS); - set_extent (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; - } - -#if 0 - /* - This can make debugging a little easier: we can still know what - the object used to be. However, since all its links have been - broken, it's usually more convenient to set a conditional - breakpoint in GDB before the property lists are wiped. - */ - mutable_property_alist_ = scm_acons (ly_symbol2scm ("name"), - scm_makfrom0str (nm.to_str0()), - mutable_property_alist_ - ); -#endif + interfaces_ = SCM_EOL; } void Grob::handle_prebroken_dependencies () { - /* - Don't do this in the derived method, since we want to keep access to - mutable_property_alist_ centralized. - */ - if (original_) + /* Don't do this in the derived method, since we want to keep access to + object_alist_ centralized. */ + if (original ()) { - Item * it = dynamic_cast (this); - substitute_mutable_properties (gh_int2scm (it->break_status_dir ()), - original_->mutable_property_alist_); + Item *it = dynamic_cast (this); + substitute_object_links (scm_from_int (it->break_status_dir ()), + original ()->object_alist_); } } -Grob* -Grob::find_broken_piece (System*) const +Grob * +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)); - else { - dim_cache_[a].offset_ += y; + 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; +} +/* Find the offset relative to D. If D equals THIS, then it is 0. + Otherwise, it recursively defd as -/* - Find the offset relative to D. If D equals THIS, then it is 0. - Otherwise, it recursively defd as - - OFFSET_ + PARENT_L_->relative_coordinate (D) -*/ + OFFSET_ + PARENT_L_->relative_coordinate (D) */ Real -Grob::relative_coordinate (Grob const*refp, Axis a) const +Grob::relative_coordinate (Grob const *refp, Axis a) const { if (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.) - - */ + /* 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); - else - return get_offset (a) + dim_cache_[a].parent_->relative_coordinate (refp, a); -} + return off; + + off += dim_cache_[a].parent_->relative_coordinate (refp, a); + return off; +} - -/* - Invoke callbacks to get offset relative to parent. -*/ +/* Invoke callbacks to get offset relative to parent. */ Real Grob::get_offset (Axis a) const { - 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_, gh_int2scm (l)); - SCM retval = gh_call2 (cb, self_scm (), gh_int2scm (a)); + if (dim_cache_[a].offset_) + return *dim_cache_[a].offset_; - Real r = gh_scm2double (retval); - if (isinf (r) || isnan (r)) - { - programming_error (INFINITY_MSG); - r = 0.0; - } - me->dim_cache_[a].offset_ +=r; + Grob *me = (Grob *) this; + + 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 ! (gh_pair_p (dim_cache_[a].dimension_) || - gh_procedure_p (dim_cache_[a].dimension_)); -} +/**************************************************************** + extents +****************************************************************/ -Interval -Grob::extent (Grob * refp, Axis a) const +void +Grob::flush_extent_cache (Axis axis) { - Real x = relative_coordinate (refp, a); - - - Dimension_cache * d = (Dimension_cache *)&dim_cache_[a]; - Interval ext ; - if (gh_pair_p (d->dimension_)) - ; - else if (gh_procedure_p (d->dimension_)) + if (dim_cache_[axis].extent_) { /* - FIXME: add doco on types, and should typecheck maybe? + Ugh, this is not accurate; will flush property, causing + callback to be called if. */ - d->dimension_= gh_call2 (d->dimension_, self_scm (), gh_int2scm (a)); + 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); } - else - return ext; - - if (!gh_pair_p (d->dimension_)) - return ext; - - ext = ly_scm2interval (d->dimension_); +} - SCM extra = get_property (a == X_AXIS - ? "extra-X-extent" - : "extra-Y-extent"); - /* - signs ? - */ - if (gh_pair_p (extra)) +Interval +Grob::extent (Grob *refp, Axis a) const +{ + Real offset = relative_coordinate (refp, a); + Interval real_ext; + if (dim_cache_[a].extent_) { - ext[BIGGER] += gh_scm2double (ly_cdr (extra)); - ext[SMALLER] += gh_scm2double (ly_car (extra)); + real_ext = *dim_cache_[a].extent_; } - - extra = get_property (a == X_AXIS - ? "minimum-X-extent" - : "minimum-Y-extent"); - if (gh_pair_p (extra)) + else { - ext.unite (Interval (gh_scm2double (ly_car (extra)), - gh_scm2double (ly_cdr (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); } - - ext.translate (x); - return ext; + real_ext.translate (offset); + + return real_ext; } -/* - Find the group-element which has both #this# and #s# -*/ -Grob * -Grob::common_refpoint (Grob const* s, Axis a) const +/**************************************************************** + 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. */ + /* 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_) + for (Grob const *d = s; d; d = d->dim_cache_[a].parent_) if (d == c) - return (Grob*)d; + return (Grob *) d; return 0; } - -Grob * -common_refpoint_of_list (SCM elist, Grob *common, Axis a) -{ - for (; gh_pair_p (elist); elist = ly_cdr (elist)) - { - Grob * s = unsmob_grob (ly_car (elist)); - if (!s) - continue; - 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--; ) - { - Grob * s = arr[i]; - if (!s) - continue; - - 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 = (gh_pair_p (nm)) ? ly_cdr (nm) : SCM_EOL; - return gh_symbol_p (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_ = gh_cons (cb, dim_cache_[a].offset_callbacks_); - dim_cache_[a].offsets_left_ ++; - } -} - -bool -Grob::has_extent_callback (SCM cb, Axis a)const +Grob::set_parent (Grob *g, Axis a) { - return scm_equal_p (cb, dim_cache_[a].dimension_) == SCM_BOOL_T; + dim_cache_[a].parent_ = g; } - -bool -Grob::has_offset_callback (SCM cb, Axis a)const +Grob * +Grob::get_parent (Axis a) const { - return scm_c_memq (cb, dim_cache_[a].offset_callbacks_) != SCM_BOOL_F; + return dim_cache_[a].parent_; } -void -Grob::set_extent (SCM dc, Axis a) -{ - dim_cache_[a].dimension_ =dc; -} void -Grob::set_parent (Grob *g, Axis a) -{ - dim_cache_[a].parent_ = g; -} - -MAKE_SCHEME_CALLBACK (Grob,fixup_refpoint,1); -SCM -Grob::fixup_refpoint (SCM smob) +Grob::fixup_refpoint () { - Grob *me = unsmob_grob (smob); - for (int a = X_AXIS; a < NO_AXES; a ++) + for (int a = X_AXIS; a < NO_AXES; a++) { Axis ax = (Axis)a; - Grob * parent = me->get_parent (ax); + Grob *parent = get_parent (ax); if (!parent) continue; - - if (parent->get_system () != me->get_system () && me->get_system ()) + + if (parent->get_system () != get_system () && get_system ()) { - Grob * newparent = parent->find_broken_piece (me->get_system ()); - me->set_parent (newparent, ax); + Grob *newparent = parent->find_broken_piece (get_system ()); + set_parent (newparent, ax); } - if (Item * i = dynamic_cast (me)) + if (Item *i = dynamic_cast (this)) { - Item *parenti = dynamic_cast (parent); + Item *parenti = dynamic_cast (parent); if (parenti && i) { - Direction my_dir = i->break_status_dir () ; - if (my_dir!= parenti->break_status_dir ()) + Direction my_dir = i->break_status_dir (); + if (my_dir != parenti->break_status_dir ()) { - Item *newparent = parenti->find_prebroken_piece (my_dir); - me->set_parent (newparent, ax); + Item *newparent = parenti->find_prebroken_piece (my_dir); + set_parent (newparent, ax); } } } } - return smob; } + +/**************************************************************** + MESSAGES +****************************************************************/ void -Grob::warning (String s)const +Grob::warning (string s) const { SCM cause = self_scm (); - while (Grob * g = unsmob_grob (cause)) - { - cause = g->get_property ("cause"); - } + while (Grob *g = unsmob_grob (cause)) + cause = g->get_property ("cause"); if (Music *m = unsmob_music (cause)) - { - m->origin ()->warning (s); - } + m->origin ()->warning (s); else ::warning (s); } -void -Grob::programming_error (String s)const + +string +Grob::name () const { - s = "Programming error: " + s; - warning (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 (); } +void +Grob::programming_error (string s) const +{ + SCM cause = self_scm (); + while (Grob *g = unsmob_grob (cause)) + cause = g->get_property ("cause"); -/**************************************************** - SMOB funcs - ****************************************************/ + s = _f ("programming error: %s", s); + if (Music *m = unsmob_music (cause)) + m->origin ()->message (s); + else + ::message (s); +} -IMPLEMENT_SMOBS (Grob); -IMPLEMENT_DEFAULT_EQUAL_P (Grob); +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. " + "\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 " + "before-line-breaking " + "cause " + "color " + "extra-X-extent " + "extra-Y-extent " + "extra-offset " + "interfaces " + "layer " + "meta " + "minimum-X-extent " + "minimum-Y-extent " + "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::mark_smob (SCM ses) +Grob::stencil_height (SCM smob) { - Grob * s = (Grob*) SCM_CELL_WORD_1 (ses); - scm_gc_mark (s->immutable_property_alist_); - - for (int a =0 ; a < 2; a++) - { - scm_gc_mark (s->dim_cache_[a].offset_callbacks_); - scm_gc_mark (s->dim_cache_[a].dimension_); - - /* - don't mark the parents. The pointers in the mutable property - list form two tree like structures (one for X relations, one - for Y relations). Marking these can be done in limited stack - space. If we add the parents, we will jump between X and Y in - an erratic manner, leading to much more recursion depth (and - core dumps if we link to pthreads.) - */ - } - - if (s->original_) - scm_gc_mark (s->original_->self_scm ()); - - s->do_derived_mark (); - return s->mutable_property_alist_; + Grob *me = unsmob_grob (smob); + return grob_stencil_extent (me, Y_AXIS); } -int -Grob::print_smob (SCM s, SCM port, scm_print_state *) +MAKE_SCHEME_CALLBACK(Grob, y_parent_positioning, 1); +SCM +Grob::y_parent_positioning (SCM smob) { - Grob *sc = (Grob *) ly_cdr (s); - - scm_puts ("#name ().to_str0 (), port); + Grob *me = unsmob_grob (smob); + Grob *par = me->get_parent (Y_AXIS); + if (par) + (void) par->get_property ("positioning-done"); - /* - don't try to print properties, that is too much hassle. - */ - scm_puts (" >", port); - return 1; + return scm_from_double (0.0); } + +MAKE_SCHEME_CALLBACK(Grob, x_parent_positioning, 1); SCM -Grob::do_derived_mark () const +Grob::x_parent_positioning (SCM smob) { - return SCM_EOL; -} - - + Grob *me = unsmob_grob (smob); + + Grob *par = me->get_parent (X_AXIS); + if (par) + (void) par->get_property ("positioning-done"); -void -Grob::discretionary_processing () -{ + return scm_from_double (0.0); } -bool -Grob::internal_has_interface (SCM k) +MAKE_SCHEME_CALLBACK (Grob, stencil_width, 1); +SCM +Grob::stencil_width (SCM smob) { - SCM ifs = get_property ("interfaces"); - - return scm_c_memq (k, ifs) != SCM_BOOL_F; + Grob *me = unsmob_grob (smob); + return grob_stencil_extent (me, X_AXIS); } -/** Return Array of Grobs in SCM list L */ -Link_array -ly_scm2grobs (SCM l) -{ - Link_array arr; - for (SCM s = l; gh_pair_p (s); s = gh_cdr (s)) - { - SCM e = gh_car (s); - arr.push (unsmob_grob (e)); - } +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; + } - arr.reverse (); - return arr; + return common; } -/** 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 = gh_cons (a[i-1]->self_scm (), s); +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 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)); -IMPLEMENT_TYPE_P (Grob, "ly:grob?"); - -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 " - "staff-symbol interfaces dependencies X-extent Y-extent extra-X-extent " - "meta layer before-line-breaking-callback " - "after-line-breaking-callback extra-Y-extent minimum-X-extent " - "minimum-Y-extent transparent"); - + return ext; +}