X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;ds=sidebyside;f=lily%2Fgrob.cc;h=dd8726cac8bdc972324dc54391dcf6b7e4142072;hb=931465a3c93bd73bdabfcaccb71c37f4b4e5b814;hp=380ba92ded9d6fb8bfa639643cb6155cfd931352;hpb=31a6650e2b2a5c1cae3237ee47b80cd43d084d53;p=lilypond.git diff --git a/lily/grob.cc b/lily/grob.cc index 380ba92ded..dd8726cac8 100644 --- a/lily/grob.cc +++ b/lily/grob.cc @@ -3,60 +3,28 @@ source file of the GNU LilyPond music typesetter - (c) 1997--2005 Han-Wen Nienhuys + (c) 1997--2006 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" -MAKE_SCHEME_CALLBACK(Grob, same_axis_parent_positioning, 2); -SCM -Grob::same_axis_parent_positioning (SCM element_smob, SCM axis) -{ - Grob *me = unsmob_grob (element_smob); - Axis ax = Axis (scm_to_int (axis)); - - Grob *par = me->get_parent (ax); - if (par) - par->get_property ("positioning-done"); - - return scm_from_double (0.0); -} - -MAKE_SCHEME_CALLBACK(Grob,other_axis_parent_positioning, 2); -SCM -Grob::other_axis_parent_positioning (SCM element_smob, SCM axis) -{ - Grob *me = unsmob_grob (element_smob); - Axis ax = other_axis ((Axis) scm_to_int (axis)); - - Grob *par = me->get_parent (ax); - if (par) - par->get_property ("positioning-done"); - - return scm_from_double (0.0); -} - - +#include "ly-smobs.icc" Grob * Grob::clone (int count) const @@ -64,21 +32,14 @@ Grob::clone (int count) const return new Grob (*this, count); } -/* TODO: - -- remove dynamic_cast and put this code into respective -subclass. */ - -#define HASH_SIZE 3 -#define INFINITY_MSG "Infinity or NaN encountered" - Grob::Grob (SCM basicprops, Object_key const *key) { key_ = key; + /* FIXME: default should be no callback. */ self_scm_ = SCM_EOL; - pscore_ = 0; + layout_ = 0; original_ = 0; interfaces_ = SCM_EOL; immutable_property_alist_ = basicprops; @@ -99,33 +60,6 @@ Grob::Grob (SCM basicprops, SCM meta = get_property ("meta"); if (scm_is_pair (meta)) interfaces_ = scm_cdr (scm_assq (ly_symbol2scm ("interfaces"), meta)); - - /* 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. */ - - SCM off_callbacks[] = { - get_property ("X-offset-callbacks"), - get_property ("Y-offset-callbacks") - }; - - for (int a = X_AXIS; a <= Y_AXIS; a++) - { - SCM l = off_callbacks[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 (get_property_data (ly_symbol2scm ("X-extent")) == SCM_EOL) set_property ("X-extent", Grob::stencil_width_proc); @@ -145,7 +79,7 @@ Grob::Grob (Grob const &s, int copy_index) interfaces_ = s.interfaces_; object_alist_ = SCM_EOL; - pscore_ = 0; + layout_ = 0; smobify_self (); if (key_) @@ -155,49 +89,9 @@ Grob::Grob (Grob const &s, int copy_index) Grob::~Grob () { } - - -MAKE_SCHEME_CALLBACK (Grob, stencil_height, 1); -SCM -Grob::stencil_height (SCM element_smob) -{ - Grob *me = unsmob_grob (element_smob); - return stencil_extent (me, Y_AXIS); -} - -MAKE_SCHEME_CALLBACK (Grob, stencil_width, 1); -SCM -Grob::stencil_width (SCM element_smob) -{ - Grob *me = unsmob_grob (element_smob); - return stencil_extent (me, X_AXIS); -} - -SCM -Grob::stencil_extent (Grob *me, Axis a) -{ - Stencil *m = me->get_stencil (); - Interval e; - if (m) - e = m->extent (a); - return ly_interval2scm (e); -} - -Interval -robust_relative_extent (Grob *me, Grob *refpoint, Axis a) -{ - Interval ext = me->extent (refpoint, a); - if (ext.is_empty ()) - ext.add_point (me->relative_coordinate (refpoint, a)); - - return ext; -} - -Output_def * -Grob::get_layout () const -{ - return pscore_ ? pscore_->layout () : 0; -} +/**************************************************************** + STENCILS +****************************************************************/ Stencil * Grob::get_stencil () const @@ -223,23 +117,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 (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); } } @@ -247,14 +149,19 @@ Grob::get_print_stencil () const return retval; } -/* +/**************************************************************** VIRTUAL STUBS -*/ +****************************************************************/ void Grob::do_break_processing () { } +void +Grob::discretionary_processing () +{ +} + System * Grob::get_system () const { @@ -266,7 +173,7 @@ void Grob::handle_broken_dependencies () { Spanner *sp = dynamic_cast (this); - if (original_ && sp) + if (original () && sp) return; if (sp) @@ -306,16 +213,13 @@ 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; interfaces_ = SCM_EOL; - - for (int a = X_AXIS; a <= Y_AXIS; a++) - { - dim_cache_[a].offset_callbacks_ = SCM_EOL; - dim_cache_[a].offsets_left_ = 0; - } } void @@ -323,11 +227,11 @@ Grob::handle_prebroken_dependencies () { /* Don't do this in the derived method, since we want to keep access to object_alist_ centralized. */ - if (original_) + if (original ()) { Item *it = dynamic_cast (this); substitute_object_links (scm_from_int (it->break_status_dir ()), - original_->object_alist_); + original ()->object_alist_); } } @@ -337,14 +241,23 @@ Grob::find_broken_piece (System *) const return 0; } -/* Translate in one direction. */ +/**************************************************************** + OFFSETS +****************************************************************/ + void Grob::translate_axis (Real y, Axis a) { if (isinf (y) || isnan (y)) - programming_error (_ (INFINITY_MSG)); + { + programming_error (_ ("Infinity or NaN encountered")); + return ; + } + + if (!dim_cache_[a].offset_) + dim_cache_[a].offset_ = new Real (y); else - dim_cache_[a].offset_ += y; + *dim_cache_[a].offset_ += y; } /* Find the offset relative to D. If D equals THIS, then it is 0. @@ -359,42 +272,89 @@ Grob::relative_coordinate (Grob const *refp, Axis a) const /* We catch PARENT_L_ == nil case with this, but we crash if we did not ask for the absolute coordinate (ie. REFP == nil.) */ + Real off = get_offset (a); if (refp == dim_cache_[a].parent_) - return get_offset (a); + return off; + + off += dim_cache_[a].parent_->relative_coordinate (refp, a); - return get_offset (a) + dim_cache_[a].parent_->relative_coordinate (refp, a); + return off; +} + +Real +Grob::pure_relative_y_coordinate (Grob const *refp, int start, int end) +{ + if (refp == this) + return 0.0; + + SCM pure_off = ly_lily_module_constant ("pure-Y-offset"); + Real off = 0; + + if (dim_cache_[Y_AXIS].offset_) + off = *dim_cache_[Y_AXIS].offset_; + else if (ly_is_procedure (pure_off)) + { + dim_cache_[Y_AXIS].offset_ = new Real (0.0); + off = scm_to_double (scm_apply_3 (pure_off, self_scm (), + scm_from_int (start), scm_from_int (end), + SCM_EOL)); + 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. + */ + 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 + + dim_cache_[Y_AXIS].parent_->pure_relative_y_coordinate (refp, start, end); } /* Invoke callbacks to get offset relative to parent. */ Real Grob::get_offset (Axis a) const { + if (dim_cache_[a].offset_) + return *dim_cache_[a].offset_; + Grob *me = (Grob *) this; - while (dim_cache_[a].offsets_left_) - { - int l = --me->dim_cache_[a].offsets_left_; - SCM cb = scm_list_ref (dim_cache_[a].offset_callbacks_, scm_from_int (l)); - SCM retval = scm_call_2 (cb, self_scm (), scm_from_int (a)); - Real r = scm_to_double (retval); - if (isinf (r) || isnan (r)) - { - programming_error (INFINITY_MSG); - r = 0.0; - } - me->dim_cache_[a].offset_ += r; + SCM sym = axis_offset_symbol (a); + me->dim_cache_[a].offset_ = new Real (0.0); + + /* + UGH: can't fold next 2 statements together. Apparently GCC thinks + dim_cache_[a].offset_ is unaliased. + */ + Real off = robust_scm2double (internal_get_property (sym), 0.0); + if (me->dim_cache_[a].offset_) + { + *me->dim_cache_[a].offset_ += off; + me->del_property (sym); + return *me->dim_cache_[a].offset_; } - return dim_cache_[a].offset_; + else + return 0.0; } -#if 0 -bool -Grob::is_empty (Axis a) const +Real +Grob::maybe_pure_coordinate (Grob const *refp, Axis a, bool pure, int start, int end) { - return !(scm_is_pair (dim_cache_[a].dimension_) - || ly_is_procedure (dim_cache_[a].dimension_callback_)); + 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); } -#endif + +/**************************************************************** + extents +****************************************************************/ void Grob::flush_extent_cache (Axis axis) @@ -425,25 +385,25 @@ 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 (min_ext)) - real_ext.unite (ly_scm2interval (min_ext)); + SCM ext = internal_get_property (ext_sym); if (is_number_pair (ext)) real_ext.unite (ly_scm2interval (ext)); - ((Grob*)this)->del_property (ext_sym); + SCM min_ext_sym = + (a == X_AXIS) + ? ly_symbol2scm ("minimum-X-extent") + : ly_symbol2scm ("minimum-Y-extent"); + SCM min_ext = internal_get_property (min_ext_sym); + if (is_number_pair (min_ext)) + real_ext.unite (ly_scm2interval (min_ext)); ((Grob*)this)->dim_cache_[a].extent_ = new Interval (real_ext); } @@ -452,6 +412,48 @@ Grob::extent (Grob *refp, Axis a) const return real_ext; } +Interval +Grob::pure_height (Grob *refp, int start, int end) +{ + SCM pure_height = ly_lily_module_constant ("pure-Y-extent"); + Interval iv (0, 0); + + if (ly_is_procedure (pure_height)) + iv = ly_scm2interval (scm_apply_3 (pure_height, self_scm (), + scm_from_int (start), scm_from_int (end), + SCM_EOL)); + 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)); + + 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_iv () +{ + return Interval_t (-1, 0); +} + +/**************************************************************** + REFPOINTS +****************************************************************/ + /* Find the group-element which has both #this# and #s# */ Grob * Grob::common_refpoint (Grob const *s, Axis a) const @@ -467,67 +469,18 @@ Grob::common_refpoint (Grob const *s, Axis a) const return 0; } -Grob * -common_refpoint_of_list (SCM elist, Grob *common, Axis a) -{ - for (; scm_is_pair (elist); elist = scm_cdr (elist)) - if (Grob *s = unsmob_grob (scm_car (elist))) - { - if (common) - common = common->common_refpoint (s, a); - else - common = s; - } - - return common; -} - -Grob * -common_refpoint_of_array (Link_array const &arr, Grob *common, Axis a) -{ - for (int i = arr.size (); i--;) - if (Grob *s = arr[i]) - { - if (common) - common = common->common_refpoint (s, a); - else - common = s; - } - - return common; -} - -String -Grob::name () const -{ - SCM meta = get_property ("meta"); - SCM nm = scm_assq (ly_symbol2scm ("name"), meta); - nm = (scm_is_pair (nm)) ? scm_cdr (nm) : SCM_EOL; - return scm_is_symbol (nm) ? ly_symbol2string (nm) : this->class_name (); -} - void -Grob::add_offset_callback (SCM cb, Axis a) +Grob::set_parent (Grob *g, Axis a) { - if (!has_offset_callback (cb, a)) - { - dim_cache_[a].offset_callbacks_ - = scm_cons (cb, dim_cache_[a].offset_callbacks_); - dim_cache_[a].offsets_left_++; - } + dim_cache_[a].parent_ = g; } -bool -Grob::has_offset_callback (SCM cb, Axis a) const +Grob * +Grob::get_parent (Axis a) const { - return scm_c_memq (cb, dim_cache_[a].offset_callbacks_) != SCM_BOOL_F; + return dim_cache_[a].parent_; } -void -Grob::set_parent (Grob *g, Axis a) -{ - dim_cache_[a].parent_ = g; -} void Grob::fixup_refpoint () @@ -563,21 +516,38 @@ 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 +Grob::name () const +{ + SCM meta = get_property ("meta"); + SCM nm = scm_assq (ly_symbol2scm ("name"), meta); + nm = (scm_is_pair (nm)) ? scm_cdr (nm) : SCM_EOL; + return scm_is_symbol (nm) ? ly_symbol2string (nm) : this->class_name (); +} + void -Grob::programming_error (String s) const +Grob::programming_error (string s) const { SCM cause = self_scm (); while (Grob *g = unsmob_grob (cause)) @@ -585,60 +555,15 @@ 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); } -void -Grob::discretionary_processing () -{ -} -bool -Grob::internal_has_interface (SCM k) -{ - return scm_c_memq (k, interfaces_) != SCM_BOOL_F; -} - -Grob * -Grob::get_parent (Axis a) const -{ - return dim_cache_[a].parent_; -} - -/** Return Array of Grobs in SCM list LST */ -Link_array -ly_scm2grobs (SCM lst) -{ - Link_array arr; - - for (SCM s = lst; scm_is_pair (s); s = scm_cdr (s)) - { - SCM e = scm_car (s); - arr.push (unsmob_grob (e)); - } - - arr.reverse (); - return arr; -} - -Object_key const * -Grob::get_key () const -{ - return key_; -} - -/** 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; -} ADD_INTERFACE (Grob, "grob-interface", "A grob represents a piece of music notation\n" @@ -677,9 +602,9 @@ ADD_INTERFACE (Grob, "grob-interface", /* properties */ "X-extent " - "X-offset-callbacks " + "X-offset " "Y-extent " - "Y-offset-callbacks " + "Y-offset " "after-line-breaking " "axis-group-parent-X " "axis-group-parent-Y " @@ -694,6 +619,7 @@ ADD_INTERFACE (Grob, "grob-interface", "meta " "minimum-X-extent " "minimum-Y-extent " + "rotation " "springs-and-rods " "staff-symbol " "stencil " @@ -701,3 +627,106 @@ ADD_INTERFACE (Grob, "grob-interface", ); + + + +/**************************************************************** + CALLBACKS +****************************************************************/ + + +static SCM +grob_stencil_extent (Grob *me, Axis a) +{ + Stencil *m = me->get_stencil (); + Interval e; + if (m) + e = m->extent (a); + return ly_interval2scm (e); +} + + +MAKE_SCHEME_CALLBACK (Grob, stencil_height, 1); +SCM +Grob::stencil_height (SCM smob) +{ + Grob *me = unsmob_grob (smob); + return grob_stencil_extent (me, Y_AXIS); +} + +MAKE_SCHEME_CALLBACK(Grob, y_parent_positioning, 1); +SCM +Grob::y_parent_positioning (SCM smob) +{ + Grob *me = unsmob_grob (smob); + Grob *par = me->get_parent (Y_AXIS); + if (par) + (void) par->get_property ("positioning-done"); + + return scm_from_double (0.0); +} + + +MAKE_SCHEME_CALLBACK(Grob, x_parent_positioning, 1); +SCM +Grob::x_parent_positioning (SCM smob) +{ + Grob *me = unsmob_grob (smob); + + Grob *par = me->get_parent (X_AXIS); + if (par) + (void) par->get_property ("positioning-done"); + + return scm_from_double (0.0); +} + +MAKE_SCHEME_CALLBACK (Grob, stencil_width, 1); +SCM +Grob::stencil_width (SCM smob) +{ + Grob *me = unsmob_grob (smob); + return grob_stencil_extent (me, X_AXIS); +} + + + +Grob * +common_refpoint_of_list (SCM elist, Grob *common, Axis a) +{ + for (; scm_is_pair (elist); elist = scm_cdr (elist)) + if (Grob *s = unsmob_grob (scm_car (elist))) + { + if (common) + common = common->common_refpoint (s, a); + else + common = s; + } + + return common; +} + +Grob * +common_refpoint_of_array (vector const &arr, Grob *common, Axis a) +{ + for (vsize i = arr.size (); i--;) + if (Grob *s = arr[i]) + { + if (common) + common = common->common_refpoint (s, a); + else + common = s; + } + + return common; +} + +Interval +robust_relative_extent (Grob *me, Grob *refpoint, Axis a) +{ + Interval ext = me->extent (refpoint, a); + if (ext.is_empty ()) + ext.add_point (me->relative_coordinate (refpoint, a)); + + return ext; +} +