#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 "warn.hh"
#include "spanner.hh"
#include "system.hh"
#include "item.hh"
-#include "paper-column.hh"
#include "molecule.hh"
#include "misc.hh"
-#include "paper-outputter.hh"
#include "music.hh"
#include "item.hh"
subclass.
*/
-
+//#define HASHING_FOR_MUTABLE_PROPS
+#define HASH_SIZE 3
#define INFINITY_MSG "Infinity or NaN encountered"
Grob::Grob (SCM basicprops)
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 ();
+#ifdef HASHING_FOR_MUTABLE_PROPS
+ mutable_property_alist_ = scm_c_make_hash_table (HASH_SIZE);
+#endif
+
SCM meta = get_grob_property ("meta");
if (gh_pair_p (meta))
{
SCM ifs = scm_assoc (ly_symbol2scm ("interfaces"), meta);
/*
- do it directly to bypass interface checks.
+ Switch off interface checks for the moment.
*/
- mutable_property_alist_ = gh_cons (gh_cons (ly_symbol2scm ("interfaces"),
- gh_cdr (ifs)),
- mutable_property_alist_);
+ bool itc = internal_type_checking_global_b;
+ internal_type_checking_global_b = false;
+ internal_set_grob_property (ly_symbol2scm ("interfaces"), gh_cdr(ifs));
+ internal_type_checking_global_b = itc;
}
/*
{
original_l_ = (Grob*) &s;
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_c_ = s.status_c_;
pscore_l_ = s.pscore_l_;
smobify_self ();
+
+#ifdef HASHING_FOR_MUTABLE_PROPS
+ mutable_property_alist_ = scm_c_make_hash_table (HASH_SIZE);
+#endif
}
Grob::~Grob ()
-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);
-}
-
-
-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);
}
MAKE_SCHEME_CALLBACK (Grob,preset_extent,2);
-
SCM
Grob::preset_extent (SCM element_smob, SCM scm_axis)
{
Molecule *
Grob::get_molecule () const
{
- if (immutable_property_alist_ == SCM_EOL)
+ if (!live())
{
return 0;
-
-/**
- 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 ()
{
{
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);
+
+ sc->substitute_mutable_properties (l ? l->self_scm () : SCM_UNDEFINED,
+ mutable_property_alist_);
}
}
System *line = line_l ();
- if (line && common_refpoint (line, X_AXIS) && common_refpoint (line, Y_AXIS))
+ if (live ()
+ && 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);
+ substitute_mutable_properties (line ? line->self_scm () : SCM_UNDEFINED,
+ mutable_property_alist_);
}
else if (dynamic_cast <System*> (this))
{
- mutable_property_alist_ = handle_broken_grobs (mutable_property_alist_,
- SCM_UNDEFINED);
+ 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-elts, which get then GC'd
- (a bad thing.)
+ 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 ();
}
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_l_)
+ {
+ Item * it = dynamic_cast<Item*> (this);
+ substitute_mutable_properties (gh_int2scm (it->break_status_dir ()),
+ original_l_->mutable_property_alist_);
+ }
}
Grob*
return 0;
}
+/*
+ translate in one direction
+*/
void
Grob::translate_axis (Real y, Axis a)
{
}
}
+
+/*
+ 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
{
return get_offset (a) + dim_cache_[a].parent_l_->relative_coordinate (refp, a);
}
+
+
+/*
+ Invoke callbacks to get offset relative to parent.
+*/
Real
Grob::get_offset (Axis a) const
{
return ext;
}
+/*
+ Find the group-element which has both #this# and #s#
+*/
Grob *
Grob::common_refpoint (Grob const* s, Axis a) const
{
}
void
-Grob::warning (String s)
+Grob::warning (String s)const
{
SCM cause = self_scm();
while (cause != SCM_EOL && !unsmob_music (cause))
}
else
::warning (s);
-
+}
+
+void
+Grob::programming_error (String s)const
+{
+ s = "Programming error: " + s;
+ warning (s);
}
{
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->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 ());
+
+ /*
+ 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_l_)
scm_gc_mark (s->original_l_->self_scm ());
- return s->do_derived_mark ();
+ s->do_derived_mark ();
+ return s->mutable_property_alist_;
}
int
}
-SCM
-ly_set_grob_property (SCM elt, SCM sym, SCM val)
-{
- Grob * sc = unsmob_grob (elt);
- SCM_ASSERT_TYPE(sc, elt, 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;
-}
-
-
-SCM
-ly_get_grob_property (SCM elt, SCM sym)
-{
- Grob * sc = unsmob_grob (elt);
- SCM_ASSERT_TYPE(sc, elt, 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 ()
{
}
-
-
-SCM
-spanner_get_bound (SCM slur, SCM dir)
-{
- 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
-ly_get_paper_var (SCM grob, SCM sym)
-{
- 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);
-}
-
-
-
-SCM
-ly_get_extent (SCM grob, SCM refp, SCM axis)
-{
- 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");
-
- return ly_interval2scm ( sc->extent (ref, Axis (gh_scm2int (axis))));
-}
-
-SCM
-ly_get_parent (SCM grob, SCM axis)
-{
- 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();
-}
-
-
-static void
-init_functions ()
-{
- scm_c_define_gsubr ("ly-get-grob-property", 2, 0, 0,
- (Scheme_function_unknown)ly_get_grob_property);
- scm_c_define_gsubr ("ly-set-grob-property", 3, 0, 0,
- (Scheme_function_unknown)ly_set_grob_property);
- scm_c_define_gsubr ("ly-get-spanner-bound", 2 , 0, 0,
- (Scheme_function_unknown) spanner_get_bound);
- scm_c_define_gsubr ("ly-get-paper-variable", 2, 0, 0,
- (Scheme_function_unknown) ly_get_paper_var);
- scm_c_define_gsubr ("ly-get-extent", 3, 0, 0,
- (Scheme_function_unknown) ly_get_extent);
- scm_c_define_gsubr ("ly-get-parent", 2, 0, 0,
- (Scheme_function_unknown) ly_get_parent);
-}
-
bool
Grob::internal_has_interface (SCM k)
{
return scm_memq (k, ifs) != SCM_BOOL_F;
}
-
-ADD_SCM_INIT_FUNC (scoreelt, init_functions);
IMPLEMENT_TYPE_P (Grob, "ly-grob?");
ADD_INTERFACE (Grob, "grob-interface",
- "All grobs support this",
+ "In music notation, lots of symbols are related in some way. You can
+think of music notation as a graph where nodes are formed by the
+symbols, and the arcs by their relations. A grob is a node in that
+graph. The directed edges in the graph are formed by references to
+other grobs (i.e. pointers). This big graph of grobs specifies the
+notation problem. The solution of this problem is a description of the
+printout in closed form, i.e. a list of values. These values are
+Molecules.
+
+All grobs have an X and Y-position on the page. These X and Y positions
+are stored in a relative format, so they can easily be combined by
+stacking them, hanging one grob to the side of another, and coupling
+them into a grouping-grob.
+
+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-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.
+
+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}
+is also an abstract grob: it only moves around chords, but doesn't print
+anything.
+",
"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");
+
projects / lilypond.git / blobdiff