source file of the GNU LilyPond music typesetter
- (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1997--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
*/
+#include "grob.hh"
-#include <string.h>
-#include <math.h>
+#include <cstring>
+#include "align-interface.hh"
+#include "input.hh"
+#include "international.hh"
+#include "item.hh"
#include "main.hh"
-#include "input-smob.hh"
-#include "warn.hh"
-#include "group-interface.hh"
#include "misc.hh"
-#include "paper-score.hh"
+#include "music.hh"
+#include "output-def.hh"
+#include "pointer-group-interface.hh"
#include "stencil.hh"
-#include "grob.hh"
-#include "warn.hh"
-#include "spanner.hh"
+#include "stream-event.hh"
#include "system.hh"
-#include "item.hh"
-#include "stencil.hh"
-#include "misc.hh"
-#include "music.hh"
-#include "item.hh"
+#include "warn.hh"
#include "ly-smobs.icc"
-/*
-TODO:
-
-remove dynamic_cast<Spanner,Item> 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::clone () const
+{
+ return new Grob (*this);
+}
-Grob::Grob (SCM basicprops)
+Grob::Grob (SCM basicprops)
{
- /*
- fixme: default should be no callback.
- */
+
+ /* FIXME: default should be no callback. */
self_scm_ = SCM_EOL;
- pscore_=0;
- status_ = 0;
+ layout_ = 0;
original_ = 0;
- immutable_property_alist_ = basicprops;
+ interfaces_ = SCM_EOL;
+ 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.
- */
+ object_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_pair_p (meta))
+ if (scm_is_pair (meta))
{
- SCM ifs = scm_assoc (ly_symbol2scm ("interfaces"), meta);
+ interfaces_ = scm_cdr (scm_assq (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:
-
- 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*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_property (onames[a]);
-
- if (scm_ilength (l) >=0)
- {
- dim_cache_[a].offset_callbacks_ = l;
- dim_cache_[a].offsets_left_ = scm_ilength (l);
- }
- else
+ SCM object_cbs = scm_assq (ly_symbol2scm ("object-callbacks"), meta);
+ if (scm_is_pair (object_cbs))
{
- programming_error ("[XY]-offset-callbacks must be a list");
+ for (SCM s = scm_cdr (object_cbs); scm_is_pair (s); s = scm_cdr (s))
+ set_object (scm_caar (s), scm_cdar (s));
}
-
- SCM cb = get_property (enames[a]);
- SCM xt = get_property (xnames[a]);
-
- /*
- Should change default to empty?
- */
- if (is_number_pair (xt))
- cb = xt;
- else if (cb != SCM_BOOL_F
- && !ly_procedure_p (cb) && !ly_pair_p (cb)
- && ly_procedure_p (get_property ("print-function")))
- cb = stencil_extent_proc;
-
- dim_cache_[a].dimension_ = cb;
}
-
+
+ if (get_property_data ("X-extent") == SCM_EOL)
+ set_property ("X-extent", Grob::stencil_width_proc);
+ if (get_property_data ("Y-extent") == SCM_EOL)
+ set_property ("Y-extent", Grob::stencil_height_proc);
}
-Grob::Grob (Grob const&s)
- : dim_cache_ (s.dim_cache_)
+Grob::Grob (Grob const &s)
+ : dim_cache_ (s.dim_cache_)
{
- original_ = (Grob*) &s;
+ original_ = (Grob *) & s;
self_scm_ = SCM_EOL;
immutable_property_alist_ = s.immutable_property_alist_;
- mutable_property_alist_ = SCM_EOL;
-
- /*
- No properties are copied. That is the job of handle_broken_dependencies.
- */
-
- status_ = s.status_;
- pscore_ = 0;
+ mutable_property_alist_ = ly_deep_copy (s.mutable_property_alist_);
+ interfaces_ = s.interfaces_;
+ object_alist_ = SCM_EOL;
- smobify_self ();
+ layout_ = 0;
-#ifdef HASHING_FOR_MUTABLE_PROPS
- mutable_property_alist_ = scm_c_make_hash_table (HASH_SIZE);
-#endif
+ smobify_self ();
}
Grob::~Grob ()
{
- /*
- do nothing scm-ish and no unprotecting here.
- */
}
+/****************************************************************
+ STENCILS
+****************************************************************/
-
-MAKE_SCHEME_CALLBACK (Grob,stencil_extent,2);
-SCM
-Grob::stencil_extent (SCM element_smob, SCM scm_axis)
+Stencil *
+Grob::get_stencil () const
{
- Grob *s = unsmob_grob (element_smob);
- Axis a = (Axis) ly_scm2int (scm_axis);
-
- Stencil *m = s->get_stencil ();
- Interval e ;
- if (m)
- e = m->extent (a);
- return ly_interval2scm (e);
-}
+ if (!is_live ())
+ return 0;
-Paper_def*
-Grob::get_paper () const
-{
- return pscore_ ? pscore_->paper_ : 0;
+ SCM stil = get_property ("stencil");
+ return unsmob_stencil (stil);
}
-void
-Grob::calculate_dependencies (int final, int busy, SCM funcname)
+Stencil
+Grob::get_print_stencil () const
{
- if (status_ >= final)
- return;
-
- if (status_== busy)
- {
- programming_error ("Element is busy, come back later");
- return;
- }
-
- status_= busy;
+ SCM stil = get_property ("stencil");
- for (SCM d = get_property ("dependencies"); ly_pair_p (d);
- d = ly_cdr (d))
+ Stencil retval;
+ if (Stencil *m = unsmob_stencil (stil))
{
- unsmob_grob (ly_car (d))
- ->calculate_dependencies (final, busy, funcname);
- }
-
-
- SCM proc = internal_get_property (funcname);
- if (ly_procedure_p (proc))
- scm_call_1 (proc, this->self_scm ());
-
- status_= final;
-}
+ retval = *m;
+ if (to_boolean (get_property ("transparent")))
+ retval = Stencil (m->extent_box (), SCM_EOL);
+ else
+ {
+ SCM expr = m->expr ();
+ expr = scm_list_3 (ly_symbol2scm ("grob-cause"),
+ self_scm (), expr);
-Stencil *
-Grob::get_stencil () const
-{
- if (!live ())
- {
- return 0;
- }
-
- SCM mol = get_property ("stencil");
- if (unsmob_stencil (mol))
- return unsmob_stencil (mol);
+ retval = Stencil (m->extent_box (), expr);
+ }
- mol = get_uncached_stencil ();
-
- if (live ())
- {
- Grob *me = (Grob*)this;
- me->set_property ("stencil", mol);
- }
-
- return unsmob_stencil (mol);
-}
+ 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));
-SCM
-Grob::get_uncached_stencil ()const
-{
- SCM proc = get_property ("print-function");
+ retval.rotate_degrees (angle, Offset (x, y));
+ }
- SCM mol = SCM_EOL;
- if (ly_procedure_p (proc))
- mol = scm_apply_0 (proc, scm_list_n (this->self_scm (), SCM_UNDEFINED));
-
- Stencil *m = unsmob_stencil (mol);
-
- if (unsmob_stencil (mol))
- {
- SCM origin = ly_symbol2scm ("no-origin");
-
- if (store_locations_global_b)
+ /* color support... see interpret_stencil_expression () for more... */
+ SCM color = get_property ("color");
+ if (scm_is_pair (color))
{
- 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;
- }
- }
+ SCM expr = scm_list_3 (ly_symbol2scm ("color"),
+ color,
+ retval.expr ());
- // ugr.
-
- mol = Stencil (m->extent_box (),
- scm_list_n (origin, m->get_expr (), SCM_UNDEFINED)
- ). smobbed_copy ();
+ retval = Stencil (retval.extent_box (), expr);
+ }
- m = unsmob_stencil (mol);
}
-
- /*
- transparent retains dimensions of element.
- */
- if (m && to_boolean (get_property ("transparent")))
- mol = Stencil (m->extent_box (), SCM_EOL).smobbed_copy ();
- return mol;
+ return retval;
}
-/*
-
+/****************************************************************
VIRTUAL STUBS
-
- */
+****************************************************************/
void
Grob::do_break_processing ()
{
}
-System *
-Grob::get_system () const
+void
+Grob::discretionary_processing ()
{
- return 0;
}
-void
-Grob::add_dependency (Grob*e)
+System *
+Grob::get_system () const
{
- if (e)
- {
- Pointer_group_interface::add_grob (this, ly_symbol2scm ("dependencies"),e);
- }
- else
- programming_error ("Null dependency added");
+ return 0;
}
void
Grob::handle_broken_dependencies ()
{
- Spanner * sp = dynamic_cast<Spanner*> (this);
- if (original_ && sp)
+ Spanner *sp = dynamic_cast<Spanner *> (this);
+ if (original () && sp)
return;
if (sp)
+ /* THIS, SP is the original spanner. We use a special function
+ because some Spanners have enormously long lists in their
+ properties, and a special function fixes FOO */
{
- /*
- 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_pair_p (s);
- s = ly_cdr (s))
- {
- sp->substitute_one_mutable_property (ly_caar (s),
- ly_cdar (s));
- }
+ for (SCM s = object_alist_; scm_is_pair (s); s = scm_cdr (s))
+ sp->substitute_one_mutable_property (scm_caar (s), scm_cdar (s));
}
-
System *system = get_system ();
- if (live ()
- && system && common_refpoint (system, X_AXIS) && common_refpoint (system, Y_AXIS))
- {
- substitute_mutable_properties (system ? system->self_scm () : SCM_UNDEFINED,
- mutable_property_alist_);
- }
- else if (dynamic_cast <System*> (this))
- {
- substitute_mutable_properties (SCM_UNDEFINED, mutable_property_alist_);
- }
+ if (is_live ()
+ && system
+ && common_refpoint (system, X_AXIS)
+ && common_refpoint (system, Y_AXIS))
+ substitute_object_links (system->self_scm (), object_alist_);
+ else if (dynamic_cast<System *> (this))
+ substitute_object_links (SCM_UNDEFINED, object_alist_);
else
- {
- /*
- 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-grobs, which get then GC'd (a bad
- thing.)
-
- */
- suicide ();
- }
+ /* 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-grobs, which get then GC'd (a bad
+ thing). */
+ suicide ();
}
-/*
- Note that we still want references to this element to be
- rearranged, and not silently thrown away, so we keep pointers
- like {broken_into_{drul,array}, original}
+/* Note that we still want references to this element to be
+ rearranged, and not silently thrown away, so we keep pointers like
+ {broken_into_{drul, array}, original}
*/
void
Grob::suicide ()
{
- if (!live ())
- return;
+ if (!is_live ())
+ return;
+
+ for (int a = X_AXIS; a < NO_AXES; a++)
+ dim_cache_[a].clear ();
-#if 0 // see below.
- String nm = name ();
-#endif
-
mutable_property_alist_ = SCM_EOL;
+ object_alist_ = SCM_EOL;
immutable_property_alist_ = SCM_EOL;
-
- 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
+ interfaces_ = SCM_EOL;
}
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_)
+ /* Don't do this in the derived method, since we want to keep access to
+ object_alist_ centralized. */
+ if (original ())
{
- Item * it = dynamic_cast<Item*> (this);
- substitute_mutable_properties (scm_int2num (it->break_status_dir ()),
- original_->mutable_property_alist_);
+ Item *it = dynamic_cast<Item *> (this);
+ substitute_object_links (scm_from_int (it->break_status_dir ()),
+ original ()->object_alist_);
}
}
-Grob*
-Grob::find_broken_piece (System*) const
+Grob *
+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));
- else
{
- dim_cache_[a].offset_ += y;
+ 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;
+}
+/* Find the offset relative to D. If D equals THIS, then it is 0.
+ Otherwise, it recursively defd as
-/*
- 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)
-*/
+ OFFSET_ + PARENT_L_->relative_coordinate (D) */
Real
-Grob::relative_coordinate (Grob const*refp, Axis a) const
+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
- not ask for the absolute coordinate (ie. REFP == nil.)
-
- */
+ /* 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);
- else
- return get_offset (a) + dim_cache_[a].parent_->relative_coordinate (refp, a);
-}
+ return off;
+
+ off += dim_cache_[a].parent_->relative_coordinate (refp, a);
+ return off;
+}
-
-/*
- Invoke callbacks to get offset relative to parent.
-*/
Real
-Grob::get_offset (Axis a) const
+Grob::pure_relative_y_coordinate (Grob const *refp, int start, int end)
{
- Grob *me = (Grob*) this;
- while (dim_cache_[a].offsets_left_)
+ if (refp == this)
+ return 0.0;
+
+ Real off = 0;
+
+ if (dim_cache_[Y_AXIS].offset_)
{
- int l = --me->dim_cache_[a].offsets_left_;
- SCM cb = scm_list_ref (dim_cache_[a].offset_callbacks_, scm_int2num (l));
- SCM retval = scm_call_2 (cb, self_scm (), scm_int2num (a));
+ if (to_boolean (get_property ("pure-Y-offset-in-progress")))
+ programming_error ("cyclic chain in pure-Y-offset callbacks");
- Real r = ly_scm2double (retval);
- if (isinf (r) || isnan (r))
- {
- programming_error (INFINITY_MSG);
- r = 0.0;
- }
- me->dim_cache_[a].offset_ +=r;
+ 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;
}
- return dim_cache_[a].offset_;
-}
+ /* 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);
-bool
-Grob::is_empty (Axis a)const
-{
- return ! (ly_pair_p (dim_cache_[a].dimension_) ||
- ly_procedure_p (dim_cache_[a].dimension_));
+ return off + trans + p->pure_relative_y_coordinate (refp, start, end);
+ }
+ return off;
}
-Interval
-Grob::extent (Grob * refp, Axis a) const
+/* Invoke callbacks to get offset relative to parent. */
+Real
+Grob::get_offset (Axis a) const
{
- Real x = relative_coordinate (refp, a);
+ if (dim_cache_[a].offset_)
+ return *dim_cache_[a].offset_;
-
- Dimension_cache * d = (Dimension_cache *)&dim_cache_[a];
- Interval ext ;
- if (ly_pair_p (d->dimension_))
- ;
- else if (ly_procedure_p (d->dimension_))
- {
- /*
- FIXME: add doco on types, and should typecheck maybe?
- */
- d->dimension_= scm_call_2 (d->dimension_, self_scm (), scm_int2num (a));
- }
- else
- return ext;
-
- if (!ly_pair_p (d->dimension_))
- return ext;
-
- ext = ly_scm2interval (d->dimension_);
+ Grob *me = (Grob *) this;
- SCM extra = get_property (a == X_AXIS
- ? "extra-X-extent"
- : "extra-Y-extent");
+ SCM sym = axis_offset_symbol (a);
+ me->dim_cache_[a].offset_ = new Real (0.0);
/*
- signs ?
- */
- if (ly_pair_p (extra))
+ 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_)
{
- ext[BIGGER] += ly_scm2double (ly_cdr (extra));
- ext[SMALLER] += ly_scm2double (ly_car (extra));
+ *me->dim_cache_[a].offset_ += off;
+ me->del_property (sym);
+ return *me->dim_cache_[a].offset_;
}
-
- extra = get_property (a == X_AXIS
- ? "minimum-X-extent"
- : "minimum-Y-extent");
- if (ly_pair_p (extra))
- {
- ext.unite (Interval (ly_scm2double (ly_car (extra)),
- ly_scm2double (ly_cdr (extra))));
- }
-
- ext.translate (x);
-
- return ext;
+ else
+ return 0.0;
}
-/*
- Find the group-element which has both #this# and #s#
-*/
-Grob *
-Grob::common_refpoint (Grob const* s, Axis a) const
+Real
+Grob::maybe_pure_coordinate (Grob const *refp, Axis a, bool pure, int start, int end)
{
- /*
- 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_)
- for (Grob const * d = s; d; d = d->dim_cache_[a].parent_)
- if (d == c)
- return (Grob*)d;
-
- return 0;
+ 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
+****************************************************************/
-Grob *
-common_refpoint_of_list (SCM elist, Grob *common, Axis a)
+void
+Grob::flush_extent_cache (Axis axis)
{
- for (; ly_pair_p (elist); elist = ly_cdr (elist))
+ if (dim_cache_[axis].extent_)
{
- Grob * s = unsmob_grob (ly_car (elist));
- if (!s)
- continue;
- if (common)
- common = common->common_refpoint (s, a);
- else
- common = s;
+ /*
+ Ugh, this is not accurate; will flush property, causing
+ callback to be called if.
+ */
+ del_property ((axis == X_AXIS) ? ly_symbol2scm ("X-extent") : ly_symbol2scm ("Y-extent"));
+ delete dim_cache_[axis].extent_;
+ dim_cache_[axis].extent_ = 0;
+ if (get_parent (axis))
+ get_parent (axis)->flush_extent_cache (axis);
}
-
- return common;
}
-
-Grob *
-common_refpoint_of_array (Link_array<Grob> const &arr, Grob *common, Axis a)
+Interval
+Grob::extent (Grob *refp, Axis a) const
{
- for (int i = arr.size () ; i--; )
+ Real offset = relative_coordinate (refp, a);
+ Interval real_ext;
+ if (dim_cache_[a].extent_)
{
- Grob * s = arr[i];
- if (!s)
- continue;
-
- if (common)
- common = common->common_refpoint (s, a);
- else
- common = s;
+ real_ext = *dim_cache_[a].extent_;
}
-
- return common;
+ else
+ {
+ /*
+ Order is significant: ?-extent may trigger suicide.
+ */
+ SCM ext_sym =
+ (a == X_AXIS)
+ ? ly_symbol2scm ("X-extent")
+ : ly_symbol2scm ("Y-extent");
+
+ 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));
+
+ ((Grob*)this)->dim_cache_[a].extent_ = new Interval (real_ext);
+ }
+
+ real_ext.translate (offset);
+
+ return real_ext;
}
-String
-Grob::name () const
+Interval
+Grob::pure_height (Grob *refp, int start, int end)
{
- SCM meta = get_property ("meta");
- SCM nm = scm_assoc (ly_symbol2scm ("name"), meta);
- nm = (ly_pair_p (nm)) ? ly_cdr (nm) : SCM_EOL;
- return ly_symbol_p (nm) ? ly_symbol2string (nm) : classname (this);
+ 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;
}
-void
-Grob::add_offset_callback (SCM cb, Axis a)
+Interval
+Grob::maybe_pure_extent (Grob *refp, Axis a, bool pure, int start, int end)
{
- if (!has_offset_callback (cb, a))
- {
- dim_cache_[a].offset_callbacks_ = scm_cons (cb, dim_cache_[a].offset_callbacks_);
- dim_cache_[a].offsets_left_ ++;
- }
+ 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);
}
-bool
-Grob::has_extent_callback (SCM cb, Axis a)const
+Interval_t<int>
+Grob::spanned_rank_interval () const
{
- return scm_equal_p (cb, dim_cache_[a].dimension_) == SCM_BOOL_T;
+ return Interval_t<int> (-1, 0);
}
+/****************************************************************
+ REFPOINTS
+****************************************************************/
-bool
-Grob::has_offset_callback (SCM cb, Axis a)const
+/* Find the group-element which has both #this# and #s# */
+Grob *
+Grob::common_refpoint (Grob const *s, Axis a) const
{
- return scm_c_memq (cb, dim_cache_[a].offset_callbacks_) != SCM_BOOL_F;
-}
+ /* 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_)
+ for (Grob const *d = s; d; d = d->dim_cache_[a].parent_)
+ if (d == c)
+ return (Grob *) d;
-void
-Grob::set_extent (SCM dc, Axis a)
-{
- dim_cache_[a].dimension_ =dc;
+ return 0;
}
void
dim_cache_[a].parent_ = g;
}
-MAKE_SCHEME_CALLBACK (Grob,fixup_refpoint,1);
-SCM
-Grob::fixup_refpoint (SCM smob)
+Grob *
+Grob::get_parent (Axis a) const
{
- Grob *me = unsmob_grob (smob);
- for (int a = X_AXIS; a < NO_AXES; a ++)
+ return dim_cache_[a].parent_;
+}
+
+
+void
+Grob::fixup_refpoint ()
+{
+ for (int a = X_AXIS; a < NO_AXES; a++)
{
Axis ax = (Axis)a;
- Grob * parent = me->get_parent (ax);
+ Grob *parent = get_parent (ax);
if (!parent)
continue;
-
- if (parent->get_system () != me->get_system () && me->get_system ())
+
+ if (parent->get_system () != get_system () && get_system ())
{
- Grob * newparent = parent->find_broken_piece (me->get_system ());
- me->set_parent (newparent, ax);
+ Grob *newparent = parent->find_broken_piece (get_system ());
+ set_parent (newparent, ax);
}
- if (Item * i = dynamic_cast<Item*> (me))
+ if (Item *i = dynamic_cast<Item *> (this))
{
- Item *parenti = dynamic_cast<Item*> (parent);
+ Item *parenti = dynamic_cast<Item *> (parent);
if (parenti && i)
{
- Direction my_dir = i->break_status_dir () ;
- if (my_dir!= parenti->break_status_dir ())
+ Direction my_dir = i->break_status_dir ();
+ if (my_dir != parenti->break_status_dir ())
{
- Item *newparent = parenti->find_prebroken_piece (my_dir);
- me->set_parent (newparent, ax);
+ Item *newparent = parenti->find_prebroken_piece (my_dir);
+ set_parent (newparent, ax);
}
}
}
}
- return smob;
}
+
+/****************************************************************
+ 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");
- }
+ 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);
- }
+ m->origin ()->warning (s);
+ else if (Stream_event *ev = unsmob_stream_event (cause))
+ ev->origin ()->warning (s);
else
::warning (s);
}
-void
-Grob::programming_error (String s)const
+
+string
+Grob::name () const
{
- s = "Programming error: " + s;
- warning (s);
+ 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
+{
+ SCM cause = self_scm ();
+ while (Grob *g = unsmob_grob (cause))
+ cause = g->get_property ("cause");
-/****************************************************
- SMOB funcs
- ****************************************************/
+ 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);
+}
-IMPLEMENT_SMOBS (Grob);
-IMPLEMENT_DEFAULT_EQUAL_P (Grob);
+ADD_INTERFACE (Grob,
+ "A grob represents a piece of music notation.\n"
+ "\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 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 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 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 "
+ "X-offset "
+ "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 "
+ "interfaces "
+ "layer "
+ "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)
+{
+ 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::mark_smob (SCM ses)
+Grob::stencil_height (SCM smob)
{
- Grob * s = (Grob*) SCM_CELL_WORD_1 (ses);
- scm_gc_mark (s->immutable_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->original_)
- scm_gc_mark (s->original_->self_scm ());
-
- s->do_derived_mark ();
- return s->mutable_property_alist_;
+ Grob *me = unsmob_grob (smob);
+ return grob_stencil_extent (me, Y_AXIS);
}
-int
-Grob::print_smob (SCM s, SCM port, scm_print_state *)
+MAKE_SCHEME_CALLBACK (Grob, y_parent_positioning, 1);
+SCM
+Grob::y_parent_positioning (SCM smob)
{
- Grob *sc = (Grob *) ly_cdr (s);
-
- scm_puts ("#<Grob ", port);
- scm_puts ((char *)sc->name ().to_str0 (), port);
+ Grob *me = unsmob_grob (smob);
+ Grob *par = me->get_parent (Y_AXIS);
+ if (par)
+ (void) par->get_property ("positioning-done");
- /*
- don't try to print properties, that is too much hassle.
- */
- scm_puts (" >", port);
- return 1;
+ return scm_from_double (0.0);
}
+
+MAKE_SCHEME_CALLBACK (Grob, x_parent_positioning, 1);
SCM
-Grob::do_derived_mark () const
+Grob::x_parent_positioning (SCM smob)
{
- return SCM_EOL;
-}
-
-
+ Grob *me = unsmob_grob (smob);
+
+ Grob *par = me->get_parent (X_AXIS);
+ if (par)
+ (void) par->get_property ("positioning-done");
-void
-Grob::discretionary_processing ()
-{
+ return scm_from_double (0.0);
}
-bool
-Grob::internal_has_interface (SCM k)
+MAKE_SCHEME_CALLBACK (Grob, stencil_width, 1);
+SCM
+Grob::stencil_width (SCM smob)
{
- SCM ifs = get_property ("interfaces");
-
- return scm_c_memq (k, ifs) != SCM_BOOL_F;
+ Grob *me = unsmob_grob (smob);
+ return grob_stencil_extent (me, X_AXIS);
}
-/** Return Array of Grobs in SCM list L */
-Link_array<Grob>
-ly_scm2grobs (SCM l)
-{
- Link_array<Grob> arr;
- for (SCM s = l; ly_pair_p (s); s = ly_cdr (s))
- {
- SCM e = ly_car (s);
- arr.push (unsmob_grob (e));
- }
+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;
+ }
- arr.reverse ();
- return arr;
+ return common;
}
-/** Return SCM list of Grob array A */
-SCM
-ly_grobs2scm (Link_array<Grob> a)
+Grob *
+common_refpoint_of_array (vector<Grob*> const &arr, Grob *common, Axis a)
{
- SCM s = SCM_EOL;
- for (int i = a.size (); i; i--)
- s = scm_cons (a[i-1]->self_scm (), s);
+ for (vsize i = 0; i < arr.size (); i++)
+ if (common)
+ common = common->common_refpoint (arr[i], a);
+ else
+ common = arr[i];
- return 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));
-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 "
- "minimum-Y-extent transparent");
-
+ return ext;
+}