source file of the GNU LilyPond music typesetter
- (c) 1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
*/
+#include "grob.hh"
-#include <string.h>
+#include <cstring>
#include <math.h>
#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 "grob.hh"
-#include "debug.hh"
-#include "spanner.hh"
+#include "stencil.hh"
+#include "warn.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"
#include "ly-smobs.icc"
-/*
-TODO:
+Grob *
+Grob::clone (int count) const
+{
+ return new Grob (*this, count);
+}
-remove dynamic_cast<Spanner,Item> and put this code into respective
- subclass.
-*/
+/* TODO:
+- remove dynamic_cast<Spanner, Item> and put this code into respective
+subclass. */
+#define HASH_SIZE 3
#define INFINITY_MSG "Infinity or NaN encountered"
-Grob::Grob (SCM basicprops)
+Grob::Grob (SCM basicprops,
+ Object_key const *key)
{
- /*
- fixme: default should be no callback.
- */
-
- pscore_l_=0;
- status_c_ = 0;
- original_l_ = 0;
- immutable_property_alist_ = basicprops;
+ key_ = key;
+ /* FIXME: default should be no callback. */
+ 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 ();
-
- SCM meta = get_grob_property ("meta");
- if (gh_pair_p (meta))
+ /*
+ We always get a new key object for a new grob.
+ */
+ scm_gc_unprotect_object (key_->self_scm ());
+ SCM meta = get_property ("meta");
+ if (scm_is_pair (meta))
{
SCM ifs = scm_assoc (ly_symbol2scm ("interfaces"), meta);
- /*
- do it directly to bypass interface checks.
- */
- mutable_property_alist_ = gh_cons (gh_cons (ly_symbol2scm ("interfaces"),
- gh_cdr (ifs)),
- mutable_property_alist_);
+ /* Switch off interface checks for the moment. */
+ bool itc = do_internal_type_checking_global;
+ do_internal_type_checking_global = false;
+ internal_set_property (ly_symbol2scm ("interfaces"), scm_cdr (ifs));
+ do_internal_type_checking_global = 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*enames[] = {"X-extent-callback", "Y-extent-callback"};
-
+
+ /* 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_grob_property (onames[a]);
+ SCM l = get_property (onames[a]);
- if (scm_ilength (l) >=0)
+ 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");
+
+ SCM cb = get_property (enames[a]);
+ if (cb == SCM_BOOL_F)
{
- programming_error ("[XY]-offset-callbacks must be a list");
+ dim_cache_[a].dimension_ = SCM_BOOL_F;
}
- SCM cb = get_grob_property (enames[a]);
-
- /*
- Should change default to be 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;
-
- dim_cache_[a].dimension_ = cb;
+ SCM xt = get_property (xnames[a]);
+ if (is_number_pair (xt))
+ {
+ dim_cache_[a].dimension_ = xt;
+ }
+ else if (ly_c_procedure_p (cb))
+ {
+ dim_cache_[a].dimension_callback_ = cb;
+ }
+ else if (cb == SCM_EOL
+ && ly_c_procedure_p (get_property ("print-function")))
+ dim_cache_[a].dimension_callback_ = stencil_extent_proc;
}
-
}
-Grob::Grob (Grob const&s)
- : dim_cache_ (s.dim_cache_)
+Grob::Grob (Grob const &s, int copy_index)
+ : dim_cache_ (s.dim_cache_)
{
- original_l_ = (Grob*) &s;
+ key_ = new Copied_key (s.key_, copy_index);
+ 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 ();
+ scm_gc_unprotect_object (key_->self_scm ());
}
Grob::~Grob ()
{
- /*
- do nothing scm-ish and no unprotecting here.
- */
-}
-
-
-
-extern void check_interfaces_for_property (Grob const *me, SCM sym);
-
-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?")));
- check_interfaces_for_property(this, s);
- }
-#endif
-
-
- mutable_property_alist_ = scm_assq_set_x (mutable_property_alist_, s, v);
}
-
+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_);
-
-#ifndef NDEBUG
- if (internal_type_checking_global_b && gh_pair_p (s))
- {
- assert (type_check_assignment (sym, gh_cdr (s), ly_symbol2scm ("backend-type?")));
- check_interfaces_for_property(this, sym);
- }
-#endif
-
- 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;
-}
-
-
-
-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) scm_to_int (scm_axis);
- Molecule *m = s->get_molecule ();
- Interval e ;
+ 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)
+Interval
+robust_relative_extent (Grob *me, Grob *refp, Axis a)
{
- 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))
+ Interval ext = me->extent (refp, a);
+ if (ext.is_empty ())
{
- Real l = gh_scm2double (ly_car (ext));
- Real r = gh_scm2double (ly_cdr (ext));
- return ly_interval2scm (Interval (l, r));
+ ext.add_point (me->relative_coordinate (refp, a));
}
-
- return ly_interval2scm (Interval ());
-}
-
+ return ext;
+}
-Paper_def*
-Grob::paper_l () const
+Output_def *
+Grob::get_layout () const
{
- return pscore_l_ ? pscore_l_->paper_l_ : 0;
+ return pscore_ ? pscore_->layout_ : 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_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;
- for (SCM d = get_grob_property ("dependencies"); gh_pair_p (d);
- d = ly_cdr (d))
- {
- unsmob_grob (ly_car (d))
- ->calculate_dependencies (final, busy, funcname);
- }
+ status_ = busy;
+
+ for (SCM d = get_property ("dependencies"); scm_is_pair (d);
+ d = scm_cdr (d))
+ unsmob_grob (scm_car (d))->calculate_dependencies (final, busy, funcname);
-
- SCM proc = internal_get_grob_property (funcname);
- if (gh_procedure_p (proc))
- gh_call1 (proc, 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
{
- if (immutable_property_alist_ == SCM_EOL)
+ if (!is_live ())
+ return 0;
+
+ SCM stil = get_property ("stencil");
+ if (unsmob_stencil (stil))
+ return unsmob_stencil (stil);
+
+ stil = get_uncached_stencil ();
+ if (is_live ())
{
- return 0;
-
+ Grob *me = (Grob *) this;
+ me->set_property ("stencil", stil);
}
-
- SCM mol = get_grob_property ("molecule");
- if (unsmob_molecule (mol))
- return unsmob_molecule (mol);
-
- mol = get_uncached_molecule ();
-
- Grob *me = (Grob*)this;
- me->set_grob_property ("molecule", mol);
-
- return unsmob_molecule (mol);
+
+ return unsmob_stencil (stil);
}
+
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));
+ SCM stil = SCM_EOL;
+ if (ly_c_procedure_p (proc))
+ stil = scm_apply_0 (proc, scm_list_n (this->self_scm (), SCM_UNDEFINED));
-
- Molecule *m = unsmob_molecule (mol);
-
- if (unsmob_molecule (mol))
+ if (Stencil *m = unsmob_stencil (stil))
{
- 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 (to_boolean (get_property ("transparent")))
+ stil = Stencil (m->extent_box (), SCM_EOL).smobbed_copy ();
+ else
+ {
+ SCM expr = scm_list_3 (ly_symbol2scm ("grob-cause"), self_scm (),
+ m->expr ());
+ stil = Stencil (m->extent_box (), expr). smobbed_copy ();
+ }
- // ugr.
-
- mol = Molecule (m->extent_box (),
- scm_list_n (origin, m->get_expr (), SCM_UNDEFINED)
- ). smobbed_copy ();
+ /* color support... see interpret_stencil_expression() for more... */
+ SCM color = get_property ("color");
+ if (color != SCM_EOL)
+ {
+ m = unsmob_stencil (stil);
+ SCM expr = scm_list_3 (ly_symbol2scm ("color"),
+ color,
+ m->expr ());
- m = unsmob_molecule (mol);
+ stil = Stencil (m->extent_box (), expr).smobbed_copy ();
+ }
}
-
- /*
- transparent retains dimensions of element.
- */
- if (m && to_boolean (get_grob_property ("transparent")))
- mol = Molecule (m->extent_box (), SCM_EOL).smobbed_copy ();
- return mol;
+ return stil;
}
/*
-
VIRTUAL STUBS
-
- */
+*/
void
Grob::do_break_processing ()
{
}
-
-
-
-
-
System *
-Grob::line_l () const
+Grob::get_system () const
{
return 0;
}
void
-Grob::add_dependency (Grob*e)
+Grob::add_dependency (Grob *e)
{
if (e)
- {
- Pointer_group_interface::add_grob (this, ly_symbol2scm ("dependencies"),e);
- }
+ Pointer_group_interface::add_grob (this, ly_symbol2scm ("dependencies"),
+ e);
else
programming_error ("Null dependency added");
}
-
-
-
-/**
- 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<Item*> (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<System*> (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<Spanner*> (this);
- if (original_l_ && s)
+ Spanner *sp = dynamic_cast<Spanner *> (this);
+ if (original_ && sp)
return;
- if (s)
- {
- for (int i = 0; i< s->broken_into_l_arr_ .size (); i++)
- {
- 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);
- }
- }
-
-
- System *line = line_l ();
-
- if (line && common_refpoint (line, X_AXIS) && common_refpoint (line, Y_AXIS))
- {
- mutable_property_alist_
- = handle_broken_grobs (mutable_property_alist_,
- line ? line->self_scm () : SCM_UNDEFINED);
- }
- else if (dynamic_cast <System*> (this))
- {
- mutable_property_alist_ = handle_broken_grobs (mutable_property_alist_,
- SCM_UNDEFINED);
- }
+ 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 */
+ for (SCM s = mutable_property_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 (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_);
+ else if (dynamic_cast<System *> (this))
+ substitute_mutable_properties (SCM_UNDEFINED, mutable_property_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 (!is_live ())
+ return;
+
mutable_property_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++)
+ set_extent_callback (SCM_EOL, Y_AXIS);
+ set_extent_callback (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;
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<Item *> (this);
+ substitute_mutable_properties (scm_int2num (it->break_status_dir ()),
+ original_->mutable_property_alist_);
+ }
}
-Grob*
-Grob::find_broken_piece (System*) const
+Grob *
+Grob::find_broken_piece (System *) const
{
return 0;
}
+/* Translate in one direction. */
void
Grob::translate_axis (Real y, Axis a)
{
if (isinf (y) || isnan (y))
programming_error (_ (INFINITY_MSG));
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.
+ Otherwise, it recursively defd as
+
+ 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)
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.)
-
- */
- if (refp == dim_cache_[a].parent_l_)
+ /* We catch PARENT_L_ == nil case with this, but we crash if we did
+ not ask for the absolute coordinate (ie. REFP == nil.) */
+ 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
{
- Grob *me = (Grob*) this;
+ 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_, 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 = scm_to_double (retval);
if (isinf (r) || isnan (r))
{
programming_error (INFINITY_MSG);
r = 0.0;
}
- me->dim_cache_[a].offset_ +=r;
+ me->dim_cache_[a].offset_ += r;
}
return dim_cache_[a].offset_;
}
-
-MAKE_SCHEME_CALLBACK (Grob,point_dimension_callback,2);
-SCM
-Grob::point_dimension_callback (SCM , SCM)
+bool
+Grob::is_empty (Axis a) const
{
- return ly_interval2scm (Interval (0,0));
+ return !(scm_is_pair (dim_cache_[a].dimension_)
+ || ly_c_procedure_p (dim_cache_[a].dimension_callback_));
}
-bool
-Grob::empty_b (Axis a)const
+void
+Grob::flush_extent_cache (Axis axis)
{
- return ! (gh_pair_p (dim_cache_[a].dimension_) ||
- gh_procedure_p (dim_cache_[a].dimension_));
+ Dimension_cache *d = &dim_cache_[axis];
+ if (ly_c_procedure_p (d->dimension_callback_)
+ && scm_is_pair (d->dimension_))
+ {
+ d->dimension_ = SCM_EOL;
+
+ if (get_parent (axis))
+ get_parent (axis)->flush_extent_cache (axis);
+ }
}
Interval
-Grob::extent (Grob * refp, Axis a) const
+Grob::extent (Grob *refp, Axis a) const
{
Real x = relative_coordinate (refp, a);
-
- Dimension_cache * d = (Dimension_cache *)&dim_cache_[a];
- Interval ext ;
- if (gh_pair_p (d->dimension_))
- ;
- else if (gh_procedure_p (d->dimension_))
- {
- /*
- FIXME: add doco on types, and should typecheck maybe?
- */
- d->dimension_= gh_call2 (d->dimension_, self_scm (), gh_int2scm (a));
- }
+ Dimension_cache *d = (Dimension_cache *) &dim_cache_[a];
+ Interval ext;
+
+ SCM dimpair = d->dimension_;
+ if (scm_is_pair (dimpair));
+ else if (ly_c_procedure_p (d->dimension_callback_)
+ && d->dimension_ == SCM_EOL)
+ d->dimension_ = scm_call_2 (d->dimension_callback_, self_scm (), scm_int2num (a));
else
return ext;
- if (!gh_pair_p (d->dimension_))
+ if (!scm_is_pair (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))
+ /* Signs ? */
+ if (scm_is_pair (extra))
{
- ext[BIGGER] += gh_scm2double (ly_cdr (extra));
- ext[SMALLER] += gh_scm2double (ly_car (extra));
- }
-
- extra = get_grob_property (a == X_AXIS
- ? "minimum-extent-X"
- : "minimum-extent-Y");
- if (gh_pair_p (extra))
- {
- ext.unite (Interval (gh_scm2double (ly_car (extra)),
- gh_scm2double (ly_cdr (extra))));
+ ext[BIGGER] += scm_to_double (scm_cdr (extra));
+ ext[SMALLER] += scm_to_double (scm_car (extra));
}
+ extra = get_property (a == X_AXIS
+ ? "minimum-X-extent"
+ : "minimum-Y-extent");
+ if (scm_is_pair (extra))
+ ext.unite (Interval (scm_to_double (scm_car (extra)),
+ scm_to_double (scm_cdr (extra))));
+
ext.translate (x);
-
+
return ext;
}
-Grob *
-Grob::common_refpoint (Grob const* s, Axis a) const
+/* Find the group-element which has both #this# and #s# */
+Grob *
+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_)
+ /* 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 (Grob *) d;
return 0;
}
-
Grob *
-common_refpoint_of_list (SCM elist, Grob *common, Axis a)
-{
- for (; gh_pair_p (elist); elist = ly_cdr (elist))
- {
- Grob * s = unsmob_grob (ly_car (elist));
- if (!s)
- continue;
- if (common)
- common = common->common_refpoint (s, a);
- else
- common = s;
- }
+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<Grob> 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;
- }
+common_refpoint_of_array (Link_array<Grob> 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_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 = (scm_is_pair (nm)) ? scm_cdr (nm) : SCM_EOL;
+ return scm_is_symbol (nm) ? ly_symbol2string (nm) : classname (this);
}
void
Grob::add_offset_callback (SCM cb, Axis a)
{
- if (!has_offset_callback_b (cb, a))
- {
- dim_cache_[a].offset_callbacks_ = gh_cons (cb, dim_cache_[a].offset_callbacks_);
- dim_cache_[a].offsets_left_ ++;
- }
+ if (!has_offset_callback (cb, a))
+ {
+ 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;
+ return scm_equal_p (cb, dim_cache_[a].dimension_callback_) == 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
+Grob::set_extent_callback (SCM dc, Axis a)
+{
+ dim_cache_[a].dimension_callback_ = dc;
}
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);
+MAKE_SCHEME_CALLBACK (Grob, fixup_refpoint, 1);
SCM
Grob::fixup_refpoint (SCM smob)
{
Grob *me = unsmob_grob (smob);
- for (int a = X_AXIS; a < NO_AXES; a ++)
+ for (int a = X_AXIS; a < NO_AXES; a++)
{
Axis ax = (Axis)a;
- Grob * parent = me->get_parent (ax);
+ Grob *parent = me->get_parent (ax);
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);
}
- if (Item * i = dynamic_cast<Item*> (me))
+ if (Item *i = dynamic_cast<Item *> (me))
{
- Item *parenti = dynamic_cast<Item*> (parent);
+ Item *parenti = dynamic_cast<Item *> (parent);
if (parenti && i)
{
- Direction my_dir = i->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);
+ Item *newparent = parenti->find_prebroken_piece (my_dir);
me->set_parent (newparent, ax);
}
}
}
void
-Grob::warning (String s)
+Grob::warning (String s) const
{
- SCM cause = self_scm();
- while (cause != SCM_EOL && !unsmob_music (cause))
- {
- Grob * g = unsmob_grob (cause);
- cause = g->get_grob_property ("cause");
- }
+ SCM cause = self_scm ();
+ while (Grob *g = unsmob_grob (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);
+}
/****************************************************
SMOB funcs
- ****************************************************/
-
-
+****************************************************/
IMPLEMENT_SMOBS (Grob);
IMPLEMENT_DEFAULT_EQUAL_P (Grob);
SCM
Grob::mark_smob (SCM ses)
{
- Grob * s = (Grob*) SCM_CELL_WORD_1 (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->key_->self_scm ());
+ 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 ());
+ scm_gc_mark (s->dim_cache_[a].dimension_callback_);
+
+ /* Do not 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 ());
- return s->do_derived_mark ();
+ if (s->original_)
+ scm_gc_mark (s->original_->self_scm ());
+
+ s->do_derived_mark ();
+ return s->mutable_property_alist_;
}
int
Grob::print_smob (SCM s, SCM port, scm_print_state *)
{
- Grob *sc = (Grob *) ly_cdr (s);
-
+ Grob *sc = (Grob *) SCM_CELL_WORD_1 (s);
+
scm_puts ("#<Grob ", port);
- scm_puts ((char *)sc->name ().ch_C (), port);
+ scm_puts ((char *) sc->name ().to_str0 (), port);
- /*
- don't try to print properties, that is too much hassle.
- */
+ /* Do not print properties, that is too much hassle. */
scm_puts (" >", port);
return 1;
}
SCM
-Grob::do_derived_mark ()
+Grob::do_derived_mark () const
{
return SCM_EOL;
}
-LY_DEFINE(ly_set_grob_property,"ly-set-grob-property", 3, 0, 0,
-(SCM grob, SCM sym, SCM val),
-"
-Set @var{sym} in grob @var{grob} to value @var{val}")
-{
- 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");
-
- if (!type_check_assignment (sym, val, ly_symbol2scm ("backend-type?")))
- error ("typecheck failed");
-
- sc->internal_set_grob_property (sym, val);
- return SCM_UNSPECIFIED;
-}
-
-LY_DEFINE(ly_get_grob_property,
- "ly-get-grob-property", 2, 0, 0, (SCM grob, SCM sym),
- " Get the value of a value in grob @var{g} of property @var{sym}. It
-will return @code{'()} (end-of-list) if @var{g} doesn't have @var{sym} set.
-")
-{
- 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->internal_get_grob_property (sym);
-}
-
-
void
Grob::discretionary_processing ()
{
}
-
-LY_DEFINE(spanner_get_bound, "ly-get-spanner-bound", 2 , 0, 0,
- (SCM slur, SCM dir),
- "Get one of the bounds of @var{spanner}. @var{dir} may be @code{-1} for
-left, and @code{1} for right.
-")
+bool
+Grob::internal_has_interface (SCM k)
{
- Spanner * sl = dynamic_cast<Spanner*> (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 ifs = get_property ("interfaces");
+
+ return scm_c_memq (k, ifs) != SCM_BOOL_F;
}
-LY_DEFINE(ly_get_paper_var,"ly-get-paper-variable", 2, 0, 0,
- (SCM grob, SCM sym),
- "Get a variable from the \\paper block.")
+Grob *
+Grob::get_parent (Axis a) const
{
- 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);
+ return dim_cache_[a].parent_;
}
-
-
-LY_DEFINE(ly_get_extent, "ly-get-extent", 3, 0, 0,
- (SCM grob, SCM refp, SCM axis),
- "Get the extent in @var{axis} direction of @var{grob} relative to the
-grob @var{refp}")
+/** Return Array of Grobs in SCM list LST */
+Link_array<Grob>
+ly_scm2grobs (SCM lst)
{
- 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");
+ Link_array<Grob> arr;
+
+ for (SCM s = lst; scm_is_pair (s); s = scm_cdr (s))
+ {
+ SCM e = scm_car (s);
+ arr.push (unsmob_grob (e));
+ }
- return ly_interval2scm ( sc->extent (ref, Axis (gh_scm2int (axis))));
+ arr.reverse ();
+ return arr;
}
-LY_DEFINE (ly_get_parent, "ly-get-parent", 2, 0, 0, (SCM grob, SCM axis),
- "Get the parent of @var{grob}. @var{axis} can be 0 for the X-axis, 1
-for the Y-axis.")
+Object_key const *
+Grob::get_key () const
{
- 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");
-
- return sc->get_parent (Axis (gh_scm2int (axis)))->self_scm();
+ return key_;
}
-
-bool
-Grob::internal_has_interface (SCM k)
+/** Return SCM list of Grob array A */
+SCM
+ly_grobs2scm (Link_array<Grob> a)
{
- SCM ifs = get_grob_property ("interfaces");
+ SCM s = SCM_EOL;
+ for (int i = a.size (); i; i--)
+ s = scm_cons (a[i - 1]->self_scm (), s);
- return scm_memq (k, ifs) != SCM_BOOL_F;
+ return s;
}
-IMPLEMENT_TYPE_P (Grob, "ly-grob?");
+IMPLEMENT_TYPE_P (Grob, "ly:grob?");
ADD_INTERFACE (Grob, "grob-interface",
- "All grobs support this",
- "X-offset-callbacks Y-offset-callbacks X-extent-callback molecule cause
-Y-extent-callback molecule-callback extra-offset
-spacing-procedure
-staff-symbol interfaces dependencies 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 "
+ "context staff-symbol interfaces dependencies X-extent Y-extent extra-X-extent "
+ "meta layer before-line-breaking-callback "
+ "color "
+ "axis-group-parent-X "
+ "axis-group-parent-Y "
+ "after-line-breaking-callback extra-Y-extent minimum-X-extent "
+ "minimum-Y-extent transparent tweak-count tweak-rank");
projects / lilypond.git / blobdiff