2 grob.cc -- implement Grob
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
13 #include "align-interface.hh"
15 #include "international.hh"
20 #include "output-def.hh"
21 #include "pointer-group-interface.hh"
23 #include "stream-event.hh"
27 #include "ly-smobs.icc"
30 Grob::clone (int count) const
32 return new Grob (*this, count);
35 Grob::Grob (SCM basicprops,
36 Object_key const *key)
40 /* FIXME: default should be no callback. */
44 interfaces_ = SCM_EOL;
45 immutable_property_alist_ = basicprops;
46 mutable_property_alist_ = SCM_EOL;
47 object_alist_ = SCM_EOL;
49 /* We do smobify_self () as the first step. Since the object lives
50 on the heap, none of its SCM variables are protected from
51 GC. After smobify_self (), they are. */
55 We always get a new key object for a new grob.
58 ((Object_key *)key_)->unprotect ();
60 SCM meta = get_property ("meta");
61 if (scm_is_pair (meta))
62 interfaces_ = scm_cdr (scm_assq (ly_symbol2scm ("interfaces"), meta));
64 if (get_property_data (ly_symbol2scm ("X-extent")) == SCM_EOL)
65 set_property ("X-extent", Grob::stencil_width_proc);
66 if (get_property_data (ly_symbol2scm ("Y-extent")) == SCM_EOL)
67 set_property ("Y-extent", Grob::stencil_height_proc);
70 Grob::Grob (Grob const &s, int copy_index)
71 : dim_cache_ (s.dim_cache_)
73 key_ = (use_object_keys) ? new Copied_key (s.key_, copy_index) : 0;
74 original_ = (Grob *) & s;
77 immutable_property_alist_ = s.immutable_property_alist_;
78 mutable_property_alist_ = ly_deep_copy (s.mutable_property_alist_);
79 interfaces_ = s.interfaces_;
80 object_alist_ = SCM_EOL;
86 ((Object_key *)key_)->unprotect ();
92 /****************************************************************
94 ****************************************************************/
97 Grob::get_stencil () const
102 SCM stil = get_property ("stencil");
103 return unsmob_stencil (stil);
107 Grob::get_print_stencil () const
109 SCM stil = get_property ("stencil");
112 if (Stencil *m = unsmob_stencil (stil))
115 if (to_boolean (get_property ("transparent")))
116 retval = Stencil (m->extent_box (), SCM_EOL);
119 SCM expr = m->expr ();
120 expr = scm_list_3 (ly_symbol2scm ("grob-cause"),
123 retval = Stencil (m->extent_box (), expr);
126 SCM rot = get_property ("rotation");
127 if (scm_is_pair (rot))
129 Real angle = scm_to_double (scm_car (rot));
130 Real x = scm_to_double (scm_cadr (rot));
131 Real y = scm_to_double (scm_caddr (rot));
133 retval.rotate (angle, Offset (x, y));
136 /* color support... see interpret_stencil_expression () for more... */
137 SCM color = get_property ("color");
138 if (color != SCM_EOL)
140 SCM expr = scm_list_3 (ly_symbol2scm ("color"),
144 retval = Stencil (retval.extent_box (), expr);
152 /****************************************************************
154 ****************************************************************/
156 Grob::do_break_processing ()
161 Grob::discretionary_processing ()
166 Grob::get_system () const
173 Grob::handle_broken_dependencies ()
175 Spanner *sp = dynamic_cast<Spanner *> (this);
176 if (original () && sp)
180 /* THIS, SP is the original spanner. We use a special function
181 because some Spanners have enormously long lists in their
182 properties, and a special function fixes FOO */
184 for (SCM s = object_alist_; scm_is_pair (s); s = scm_cdr (s))
185 sp->substitute_one_mutable_property (scm_caar (s), scm_cdar (s));
187 System *system = get_system ();
191 && common_refpoint (system, X_AXIS)
192 && common_refpoint (system, Y_AXIS))
193 substitute_object_links (system->self_scm (), object_alist_);
194 else if (dynamic_cast<System *> (this))
195 substitute_object_links (SCM_UNDEFINED, object_alist_);
197 /* THIS element is `invalid'; it has been removed from all
198 dependencies, so let's junk the element itself.
200 Do not do this for System, since that would remove references
201 to the originals of score-grobs, which get then GC'd (a bad
206 /* Note that we still want references to this element to be
207 rearranged, and not silently thrown away, so we keep pointers like
208 {broken_into_{drul, array}, original}
216 for (int a = X_AXIS; a < NO_AXES; a++)
217 dim_cache_[a].clear ();
219 mutable_property_alist_ = SCM_EOL;
220 object_alist_ = SCM_EOL;
221 immutable_property_alist_ = SCM_EOL;
222 interfaces_ = SCM_EOL;
226 Grob::handle_prebroken_dependencies ()
228 /* Don't do this in the derived method, since we want to keep access to
229 object_alist_ centralized. */
232 Item *it = dynamic_cast<Item *> (this);
233 substitute_object_links (scm_from_int (it->break_status_dir ()),
234 original ()->object_alist_);
239 Grob::find_broken_piece (System *) const
244 /****************************************************************
246 ****************************************************************/
249 Grob::translate_axis (Real y, Axis a)
251 if (isinf (y) || isnan (y))
253 programming_error (_ ("Infinity or NaN encountered"));
257 if (!dim_cache_[a].offset_)
258 dim_cache_[a].offset_ = new Real (y);
260 *dim_cache_[a].offset_ += y;
263 /* Find the offset relative to D. If D equals THIS, then it is 0.
264 Otherwise, it recursively defd as
266 OFFSET_ + PARENT_L_->relative_coordinate (D) */
268 Grob::relative_coordinate (Grob const *refp, Axis a) const
273 /* We catch PARENT_L_ == nil case with this, but we crash if we did
274 not ask for the absolute coordinate (ie. REFP == nil.) */
275 Real off = get_offset (a);
276 if (refp == dim_cache_[a].parent_)
279 off += dim_cache_[a].parent_->relative_coordinate (refp, a);
285 Grob::pure_relative_y_coordinate (Grob const *refp, int start, int end)
290 SCM pure_off = ly_lily_module_constant ("pure-Y-offset");
293 if (dim_cache_[Y_AXIS].offset_)
294 off = *dim_cache_[Y_AXIS].offset_;
295 else if (ly_is_procedure (pure_off))
297 dim_cache_[Y_AXIS].offset_ = new Real (0.0);
298 off = scm_to_double (scm_apply_3 (pure_off, self_scm (),
299 scm_from_int (start), scm_from_int (end),
301 delete dim_cache_[Y_AXIS].offset_;
302 dim_cache_[Y_AXIS].offset_ = 0;
305 /* we simulate positioning-done if we are the child of a VerticalAlignment */
306 Grob *p = get_parent (Y_AXIS);
308 if (Align_interface::has_interface (p))
309 trans = Align_interface::get_pure_child_y_translation (p, this, start, end);
312 + dim_cache_[Y_AXIS].parent_->pure_relative_y_coordinate (refp, start, end);
315 /* Invoke callbacks to get offset relative to parent. */
317 Grob::get_offset (Axis a) const
319 if (dim_cache_[a].offset_)
320 return *dim_cache_[a].offset_;
322 Grob *me = (Grob *) this;
324 SCM sym = axis_offset_symbol (a);
325 me->dim_cache_[a].offset_ = new Real (0.0);
328 UGH: can't fold next 2 statements together. Apparently GCC thinks
329 dim_cache_[a].offset_ is unaliased.
331 Real off = robust_scm2double (internal_get_property (sym), 0.0);
332 if (me->dim_cache_[a].offset_)
334 *me->dim_cache_[a].offset_ += off;
335 me->del_property (sym);
336 return *me->dim_cache_[a].offset_;
343 Grob::maybe_pure_coordinate (Grob const *refp, Axis a, bool pure, int start, int end)
345 if (pure && a != Y_AXIS)
346 programming_error ("tried to get pure X-offset");
347 return (pure && a == Y_AXIS) ? pure_relative_y_coordinate (refp, start, end)
348 : relative_coordinate (refp, a);
351 /****************************************************************
353 ****************************************************************/
356 Grob::flush_extent_cache (Axis axis)
358 if (dim_cache_[axis].extent_)
361 Ugh, this is not accurate; will flush property, causing
362 callback to be called if.
364 del_property ((axis == X_AXIS) ? ly_symbol2scm ("X-extent") : ly_symbol2scm ("Y-extent"));
365 delete dim_cache_[axis].extent_;
366 dim_cache_[axis].extent_ = 0;
367 if (get_parent (axis))
368 get_parent (axis)->flush_extent_cache (axis);
374 Grob::extent (Grob *refp, Axis a) const
376 Real offset = relative_coordinate (refp, a);
378 if (dim_cache_[a].extent_)
380 real_ext = *dim_cache_[a].extent_;
385 Order is significant: ?-extent may trigger suicide.
389 ? ly_symbol2scm ("X-extent")
390 : ly_symbol2scm ("Y-extent");
392 SCM ext = internal_get_property (ext_sym);
393 if (is_number_pair (ext))
394 real_ext.unite (ly_scm2interval (ext));
398 ? ly_symbol2scm ("minimum-X-extent")
399 : ly_symbol2scm ("minimum-Y-extent");
400 SCM min_ext = internal_get_property (min_ext_sym);
401 if (is_number_pair (min_ext))
402 real_ext.unite (ly_scm2interval (min_ext));
403 ((Grob*)this)->dim_cache_[a].extent_ = new Interval (real_ext);
406 real_ext.translate (offset);
412 Grob::pure_height (Grob *refp, int start, int end)
414 SCM pure_height = ly_lily_module_constant ("pure-Y-extent");
417 if (ly_is_procedure (pure_height))
418 iv = ly_scm2interval (scm_apply_3 (pure_height, self_scm (),
419 scm_from_int (start), scm_from_int (end),
421 Real offset = pure_relative_y_coordinate (refp, start, end);
423 SCM min_ext = get_property ("minimum-Y-extent");
424 if (is_number_pair (min_ext))
425 iv.unite (ly_scm2interval (min_ext));
427 iv.translate (offset);
432 Grob::maybe_pure_extent (Grob *refp, Axis a, bool pure, int start, int end)
434 if (pure && a != Y_AXIS)
435 programming_error ("tried to get pure width");
436 return (pure && a == Y_AXIS) ? pure_height (refp, start, end) : extent (refp, a);
440 Grob::spanned_rank_iv ()
442 return Interval_t<int> (-1, 0);
445 /****************************************************************
447 ****************************************************************/
449 /* Find the group-element which has both #this# and #s# */
451 Grob::common_refpoint (Grob const *s, Axis a) const
453 /* I don't like the quadratic aspect of this code, but I see no
454 other way. The largest chain of parents might be 10 high or so,
455 so it shouldn't be a real issue. */
456 for (Grob const *c = this; c; c = c->dim_cache_[a].parent_)
457 for (Grob const *d = s; d; d = d->dim_cache_[a].parent_)
465 Grob::set_parent (Grob *g, Axis a)
467 dim_cache_[a].parent_ = g;
471 Grob::get_parent (Axis a) const
473 return dim_cache_[a].parent_;
478 Grob::fixup_refpoint ()
480 for (int a = X_AXIS; a < NO_AXES; a++)
483 Grob *parent = get_parent (ax);
488 if (parent->get_system () != get_system () && get_system ())
490 Grob *newparent = parent->find_broken_piece (get_system ());
491 set_parent (newparent, ax);
494 if (Item *i = dynamic_cast<Item *> (this))
496 Item *parenti = dynamic_cast<Item *> (parent);
500 Direction my_dir = i->break_status_dir ();
501 if (my_dir != parenti->break_status_dir ())
503 Item *newparent = parenti->find_prebroken_piece (my_dir);
504 set_parent (newparent, ax);
512 /****************************************************************
514 ****************************************************************/
516 Grob::warning (string s) const
518 SCM cause = self_scm ();
519 while (Grob *g = unsmob_grob (cause))
520 cause = g->get_property ("cause");
522 /* ES TODO: cause can't be Music*/
523 if (Music *m = unsmob_music (cause))
524 m->origin ()->warning (s);
525 else if (Stream_event *ev = unsmob_stream_event (cause))
526 ev->origin ()->warning (s);
535 SCM meta = get_property ("meta");
536 SCM nm = scm_assq (ly_symbol2scm ("name"), meta);
537 nm = (scm_is_pair (nm)) ? scm_cdr (nm) : SCM_EOL;
538 return scm_is_symbol (nm) ? ly_symbol2string (nm) : this->class_name ();
542 Grob::programming_error (string s) const
544 SCM cause = self_scm ();
545 while (Grob *g = unsmob_grob (cause))
546 cause = g->get_property ("cause");
548 s = _f ("programming error: %s", s);
550 /* ES TODO: cause can't be Music*/
551 if (Music *m = unsmob_music (cause))
552 m->origin ()->message (s);
553 else if (Stream_event *ev = unsmob_stream_event (cause))
554 ev->origin ()->warning (s);
560 ADD_INTERFACE (Grob, "grob-interface",
561 "A grob represents a piece of music notation\n"
563 "All grobs have an X and Y-position on the page. These X and Y positions\n"
564 "are stored in a relative format, so they can easily be combined by\n"
565 "stacking them, hanging one grob to the side of another, and coupling\n"
566 "them into a grouping objects.\n"
568 "Each grob has a reference point (a.k.a. parent): the position of a grob\n"
569 "is stored relative to that reference point. For example the X-reference\n"
570 "point of a staccato dot usually is the note head that it applies\n"
571 "to. When the note head is moved, the staccato dot moves along\n"
574 "A grob is often associated with a symbol, but some grobs do not print\n"
575 "any symbols. They take care of grouping objects. For example, there is a\n"
576 "separate grob that stacks staves vertically. The @ref{NoteCollision}\n"
577 "is also an abstract grob: it only moves around chords, but doesn't print\n"
580 "Grobs have a properties: Scheme variables, that can be read and set. "
581 "They have two types. Immutable variables "
582 "define the default style and behavior. They are shared between many objects. "
583 "They can be changed using @code{\\override} and @code{\\revert}. "
585 "Mutable properties are variables that are specific to one grob. Typically, "
586 "lists of other objects, or results from computations are stored in"
587 "mutable properties: every call to set-grob-property (or its C++ equivalent) "
588 "sets a mutable property. "
590 "The properties @code{after-line-breaking} and @code{before-line-breaking} "
591 "are dummies that are not user-serviceable. "
600 "after-line-breaking "
601 "axis-group-parent-X "
602 "axis-group-parent-Y "
603 "before-line-breaking "
625 /****************************************************************
627 ****************************************************************/
631 grob_stencil_extent (Grob *me, Axis a)
633 Stencil *m = me->get_stencil ();
637 return ly_interval2scm (e);
641 MAKE_SCHEME_CALLBACK (Grob, stencil_height, 1);
643 Grob::stencil_height (SCM smob)
645 Grob *me = unsmob_grob (smob);
646 return grob_stencil_extent (me, Y_AXIS);
649 MAKE_SCHEME_CALLBACK(Grob, y_parent_positioning, 1);
651 Grob::y_parent_positioning (SCM smob)
653 Grob *me = unsmob_grob (smob);
654 Grob *par = me->get_parent (Y_AXIS);
656 (void) par->get_property ("positioning-done");
658 return scm_from_double (0.0);
662 MAKE_SCHEME_CALLBACK(Grob, x_parent_positioning, 1);
664 Grob::x_parent_positioning (SCM smob)
666 Grob *me = unsmob_grob (smob);
668 Grob *par = me->get_parent (X_AXIS);
670 (void) par->get_property ("positioning-done");
672 return scm_from_double (0.0);
675 MAKE_SCHEME_CALLBACK (Grob, stencil_width, 1);
677 Grob::stencil_width (SCM smob)
679 Grob *me = unsmob_grob (smob);
680 return grob_stencil_extent (me, X_AXIS);
686 common_refpoint_of_list (SCM elist, Grob *common, Axis a)
688 for (; scm_is_pair (elist); elist = scm_cdr (elist))
689 if (Grob *s = unsmob_grob (scm_car (elist)))
692 common = common->common_refpoint (s, a);
701 common_refpoint_of_array (vector<Grob*> const &arr, Grob *common, Axis a)
703 for (vsize i = arr.size (); i--;)
704 if (Grob *s = arr[i])
707 common = common->common_refpoint (s, a);
716 robust_relative_extent (Grob *me, Grob *refpoint, Axis a)
718 Interval ext = me->extent (refpoint, a);
720 ext.add_point (me->relative_coordinate (refpoint, a));