/*
- score-elem.cc -- implement Grob
+ grob.cc -- implement Grob
source file of the GNU LilyPond music typesetter
- (c) 1997--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
*/
#include <string.h>
#include <math.h>
+#include "main.hh"
#include "input-smob.hh"
-#include "libc-extension.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 "line-of-score.hh"
+#include "system.hh"
#include "item.hh"
-#include "paper-column.hh"
#include "molecule.hh"
#include "misc.hh"
-#include "paper-outputter.hh"
-#include "dimension-cache.hh"
-#include "side-position-interface.hh"
+#include "music.hh"
#include "item.hh"
#include "ly-smobs.icc"
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);
+
+ /*
+ Switch off interface checks for the moment.
+ */
+ 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;
+ }
+
/*
TODO:
/*
Should change default to be empty?
*/
- if (cb != SCM_BOOL_F && !gh_procedure_p (cb) && !gh_pair_p (cb))
+ 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 meta = get_grob_property ("meta");
- if (gh_pair_p (meta))
- {
- SCM ifs = scm_assoc (ly_symbol2scm ("interfaces"), meta);
-
- set_grob_property ("interfaces",ly_cdr (ifs));
- }
}
Grob::Grob (Grob const&s)
{
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 ()
}
-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_);
- 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;
-}
-
-
-#if 0
-/*
- Puts the k, v in the immutable_property_alist_, which is convenient for
- storing variables that are needed during the breaking process. (eg.
- Line_of_score::rank : int)
- */
-void
-Grob::set_immutable_grob_property (const char*k, SCM v)
-{
- SCM s = ly_symbol2scm (k);
- set_immutable_grob_property (s, v);
-}
-
-void
-Grob::set_immutable_grob_property (SCM s, SCM v)
-{
- immutable_property_alist_ = gh_cons (gh_cons (s,v), mutable_property_alist_);
- mutable_property_alist_ = scm_assq_remove_x (mutable_property_alist_, s);
-}
-#endif
-
-
-void
-Grob::internal_set_grob_property (SCM s, SCM v)
-{
- mutable_property_alist_ = scm_assq_set_x (mutable_property_alist_, s, v);
-}
MAKE_SCHEME_CALLBACK (Grob,molecule_extent,2);
}
MAKE_SCHEME_CALLBACK (Grob,preset_extent,2);
-
SCM
Grob::preset_extent (SCM element_smob, SCM scm_axis)
{
status_c_= busy;
- for (SCM d= get_grob_property ("dependencies"); gh_pair_p (d); d = ly_cdr (d))
+ 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);
}
- // ughugh.
- String s = ly_symbol2string (funcname);
- SCM proc = get_grob_property (s.ch_C ());
+
+ SCM proc = internal_get_grob_property (funcname);
if (gh_procedure_p (proc))
gh_call1 (proc, this->self_scm ());
-
+
status_c_= final;
-
}
Molecule *
Grob::get_molecule () const
{
+ if (!live())
+ {
+ return 0;
+
+ }
+
SCM mol = get_grob_property ("molecule");
if (unsmob_molecule (mol))
return unsmob_molecule (mol);
if (unsmob_molecule (mol))
{
- /*
- TODO: add option for not copying origin info.
- */
- SCM origin =get_grob_property ("origin");
- if (!unsmob_input (origin))
- origin =ly_symbol2scm ("no-origin");
-
+ 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;
+ }
+ }
+
// ugr.
mol = Molecule (m->extent_box (),
-Line_of_score *
+System *
Grob::line_l () const
{
return 0;
{
if (e)
{
- Pointer_group_interface ::add_element (this, "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
- {
- Line_of_score * line
- = dynamic_cast<Line_of_score*> (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 (SCM_CONSP (src))
- {
- 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 ()
{
for (int i = 0; i< s->broken_into_l_arr_ .size (); i++)
{
Grob * sc = s->broken_into_l_arr_[i];
- Line_of_score * l = sc->line_l ();
- sc->mutable_property_alist_ =
- handle_broken_grobs (mutable_property_alist_,
- l ? l->self_scm () : SCM_UNDEFINED);
+ System * l = sc->line_l ();
+
+ sc->substitute_mutable_properties (l ? l->self_scm () : SCM_UNDEFINED,
+ mutable_property_alist_);
}
}
- Line_of_score *line = line_l ();
+ 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 <Line_of_score*> (this))
+ 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 Line_of_score, 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 ();
}
mutable_property_alist_ = SCM_EOL;
immutable_property_alist_ = SCM_EOL;
- set_extent_callback (SCM_EOL, Y_AXIS);
- set_extent_callback (SCM_EOL, X_AXIS);
+ set_extent (SCM_EOL, Y_AXIS);
+ set_extent (SCM_EOL, X_AXIS);
for (int a= X_AXIS; a <= Y_AXIS; a++)
{
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*
-Grob::find_broken_piece (Line_of_score*) const
+Grob::find_broken_piece (System*) const
{
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
{
gh_procedure_p (dim_cache_[a].dimension_));
}
-/*
- TODO: add
-
- Grob *refpoint
-
- to arguments?
- */
Interval
Grob::extent (Grob * refp, 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
{
Grob *
-Grob::common_refpoint (SCM elist, Axis a) const
+common_refpoint_of_list (SCM elist, Grob *common, Axis a)
{
- Grob * common = (Grob*) this;
for (; gh_pair_p (elist); elist = ly_cdr (elist))
{
Grob * s = unsmob_grob (ly_car (elist));
- if (s)
+ if (!s)
+ continue;
+ 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;
}
return common;
}
-bool
-Grob::has_extent_callback_b (Axis a) const
-{
- return gh_procedure_p (dim_cache_[a].dimension_);
-}
-
bool
Grob::has_offset_callback_b (SCM cb, Axis a)const
{
}
void
-Grob::set_extent_callback (SCM dc, Axis a)
+Grob::set_extent (SCM dc, Axis a)
{
dim_cache_[a].dimension_ =dc;
}
for (int a = X_AXIS; a < NO_AXES; a ++)
{
Axis ax = (Axis)a;
- Grob * parent = me->parent_l (ax);
+ Grob * parent = me->get_parent (ax);
if (!parent)
continue;
return smob;
}
+void
+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");
+ }
+
+ if (Music *m = unsmob_music (cause))
+ {
+ m->origin()->warning (s);
+ }
+ 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->parent_l (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);
-
- if (!gh_symbol_p (sym))
- {
- error ("Not a symbol");
- ly_display_scm (sym);
- return SCM_UNSPECIFIED;
- }
-
- if (sc)
- {
- sc->internal_set_grob_property (sym, val);
- }
- else
- {
- error ("Not a score element");
- ly_display_scm (elt);
- }
-
- return SCM_UNSPECIFIED;
-}
-
-
-SCM
-ly_get_grob_property (SCM elt, SCM sym)
-{
- Grob * sc = unsmob_grob (elt);
-
- if (sc)
- {
- return sc->internal_get_grob_property (sym);
- }
- else
- {
- error ("Not a score element");
- ly_display_scm (elt);
- }
- return SCM_UNSPECIFIED;
-}
-
void
Grob::discretionary_processing ()
{
}
-
-
-SCM
-spanner_get_bound (SCM slur, SCM dir)
-{
- return dynamic_cast<Spanner*> (unsmob_grob (slur))->get_bound (to_dir (dir))->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);
-}
-
bool
-Grob::has_interface (SCM k)
+Grob::internal_has_interface (SCM k)
{
SCM ifs = get_grob_property ("interfaces");
return scm_memq (k, ifs) != SCM_BOOL_F;
}
-void
-Grob::set_interface (SCM k)
-{
- if (has_interface (k))
- return ;
- else
- {
- set_grob_property ("interfaces",
- gh_cons (k, get_grob_property ("interfaces")));
- }
-}
+IMPLEMENT_TYPE_P (Grob, "ly-grob?");
+
+ADD_INTERFACE (Grob, "grob-interface",
+ "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");
-ADD_SCM_INIT_FUNC (scoreelt, init_functions);
-IMPLEMENT_TYPE_P (Grob, "ly-grob?");
projects / lilypond.git / blobdiff