X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fgrob.cc;h=477577066388d5d2059d8e62044fe4eebc6ac877;hb=99433c54bea756a38ed6b2a70bc8c90cd0d37902;hp=61f48a6aff5f00609a431372a3c5c603495ed8d3;hpb=8b956db3cbebf3bb1bcb5fd1cf9b21f6fd767fc7;p=lilypond.git diff --git a/lily/grob.cc b/lily/grob.cc index 61f48a6aff..4775770663 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 */ @@ -16,13 +16,13 @@ #include "group-interface.hh" #include "misc.hh" #include "paper-score.hh" -#include "molecule.hh" +#include "stencil.hh" #include "grob.hh" #include "warn.hh" #include "spanner.hh" #include "system.hh" #include "item.hh" -#include "molecule.hh" +#include "stencil.hh" #include "misc.hh" #include "music.hh" #include "item.hh" @@ -36,7 +36,6 @@ 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" @@ -45,7 +44,7 @@ Grob::Grob (SCM basicprops) /* fixme: default should be no callback. */ - + self_scm_ = SCM_EOL; pscore_=0; status_ = 0; original_ = 0; @@ -53,19 +52,16 @@ Grob::Grob (SCM basicprops) mutable_property_alist_ = SCM_EOL; /* - We do smobify_self() as the first step. Since the object lives on + 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 (), 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 meta = get_property ("meta"); + if (ly_c_pair_p (meta)) { SCM ifs = scm_assoc (ly_symbol2scm ("interfaces"), meta); @@ -74,7 +70,7 @@ Grob::Grob (SCM basicprops) */ bool itc = internal_type_checking_global_b; internal_type_checking_global_b = false; - internal_set_grob_property (ly_symbol2scm ("interfaces"), gh_cdr(ifs)); + internal_set_property (ly_symbol2scm ("interfaces"), ly_cdr (ifs)); internal_type_checking_global_b = itc; } @@ -86,11 +82,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) { @@ -102,16 +99,18 @@ 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) - && gh_procedure_p (get_grob_property ("molecule-callback")) - ) - 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; } @@ -122,8 +121,9 @@ Grob::Grob (Grob const&s) : dim_cache_ (s.dim_cache_) { original_ = (Grob*) &s; - immutable_property_alist_ = s.immutable_property_alist_; + self_scm_ = SCM_EOL; + immutable_property_alist_ = s.immutable_property_alist_; mutable_property_alist_ = SCM_EOL; /* @@ -131,76 +131,52 @@ Grob::Grob (Grob const&s) */ status_ = s.status_; - pscore_ = s.pscore_; + pscore_ = 0; smobify_self (); - -#ifdef HASHING_FOR_MUTABLE_PROPS - mutable_property_alist_ = scm_c_make_hash_table (HASH_SIZE); -#endif } Grob::~Grob () { - /* - do nothing scm-ish and no unprotecting here. - */ } - - - -MAKE_SCHEME_CALLBACK (Grob,molecule_extent,2); +MAKE_SCHEME_CALLBACK (Grob,stencil_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* +Output_def* Grob::get_paper () const { return pscore_ ? pscore_->paper_ : 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) + if (status_ == busy) { programming_error ("Element is busy, come back later"); return; @@ -208,7 +184,7 @@ Grob::calculate_dependencies (int final, int busy, SCM funcname) 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)) @@ -216,74 +192,70 @@ Grob::calculate_dependencies (int final, int busy, SCM funcname) } - SCM proc = internal_get_grob_property (funcname); - if (gh_procedure_p (proc)) - gh_call1 (proc, this->self_scm ()); + SCM proc = internal_get_property (funcname); + if (ly_c_procedure_p (proc)) + scm_call_1 (proc, this->self_scm ()); - status_= final; + status_ = final; } -Molecule * -Grob::get_molecule () const +Stencil * +Grob::get_stencil () const { - if (!live()) + if (!is_live ()) { return 0; - } - SCM mol = get_grob_property ("molecule"); - if (unsmob_molecule (mol)) - return unsmob_molecule (mol); + 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 (is_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)); - - - Molecule *m = unsmob_molecule (mol); + if (ly_c_procedure_p (proc)) + mol = scm_apply_0 (proc, scm_list_n (this->self_scm (), SCM_UNDEFINED)); - if (unsmob_molecule (mol)) - { - SCM origin = ly_symbol2scm ("no-origin"); + if (Stencil *m = unsmob_stencil (mol)) + { + if (to_boolean (get_property ("transparent"))) + mol = Stencil (m->extent_box (), SCM_EOL).smobbed_copy (); + else + { + SCM origin = ly_symbol2scm ("no-origin"); - if (store_locations_global_b){ - SCM cause = get_grob_property ("cause"); - if (Music*m = unsmob_music (cause)) + if (store_locations_global_b) { - SCM music_origin = m->get_mus_property ("origin"); - if (unsmob_input (music_origin)) - origin = music_origin; + 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) - ). smobbed_copy (); - m = unsmob_molecule (mol); - } - - /* - transparent retains dimensions of element. - */ - if (m && to_boolean (get_grob_property ("transparent"))) - mol = Molecule (m->extent_box (), SCM_EOL).smobbed_copy (); + // ugr. + mol = Stencil (m->extent_box (), + scm_list_n (origin, m->expr (), SCM_UNDEFINED) + ). smobbed_copy (); + } + } return mol; } @@ -315,34 +287,35 @@ Grob::add_dependency (Grob*e) programming_error ("Null dependency added"); } - void Grob::handle_broken_dependencies () { - Spanner * s= dynamic_cast (this); - if (original_ && s) + Spanner * sp = dynamic_cast (this); + if (original_ && sp) return; - if (s) + if (sp) { - for (int i = 0; i< s->broken_intos_ .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_intos_[i]; - System * l = sc->get_system (); - - sc->substitute_mutable_properties (l ? l->self_scm () : SCM_UNDEFINED, - mutable_property_alist_); + sp->substitute_one_mutable_property (ly_caar (s), + ly_cdar (s)); } } - System *system = get_system (); - if (live () + if (is_live () && system && common_refpoint (system, X_AXIS) && common_refpoint (system, Y_AXIS)) { substitute_mutable_properties (system ? system->self_scm () : SCM_UNDEFINED, - mutable_property_alist_); + mutable_property_alist_); } else if (dynamic_cast (this)) { @@ -371,6 +344,10 @@ Grob::handle_broken_dependencies () void Grob::suicide () { + if (!is_live ()) + return; + + mutable_property_alist_ = SCM_EOL; immutable_property_alist_ = SCM_EOL; @@ -394,7 +371,7 @@ Grob::handle_prebroken_dependencies () if (original_) { Item * it = dynamic_cast (this); - substitute_mutable_properties (gh_int2scm (it->break_status_dir ()), + substitute_mutable_properties (scm_int2num (it->break_status_dir ()), original_->mutable_property_alist_); } } @@ -455,10 +432,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); @@ -470,18 +447,11 @@ 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_)); } Interval @@ -492,43 +462,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); @@ -558,7 +528,7 @@ Grob::common_refpoint (Grob const* s, Axis a) const Grob * common_refpoint_of_list (SCM elist, Grob *common, Axis a) { - 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) @@ -577,7 +547,7 @@ common_refpoint_of_list (SCM elist, Grob *common, Axis a) Grob * common_refpoint_of_array (Link_array const &arr, Grob *common, Axis a) { - for (int i = arr.size() ; i--; ) + for (int i = arr.size () ; i--; ) { Grob * s = arr[i]; if (!s) @@ -595,39 +565,39 @@ common_refpoint_of_array (Link_array const &arr, Grob *common, Axis a) 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_offset_callback_b (SCM cb, Axis a)const +Grob::has_offset_callback (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 (SCM dc, Axis a) { - dim_cache_[a].dimension_ =dc; + dim_cache_[a].dimension_ = dc; } void @@ -676,16 +646,15 @@ Grob::fixup_refpoint (SCM smob) void 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); @@ -752,7 +721,7 @@ Grob::print_smob (SCM s, SCM port, scm_print_state *) } SCM -Grob::do_derived_mark () +Grob::do_derived_mark () const { return SCM_EOL; } @@ -767,9 +736,9 @@ Grob::discretionary_processing () bool Grob::internal_has_interface (SCM k) { - SCM ifs = get_grob_property ("interfaces"); + SCM ifs = get_property ("interfaces"); - return scm_memq (k, ifs) != SCM_BOOL_F; + return scm_c_memq (k, ifs) != SCM_BOOL_F; } @@ -779,9 +748,9 @@ ly_scm2grobs (SCM l) { Link_array arr; - for (SCM s = l; gh_pair_p (s); s = gh_cdr (s)) + for (SCM s = l; ly_c_pair_p (s); s = ly_cdr (s)) { - SCM e = gh_car (s); + SCM e = ly_car (s); arr.push (unsmob_grob (e)); } @@ -795,46 +764,52 @@ 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); + s = scm_cons (a[i-1]->self_scm (), s); return s; } -IMPLEMENT_TYPE_P (Grob, "ly-grob?"); +IMPLEMENT_TYPE_P (Grob, "ly:grob?"); ADD_INTERFACE (Grob, "grob-interface", - "In music notation, lots of symbols are related in some way. You can -think of music notation as a graph where nodes are formed by the -symbols, and the arcs by their relations. A grob is a node in that -graph. The directed edges in the graph are formed by references to -other grobs (i.e. pointers). This big graph of grobs specifies the -notation problem. The solution of this problem is a description of the -printout in closed form, i.e. a list of values. These values are -Molecules. - -All grobs have an X and Y-position on the page. These X and Y positions -are stored in a relative format, so they can easily be combined by -stacking them, hanging one grob to the side of another, and coupling -them into a grouping-grob. - -Each grob has a reference point (a.k.a. parent): the position of a grob -is stored relative to that reference point. For example the X-reference -point of a staccato dot usually is the note head that it applies -to. When the note head is moved, the staccato dot moves along -automatically. - -A grob is often associated with a symbol, but some grobs do not print -any symbols. They take care of grouping objects. For example, there is a -separate grob that stacks staves vertically. The @ref{NoteCollision} -is also an abstract grob: it only moves around chords, but doesn't print -anything. -", - "X-offset-callbacks Y-offset-callbacks X-extent-callback molecule cause -Y-extent-callback molecule-callback extra-offset spacing-procedure -staff-symbol interfaces dependencies extent-X extent-Y extra-extent-X -causes meta layer before-line-breaking-callback -after-line-breaking-callback extra-extent-Y minimum-extent-X -minimum-extent-Y transparent"); + "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 " + );