X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fgrob.cc;h=b1e6324a943a7f7904f12ff08dd488e8e0eccc99;hb=da66c77772050eccbb972538c2cf9f6ec76018b4;hp=94758b7990073928724da25a630f5e49b1cf6d4f;hpb=352fd1005d930ced9e8631cd69f6ce439ceff512;p=lilypond.git diff --git a/lily/grob.cc b/lily/grob.cc index 94758b7990..b1e6324a94 100644 --- a/lily/grob.cc +++ b/lily/grob.cc @@ -3,7 +3,7 @@ source file of the GNU LilyPond music typesetter - (c) 1997--2002 Han-Wen Nienhuys + (c) 1997--2004 Han-Wen Nienhuys */ @@ -12,21 +12,18 @@ #include "main.hh" #include "input-smob.hh" - +#include "warn.hh" #include "group-interface.hh" #include "misc.hh" #include "paper-score.hh" -#include "paper-def.hh" -#include "molecule.hh" +#include "stencil.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 "stencil.hh" #include "misc.hh" -#include "paper-outputter.hh" #include "music.hh" #include "item.hh" @@ -39,7 +36,8 @@ 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) @@ -47,15 +45,39 @@ Grob::Grob (SCM basicprops) /* fixme: default should be no callback. */ - - pscore_l_=0; - status_c_ = 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_property ("meta"); + if (ly_c_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_property (ly_symbol2scm ("interfaces"), ly_cdr (ifs)); + internal_type_checking_global_b = itc; + } + /* TODO: @@ -64,11 +86,12 @@ Grob::Grob (SCM basicprops) 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_grob_property (onames[a]); + SCM l = get_property (onames[a]); if (scm_ilength (l) >=0) { @@ -80,37 +103,45 @@ Grob::Grob (SCM basicprops) programming_error ("[XY]-offset-callbacks must be a list"); } - SCM cb = get_grob_property (enames[a]); - + SCM cb = get_property (enames[a]); + SCM xt = get_property (xnames[a]); + /* - Should change default to be empty? + Should change default to empty? */ - if (cb != SCM_BOOL_F && !gh_procedure_p (cb) && !gh_pair_p (cb)) - cb = molecule_extent_proc; + if (is_number_pair (xt)) + cb = xt; + else if (cb != SCM_BOOL_F + && !ly_c_procedure_p (cb) && !ly_c_pair_p (cb) + && ly_c_procedure_p (get_property ("print-function"))) + cb = stencil_extent_proc; dim_cache_[a].dimension_ = cb; } - SCM meta = get_grob_property ("meta"); - if (gh_pair_p (meta)) - { - SCM ifs = scm_assoc (ly_symbol2scm ("interfaces"), meta); - - set_grob_property ("interfaces",ly_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_c_ = s.status_c_; - 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 () @@ -121,197 +152,118 @@ Grob::~Grob () } +MAKE_SCHEME_CALLBACK (Grob,stencil_extent,2); SCM -Grob::internal_get_grob_property (SCM sym) const -{ - SCM s = scm_sloppy_assq (sym, mutable_property_alist_); - if (s != SCM_BOOL_F) - return ly_cdr (s); - - s = scm_sloppy_assq (sym, immutable_property_alist_); - return (s == SCM_BOOL_F) ? SCM_EOL : ly_cdr (s); -} - -/* - Remove the value associated with KEY, and return it. The result is - that a next call will yield SCM_EOL (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; -} - - -#if 0 -/* - Puts the k, v in the immutable_property_alist_, which is convenient for - storing variables that are needed during the breaking process. (eg. - System::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); -} -#endif - -void -Grob::internal_set_grob_property (SCM s, SCM v) -{ -#ifndef NDEBUG - if (internal_type_checking_global_b) - assert (type_check_assignment (s, v, ly_symbol2scm ("backend-type?"))); -#endif - - - mutable_property_alist_ = scm_assq_set_x (mutable_property_alist_, s, v); -} - - -MAKE_SCHEME_CALLBACK (Grob,molecule_extent,2); -SCM -Grob::molecule_extent (SCM element_smob, SCM scm_axis) +Grob::stencil_extent (SCM element_smob, SCM scm_axis) { Grob *s = unsmob_grob (element_smob); - Axis a = (Axis) gh_scm2int (scm_axis); + Axis a = (Axis) ly_scm2int (scm_axis); - Molecule *m = s->get_molecule (); + Stencil *m = s->get_stencil (); Interval e ; if (m) e = m->extent (a); return ly_interval2scm (e); } -MAKE_SCHEME_CALLBACK (Grob,preset_extent,2); - -SCM -Grob::preset_extent (SCM element_smob, SCM scm_axis) -{ - Grob *s = unsmob_grob (element_smob); - 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 (ly_car (ext)); - Real r = gh_scm2double (ly_cdr (ext)); - return ly_interval2scm (Interval (l, r)); - } - - 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) { - if (status_c_ >= final) + if (status_ >= final) return; - if (status_c_== busy) + if (status_== busy) { programming_error ("Element is busy, come back later"); return; } - status_c_= busy; + status_= busy; - for (SCM d = get_grob_property ("dependencies"); gh_pair_p (d); + for (SCM d = get_property ("dependencies"); ly_c_pair_p (d); d = ly_cdr (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 ()); - if (gh_procedure_p (proc)) - gh_call1 (proc, this->self_scm ()); - else if (gh_list_p (proc)) - for (SCM i = proc; gh_pair_p (i); i = ly_cdr (i)) - gh_call1 (ly_car (i), this->self_scm ()); - status_c_= final; + SCM proc = internal_get_property (funcname); + if (ly_c_procedure_p (proc)) + scm_call_1 (proc, this->self_scm ()); + + status_= final; } -Molecule * -Grob::get_molecule () const +Stencil * +Grob::get_stencil () const { - SCM mol = get_grob_property ("molecule"); - if (unsmob_molecule (mol)) - return unsmob_molecule (mol); + if (!live ()) + { + return 0; + } + + SCM mol = get_property ("stencil"); + if (unsmob_stencil (mol)) + return unsmob_stencil (mol); - mol = get_uncached_molecule (); + mol = get_uncached_stencil (); - Grob *me = (Grob*)this; - me->set_grob_property ("molecule", mol); + if (live ()) + { + Grob *me = (Grob*)this; + me->set_property ("stencil", mol); + } - return unsmob_molecule (mol); + return unsmob_stencil (mol); } + SCM -Grob::get_uncached_molecule ()const +Grob::get_uncached_stencil ()const { - SCM proc = get_grob_property ("molecule-callback"); + SCM proc = get_property ("print-function"); SCM mol = SCM_EOL; - if (gh_procedure_p (proc)) - mol = gh_apply (proc, scm_list_n (this->self_scm (), SCM_UNDEFINED)); - + if (ly_c_procedure_p (proc)) + mol = scm_apply_0 (proc, scm_list_n (this->self_scm (), SCM_UNDEFINED)); - Molecule *m = unsmob_molecule (mol); + Stencil *m = unsmob_stencil (mol); - if (unsmob_molecule (mol)) + if (unsmob_stencil (mol)) { 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; - } + if (store_locations_global_b) + { + 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; + } } // ugr. - mol = Molecule (m->extent_box (), - scm_list_n (origin, m->get_expr (), SCM_UNDEFINED) + mol = Stencil (m->extent_box (), + scm_list_n (origin, m->expr (), SCM_UNDEFINED) ). smobbed_copy (); - m = unsmob_molecule (mol); + m = unsmob_stencil (mol); } /* transparent retains dimensions of element. */ - if (m && to_boolean (get_grob_property ("transparent"))) - mol = Molecule (m->extent_box (), SCM_EOL).smobbed_copy (); + if (m && to_boolean (get_property ("transparent"))) + mol = Stencil (m->extent_box (), SCM_EOL).smobbed_copy (); return mol; } @@ -326,13 +278,8 @@ Grob::do_break_processing () { } - - - - - System * -Grob::line_l () const +Grob::get_system () const { return 0; } @@ -349,129 +296,39 @@ Grob::add_dependency (Grob*e) } - - -/** - 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. - - It is rather tightly coded, since it takes a lot of time; it is - one of the top functions in the profile. - -*/ -SCM -Grob::handle_broken_grobs (SCM src, SCM criterion) -{ - again: - Grob *sc = unsmob_grob (src); - if (sc) - { - if (SCM_INUMP (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 - { - System * 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) - return sc->self_scm(); - /* - This was introduced in 1.3.49 as a measure to prevent - programming errors. It looks expensive (?). TODO: - benchmark , document when (what kind of programming - errors) this happens. - */ - if (sc->common_refpoint (line, X_AXIS) - && sc->common_refpoint (line, Y_AXIS)) - { - return sc->self_scm (); - } - return SCM_UNDEFINED; - } - } - else if (ly_pair_p (src)) // SCM_CONSP (src)) // huh? - { - SCM oldcar =ly_car (src); - /* - UGH! breaks on circular lists. - */ - SCM newcar = handle_broken_grobs (oldcar, criterion); - SCM oldcdr = ly_cdr (src); - - if (newcar == SCM_UNDEFINED - && (gh_pair_p (oldcdr) || oldcdr == SCM_EOL)) - { - /* - This is tail-recursion, ie. - - return handle_broken_grobs (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_grobs (oldcdr, criterion); - return scm_cons (newcar, newcdr); - } - else - return src; - - return src; -} - void 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_; ly_c_pair_p (s); + s = ly_cdr (s)) { - Grob * sc = s->broken_into_l_arr_[i]; - System * l = sc->line_l (); - sc->mutable_property_alist_ = - handle_broken_grobs (mutable_property_alist_, - l ? l->self_scm () : SCM_UNDEFINED); + sp->substitute_one_mutable_property (ly_caar (s), + ly_cdar (s)); } } + System *system = get_system (); - System *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_grobs (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)) { - mutable_property_alist_ = handle_broken_grobs (mutable_property_alist_, - SCM_UNDEFINED); + substitute_mutable_properties (SCM_UNDEFINED, mutable_property_alist_); } else { @@ -479,9 +336,10 @@ 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 System, 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 (); } @@ -495,22 +353,52 @@ 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 () { + /* + 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 (scm_int2num (it->break_status_dir ()), + original_->mutable_property_alist_); + } } Grob* @@ -519,6 +407,9 @@ Grob::find_broken_piece (System*) const return 0; } +/* + translate in one direction +*/ void Grob::translate_axis (Real y, Axis a) { @@ -530,6 +421,13 @@ Grob::translate_axis (Real y, Axis a) } } + +/* + 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 { @@ -541,12 +439,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 { @@ -554,10 +457,10 @@ Grob::get_offset (Axis a) const 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)); + 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 = gh_scm2double (retval); + Real r = ly_scm2double (retval); if (isinf (r) || isnan (r)) { programming_error (INFINITY_MSG); @@ -569,27 +472,13 @@ Grob::get_offset (Axis a) const } -MAKE_SCHEME_CALLBACK (Grob,point_dimension_callback,2); -SCM -Grob::point_dimension_callback (SCM , SCM) -{ - 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 ! (ly_c_pair_p (dim_cache_[a].dimension_) || + ly_c_procedure_p (dim_cache_[a].dimension_)); } -/* - TODO: add - - Grob *refpoint - - to arguments? - */ Interval Grob::extent (Grob * refp, Axis a) const { @@ -598,43 +487,43 @@ Grob::extent (Grob * refp, Axis a) const Dimension_cache * d = (Dimension_cache *)&dim_cache_[a]; Interval ext ; - if (gh_pair_p (d->dimension_)) + if (ly_c_pair_p (d->dimension_)) ; - else if (gh_procedure_p (d->dimension_)) + else if (ly_c_procedure_p (d->dimension_)) { /* FIXME: add doco on types, and should typecheck maybe? */ - d->dimension_= gh_call2 (d->dimension_, self_scm (), gh_int2scm (a)); + d->dimension_= scm_call_2 (d->dimension_, self_scm (), scm_int2num (a)); } else return ext; - if (!gh_pair_p (d->dimension_)) + if (!ly_c_pair_p (d->dimension_)) return ext; ext = ly_scm2interval (d->dimension_); - SCM extra = get_grob_property (a == X_AXIS - ? "extra-extent-X" - : "extra-extent-Y"); + SCM extra = get_property (a == X_AXIS + ? "extra-X-extent" + : "extra-Y-extent"); /* signs ? */ - if (gh_pair_p (extra)) + if (ly_c_pair_p (extra)) { - ext[BIGGER] += gh_scm2double (ly_cdr (extra)); - ext[SMALLER] += gh_scm2double (ly_car (extra)); + ext[BIGGER] += ly_scm2double (ly_cdr (extra)); + ext[SMALLER] += ly_scm2double (ly_car (extra)); } - extra = get_grob_property (a == X_AXIS - ? "minimum-extent-X" - : "minimum-extent-Y"); - if (gh_pair_p (extra)) + extra = get_property (a == X_AXIS + ? "minimum-X-extent" + : "minimum-Y-extent"); + if (ly_c_pair_p (extra)) { - ext.unite (Interval (gh_scm2double (ly_car (extra)), - gh_scm2double (ly_cdr (extra)))); + ext.unite (Interval (ly_scm2double (ly_car (extra)), + ly_scm2double (ly_cdr (extra)))); } ext.translate (x); @@ -642,6 +531,9 @@ Grob::extent (Grob * refp, Axis a) const return ext; } +/* + Find the group-element which has both #this# and #s# +*/ Grob * Grob::common_refpoint (Grob const* s, Axis a) const { @@ -649,8 +541,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; @@ -659,14 +551,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 = ly_cdr (elist)) + for (; ly_c_pair_p (elist); elist = ly_cdr (elist)) { Grob * s = unsmob_grob (ly_car (elist)); - if (s) + 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; @@ -675,43 +590,37 @@ Grob::common_refpoint (SCM elist, Axis a) const String Grob::name () const { - SCM meta = get_grob_property ("meta"); + 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); + nm = (ly_c_pair_p (nm)) ? ly_cdr (nm) : SCM_EOL; + return ly_c_symbol_p (nm) ? ly_symbol2string (nm) : classname (this); } void Grob::add_offset_callback (SCM cb, Axis a) { - if (!has_offset_callback_b (cb, a)) + if (!has_offset_callback (cb, a)) { - dim_cache_[a].offset_callbacks_ = gh_cons (cb, dim_cache_[a].offset_callbacks_); + dim_cache_[a].offset_callbacks_ = scm_cons (cb, dim_cache_[a].offset_callbacks_); dim_cache_[a].offsets_left_ ++; } } bool -Grob::has_extent_callback_b (SCM cb, Axis a)const +Grob::has_extent_callback (SCM cb, Axis a)const { return scm_equal_p (cb, dim_cache_[a].dimension_) == SCM_BOOL_T; } bool -Grob::has_extent_callback_b (Axis a) const +Grob::has_offset_callback (SCM cb, Axis a)const { - return gh_procedure_p (dim_cache_[a].dimension_); -} - -bool -Grob::has_offset_callback_b (SCM cb, Axis a)const -{ - return scm_memq (cb, dim_cache_[a].offset_callbacks_) != SCM_BOOL_F; + return scm_c_memq (cb, dim_cache_[a].offset_callbacks_) != SCM_BOOL_F; } void -Grob::set_extent_callback (SCM dc, Axis a) +Grob::set_extent (SCM dc, Axis a) { dim_cache_[a].dimension_ =dc; } @@ -719,7 +628,7 @@ 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); @@ -735,9 +644,9 @@ Grob::fixup_refpoint (SCM smob) 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); } @@ -760,22 +669,27 @@ Grob::fixup_refpoint (SCM smob) } void -Grob::warning (String s) +Grob::warning (String s)const { - SCM cause = self_scm(); - while (cause != SCM_EOL && !unsmob_music (cause)) + SCM cause = self_scm (); + while (Grob * g = unsmob_grob (cause)) { - Grob * g = unsmob_grob (cause); - cause = g->get_grob_property ("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 +{ + s = "Programming error: " + s; + warning (s); } @@ -793,21 +707,27 @@ Grob::mark_smob (SCM 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_); - Grob *p = s->get_parent (Y_AXIS); - if (p) - scm_gc_mark (p->self_scm ()); + + /* + 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_l_) - scm_gc_mark (s->original_l_->self_scm ()); + if (s->original_) + scm_gc_mark (s->original_->self_scm ()); - return s->do_derived_mark (); + s->do_derived_mark (); + return s->mutable_property_alist_; } int @@ -816,7 +736,7 @@ Grob::print_smob (SCM s, SCM port, scm_print_state *) 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. @@ -826,125 +746,95 @@ 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); - SCM_ASSERT_TYPE(sc, elt, SCM_ARG1, __FUNCTION__, "grob"); - SCM_ASSERT_TYPE(gh_symbol_p(sym), sym, SCM_ARG2, __FUNCTION__, "symbol"); - - if (!type_check_assignment (sym, val, ly_symbol2scm ("backend-type?"))) - error ("typecheck failed"); - - sc->internal_set_grob_property (sym, val); - return SCM_UNSPECIFIED; -} - - -SCM -ly_get_grob_property (SCM elt, SCM sym) -{ - Grob * sc = unsmob_grob (elt); - SCM_ASSERT_TYPE(sc, elt, SCM_ARG1, __FUNCTION__, "grob"); - SCM_ASSERT_TYPE(gh_symbol_p(sym), sym, SCM_ARG2, __FUNCTION__, "symbol"); - - return sc->internal_get_grob_property (sym); -} - void Grob::discretionary_processing () { } - - -SCM -spanner_get_bound (SCM slur, SCM dir) -{ - Spanner * sl = dynamic_cast (unsmob_grob (slur)); - SCM_ASSERT_TYPE(sl, slur, SCM_ARG1, __FUNCTION__, "spanner grob"); - SCM_ASSERT_TYPE(ly_dir_p (dir), slur, SCM_ARG2, __FUNCTION__, "dir"); - return sl->get_bound (to_dir (dir))->self_scm (); -} - -SCM -ly_get_paper_var (SCM grob, SCM sym) -{ - Grob * sc = unsmob_grob (grob); - SCM_ASSERT_TYPE(sc, grob, SCM_ARG1, __FUNCTION__, "grob"); - SCM_ASSERT_TYPE(gh_symbol_p(sym), sym, SCM_ARG2, __FUNCTION__, "symbol"); - - return sc->paper_l() ->get_scmvar_scm (sym); -} - - - -SCM -ly_get_extent (SCM grob, SCM refp, SCM axis) -{ - Grob * sc = unsmob_grob (grob); - Grob * ref = unsmob_grob (refp); - SCM_ASSERT_TYPE(sc, grob, SCM_ARG1, __FUNCTION__, "grob"); - SCM_ASSERT_TYPE(ref, refp, SCM_ARG2, __FUNCTION__, "grob"); - - SCM_ASSERT_TYPE(ly_axis_p(axis), axis, SCM_ARG3, __FUNCTION__, "axis"); - - return ly_interval2scm ( sc->extent (ref, Axis (gh_scm2int (axis)))); -} - -SCM -ly_get_parent (SCM grob, SCM axis) +bool +Grob::internal_has_interface (SCM k) { - Grob * sc = unsmob_grob (grob); - SCM_ASSERT_TYPE(sc, grob, SCM_ARG1, __FUNCTION__, "grob"); - SCM_ASSERT_TYPE(ly_axis_p(axis), axis, SCM_ARG2, __FUNCTION__, "axis"); + SCM ifs = get_property ("interfaces"); - return sc->get_parent (Axis (gh_scm2int (axis)))->self_scm(); + return scm_c_memq (k, ifs) != SCM_BOOL_F; } -static void -init_functions () +/** Return Array of Grobs in SCM list L */ +Link_array +ly_scm2grobs (SCM l) { - scm_c_define_gsubr ("ly-get-grob-property", 2, 0, 0, - (Scheme_function_unknown)ly_get_grob_property); - scm_c_define_gsubr ("ly-set-grob-property", 3, 0, 0, - (Scheme_function_unknown)ly_set_grob_property); - scm_c_define_gsubr ("ly-get-spanner-bound", 2 , 0, 0, - (Scheme_function_unknown) spanner_get_bound); - scm_c_define_gsubr ("ly-get-extent", 3, 0, 0, - (Scheme_function_unknown) ly_get_extent); - scm_c_define_gsubr ("ly-get-parent", 2, 0, 0, - (Scheme_function_unknown) ly_get_parent); -} - -bool -Grob::has_interface (SCM k) -{ - SCM ifs = get_grob_property ("interfaces"); - - return scm_memq (k, ifs) != SCM_BOOL_F; -} + Link_array arr; -void -Grob::set_interface (SCM k) -{ - if (has_interface (k)) - return ; - else + for (SCM s = l; ly_c_pair_p (s); s = ly_cdr (s)) { - set_grob_property ("interfaces", - gh_cons (k, get_grob_property ("interfaces"))); + SCM e = ly_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 = scm_cons (a[i-1]->self_scm (), s); + + return s; +} + + +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 " + // FIXME: page-penalty? + "minimum-Y-extent page-penalty transparent " + ); + -ADD_SCM_INIT_FUNC (scoreelt, init_functions); -IMPLEMENT_TYPE_P (Grob, "ly-grob?");