2 grob.cc -- implement Grob
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
15 #include "input-smob.hh"
17 #include "group-interface.hh"
19 #include "paper-score.hh"
29 #include "ly-smobs.icc"
32 Grob::clone (int count) const
34 return new Grob (*this, count);
39 - remove dynamic_cast<Spanner, Item> and put this code into respective
43 #define INFINITY_MSG "Infinity or NaN encountered"
45 Grob::Grob (SCM basicprops,
46 Object_key const* key)
49 /* FIXME: default should be no callback. */
54 immutable_property_alist_ = basicprops;
55 mutable_property_alist_ = SCM_EOL;
57 /* We do smobify_self () as the first step. Since the object lives
58 on the heap, none of its SCM variables are protected from
59 GC. After smobify_self (), they are. */
63 We always get a new key object for a new grob.
65 scm_gc_unprotect_object (key_->self_scm ());
66 SCM meta = get_property ("meta");
67 if (scm_is_pair (meta))
69 SCM ifs = scm_assoc (ly_symbol2scm ("interfaces"), meta);
71 /* Switch off interface checks for the moment. */
72 bool itc = do_internal_type_checking_global;
73 do_internal_type_checking_global = false;
74 internal_set_property (ly_symbol2scm ("interfaces"), scm_cdr (ifs));
75 do_internal_type_checking_global = itc;
80 - destill this into a function, so we can re-init the immutable
81 properties with a new BASICPROPS value after
82 creation. Convenient eg. when using \override with
85 char const*onames[] = {"X-offset-callbacks", "Y-offset-callbacks"};
86 char const*xnames[] = {"X-extent", "Y-extent"};
87 char const*enames[] = {"X-extent-callback", "Y-extent-callback"};
89 for (int a = X_AXIS; a <= Y_AXIS; a++)
91 SCM l = get_property (onames[a]);
93 if (scm_ilength (l) >= 0)
95 dim_cache_[a].offset_callbacks_ = l;
96 dim_cache_[a].offsets_left_ = scm_ilength (l);
99 programming_error ("[XY]-offset-callbacks must be a list");
101 SCM cb = get_property (enames[a]);
102 if (cb == SCM_BOOL_F)
104 dim_cache_[a].dimension_ = SCM_BOOL_F;
107 SCM xt = get_property (xnames[a]);
108 if (is_number_pair (xt))
110 dim_cache_[a].dimension_ = xt;
112 else if (ly_c_procedure_p (cb))
114 dim_cache_[a].dimension_callback_ = cb;
116 else if (cb == SCM_EOL
117 && ly_c_procedure_p (get_property ("print-function")))
118 dim_cache_[a].dimension_callback_ = stencil_extent_proc;
122 Grob::Grob (Grob const &s, int copy_index)
123 : dim_cache_ (s.dim_cache_)
125 key_ = new Copied_key (s.key_, copy_index);
126 original_ = (Grob*) &s;
129 immutable_property_alist_ = s.immutable_property_alist_;
130 mutable_property_alist_ = SCM_EOL;
132 /* No properties are copied. That is the job of
133 handle_broken_dependencies. */
138 scm_gc_unprotect_object (key_->self_scm ());
145 MAKE_SCHEME_CALLBACK (Grob, stencil_extent, 2);
147 Grob::stencil_extent (SCM element_smob, SCM scm_axis)
149 Grob *s = unsmob_grob (element_smob);
150 Axis a = (Axis) scm_to_int (scm_axis);
152 Stencil *m = s->get_stencil ();
156 return ly_interval2scm (e);
161 robust_relative_extent (Grob*me, Grob*refp, Axis a)
163 Interval ext = me->extent (refp, a);
166 ext.add_point (me->relative_coordinate (refp, a));
173 Grob::get_layout () const
175 return pscore_ ? pscore_->layout_ : 0;
179 /* Recursively track all dependencies of this Grob. The status_ field
180 is used as a mark-field. It is marked with BUSY during execution
181 of this function, and marked with FINAL when finished.
183 FUNCPTR is the function to call to update this element. */
185 Grob::calculate_dependencies (int final, int busy, SCM funcname)
187 if (status_ >= final)
192 programming_error ("Element is busy, come back later");
198 for (SCM d = get_property ("dependencies"); scm_is_pair (d);
200 unsmob_grob (scm_car (d))->calculate_dependencies (final, busy, funcname);
202 SCM proc = internal_get_property (funcname);
203 if (ly_c_procedure_p (proc))
204 scm_call_1 (proc, this->self_scm ());
210 Grob::get_stencil () const
215 SCM stil = get_property ("stencil");
216 if (unsmob_stencil (stil))
217 return unsmob_stencil (stil);
219 stil = get_uncached_stencil ();
222 Grob *me = (Grob*) this;
223 me->set_property ("stencil", stil);
226 return unsmob_stencil (stil);
230 Grob::get_uncached_stencil () const
232 SCM proc = get_property ("print-function");
235 if (ly_c_procedure_p (proc))
236 stil = scm_apply_0 (proc, scm_list_n (this->self_scm (), SCM_UNDEFINED));
238 if (Stencil *m = unsmob_stencil (stil))
240 if (to_boolean (get_property ("transparent")))
241 stil = Stencil (m->extent_box (), SCM_EOL).smobbed_copy ();
244 SCM expr = scm_list_3 (ly_symbol2scm ("grob-cause"), self_scm(),
246 stil = Stencil (m->extent_box (), expr). smobbed_copy ();
249 /* color support... see interpret_stencil_expression() for more... */
250 SCM color = get_property ("color");
251 if (color != SCM_EOL)
253 m = unsmob_stencil (stil);
254 SCM expr = scm_list_3 (ly_symbol2scm ("color"),
258 stil = Stencil (m->extent_box (), expr).smobbed_copy();
269 Grob::do_break_processing ()
274 Grob::get_system () const
280 Grob::add_dependency (Grob *e)
283 Pointer_group_interface::add_grob (this, ly_symbol2scm ("dependencies"),
286 programming_error ("Null dependency added");
290 Grob::handle_broken_dependencies ()
292 Spanner *sp = dynamic_cast<Spanner*> (this);
297 /* THIS, SP is the original spanner. We use a special function
298 because some Spanners have enormously long lists in their
299 properties, and a special function fixes FOO */
300 for (SCM s = mutable_property_alist_; scm_is_pair (s); s = scm_cdr (s))
301 sp->substitute_one_mutable_property (scm_caar (s), scm_cdar (s));
303 System *system = get_system ();
306 && system && common_refpoint (system, X_AXIS)
307 && common_refpoint (system, Y_AXIS))
308 substitute_mutable_properties (system
309 ? system->self_scm () : SCM_UNDEFINED,
310 mutable_property_alist_);
311 else if (dynamic_cast <System*> (this))
312 substitute_mutable_properties (SCM_UNDEFINED, mutable_property_alist_);
314 /* THIS element is `invalid'; it has been removed from all
315 dependencies, so let's junk the element itself.
317 Do not do this for System, since that would remove references
318 to the originals of score-grobs, which get then GC'd (a bad
323 /* Note that we still want references to this element to be
324 rearranged, and not silently thrown away, so we keep pointers like
325 {broken_into_{drul, array}, original}
333 mutable_property_alist_ = SCM_EOL;
334 immutable_property_alist_ = SCM_EOL;
336 set_extent (SCM_EOL, Y_AXIS);
337 set_extent (SCM_EOL, X_AXIS);
339 set_extent_callback (SCM_EOL, Y_AXIS);
340 set_extent_callback (SCM_EOL, X_AXIS);
342 for (int a = X_AXIS; a <= Y_AXIS; a++)
344 dim_cache_[a].offset_callbacks_ = SCM_EOL;
345 dim_cache_[a].offsets_left_ = 0;
350 Grob::handle_prebroken_dependencies ()
352 /* Don't do this in the derived method, since we want to keep access to
353 mutable_property_alist_ centralized. */
356 Item *it = dynamic_cast<Item*> (this);
357 substitute_mutable_properties (scm_int2num (it->break_status_dir ()),
358 original_->mutable_property_alist_);
363 Grob::find_broken_piece (System *) const
368 /* Translate in one direction. */
370 Grob::translate_axis (Real y, Axis a)
372 if (isinf (y) || isnan (y))
373 programming_error (_ (INFINITY_MSG));
375 dim_cache_[a].offset_ += y;
379 /* Find the offset relative to D. If D equals THIS, then it is 0.
380 Otherwise, it recursively defd as
382 OFFSET_ + PARENT_L_->relative_coordinate (D) */
384 Grob::relative_coordinate (Grob const *refp, Axis a) const
389 /* We catch PARENT_L_ == nil case with this, but we crash if we did
390 not ask for the absolute coordinate (ie. REFP == nil.) */
391 if (refp == dim_cache_[a].parent_)
392 return get_offset (a);
394 return get_offset (a) + dim_cache_[a].parent_->relative_coordinate (refp, a);
397 /* Invoke callbacks to get offset relative to parent. */
399 Grob::get_offset (Axis a) const
401 Grob *me = (Grob*) this;
402 while (dim_cache_[a].offsets_left_)
404 int l = --me->dim_cache_[a].offsets_left_;
405 SCM cb = scm_list_ref (dim_cache_[a].offset_callbacks_, scm_int2num (l));
406 SCM retval = scm_call_2 (cb, self_scm (), scm_int2num (a));
408 Real r = scm_to_double (retval);
409 if (isinf (r) || isnan (r))
411 programming_error (INFINITY_MSG);
414 me->dim_cache_[a].offset_ += r;
416 return dim_cache_[a].offset_;
420 Grob::is_empty (Axis a) const
422 return !(scm_is_pair (dim_cache_[a].dimension_)
423 || ly_c_procedure_p (dim_cache_[a].dimension_callback_));
427 Grob::flush_extent_cache (Axis axis)
429 Dimension_cache * d = &dim_cache_[axis];
430 if (ly_c_procedure_p (d->dimension_callback_)
431 && scm_is_pair (d->dimension_))
433 d->dimension_ = SCM_EOL;
436 if (get_parent (axis))
437 get_parent(axis)->flush_extent_cache (axis);
442 Grob::extent (Grob *refp, Axis a) const
444 Real x = relative_coordinate (refp, a);
446 Dimension_cache *d = (Dimension_cache *) &dim_cache_[a];
449 SCM dimpair = d->dimension_;
450 if (scm_is_pair (dimpair))
452 else if (ly_c_procedure_p (d->dimension_callback_)
453 && d->dimension_ == SCM_EOL)
454 d->dimension_ = scm_call_2 (d->dimension_callback_, self_scm (), scm_int2num (a));
458 if (!scm_is_pair (d->dimension_))
461 ext = ly_scm2interval (d->dimension_);
463 SCM extra = get_property (a == X_AXIS
468 if (scm_is_pair (extra))
470 ext[BIGGER] += scm_to_double (scm_cdr (extra));
471 ext[SMALLER] += scm_to_double (scm_car (extra));
474 extra = get_property (a == X_AXIS
476 : "minimum-Y-extent");
477 if (scm_is_pair (extra))
478 ext.unite (Interval (scm_to_double (scm_car (extra)),
479 scm_to_double (scm_cdr (extra))));
486 /* Find the group-element which has both #this# and #s# */
488 Grob::common_refpoint (Grob const *s, Axis a) const
490 /* I don't like the quadratic aspect of this code, but I see no
491 other way. The largest chain of parents might be 10 high or so,
492 so it shouldn't be a real issue. */
493 for (Grob const *c = this; c; c = c->dim_cache_[a].parent_)
494 for (Grob const *d = s; d; d = d->dim_cache_[a].parent_)
502 common_refpoint_of_list (SCM elist, Grob *common, Axis a)
504 for (; scm_is_pair (elist); elist = scm_cdr (elist))
505 if (Grob *s = unsmob_grob (scm_car (elist)))
508 common = common->common_refpoint (s, a);
517 common_refpoint_of_array (Link_array<Grob> const &arr, Grob *common, Axis a)
519 for (int i = arr.size (); i--; )
520 if (Grob *s = arr[i])
523 common = common->common_refpoint (s, a);
534 SCM meta = get_property ("meta");
535 SCM nm = scm_assoc (ly_symbol2scm ("name"), meta);
536 nm = (scm_is_pair (nm)) ? scm_cdr (nm) : SCM_EOL;
537 return scm_is_symbol (nm) ? ly_symbol2string (nm) : classname (this);
541 Grob::add_offset_callback (SCM cb, Axis a)
543 if (!has_offset_callback (cb, a))
545 dim_cache_[a].offset_callbacks_
546 = scm_cons (cb, dim_cache_[a].offset_callbacks_);
547 dim_cache_[a].offsets_left_ ++;
552 Grob::has_extent_callback (SCM cb, Axis a) const
554 return scm_equal_p (cb, dim_cache_[a].dimension_callback_) == SCM_BOOL_T;
558 Grob::has_offset_callback (SCM cb, Axis a) const
560 return scm_c_memq (cb, dim_cache_[a].offset_callbacks_) != SCM_BOOL_F;
564 Grob::set_extent (SCM dc, Axis a)
566 dim_cache_[a].dimension_ = dc;
570 Grob::set_extent_callback (SCM dc, Axis a)
572 dim_cache_[a].dimension_callback_ = dc;
576 Grob::set_parent (Grob *g, Axis a)
578 dim_cache_[a].parent_ = g;
581 MAKE_SCHEME_CALLBACK (Grob, fixup_refpoint, 1);
583 Grob::fixup_refpoint (SCM smob)
585 Grob *me = unsmob_grob (smob);
586 for (int a = X_AXIS; a < NO_AXES; a ++)
589 Grob *parent = me->get_parent (ax);
594 if (parent->get_system () != me->get_system () && me->get_system ())
596 Grob *newparent = parent->find_broken_piece (me->get_system ());
597 me->set_parent (newparent, ax);
600 if (Item *i = dynamic_cast<Item*> (me))
602 Item *parenti = dynamic_cast<Item*> (parent);
606 Direction my_dir = i->break_status_dir () ;
607 if (my_dir!= parenti->break_status_dir ())
609 Item *newparent = parenti->find_prebroken_piece (my_dir);
610 me->set_parent (newparent, ax);
619 Grob::warning (String s) const
621 SCM cause = self_scm ();
622 while (Grob *g = unsmob_grob (cause))
623 cause = g->get_property ("cause");
625 if (Music *m = unsmob_music (cause))
626 m->origin ()->warning (s);
632 Grob::programming_error (String s) const
634 s = "Programming error: " + s;
639 /****************************************************
641 ****************************************************/
643 IMPLEMENT_SMOBS (Grob);
644 IMPLEMENT_DEFAULT_EQUAL_P (Grob);
647 Grob::mark_smob (SCM ses)
649 Grob *s = (Grob*) SCM_CELL_WORD_1 (ses);
650 scm_gc_mark (s->immutable_property_alist_);
651 scm_gc_mark (s->key_->self_scm ());
652 for (int a = 0 ; a < 2; a++)
654 scm_gc_mark (s->dim_cache_[a].offset_callbacks_);
655 scm_gc_mark (s->dim_cache_[a].dimension_);
656 scm_gc_mark (s->dim_cache_[a].dimension_callback_);
658 /* Do not mark the parents. The pointers in the mutable
659 property list form two tree like structures (one for X
660 relations, one for Y relations). Marking these can be done
661 in limited stack space. If we add the parents, we will jump
662 between X and Y in an erratic manner, leading to much more
663 recursion depth (and core dumps if we link to pthreads). */
667 scm_gc_mark (s->original_->self_scm ());
669 s->do_derived_mark ();
670 return s->mutable_property_alist_;
674 Grob::print_smob (SCM s, SCM port, scm_print_state *)
676 Grob *sc = (Grob *) SCM_CELL_WORD_1 (s);
678 scm_puts ("#<Grob ", port);
679 scm_puts ((char *) sc->name ().to_str0 (), port);
681 /* Do not print properties, that is too much hassle. */
682 scm_puts (" >", port);
687 Grob::do_derived_mark () const
693 Grob::discretionary_processing ()
698 Grob::internal_has_interface (SCM k)
700 SCM ifs = get_property ("interfaces");
702 return scm_c_memq (k, ifs) != SCM_BOOL_F;
706 Grob::get_parent (Axis a) const
708 return dim_cache_[a].parent_;
712 /** Return Array of Grobs in SCM list LST */
714 ly_scm2grobs (SCM lst)
716 Link_array<Grob> arr;
718 for (SCM s = lst; scm_is_pair (s); s = scm_cdr (s))
721 arr.push (unsmob_grob (e));
729 Grob::get_key () const
734 /** Return SCM list of Grob array A */
736 ly_grobs2scm (Link_array<Grob> a)
739 for (int i = a.size (); i; i--)
740 s = scm_cons (a[i-1]->self_scm (), s);
746 IMPLEMENT_TYPE_P (Grob, "ly:grob?");
748 ADD_INTERFACE (Grob, "grob-interface",
749 "A grob represents a piece of music notation\n"
751 "All grobs have an X and Y-position on the page. These X and Y positions\n"
752 "are stored in a relative format, so they can easily be combined by\n"
753 "stacking them, hanging one grob to the side of another, and coupling\n"
754 "them into a grouping objects.\n"
756 "Each grob has a reference point (a.k.a. parent): the position of a grob\n"
757 "is stored relative to that reference point. For example the X-reference\n"
758 "point of a staccato dot usually is the note head that it applies\n"
759 "to. When the note head is moved, the staccato dot moves along\n"
762 "A grob is often associated with a symbol, but some grobs do not print\n"
763 "any symbols. They take care of grouping objects. For example, there is a\n"
764 "separate grob that stacks staves vertically. The @ref{NoteCollision}\n"
765 "is also an abstract grob: it only moves around chords, but doesn't print\n"
768 "Grobs have a properties: Scheme variables, that can be read and set. "
769 "They have two types. Immutable variables "
770 "define the default style and behavior. They are shared between many objects. "
771 "They can be changed using @code{\\override} and @code{\\revert}. "
773 "Mutable properties are variables that are specific to one grob. Typically, "
774 "lists of other objects, or results from computations are stored in"
775 "mutable properties: every call to set-grob-property (or its C++ equivalent) "
776 "sets a mutable property. "
779 "X-offset-callbacks Y-offset-callbacks X-extent-callback stencil cause "
780 "Y-extent-callback print-function extra-offset spacing-procedure "
781 "context staff-symbol interfaces dependencies X-extent Y-extent extra-X-extent "
782 "meta layer before-line-breaking-callback "
784 "axis-group-parent-X "
785 "axis-group-parent-Y "
786 "after-line-breaking-callback extra-Y-extent minimum-X-extent "
787 "minimum-Y-extent transparent tweak-count tweak-rank"