#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)
/*
fixme: default should be no callback.
*/
-
- pscore_l_=0;
- status_c_ = 0;
- original_l_ = 0;
+ self_scm_ = SCM_EOL;
+ pscore_=0;
+ status_ = 0;
+ original_ = 0;
immutable_property_alist_ = basicprops;
mutable_property_alist_ = SCM_EOL;
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;
}
/*
Grob::Grob (Grob const&s)
: dim_cache_ (s.dim_cache_)
{
- original_l_ = (Grob*) &s;
+ original_ = (Grob*) &s;
+ self_scm_ = SCM_EOL;
+
immutable_property_alist_ = s.immutable_property_alist_;
- mutable_property_alist_ = SCM_EOL;
+ 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_;
+ status_ = s.status_;
+ pscore_ = s.pscore_;
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);
Axis a = (Axis) gh_scm2int (scm_axis);
SCM ext = s->get_grob_property ((a == X_AXIS)
- ? "extent-X"
- : "extent-Y");
+ ? "X-extent"
+ : "Y-extent");
if (gh_pair_p (ext))
{
Paper_def*
-Grob::paper_l () const
+Grob::get_paper () const
{
- return pscore_l_ ? pscore_l_->paper_l_ : 0;
+ return pscore_ ? pscore_->paper_ : 0;
}
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;
+ status_= busy;
for (SCM d = get_grob_property ("dependencies"); gh_pair_p (d);
d = ly_cdr (d))
if (gh_procedure_p (proc))
gh_call1 (proc, this->self_scm ());
- status_c_= final;
+ status_= final;
}
Molecule *
Grob::get_molecule () const
{
- if (immutable_property_alist_ == SCM_EOL)
+ if (!live())
{
return 0;
mol = get_uncached_molecule ();
- Grob *me = (Grob*)this;
- me->set_grob_property ("molecule", mol);
+ if (live ())
+ {
+ Grob *me = (Grob*)this;
+ me->set_grob_property ("molecule", mol);
+ }
return unsmob_molecule (mol);
}
+
SCM
Grob::get_uncached_molecule ()const
{
SCM mol = SCM_EOL;
if (gh_procedure_p (proc))
mol = gh_apply (proc, scm_list_n (this->self_scm (), SCM_UNDEFINED));
-
Molecule *m = unsmob_molecule (mol);
{
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 (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;
+ }
}
// ugr.
{
}
-
-
-
-
-
System *
-Grob::line_l () const
+Grob::get_system () const
{
return 0;
}
}
-
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)
+ if (sp)
{
- for (int i = 0; i< s->broken_into_l_arr_ .size (); i++)
+ for (SCM s = mutable_property_alist_; gh_pair_p(s);
+ s = gh_cdr(s))
{
- Grob * sc = s->broken_into_l_arr_[i];
- System * l = sc->line_l ();
-
- set_break_subsititution (l ? l->self_scm () : SCM_UNDEFINED);
- sc->mutable_property_alist_ =
- substitute_mutable_properties (mutable_property_alist_);
-
+ sp->substitute_one_mutable_property (gh_caar (s),
+ gh_cdar (s));
+
}
}
+ System *system = get_system ();
- System *line = line_l ();
-
- if (line && common_refpoint (line, X_AXIS) && common_refpoint (line, Y_AXIS))
+ if (live ()
+ && system && common_refpoint (system, X_AXIS) && common_refpoint (system, Y_AXIS))
{
- set_break_subsititution (line ? line->self_scm () : SCM_UNDEFINED);
- mutable_property_alist_ = substitute_mutable_properties (mutable_property_alist_);
+ substitute_mutable_properties (system ? system->self_scm () : SCM_UNDEFINED,
+ mutable_property_alist_);
}
else if (dynamic_cast <System*> (this))
{
- set_break_subsititution (SCM_UNDEFINED);
- mutable_property_alist_ = substitute_mutable_properties (mutable_property_alist_);
+ substitute_mutable_properties (SCM_UNDEFINED, mutable_property_alist_);
}
else
{
void
Grob::suicide ()
{
+ if (!live ())
+ return;
+
+#if 0 // see below.
+ String nm = name();
+#endif
+
mutable_property_alist_ = SCM_EOL;
immutable_property_alist_ = SCM_EOL;
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
}
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 (gh_int2scm (it->break_status_dir ()),
+ original_->mutable_property_alist_);
+ }
}
Grob*
not ask for the absolute coordinate (ie. REFP == nil.)
*/
- if (refp == dim_cache_[a].parent_l_)
+ 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);
}
ext = ly_scm2interval (d->dimension_);
SCM extra = get_grob_property (a == X_AXIS
- ? "extra-extent-X"
- : "extra-extent-Y");
+ ? "extra-X-extent"
+ : "extra-Y-extent");
/*
signs ?
}
extra = get_grob_property (a == X_AXIS
- ? "minimum-extent-X"
- : "minimum-extent-Y");
+ ? "minimum-X-extent"
+ : "minimum-Y-extent");
if (gh_pair_p (extra))
{
ext.unite (Interval (gh_scm2double (ly_car (extra)),
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_)
+ 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_parent (Grob *g, Axis a)
{
- dim_cache_[a].parent_l_ = g;
+ dim_cache_[a].parent_ = g;
}
MAKE_SCHEME_CALLBACK (Grob,fixup_refpoint,1);
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);
}
Grob::warning (String s)const
{
SCM cause = self_scm();
- while (cause != SCM_EOL && !unsmob_music (cause))
+ while (Grob * g = unsmob_grob (cause))
{
- Grob * g = unsmob_grob (cause);
cause = g->get_grob_property ("cause");
}
{
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 (Axis (a));
- 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 ());
+ if (s->original_)
+ scm_gc_mark (s->original_->self_scm ());
- return s->do_derived_mark ();
+ s->do_derived_mark ();
+ return s->mutable_property_alist_;
}
int
Grob *sc = (Grob *) ly_cdr (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.
}
SCM
-Grob::do_derived_mark ()
+Grob::do_derived_mark () const
{
return SCM_EOL;
}
return scm_memq (k, ifs) != SCM_BOOL_F;
}
-IMPLEMENT_TYPE_P (Grob, "ly-grob?");
+
+/** Return Array of Grobs in SCM list L */
+Link_array<Grob>
+ly_scm2grobs (SCM l)
+{
+ Link_array<Grob> arr;
+
+ for (SCM s = l; gh_pair_p (s); s = gh_cdr (s))
+ {
+ SCM e = gh_car (s);
+ arr.push (unsmob_grob (e));
+ }
+
+ arr.reverse ();
+ return arr;
+}
+
+/** Return SCM list of Grob array A */
+SCM
+ly_grobs2scm (Link_array<Grob> a)
+{
+ SCM s = SCM_EOL;
+ for (int i = a.size (); i; i--)
+ s = gh_cons (a[i-1]->self_scm (), s);
+
+ return s;
+}
+
+
+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");
+Y-extent-callback molecule-callback extra-offset spacing-procedure
+staff-symbol interfaces dependencies X-extent Y-extent extra-X-extent
+causes meta layer before-line-breaking-callback
+after-line-breaking-callback extra-Y-extent minimum-X-extent
+minimum-Y-extent transparent");
+
projects / lilypond.git / blobdiff