X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fgrob.cc;h=ff54ff54760f83829c5c41d450e641cf034bacf0;hb=7e72a1e50e94a7f9738d62599de79fe7745f600c;hp=ac075aba96851424bac3e0a22e19562a18abb43c;hpb=07a5ed85c189a97d04c550679826dfc5eca2eb18;p=lilypond.git diff --git a/lily/grob.cc b/lily/grob.cc index ac075aba96..ff54ff5476 100644 --- a/lily/grob.cc +++ b/lily/grob.cc @@ -1,33 +1,30 @@ /* - score-elem.cc -- implement Grob + grob.cc -- implement Grob source file of the GNU LilyPond music typesetter - (c) 1997--2000 Han-Wen Nienhuys + (c) 1997--2004 Han-Wen Nienhuys */ #include #include +#include "main.hh" #include "input-smob.hh" -#include "libc-extension.hh" +#include "warn.hh" #include "group-interface.hh" #include "misc.hh" #include "paper-score.hh" -#include "paper-def.hh" #include "molecule.hh" #include "grob.hh" -#include "debug.hh" +#include "warn.hh" #include "spanner.hh" -#include "line-of-score.hh" +#include "system.hh" #include "item.hh" -#include "paper-column.hh" #include "molecule.hh" #include "misc.hh" -#include "paper-outputter.hh" -#include "dimension-cache.hh" -#include "side-position-interface.hh" +#include "music.hh" #include "item.hh" #include "ly-smobs.icc" @@ -39,71 +36,112 @@ 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(SCM basicprops) +Grob::Grob (SCM basicprops) { /* fixme: default should be no callback. */ - - pscore_l_=0; - status_i_ = 0; - original_l_ = 0; + self_scm_ = SCM_EOL; + pscore_=0; + status_ = 0; + original_ = 0; 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 + + SCM meta = get_grob_property ("meta"); + if (gh_pair_p (meta)) + { + SCM ifs = scm_assoc (ly_symbol2scm ("interfaces"), meta); + + /* + Switch off interface checks for the moment. + */ + bool itc = internal_type_checking_global_b; + internal_type_checking_global_b = false; + internal_set_grob_property (ly_symbol2scm ("interfaces"), gh_cdr(ifs)); + internal_type_checking_global_b = itc; + } + + /* + 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*enames[] = {"X-extent-callback", "Y-extent-callback"}; - for (int a = X_AXIS; a <= Y_AXIS; a++){ - SCM l = get_grob_property (onames[a]); + for (int a = X_AXIS; a <= Y_AXIS; a++) + { + SCM l = get_grob_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"); - } + 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_grob_property (enames[a]); + SCM cb = get_grob_property (enames[a]); - /* - Should change default to be empty? - */ - if (!gh_procedure_p (cb) && !gh_pair_p (cb)) - cb = molecule_extent_proc; + /* + Should change default to be empty? + */ + if (cb != SCM_BOOL_F + && !gh_procedure_p (cb) && !gh_pair_p (cb) + && gh_procedure_p (get_grob_property ("molecule-callback")) + ) + cb = molecule_extent_proc; - dim_cache_[a].dimension_ = cb; - } + dim_cache_[a].dimension_ = cb; + } - SCM meta = get_grob_property ("meta"); - SCM ifs = scm_assoc (ly_symbol2scm ("interfaces"), meta); - - set_grob_property ("interfaces",gh_cdr (ifs)); } - Grob::Grob (Grob const&s) : dim_cache_ (s.dim_cache_) { - original_l_ =(Grob*) &s; + original_ = (Grob*) &s; + self_scm_ = SCM_EOL; + immutable_property_alist_ = s.immutable_property_alist_; mutable_property_alist_ = SCM_EOL; - status_i_ = s.status_i_; - pscore_l_ = s.pscore_l_; + /* + No properties are copied. That is the job of handle_broken_dependencies. + */ + + status_ = s.status_; + pscore_ = 0; smobify_self (); + +#ifdef HASHING_FOR_MUTABLE_PROPS + mutable_property_alist_ = scm_c_make_hash_table (HASH_SIZE); +#endif } -Grob::~Grob() +Grob::~Grob () { /* do nothing scm-ish and no unprotecting here. @@ -111,71 +149,7 @@ Grob::~Grob() } -SCM -Grob::get_grob_property (const char *nm) const -{ - SCM sym = ly_symbol2scm (nm); - return get_grob_property (sym); -} - -SCM -Grob::get_grob_property (SCM sym) const -{ - SCM s = scm_sloppy_assq(sym, mutable_property_alist_); - if (s != SCM_BOOL_F) - return gh_cdr (s); - - s = scm_sloppy_assq (sym, immutable_property_alist_); - return (s == SCM_BOOL_F) ? SCM_EOL : gh_cdr (s); -} - -/* - Remove the value associated with KEY, and return it. The result is - that a next call will yield SCM_UNDEFINED (and not the underlying - `basic' property. -*/ -SCM -Grob::remove_grob_property (const char* key) -{ - SCM val = get_grob_property (key); - if (val != SCM_EOL) - set_grob_property (key, SCM_EOL); - return val; -} - -void -Grob::set_grob_property (const char* k, SCM v) -{ - SCM s = ly_symbol2scm (k); - set_grob_property (s, v); -} - -/* - Puts the k, v in the immutable_property_alist_, which is convenient for - storing variables that are needed during the breaking process. (eg. - Line_of_score::rank : int ) - */ -void -Grob::set_immutable_grob_property (const char*k, SCM v) -{ - SCM s = ly_symbol2scm (k); - set_immutable_grob_property (s, v); -} - -void -Grob::set_immutable_grob_property (SCM s, SCM v) -{ - immutable_property_alist_ = gh_cons (gh_cons (s,v), mutable_property_alist_); - mutable_property_alist_ = scm_assq_remove_x (mutable_property_alist_, s); -} -void -Grob::set_grob_property (SCM s, SCM v) -{ - mutable_property_alist_ = scm_assq_set_x (mutable_property_alist_, s, v); -} - - -MAKE_SCHEME_CALLBACK(Grob,molecule_extent,2); +MAKE_SCHEME_CALLBACK (Grob,molecule_extent,2); SCM Grob::molecule_extent (SCM element_smob, SCM scm_axis) { @@ -185,12 +159,11 @@ Grob::molecule_extent (SCM element_smob, SCM scm_axis) Molecule *m = s->get_molecule (); Interval e ; if (m) - e = m->extent(a); - return ly_interval2scm ( e); + e = m->extent (a); + return ly_interval2scm (e); } -MAKE_SCHEME_CALLBACK(Grob,preset_extent,2); - +MAKE_SCHEME_CALLBACK (Grob,preset_extent,2); SCM Grob::preset_extent (SCM element_smob, SCM scm_axis) { @@ -198,73 +171,75 @@ Grob::preset_extent (SCM element_smob, SCM scm_axis) Axis a = (Axis) gh_scm2int (scm_axis); SCM ext = s->get_grob_property ((a == X_AXIS) - ? "extent-X" - : "extent-Y"); - - if (gh_pair_p (ext)) - { - Real l = gh_scm2double (gh_car (ext)); - Real r = gh_scm2double (gh_cdr (ext)); - return ly_interval2scm (Interval (l, r)); - } - - return ly_interval2scm ( Interval ()); + ? "X-extent" + : "Y-extent"); + + if (is_number_pair (ext)) + return ext; + else + return ly_interval2scm (Interval()); } Paper_def* -Grob::paper_l () const +Grob::get_paper () const { - return pscore_l_ ? pscore_l_->paper_l_ : 0; + return pscore_ ? pscore_->paper_ : 0; } void Grob::calculate_dependencies (int final, int busy, SCM funcname) { - assert (status_i_ >=0); - - if (status_i_ >= final) + if (status_ >= final) return; - if (status_i_== busy) + if (status_== busy) { programming_error ("Element is busy, come back later"); return; } - status_i_= busy; + status_= busy; - for (SCM d= get_grob_property ("dependencies"); gh_pair_p (d); d = gh_cdr (d)) + for (SCM d = get_grob_property ("dependencies"); gh_pair_p (d); + d = ly_cdr (d)) { - unsmob_grob (gh_car (d)) + unsmob_grob (ly_car (d)) ->calculate_dependencies (final, busy, funcname); } - // ughugh. - String s = ly_symbol2string (funcname); - SCM proc = get_grob_property (s.ch_C()); + + SCM proc = internal_get_grob_property (funcname); if (gh_procedure_p (proc)) gh_call1 (proc, this->self_scm ()); - - status_i_= final; - + + status_= final; } Molecule * Grob::get_molecule () const { + if (!live()) + { + return 0; + } + SCM mol = get_grob_property ("molecule"); if (unsmob_molecule (mol)) return unsmob_molecule (mol); - mol = get_uncached_molecule (); + mol = get_uncached_molecule (); - Grob *me = (Grob*)this; - me->set_grob_property ("molecule", mol); + if (live ()) + { + Grob *me = (Grob*)this; + me->set_grob_property ("molecule", mol); + } return unsmob_molecule (mol); } + SCM Grob::get_uncached_molecule ()const { @@ -272,31 +247,33 @@ Grob::get_uncached_molecule ()const SCM mol = SCM_EOL; if (gh_procedure_p (proc)) - mol = gh_apply (proc, gh_list (this->self_scm (), SCM_UNDEFINED)); - + mol = gh_apply (proc, scm_list_n (this->self_scm (), SCM_UNDEFINED)); Molecule *m = unsmob_molecule (mol); if (unsmob_molecule (mol)) { - /* - TODO: add option for not copying origin info. - */ - SCM origin =get_grob_property ("origin"); - if (!unsmob_input (origin)) - origin =ly_symbol2scm ("no-origin"); - + SCM origin = ly_symbol2scm ("no-origin"); + if (store_locations_global_b) + { + SCM cause = get_grob_property ("cause"); + if (Music*m = unsmob_music (cause)) + { + SCM music_origin = m->get_mus_property ("origin"); + if (unsmob_input (music_origin)) + origin = music_origin; + } + } + // ugr. mol = Molecule (m->extent_box (), - gh_list (origin, m->get_expr (), SCM_UNDEFINED) + scm_list_n (origin, m->get_expr (), SCM_UNDEFINED) ). smobbed_copy (); m = unsmob_molecule (mol); } - - /* transparent retains dimensions of element. @@ -313,17 +290,12 @@ Grob::get_uncached_molecule ()const */ void -Grob::do_break_processing() +Grob::do_break_processing () { } - - - - - -Line_of_score * -Grob::line_l() const +System * +Grob::get_system () const { return 0; } @@ -333,126 +305,46 @@ Grob::add_dependency (Grob*e) { if (e) { - Pointer_group_interface ::add_element (this, "dependencies",e); - + Pointer_group_interface::add_grob (this, ly_symbol2scm ("dependencies"),e); } else programming_error ("Null dependency added"); } - - -/** - Do break substitution in S, using CRITERION. Return new value. - CRITERION is either a SMOB pointer to the desired line, or a number - representing the break direction. Do not modify SRC. -*/ -SCM -Grob::handle_broken_smobs (SCM src, SCM criterion) -{ - again: - Grob *sc = unsmob_grob (src); - if (sc) - { - if (gh_number_p (criterion)) - { - Item * i = dynamic_cast (sc); - Direction d = to_dir (criterion); - if (i && i->break_status_dir () != d) - { - Item *br = i->find_prebroken_piece (d); - return (br) ? br->self_scm () : SCM_UNDEFINED; - } - } - else - { - Line_of_score * line - = dynamic_cast (unsmob_grob (criterion)); - if (sc->line_l () != line) - { - sc = sc->find_broken_piece (line); - - } - - /* now: !sc || (sc && sc->line_l () == line) */ - if (!sc) - return SCM_UNDEFINED; - - /* now: sc && sc->line_l () == line */ - if (!line - || (sc->common_refpoint (line, X_AXIS) - && sc->common_refpoint (line, Y_AXIS))) - { - return sc->self_scm (); - } - return SCM_UNDEFINED; - } - } - else if (gh_pair_p (src)) - { - SCM oldcar =gh_car (src); - /* - UGH! breaks on circular lists. - */ - SCM newcar = handle_broken_smobs (oldcar, criterion); - SCM oldcdr = gh_cdr (src); - - if (newcar == SCM_UNDEFINED - && (gh_pair_p (oldcdr) || oldcdr == SCM_EOL)) - { - /* - This is tail-recursion, ie. - - return handle_broken_smobs (cdr, criterion); - - We don't want to rely on the compiler to do this. Without - tail-recursion, this easily crashes with a stack overflow. */ - src = oldcdr; - goto again; - } - - SCM newcdr = handle_broken_smobs (oldcdr, criterion); - return gh_cons (newcar, newcdr); - } - else - return src; - - return src; -} - void -Grob::handle_broken_dependencies() +Grob::handle_broken_dependencies () { - Spanner * s= dynamic_cast (this); - if (original_l_ && s) + Spanner * sp = dynamic_cast (this); + if (original_ && sp) return; - if (s) + if (sp) { - for (int i = 0; i< s->broken_into_l_arr_ .size (); i++) + /* + 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)) { - Grob * sc = s->broken_into_l_arr_[i]; - Line_of_score * l = sc->line_l (); - sc->mutable_property_alist_ = - handle_broken_smobs (mutable_property_alist_, - l ? l->self_scm () : SCM_UNDEFINED); + sp->substitute_one_mutable_property (gh_caar (s), + gh_cdar (s)); } } + System *system = get_system (); - Line_of_score *line = line_l(); - - if (line && common_refpoint (line, X_AXIS) && common_refpoint (line, Y_AXIS)) + if (live () + && system && common_refpoint (system, X_AXIS) && common_refpoint (system, Y_AXIS)) { - mutable_property_alist_ - = handle_broken_smobs (mutable_property_alist_, - line ? line->self_scm () : SCM_UNDEFINED); + substitute_mutable_properties (system ? system->self_scm () : SCM_UNDEFINED, + mutable_property_alist_); } - else if (dynamic_cast (this)) + else if (dynamic_cast (this)) { - mutable_property_alist_ = handle_broken_smobs (mutable_property_alist_, - SCM_UNDEFINED); + substitute_mutable_properties (SCM_UNDEFINED, mutable_property_alist_); } else { @@ -460,11 +352,12 @@ Grob::handle_broken_dependencies() This element is `invalid'; it has been removed from all dependencies, so let's junk the element itself. - do not do this for Line_of_score, since that would remove - references to the originals of score-elts, which get then GC'd - (a bad thing.) + 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(); + suicide (); } } @@ -476,41 +369,81 @@ Grob::handle_broken_dependencies() void Grob::suicide () { + if (!live ()) + return; + +#if 0 // see below. + String nm = name(); +#endif + mutable_property_alist_ = SCM_EOL; immutable_property_alist_ = SCM_EOL; - set_extent_callback (SCM_EOL, Y_AXIS); - set_extent_callback (SCM_EOL, X_AXIS); + 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 } void -Grob::handle_prebroken_dependencies() +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_) + { + Item * it = dynamic_cast (this); + substitute_mutable_properties (gh_int2scm (it->break_status_dir ()), + original_->mutable_property_alist_); + } } Grob* -Grob::find_broken_piece (Line_of_score*) const +Grob::find_broken_piece (System*) const { return 0; } +/* + translate in one direction +*/ void Grob::translate_axis (Real y, Axis a) { if (isinf (y) || isnan (y)) - programming_error (_(INFINITY_MSG)); + programming_error (_ (INFINITY_MSG)); 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 + + OFFSET_ + PARENT_L_->relative_coordinate (D) +*/ Real Grob::relative_coordinate (Grob const*refp, Axis a) const { @@ -522,12 +455,17 @@ Grob::relative_coordinate (Grob const*refp, Axis a) const not ask for the absolute coordinate (ie. REFP == nil.) */ - if (refp == dim_cache_[a].parent_l_) + if (refp == dim_cache_[a].parent_) return get_offset (a); else - return get_offset (a) + dim_cache_[a].parent_l_->relative_coordinate (refp, a); + return get_offset (a) + dim_cache_[a].parent_->relative_coordinate (refp, a); } + + +/* + Invoke callbacks to get offset relative to parent. +*/ Real Grob::get_offset (Axis a) const { @@ -550,27 +488,20 @@ Grob::get_offset (Axis a) const } -MAKE_SCHEME_CALLBACK(Grob,point_dimension_callback,2); +MAKE_SCHEME_CALLBACK (Grob,point_dimension_callback,2); SCM -Grob::point_dimension_callback (SCM , SCM ) +Grob::point_dimension_callback (SCM , SCM) { - return ly_interval2scm ( Interval (0,0)); + return ly_interval2scm (Interval (0,0)); } bool -Grob::empty_b (Axis a)const +Grob::is_empty (Axis a)const { - return ! (gh_pair_p (dim_cache_[a].dimension_ ) || - gh_procedure_p (dim_cache_[a].dimension_ )); + return ! (gh_pair_p (dim_cache_[a].dimension_) || + gh_procedure_p (dim_cache_[a].dimension_)); } -/* - TODO: add - - Grob *refpoint - - to arguments? - */ Interval Grob::extent (Grob * refp, Axis a) const { @@ -586,7 +517,7 @@ Grob::extent (Grob * refp, Axis a) const /* FIXME: add doco on types, and should typecheck maybe? */ - d->dimension_= gh_call2 (d->dimension_, self_scm(), gh_int2scm (a)); + d->dimension_= gh_call2 (d->dimension_, self_scm (), gh_int2scm (a)); } else return ext; @@ -597,25 +528,25 @@ Grob::extent (Grob * refp, Axis a) const ext = ly_scm2interval (d->dimension_); SCM extra = get_grob_property (a == X_AXIS - ? "extra-extent-X" - : "extra-extent-Y"); + ? "extra-X-extent" + : "extra-Y-extent"); /* signs ? */ if (gh_pair_p (extra)) { - ext[BIGGER] += gh_scm2double (gh_cdr (extra)); - ext[SMALLER] += gh_scm2double (gh_car (extra)); + ext[BIGGER] += gh_scm2double (ly_cdr (extra)); + ext[SMALLER] += gh_scm2double (ly_car (extra)); } extra = get_grob_property (a == X_AXIS - ? "minimum-extent-X" - : "minimum-extent-Y"); + ? "minimum-X-extent" + : "minimum-Y-extent"); if (gh_pair_p (extra)) { - ext.unite (Interval (gh_scm2double (gh_car (extra)), - gh_scm2double (gh_cdr (extra)))); + ext.unite (Interval (gh_scm2double (ly_car (extra)), + gh_scm2double (ly_cdr (extra)))); } ext.translate (x); @@ -623,13 +554,9 @@ Grob::extent (Grob * refp, Axis a) const return ext; } - -Grob* -Grob::parent_l (Axis a) const -{ - return dim_cache_[a].parent_l_; -} - +/* + Find the group-element which has both #this# and #s# +*/ Grob * Grob::common_refpoint (Grob const* s, Axis a) const { @@ -637,8 +564,8 @@ 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_l_) - for (Grob const * d = s; d; d = d->dim_cache_[a].parent_l_) + 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; @@ -647,14 +574,37 @@ Grob::common_refpoint (Grob const* s, Axis a) const Grob * -Grob::common_refpoint (SCM elist, Axis a) const +common_refpoint_of_list (SCM elist, Grob *common, Axis a) { - Grob * common = (Grob*) this; - for (; gh_pair_p (elist); elist = gh_cdr (elist)) + for (; gh_pair_p (elist); elist = ly_cdr (elist)) { - Grob * s = unsmob_grob (gh_car (elist)); - if (s) + 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; @@ -665,8 +615,8 @@ Grob::name () const { SCM meta = get_grob_property ("meta"); SCM nm = scm_assoc (ly_symbol2scm ("name"), meta); - nm = (gh_pair_p (nm)) ? gh_cdr (nm) : SCM_EOL; - return gh_string_p (nm) ?ly_scm2string (nm) : classname (this); + nm = (gh_pair_p (nm)) ? ly_cdr (nm) : SCM_EOL; + return gh_symbol_p (nm) ? ly_symbol2string (nm) : classname (this); } void @@ -674,7 +624,7 @@ Grob::add_offset_callback (SCM cb, Axis a) { if (!has_offset_callback_b (cb, a)) { - dim_cache_[a].offset_callbacks_ = gh_cons (cb, dim_cache_[a].offset_callbacks_ ); + dim_cache_[a].offset_callbacks_ = gh_cons (cb, dim_cache_[a].offset_callbacks_); dim_cache_[a].offsets_left_ ++; } } @@ -682,16 +632,10 @@ Grob::add_offset_callback (SCM cb, Axis a) bool Grob::has_extent_callback_b (SCM cb, Axis a)const { - return scm_equal_p (cb, dim_cache_[a].dimension_); + return scm_equal_p (cb, dim_cache_[a].dimension_) == SCM_BOOL_T; } -bool -Grob::has_extent_callback_b (Axis a) const -{ - return gh_procedure_p (dim_cache_[a].dimension_); -} - bool Grob::has_offset_callback_b (SCM cb, Axis a)const { @@ -699,7 +643,7 @@ Grob::has_offset_callback_b (SCM cb, Axis a)const } void -Grob::set_extent_callback (SCM dc, Axis a) +Grob::set_extent (SCM dc, Axis a) { dim_cache_[a].dimension_ =dc; } @@ -707,10 +651,10 @@ Grob::set_extent_callback (SCM dc, Axis a) void Grob::set_parent (Grob *g, Axis a) { - dim_cache_[a].parent_l_ = g; + dim_cache_[a].parent_ = g; } -MAKE_SCHEME_CALLBACK(Grob,fixup_refpoint,1); +MAKE_SCHEME_CALLBACK (Grob,fixup_refpoint,1); SCM Grob::fixup_refpoint (SCM smob) { @@ -718,14 +662,14 @@ Grob::fixup_refpoint (SCM smob) for (int a = X_AXIS; a < NO_AXES; a ++) { Axis ax = (Axis)a; - Grob * parent = me->parent_l (ax); + Grob * parent = me->get_parent (ax); if (!parent) continue; - if (parent->line_l () != me->line_l () && me->line_l ()) + if (parent->get_system () != me->get_system () && me->get_system ()) { - Grob * newparent = parent->find_broken_piece (me->line_l ()); + Grob * newparent = parent->find_broken_piece (me->get_system ()); me->set_parent (newparent, ax); } @@ -736,7 +680,7 @@ Grob::fixup_refpoint (SCM smob) if (parenti && i) { Direction my_dir = i->break_status_dir () ; - if (my_dir!= parenti->break_status_dir()) + if (my_dir!= parenti->break_status_dir ()) { Item *newparent = parenti->find_prebroken_piece (my_dir); me->set_parent (newparent, ax); @@ -747,6 +691,29 @@ Grob::fixup_refpoint (SCM smob) return smob; } +void +Grob::warning (String s)const +{ + SCM cause = self_scm(); + while (Grob * g = unsmob_grob (cause)) + { + cause = g->get_grob_property ("cause"); + } + + if (Music *m = unsmob_music (cause)) + { + m->origin()->warning (s); + } + else + ::warning (s); +} + +void +Grob::programming_error (String s)const +{ + s = "Programming error: " + s; + warning (s); +} /**************************************************** @@ -754,40 +721,45 @@ Grob::fixup_refpoint (SCM smob) ****************************************************/ -IMPLEMENT_UNSMOB(Grob, grob); -IMPLEMENT_SMOBS(Grob); -IMPLEMENT_DEFAULT_EQUAL_P(Grob); + +IMPLEMENT_SMOBS (Grob); +IMPLEMENT_DEFAULT_EQUAL_P (Grob); SCM Grob::mark_smob (SCM ses) { - Grob * s = (Grob*) SCM_CELL_WORD_1(ses); + Grob * s = (Grob*) SCM_CELL_WORD_1 (ses); scm_gc_mark (s->immutable_property_alist_); - scm_gc_mark (s->mutable_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->parent_l (Y_AXIS)) - scm_gc_mark (s->parent_l (Y_AXIS)->self_scm ()); - if (s->parent_l (X_AXIS)) - scm_gc_mark (s->parent_l (X_AXIS)->self_scm ()); + if (s->original_) + scm_gc_mark (s->original_->self_scm ()); - if (s->original_l_) - scm_gc_mark (s->original_l_->self_scm ()); - return s->do_derived_mark (); + s->do_derived_mark (); + return s->mutable_property_alist_; } int Grob::print_smob (SCM s, SCM port, scm_print_state *) { - Grob *sc = (Grob *) gh_cdr (s); + Grob *sc = (Grob *) ly_cdr (s); scm_puts ("#name ().ch_C(), port); + scm_puts ((char *)sc->name ().to_str0 (), port); /* don't try to print properties, that is too much hassle. @@ -797,102 +769,89 @@ Grob::print_smob (SCM s, SCM port, scm_print_state *) } SCM -Grob::do_derived_mark () +Grob::do_derived_mark () const { return SCM_EOL; } -SCM -ly_set_grob_property (SCM elt, SCM sym, SCM val) -{ - Grob * sc = unsmob_grob (elt); - - if (!gh_symbol_p (sym)) - { - error ("Not a symbol"); - ly_display_scm (sym); - return SCM_UNSPECIFIED; - } - - if (sc) - { - sc->set_grob_property (sym, val); - } - else - { - error ("Not a score element"); - ly_display_scm (elt); - } - - return SCM_UNSPECIFIED; -} - - -SCM -ly_get_grob_property (SCM elt, SCM sym) -{ - Grob * sc = unsmob_grob (elt); - - if (sc) - { - return sc->get_grob_property (sym); - } - else - { - error ("Not a score element"); - ly_display_scm (elt); - } - return SCM_UNSPECIFIED; -} - void -Grob::discretionary_processing() +Grob::discretionary_processing () { } - - -SCM -spanner_get_bound (SCM slur, SCM dir) -{ - return dynamic_cast (unsmob_grob (slur))->get_bound (to_dir (dir))->self_scm (); -} - - - -static SCM interfaces_sym; -static void -init_functions () -{ - interfaces_sym = scm_permanent_object (ly_symbol2scm ("interfaces")); - - scm_make_gsubr ("ly-get-elt-property", 2, 0, 0, (Scheme_function_unknown)ly_get_grob_property); - scm_make_gsubr ("ly-set-elt-property", 3, 0, 0, (Scheme_function_unknown)ly_set_grob_property); - scm_make_gsubr ("ly-get-spanner-bound", 2 , 0, 0, (Scheme_function_unknown) spanner_get_bound); -} - bool -Grob::has_interface (SCM k) +Grob::internal_has_interface (SCM k) { - SCM ifs = get_grob_property (interfaces_sym); + SCM ifs = get_grob_property ("interfaces"); return scm_memq (k, ifs) != SCM_BOOL_F; } -void -Grob::set_interface (SCM k) + +/** Return Array of Grobs in SCM list L */ +Link_array +ly_scm2grobs (SCM l) { - if (has_interface (k)) - return ; - else + Link_array arr; + + for (SCM s = l; gh_pair_p (s); s = gh_cdr (s)) { - set_grob_property (interfaces_sym, - gh_cons (k, get_grob_property (interfaces_sym))); + SCM e = gh_car (s); + arr.push (unsmob_grob (e)); } + + arr.reverse (); + return arr; } +/** 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); + + return s; +} + + +IMPLEMENT_TYPE_P (Grob, "ly:grob?"); + +ADD_INTERFACE (Grob, "grob-interface", + "In music notation, lots of symbols are related in some way. You can\n" +"think of music notation as a graph where nodes are formed by the\n" +"symbols, and the arcs by their relations. A grob is a node in that\n" +"graph. The directed edges in the graph are formed by references to\n" +"other grobs (i.e. pointers). This big graph of grobs specifies the\n" +"notation problem. The solution of this problem is a description of the\n" +"printout in closed form, i.e. a list of values. These values are\n" +"Molecules.\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-grob.\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" +, + "X-offset-callbacks Y-offset-callbacks X-extent-callback molecule cause " +"Y-extent-callback molecule-callback 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"); + -ADD_SCM_INIT_FUNC(scoreelt, init_functions); -IMPLEMENT_TYPE_P(Grob, "ly-grob?");