source file of the GNU LilyPond music typesetter
- (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
*/
#include "grob.hh"
#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 "stencil.hh"
-#include "warn.hh"
-#include "system.hh"
+#include "international.hh"
#include "item.hh"
-#include "stencil.hh"
+#include "main.hh"
#include "misc.hh"
#include "music.hh"
-#include "item.hh"
+#include "output-def.hh"
+#include "pointer-group-interface.hh"
+#include "stencil.hh"
+#include "system.hh"
+#include "warn.hh"
#include "ly-smobs.icc"
-Grob *
+Grob *
Grob::clone (int count) const
{
return new Grob (*this, count);
}
-/* 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,
- Object_key const* key)
+ Object_key const *key)
{
key_ = key;
/* 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;
-
+ 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. */
/*
We always get a new key object for a new grob.
- */
- scm_gc_unprotect_object (key_->self_scm ());
+ */
+ if (key_)
+ ((Object_key *)key_)->unprotect ();
+
SCM meta = get_property ("meta");
if (scm_is_pair (meta))
- {
- SCM ifs = scm_assoc (ly_symbol2scm ("interfaces"), meta);
-
- /* 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*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
- programming_error ("[XY]-offset-callbacks must be a list");
-
- 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_c_procedure_p (cb) && !scm_is_pair (cb)
- && ly_c_procedure_p (get_property ("print-function")))
- cb = stencil_extent_proc;
-
- dim_cache_[a].dimension_ = cb;
- }
+ interfaces_ = scm_cdr (scm_assq (ly_symbol2scm ("interfaces"), meta));
+
+ if (get_property_data (ly_symbol2scm ("X-extent")) == SCM_EOL)
+ set_property ("X-extent", Grob::stencil_width_proc);
+ if (get_property_data (ly_symbol2scm ("Y-extent")) == SCM_EOL)
+ set_property ("Y-extent", Grob::stencil_height_proc);
}
Grob::Grob (Grob const &s, int copy_index)
- : dim_cache_ (s.dim_cache_)
+ : dim_cache_ (s.dim_cache_)
{
- key_ = new Copied_key (s.key_, copy_index);
- original_ = (Grob*) &s;
+ key_ = (use_object_keys) ? new Copied_key (s.key_, copy_index) : 0;
+ original_ = (Grob *) & s;
self_scm_ = SCM_EOL;
immutable_property_alist_ = s.immutable_property_alist_;
- mutable_property_alist_ = SCM_EOL;
+ mutable_property_alist_ = ly_deep_copy (s.mutable_property_alist_);
+ interfaces_ = s.interfaces_;
+ object_alist_ = SCM_EOL;
- /* No properties are copied. That is the job of
- handle_broken_dependencies. */
- status_ = s.status_;
- pscore_ = 0;
+ layout_ = 0;
smobify_self ();
- scm_gc_unprotect_object (key_->self_scm ());
+ if (key_)
+ ((Object_key *)key_)->unprotect ();
}
Grob::~Grob ()
{
}
-
-MAKE_SCHEME_CALLBACK (Grob, stencil_extent, 2);
-SCM
-Grob::stencil_extent (SCM element_smob, SCM scm_axis)
-{
- Grob *s = unsmob_grob (element_smob);
- Axis a = (Axis) scm_to_int (scm_axis);
-
- Stencil *m = s->get_stencil ();
- Interval e;
- if (m)
- e = m->extent (a);
- return ly_interval2scm (e);
-}
-
-
-Interval
-robust_relative_extent (Grob*me, Grob*refp, Axis a)
-{
- Interval ext = me->extent (refp, a);
- if (ext.is_empty())
- {
- ext.add_point (me->relative_coordinate (refp, a));
- }
-
- return ext;
-}
-
-Output_def *
-Grob::get_layout () const
-{
- 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_ >= final)
- return;
-
- if (status_ == busy)
- {
- programming_error ("Element is busy, come back later");
- return;
- }
-
- 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_property (funcname);
- if (ly_c_procedure_p (proc))
- scm_call_1 (proc, this->self_scm ());
-
- status_ = final;
-}
+/****************************************************************
+ STENCILS
+****************************************************************/
Stencil *
-Grob::get_stencil () const
+Grob::get_stencil () const
{
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 ())
- {
- Grob *me = (Grob*) this;
- me->set_property ("stencil", stil);
- }
-
return unsmob_stencil (stil);
}
-SCM
-Grob::get_uncached_stencil () const
+Stencil
+Grob::get_print_stencil () const
{
- SCM proc = get_property ("print-function");
-
- SCM stil = SCM_EOL;
- if (ly_c_procedure_p (proc))
- stil = scm_apply_0 (proc, scm_list_n (this->self_scm (), SCM_UNDEFINED));
+ SCM stil = get_property ("stencil");
+ Stencil retval;
if (Stencil *m = unsmob_stencil (stil))
- {
+ {
+ retval = *m;
if (to_boolean (get_property ("transparent")))
- stil = Stencil (m->extent_box (), SCM_EOL).smobbed_copy ();
+ retval = Stencil (m->extent_box (), SCM_EOL);
else
{
- SCM expr = scm_list_3 (ly_symbol2scm ("grob-cause"), self_scm(),
+ SCM expr = m->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)
+ {
+ m = unsmob_stencil (stil);
+ SCM expr = scm_list_3 (ly_symbol2scm ("color"),
+ color,
m->expr ());
- stil = Stencil (m->extent_box (),expr). smobbed_copy ();
+
+ retval = Stencil (m->extent_box (), expr);
}
- }
- return stil;
+ }
+
+ return retval;
}
-/*
+/****************************************************************
VIRTUAL STUBS
- */
+****************************************************************/
void
Grob::do_break_processing ()
{
}
+void
+Grob::discretionary_processing ()
+{
+}
+
System *
Grob::get_system () const
{
return 0;
}
-void
-Grob::add_dependency (Grob *e)
-{
- if (e)
- Pointer_group_interface::add_grob (this, ly_symbol2scm ("dependencies"),
- e);
- else
- programming_error ("Null dependency added");
-}
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 */
- 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));
-
+ {
+ 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 (is_live ()
- && system && common_refpoint (system, X_AXIS)
+ && 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_);
+ 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.
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;
-
- 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;
- }
+ 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_)
+ 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_);
}
}
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.
Otherwise, it recursively defd as
/* 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;
}
/* Invoke callbacks to get offset relative to parent. */
Real
Grob::get_offset (Axis a) const
{
- 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_int2num (l));
- SCM retval = scm_call_2 (cb, self_scm (), scm_int2num (a));
+ if (dim_cache_[a].offset_)
+ return *dim_cache_[a].offset_;
- Real r = scm_to_double (retval);
- if (isinf (r) || isnan (r))
- {
- programming_error (INFINITY_MSG);
- r = 0.0;
- }
- me->dim_cache_[a].offset_ += r;
+ Grob *me = (Grob *) this;
+
+ 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;
}
-bool
-Grob::is_empty (Axis a) const
+
+/****************************************************************
+ extents
+****************************************************************/
+
+void
+Grob::flush_extent_cache (Axis axis)
{
- return ! (scm_is_pair (dim_cache_[a].dimension_)
- || ly_c_procedure_p (dim_cache_[a].dimension_));
+ if (dim_cache_[axis].extent_)
+ {
+ /*
+ 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);
+ }
}
+
Interval
Grob::extent (Grob *refp, Axis a) const
{
- Real x = relative_coordinate (refp, a);
-
- Dimension_cache *d = (Dimension_cache *) &dim_cache_[a];
- Interval ext;
- if (scm_is_pair (d->dimension_))
- ;
- else if (ly_c_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));
+ Real offset = relative_coordinate (refp, a);
+ Interval real_ext;
+ if (dim_cache_[a].extent_)
+ {
+ real_ext = *dim_cache_[a].extent_;
+ }
else
- return ext;
-
- if (!scm_is_pair (d->dimension_))
- return ext;
-
- ext = ly_scm2interval (d->dimension_);
-
- SCM extra = get_property (a == X_AXIS
- ? "extra-X-extent"
- : "extra-Y-extent");
-
- /* Signs ? */
- if (scm_is_pair (extra))
{
- ext[BIGGER] += scm_to_double (scm_cdr (extra));
- ext[SMALLER] += scm_to_double (scm_car (extra));
+ /*
+ 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)->del_property (ext_sym);
+ ((Grob*)this)->dim_cache_[a].extent_ = new Interval (real_ext);
}
-
- 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;
+
+ real_ext.translate (offset);
+
+ return real_ext;
}
+/****************************************************************
+ REFPOINTS
+****************************************************************/
+
/* Find the group-element which has both #this# and #s# */
Grob *
Grob::common_refpoint (Grob const *s, Axis a) const
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 (; 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--; )
- 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_assoc (ly_symbol2scm ("name"), meta);
- 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 (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 (SCM cb, Axis a)const
+Grob::set_parent (Grob *g, Axis a)
{
- return scm_equal_p (cb, dim_cache_[a].dimension_) == SCM_BOOL_T;
+ 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_extent (SCM dc, Axis a)
-{
- dim_cache_[a].dimension_ = dc;
-}
void
-Grob::set_parent (Grob *g, Axis a)
-{
- dim_cache_[a].parent_ = g;
-}
-
-MAKE_SCHEME_CALLBACK (Grob,fixup_refpoint,1);
-SCM
-Grob::fixup_refpoint (SCM smob)
+Grob::fixup_refpoint ()
{
- 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 = 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);
+ 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))
::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
{
- s = "Programming error: " + s;
- warning (s);
+ SCM cause = self_scm ();
+ while (Grob *g = unsmob_grob (cause))
+ cause = g->get_property ("cause");
+
+ s = _f ("programming error: %s", s);
+
+ if (Music *m = unsmob_music (cause))
+ m->origin ()->message (s);
+ else
+ ::message (s);
}
-/****************************************************
- SMOB funcs
- ****************************************************/
+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. "
+ "\n\n"
+ "The properties @code{after-line-breaking} and @code{before-line-breaking} "
+ "are dummies that are not user-serviceable. "
-IMPLEMENT_SMOBS (Grob);
-IMPLEMENT_DEFAULT_EQUAL_P (Grob);
+ ,
-SCM
-Grob::mark_smob (SCM ses)
-{
- Grob *s = (Grob*) SCM_CELL_WORD_1 (ses);
- scm_gc_mark (s->immutable_property_alist_);
- 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_);
-
- /* 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). */
- }
+ /* properties */
+ "X-extent "
+ "X-offset "
+ "Y-extent "
+ "Y-offset "
+ "after-line-breaking "
+ "axis-group-parent-X "
+ "axis-group-parent-Y "
+ "before-line-breaking "
+ "cause "
+ "color "
+ "extra-X-extent "
+ "extra-Y-extent "
+ "extra-offset "
+ "interfaces "
+ "layer "
+ "meta "
+ "minimum-X-extent "
+ "minimum-Y-extent "
+ "rotation "
+ "springs-and-rods "
+ "staff-symbol "
+ "stencil "
+ "transparent "
+ );
- 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 *) SCM_CELL_WORD_1 (s);
- scm_puts ("#<Grob ", port);
- scm_puts ((char *) sc->name ().to_str0 (), port);
- /* Do not print properties, that is too much hassle. */
- scm_puts (" >", port);
- return 1;
+/****************************************************************
+ 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::do_derived_mark () const
+Grob::stencil_height (SCM smob)
{
- return SCM_EOL;
+ Grob *me = unsmob_grob (smob);
+ return grob_stencil_extent (me, Y_AXIS);
}
-void
-Grob::discretionary_processing ()
+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);
+}
-bool
-Grob::internal_has_interface (SCM k)
+MAKE_SCHEME_CALLBACK(Grob, x_parent_positioning, 1);
+SCM
+Grob::x_parent_positioning (SCM smob)
{
- SCM ifs = get_property ("interfaces");
+ Grob *me = unsmob_grob (smob);
+
+ Grob *par = me->get_parent (X_AXIS);
+ if (par)
+ (void) par->get_property ("positioning-done");
- return scm_c_memq (k, ifs) != SCM_BOOL_F;
+ return scm_from_double (0.0);
}
-Grob*
-Grob::get_parent (Axis a) const
+MAKE_SCHEME_CALLBACK (Grob, stencil_width, 1);
+SCM
+Grob::stencil_width (SCM smob)
{
- return dim_cache_[a].parent_;
+ Grob *me = unsmob_grob (smob);
+ return grob_stencil_extent (me, X_AXIS);
}
-/** Return Array of Grobs in SCM list LST */
-Link_array<Grob>
-ly_scm2grobs (SCM lst)
-{
- 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));
- }
+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;
}
-Object_key const *
-Grob::get_key () const
+Grob *
+common_refpoint_of_array (vector<Grob*> const &arr, Grob *common, Axis a)
{
- return key_;
+ for (vsize i = arr.size (); i--;)
+ if (Grob *s = arr[i])
+ {
+ if (common)
+ common = common->common_refpoint (s, a);
+ else
+ common = s;
+ }
+
+ return common;
}
-/** Return SCM list of Grob array A */
-SCM
-ly_grobs2scm (Link_array<Grob> a)
+Interval
+robust_relative_extent (Grob *me, Grob *refpoint, Axis a)
{
- SCM s = SCM_EOL;
- for (int i = a.size (); i; i--)
- s = scm_cons (a[i-1]->self_scm (), s);
+ Interval ext = me->extent (refpoint, a);
+ if (ext.is_empty ())
+ ext.add_point (me->relative_coordinate (refpoint, a));
- return s;
+ return ext;
}
-
-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 "
- "context staff-symbol interfaces dependencies X-extent Y-extent extra-X-extent "
- "meta layer before-line-breaking-callback "
- "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