X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fgrob.cc;h=bb27448cacc801390eac7e875c3cf59ff7375622;hb=ac6c83f047635535d0481a15654c13e776334dc6;hp=514eb57b0361e17b0c2c25b0ee390c62fb6af8c7;hpb=75c339f75315f38e85d137c8ea0693fbc4cc4028;p=lilypond.git diff --git a/lily/grob.cc b/lily/grob.cc index 514eb57b03..78be89e399 100644 --- a/lily/grob.cc +++ b/lily/grob.cc @@ -3,45 +3,38 @@ source file of the GNU LilyPond music typesetter - (c) 1997--2005 Han-Wen Nienhuys + (c) 1997--2007 Han-Wen Nienhuys */ #include "grob.hh" #include -#include "main.hh" -#include "input-smob.hh" -#include "warn.hh" -#include "pointer-group-interface.hh" -#include "misc.hh" -#include "paper-score.hh" -#include "stencil.hh" -#include "warn.hh" -#include "system.hh" +#include "align-interface.hh" +#include "input.hh" +#include "international.hh" #include "item.hh" -#include "stencil.hh" +#include "main.hh" #include "misc.hh" #include "music.hh" -#include "item.hh" -#include "paper-score.hh" -#include "ly-smobs.icc" #include "output-def.hh" +#include "pointer-group-interface.hh" +#include "stencil.hh" +#include "stream-event.hh" +#include "system.hh" +#include "warn.hh" - - - +#include "ly-smobs.icc" Grob * -Grob::clone (int count) const +Grob::clone () const { - return new Grob (*this, count); + return new Grob (*this); } -Grob::Grob (SCM basicprops, - Object_key const *key) +Grob::Grob (SCM basicprops) { - key_ = key; + /* FIXME: default should be no callback. */ self_scm_ = SCM_EOL; layout_ = 0; @@ -56,26 +49,28 @@ Grob::Grob (SCM basicprops, GC. After smobify_self (), they are. */ smobify_self (); - /* - We always get a new key object for a new grob. - */ - if (key_) - ((Object_key *)key_)->unprotect (); - SCM meta = get_property ("meta"); if (scm_is_pair (meta)) - interfaces_ = scm_cdr (scm_assq (ly_symbol2scm ("interfaces"), meta)); + { + interfaces_ = scm_cdr (scm_assq (ly_symbol2scm ("interfaces"), meta)); + + SCM object_cbs = scm_assq (ly_symbol2scm ("object-callbacks"), meta); + if (scm_is_pair (object_cbs)) + { + for (SCM s = scm_cdr (object_cbs); scm_is_pair (s); s = scm_cdr (s)) + set_object (scm_caar (s), scm_cdar (s)); + } + } - if (get_property_data (ly_symbol2scm ("X-extent")) == SCM_EOL) + if (get_property_data ("X-extent") == SCM_EOL) set_property ("X-extent", Grob::stencil_width_proc); - if (get_property_data (ly_symbol2scm ("Y-extent")) == SCM_EOL) + if (get_property_data ("Y-extent") == SCM_EOL) set_property ("Y-extent", Grob::stencil_height_proc); } -Grob::Grob (Grob const &s, int copy_index) +Grob::Grob (Grob const &s) : dim_cache_ (s.dim_cache_) { - key_ = (use_object_keys) ? new Copied_key (s.key_, copy_index) : 0; original_ = (Grob *) & s; self_scm_ = SCM_EOL; @@ -87,8 +82,6 @@ Grob::Grob (Grob const &s, int copy_index) layout_ = 0; smobify_self (); - if (key_) - ((Object_key *)key_)->unprotect (); } Grob::~Grob () @@ -122,23 +115,31 @@ Grob::get_print_stencil () const else { SCM expr = m->expr (); - if (point_and_click_global) - expr = scm_list_3 (ly_symbol2scm ("grob-cause"), - self_scm (), expr); + expr = scm_list_3 (ly_symbol2scm ("grob-cause"), + self_scm (), expr); retval = Stencil (m->extent_box (), expr); } + SCM rot = get_property ("rotation"); + if (scm_is_pair (rot)) + { + Real angle = scm_to_double (scm_car (rot)); + Real x = scm_to_double (scm_cadr (rot)); + Real y = scm_to_double (scm_caddr (rot)); + + retval.rotate_degrees (angle, Offset (x, y)); + } + /* color support... see interpret_stencil_expression () for more... */ SCM color = get_property ("color"); - if (color != SCM_EOL) + if (scm_is_pair (color)) { - m = unsmob_stencil (stil); SCM expr = scm_list_3 (ly_symbol2scm ("color"), color, - m->expr ()); + retval.expr ()); - retval = Stencil (m->extent_box (), expr); + retval = Stencil (retval.extent_box (), expr); } } @@ -210,6 +211,9 @@ Grob::suicide () if (!is_live ()) return; + for (int a = X_AXIS; a < NO_AXES; a++) + dim_cache_[a].clear (); + mutable_property_alist_ = SCM_EOL; object_alist_ = SCM_EOL; immutable_property_alist_ = SCM_EOL; @@ -261,7 +265,8 @@ Grob::translate_axis (Real y, Axis a) Real Grob::relative_coordinate (Grob const *refp, Axis a) const { - if (refp == this) + /* eaa - hmmm, should we do a programming_error() here? */ + if ((this == NULL) || (refp == this)) return 0.0; /* We catch PARENT_L_ == nil case with this, but we crash if we did @@ -275,6 +280,52 @@ Grob::relative_coordinate (Grob const *refp, Axis a) const return off; } +Real +Grob::pure_relative_y_coordinate (Grob const *refp, int start, int end) +{ + if (refp == this) + return 0.0; + + Real off = 0; + + if (dim_cache_[Y_AXIS].offset_) + { + if (to_boolean (get_property ("pure-Y-offset-in-progress"))) + programming_error ("cyclic chain in pure-Y-offset callbacks"); + + off = *dim_cache_[Y_AXIS].offset_; + } + else + { + SCM proc = get_property_data ("Y-offset"); + + dim_cache_[Y_AXIS].offset_ = new Real (0.0); + set_property ("pure-Y-offset-in-progress", SCM_BOOL_T); + off = robust_scm2double (call_pure_function (proc, + scm_list_1 (self_scm ()), + start, end), + 0.0); + del_property ("pure-Y-offset-in-progress"); + delete dim_cache_[Y_AXIS].offset_; + dim_cache_[Y_AXIS].offset_ = 0; + } + + /* we simulate positioning-done if we are the child of a VerticalAlignment, + but only if we don't have a cached offset. If we do have a cached offset, + it probably means that the Alignment was fixed and it has already been + calculated. + */ + if (Grob *p = get_parent (Y_AXIS)) + { + Real trans = 0; + if (Align_interface::has_interface (p) && !dim_cache_[Y_AXIS].offset_) + trans = Align_interface::get_pure_child_y_translation (p, this, start, end); + + return off + trans + p->pure_relative_y_coordinate (refp, start, end); + } + return off; +} + /* Invoke callbacks to get offset relative to parent. */ Real Grob::get_offset (Axis a) const @@ -292,12 +343,24 @@ Grob::get_offset (Axis a) const dim_cache_[a].offset_ is unaliased. */ Real off = robust_scm2double (internal_get_property (sym), 0.0); - *me->dim_cache_[a].offset_ += off; - - me->del_property (sym); - return *me->dim_cache_[a].offset_; + if (me->dim_cache_[a].offset_) + { + *me->dim_cache_[a].offset_ += off; + me->del_property (sym); + return *me->dim_cache_[a].offset_; + } + else + return 0.0; } +Real +Grob::maybe_pure_coordinate (Grob const *refp, Axis a, bool pure, int start, int end) +{ + if (pure && a != Y_AXIS) + programming_error ("tried to get pure X-offset"); + return (pure && a == Y_AXIS) ? pure_relative_y_coordinate (refp, start, end) + : relative_coordinate (refp, a); +} /**************************************************************** extents @@ -332,25 +395,26 @@ Grob::extent (Grob *refp, Axis a) const } else { - SCM min_ext_sym = - (a == X_AXIS) - ? ly_symbol2scm ("minimum-X-extent") - : ly_symbol2scm ("minimum-Y-extent"); - + /* + Order is significant: ?-extent may trigger suicide. + */ SCM ext_sym = (a == X_AXIS) ? ly_symbol2scm ("X-extent") : ly_symbol2scm ("Y-extent"); - - SCM min_ext = internal_get_property (min_ext_sym); + 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)); - if (is_number_pair (ext)) - real_ext.unite (ly_scm2interval (ext)); - ((Grob*)this)->del_property (ext_sym); ((Grob*)this)->dim_cache_[a].extent_ = new Interval (real_ext); } @@ -359,6 +423,43 @@ Grob::extent (Grob *refp, Axis a) const return real_ext; } +Interval +Grob::pure_height (Grob *refp, int start, int end) +{ + SCM proc = get_property_data (ly_symbol2scm ("Y-extent")); + SCM iv_scm = call_pure_function (proc, + scm_list_1 (self_scm ()), + start, end); + Interval iv = robust_scm2interval (iv_scm, Interval (0, 0)); + Real offset = pure_relative_y_coordinate (refp, start, end); + + SCM min_ext = get_property ("minimum-Y-extent"); + + /* we don't add minimum-Y-extent if the extent is empty. This solves + a problem with Hara-kiri spanners. They would request_suicide and + return empty extents, but we would force them here to be large. */ + if (!iv.is_empty () && is_number_pair (min_ext)) + iv.unite (ly_scm2interval (min_ext)); + + if (!iv.is_empty ()) + iv.translate (offset); + return iv; +} + +Interval +Grob::maybe_pure_extent (Grob *refp, Axis a, bool pure, int start, int end) +{ + if (pure && a != Y_AXIS) + programming_error ("tried to get pure width"); + return (pure && a == Y_AXIS) ? pure_height (refp, start, end) : extent (refp, a); +} + +Interval_t +Grob::spanned_rank_interval () const +{ + return Interval_t (-1, 0); +} + /**************************************************************** REFPOINTS ****************************************************************/ @@ -430,20 +531,23 @@ Grob::fixup_refpoint () MESSAGES ****************************************************************/ void -Grob::warning (String s) const +Grob::warning (string s) const { SCM cause = self_scm (); while (Grob *g = unsmob_grob (cause)) cause = g->get_property ("cause"); + /* ES TODO: cause can't be Music*/ if (Music *m = unsmob_music (cause)) m->origin ()->warning (s); + else if (Stream_event *ev = unsmob_stream_event (cause)) + ev->origin ()->warning (s); else ::warning (s); } -String +string Grob::name () const { SCM meta = get_property ("meta"); @@ -453,7 +557,7 @@ Grob::name () const } void -Grob::programming_error (String s) const +Grob::programming_error (string s) const { SCM cause = self_scm (); while (Grob *g = unsmob_grob (cause)) @@ -461,47 +565,53 @@ Grob::programming_error (String s) const s = _f ("programming error: %s", s); + /* ES TODO: cause can't be Music*/ if (Music *m = unsmob_music (cause)) m->origin ()->message (s); + else if (Stream_event *ev = unsmob_stream_event (cause)) + ev->origin ()->warning (s); else ::message (s); } -ADD_INTERFACE (Grob, "grob-interface", - "A grob represents a piece of music notation\n" +ADD_INTERFACE (Grob, + "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" + "All grobs have an X and Y@tie{}position on the page. These" + " X and Y@tie{}positions are stored in a relative format, thus" + " they can easily be combined by stacking them, hanging one" + " grob to the side of another, or coupling them into 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" + "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@tie{}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.\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" + "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} object is also an" + " abstract grob: It only moves around chords, but doesn't print" + " 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. " - - , + "Grobs have properties (Scheme variables) that can be read and" + " set. Two types of them exist: immutable and mutable." + " Immutable variables define the default style and behavior." + " They are shared between many objects. They can be changed" + " using @code{\\override} and @code{\\revert}. Mutable" + " properties are variables that are specific to one grob." + " Typically, lists of other objects, or results from" + " computations are stored in mutable properties. In" + " particular, every call to @code{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 " @@ -509,11 +619,13 @@ ADD_INTERFACE (Grob, "grob-interface", "Y-extent " "Y-offset " "after-line-breaking " + "avoid-slur " "axis-group-parent-X " "axis-group-parent-Y " "before-line-breaking " "cause " "color " + "cross-staff " "extra-X-extent " "extra-Y-extent " "extra-offset " @@ -522,21 +634,21 @@ ADD_INTERFACE (Grob, "grob-interface", "meta " "minimum-X-extent " "minimum-Y-extent " + "outside-staff-horizontal-padding " + "outside-staff-padding " + "outside-staff-priority " + "pure-Y-offset-in-progress " + "rotation " "springs-and-rods " "staff-symbol " "stencil " "transparent " ); - - - - /**************************************************************** CALLBACKS ****************************************************************/ - static SCM grob_stencil_extent (Grob *me, Axis a) { @@ -556,7 +668,7 @@ Grob::stencil_height (SCM smob) return grob_stencil_extent (me, Y_AXIS); } -MAKE_SCHEME_CALLBACK(Grob, y_parent_positioning, 1); +MAKE_SCHEME_CALLBACK (Grob, y_parent_positioning, 1); SCM Grob::y_parent_positioning (SCM smob) { @@ -569,7 +681,7 @@ Grob::y_parent_positioning (SCM smob) } -MAKE_SCHEME_CALLBACK(Grob, x_parent_positioning, 1); +MAKE_SCHEME_CALLBACK (Grob, x_parent_positioning, 1); SCM Grob::x_parent_positioning (SCM smob) { @@ -608,9 +720,9 @@ common_refpoint_of_list (SCM elist, Grob *common, Axis a) } Grob * -common_refpoint_of_array (Link_array const &arr, Grob *common, Axis a) +common_refpoint_of_array (vector const &arr, Grob *common, Axis a) { - for (int i = arr.size (); i--;) + for (vsize i = arr.size (); i--;) if (Grob *s = arr[i]) { if (common)