2 score-elem.cc -- implement Grob
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
13 #include "input-smob.hh"
14 #include "libc-extension.hh"
15 #include "group-interface.hh"
17 #include "paper-score.hh"
18 #include "paper-def.hh"
19 #include "molecule.hh"
23 #include "line-of-score.hh"
25 #include "paper-column.hh"
26 #include "molecule.hh"
28 #include "paper-outputter.hh"
29 #include "dimension-cache.hh"
30 #include "side-position-interface.hh"
33 #include "ly-smobs.icc"
38 remove dynamic_cast<Spanner,Item> and put this code into respective
43 #define INFINITY_MSG "Infinity or NaN encountered"
45 Grob::Grob (SCM basicprops)
48 fixme: default should be no callback.
54 immutable_property_alist_ = basicprops;
55 mutable_property_alist_ = SCM_EOL;
59 char const*onames[] = {"X-offset-callbacks", "Y-offset-callbacks"};
60 char const*enames[] = {"X-extent-callback", "Y-extent-callback"};
62 for (int a = X_AXIS; a <= Y_AXIS; a++){
63 SCM l = get_grob_property (onames[a]);
65 if (scm_ilength (l) >=0)
67 dim_cache_[a].offset_callbacks_ = l;
68 dim_cache_[a].offsets_left_ = scm_ilength (l);
72 programming_error ("[XY]-offset-callbacks must be a list");
75 SCM cb = get_grob_property (enames[a]);
78 Should change default to be empty?
80 if (cb != SCM_BOOL_F && !gh_procedure_p (cb) && !gh_pair_p (cb))
81 cb = molecule_extent_proc;
83 dim_cache_[a].dimension_ = cb;
86 SCM meta = get_grob_property ("meta");
87 SCM ifs = scm_assoc (ly_symbol2scm ("interfaces"), meta);
89 set_grob_property ("interfaces",gh_cdr (ifs));
93 Grob::Grob (Grob const&s)
94 : dim_cache_ (s.dim_cache_)
96 original_l_ = (Grob*) &s;
97 immutable_property_alist_ = s.immutable_property_alist_;
98 mutable_property_alist_ = SCM_EOL;
100 status_i_ = s.status_i_;
101 pscore_l_ = s.pscore_l_;
109 do nothing scm-ish and no unprotecting here.
115 Grob::get_grob_property (const char *nm) const
117 SCM sym = ly_symbol2scm (nm);
118 return get_grob_property (sym);
122 Grob::get_grob_property (SCM sym) const
124 SCM s = scm_sloppy_assq (sym, mutable_property_alist_);
128 s = scm_sloppy_assq (sym, immutable_property_alist_);
129 return (s == SCM_BOOL_F) ? SCM_EOL : gh_cdr (s);
133 Remove the value associated with KEY, and return it. The result is
134 that a next call will yield SCM_UNDEFINED (and not the underlying
138 Grob::remove_grob_property (const char* key)
140 SCM val = get_grob_property (key);
142 set_grob_property (key, SCM_EOL);
147 Grob::set_grob_property (const char* k, SCM v)
149 SCM s = ly_symbol2scm (k);
150 set_grob_property (s, v);
154 Puts the k, v in the immutable_property_alist_, which is convenient for
155 storing variables that are needed during the breaking process. (eg.
156 Line_of_score::rank : int)
159 Grob::set_immutable_grob_property (const char*k, SCM v)
161 SCM s = ly_symbol2scm (k);
162 set_immutable_grob_property (s, v);
166 Grob::set_immutable_grob_property (SCM s, SCM v)
168 immutable_property_alist_ = gh_cons (gh_cons (s,v), mutable_property_alist_);
169 mutable_property_alist_ = scm_assq_remove_x (mutable_property_alist_, s);
172 Grob::set_grob_property (SCM s, SCM v)
174 mutable_property_alist_ = scm_assq_set_x (mutable_property_alist_, s, v);
178 MAKE_SCHEME_CALLBACK (Grob,molecule_extent,2);
180 Grob::molecule_extent (SCM element_smob, SCM scm_axis)
182 Grob *s = unsmob_grob (element_smob);
183 Axis a = (Axis) gh_scm2int (scm_axis);
185 Molecule *m = s->get_molecule ();
189 return ly_interval2scm (e);
192 MAKE_SCHEME_CALLBACK (Grob,preset_extent,2);
195 Grob::preset_extent (SCM element_smob, SCM scm_axis)
197 Grob *s = unsmob_grob (element_smob);
198 Axis a = (Axis) gh_scm2int (scm_axis);
200 SCM ext = s->get_grob_property ((a == X_AXIS)
206 Real l = gh_scm2double (gh_car (ext));
207 Real r = gh_scm2double (gh_cdr (ext));
208 return ly_interval2scm (Interval (l, r));
211 return ly_interval2scm (Interval ());
217 Grob::paper_l () const
219 return pscore_l_ ? pscore_l_->paper_l_ : 0;
223 Grob::calculate_dependencies (int final, int busy, SCM funcname)
225 assert (status_i_ >=0);
227 if (status_i_ >= final)
230 if (status_i_== busy)
232 programming_error ("Element is busy, come back later");
238 for (SCM d= get_grob_property ("dependencies"); gh_pair_p (d); d = gh_cdr (d))
240 unsmob_grob (gh_car (d))
241 ->calculate_dependencies (final, busy, funcname);
245 String s = ly_symbol2string (funcname);
246 SCM proc = get_grob_property (s.ch_C ());
247 if (gh_procedure_p (proc))
248 gh_call1 (proc, this->self_scm ());
255 Grob::get_molecule () const
257 SCM mol = get_grob_property ("molecule");
258 if (unsmob_molecule (mol))
259 return unsmob_molecule (mol);
261 mol = get_uncached_molecule ();
263 Grob *me = (Grob*)this;
264 me->set_grob_property ("molecule", mol);
266 return unsmob_molecule (mol);
269 Grob::get_uncached_molecule ()const
271 SCM proc = get_grob_property ("molecule-callback");
274 if (gh_procedure_p (proc))
275 mol = gh_apply (proc, gh_list (this->self_scm (), SCM_UNDEFINED));
278 Molecule *m = unsmob_molecule (mol);
280 if (unsmob_molecule (mol))
283 TODO: add option for not copying origin info.
285 SCM origin =get_grob_property ("origin");
286 if (!unsmob_input (origin))
287 origin =ly_symbol2scm ("no-origin");
292 mol = Molecule (m->extent_box (),
293 gh_list (origin, m->get_expr (), SCM_UNDEFINED)
296 m = unsmob_molecule (mol);
300 transparent retains dimensions of element.
302 if (m && to_boolean (get_grob_property ("transparent")))
303 mol = Molecule (m->extent_box (), SCM_EOL).smobbed_copy ();
314 Grob::do_break_processing ()
324 Grob::line_l () const
330 Grob::add_dependency (Grob*e)
334 Pointer_group_interface ::add_element (this, "dependencies",e);
338 programming_error ("Null dependency added");
345 Do break substitution in S, using CRITERION. Return new value.
346 CRITERION is either a SMOB pointer to the desired line, or a number
347 representing the break direction. Do not modify SRC.
350 Grob::handle_broken_grobs (SCM src, SCM criterion)
353 Grob *sc = unsmob_grob (src);
356 if (gh_number_p (criterion))
358 Item * i = dynamic_cast<Item*> (sc);
359 Direction d = to_dir (criterion);
360 if (i && i->break_status_dir () != d)
362 Item *br = i->find_prebroken_piece (d);
363 return (br) ? br->self_scm () : SCM_UNDEFINED;
369 = dynamic_cast<Line_of_score*> (unsmob_grob (criterion));
370 if (sc->line_l () != line)
372 sc = sc->find_broken_piece (line);
376 /* now: !sc || (sc && sc->line_l () == line) */
378 return SCM_UNDEFINED;
380 /* now: sc && sc->line_l () == line */
382 || (sc->common_refpoint (line, X_AXIS)
383 && sc->common_refpoint (line, Y_AXIS)))
385 return sc->self_scm ();
387 return SCM_UNDEFINED;
390 else if (gh_pair_p (src))
392 SCM oldcar =gh_car (src);
394 UGH! breaks on circular lists.
396 SCM newcar = handle_broken_grobs (oldcar, criterion);
397 SCM oldcdr = gh_cdr (src);
399 if (newcar == SCM_UNDEFINED
400 && (gh_pair_p (oldcdr) || oldcdr == SCM_EOL))
403 This is tail-recursion, ie.
405 return handle_broken_grobs (cdr, criterion);
407 We don't want to rely on the compiler to do this. Without
408 tail-recursion, this easily crashes with a stack overflow. */
413 SCM newcdr = handle_broken_grobs (oldcdr, criterion);
414 return gh_cons (newcar, newcdr);
423 Grob::handle_broken_dependencies ()
425 Spanner * s= dynamic_cast<Spanner*> (this);
426 if (original_l_ && s)
431 for (int i = 0; i< s->broken_into_l_arr_ .size (); i++)
433 Grob * sc = s->broken_into_l_arr_[i];
434 Line_of_score * l = sc->line_l ();
435 sc->mutable_property_alist_ =
436 handle_broken_grobs (mutable_property_alist_,
437 l ? l->self_scm () : SCM_UNDEFINED);
442 Line_of_score *line = line_l ();
444 if (line && common_refpoint (line, X_AXIS) && common_refpoint (line, Y_AXIS))
446 mutable_property_alist_
447 = handle_broken_grobs (mutable_property_alist_,
448 line ? line->self_scm () : SCM_UNDEFINED);
450 else if (dynamic_cast <Line_of_score*> (this))
452 mutable_property_alist_ = handle_broken_grobs (mutable_property_alist_,
458 This element is `invalid'; it has been removed from all
459 dependencies, so let's junk the element itself.
461 do not do this for Line_of_score, since that would remove
462 references to the originals of score-elts, which get then GC'd
470 Note that we still want references to this element to be
471 rearranged, and not silently thrown away, so we keep pointers
472 like {broken_into_{drul,array}, original}
477 mutable_property_alist_ = SCM_EOL;
478 immutable_property_alist_ = SCM_EOL;
480 set_extent_callback (SCM_EOL, Y_AXIS);
481 set_extent_callback (SCM_EOL, X_AXIS);
483 for (int a= X_AXIS; a <= Y_AXIS; a++)
485 dim_cache_[a].offset_callbacks_ = SCM_EOL;
486 dim_cache_[a].offsets_left_ = 0;
491 Grob::handle_prebroken_dependencies ()
496 Grob::find_broken_piece (Line_of_score*) const
502 Grob::translate_axis (Real y, Axis a)
504 if (isinf (y) || isnan (y))
505 programming_error (_ (INFINITY_MSG));
508 dim_cache_[a].offset_ += y;
513 Grob::relative_coordinate (Grob const*refp, Axis a) const
519 We catch PARENT_L_ == nil case with this, but we crash if we did
520 not ask for the absolute coordinate (ie. REFP == nil.)
523 if (refp == dim_cache_[a].parent_l_)
524 return get_offset (a);
526 return get_offset (a) + dim_cache_[a].parent_l_->relative_coordinate (refp, a);
530 Grob::get_offset (Axis a) const
532 Grob *me = (Grob*) this;
533 while (dim_cache_[a].offsets_left_)
535 int l = --me->dim_cache_[a].offsets_left_;
536 SCM cb = scm_list_ref (dim_cache_[a].offset_callbacks_, gh_int2scm (l));
537 SCM retval = gh_call2 (cb, self_scm (), gh_int2scm (a));
539 Real r = gh_scm2double (retval);
540 if (isinf (r) || isnan (r))
542 programming_error (INFINITY_MSG);
545 me->dim_cache_[a].offset_ +=r;
547 return dim_cache_[a].offset_;
551 MAKE_SCHEME_CALLBACK (Grob,point_dimension_callback,2);
553 Grob::point_dimension_callback (SCM , SCM)
555 return ly_interval2scm (Interval (0,0));
559 Grob::empty_b (Axis a)const
561 return ! (gh_pair_p (dim_cache_[a].dimension_) ||
562 gh_procedure_p (dim_cache_[a].dimension_));
573 Grob::extent (Grob * refp, Axis a) const
575 Real x = relative_coordinate (refp, a);
578 Dimension_cache * d = (Dimension_cache *)&dim_cache_[a];
580 if (gh_pair_p (d->dimension_))
582 else if (gh_procedure_p (d->dimension_))
585 FIXME: add doco on types, and should typecheck maybe?
587 d->dimension_= gh_call2 (d->dimension_, self_scm (), gh_int2scm (a));
592 if (!gh_pair_p (d->dimension_))
595 ext = ly_scm2interval (d->dimension_);
597 SCM extra = get_grob_property (a == X_AXIS
604 if (gh_pair_p (extra))
606 ext[BIGGER] += gh_scm2double (gh_cdr (extra));
607 ext[SMALLER] += gh_scm2double (gh_car (extra));
610 extra = get_grob_property (a == X_AXIS
612 : "minimum-extent-Y");
613 if (gh_pair_p (extra))
615 ext.unite (Interval (gh_scm2double (gh_car (extra)),
616 gh_scm2double (gh_cdr (extra))));
626 Grob::parent_l (Axis a) const
628 return dim_cache_[a].parent_l_;
632 Grob::common_refpoint (Grob const* s, Axis a) const
635 I don't like the quadratic aspect of this code, but I see no other
636 way. The largest chain of parents might be 10 high or so, so
637 it shouldn't be a real issue. */
638 for (Grob const *c = this; c; c = c->dim_cache_[a].parent_l_)
639 for (Grob const * d = s; d; d = d->dim_cache_[a].parent_l_)
648 Grob::common_refpoint (SCM elist, Axis a) const
650 Grob * common = (Grob*) this;
651 for (; gh_pair_p (elist); elist = gh_cdr (elist))
653 Grob * s = unsmob_grob (gh_car (elist));
655 common = common->common_refpoint (s, a);
664 SCM meta = get_grob_property ("meta");
665 SCM nm = scm_assoc (ly_symbol2scm ("name"), meta);
666 nm = (gh_pair_p (nm)) ? gh_cdr (nm) : SCM_EOL;
667 return gh_string_p (nm) ?ly_scm2string (nm) : classname (this);
671 Grob::add_offset_callback (SCM cb, Axis a)
673 if (!has_offset_callback_b (cb, a))
675 dim_cache_[a].offset_callbacks_ = gh_cons (cb, dim_cache_[a].offset_callbacks_);
676 dim_cache_[a].offsets_left_ ++;
681 Grob::has_extent_callback_b (SCM cb, Axis a)const
683 return scm_equal_p (cb, dim_cache_[a].dimension_) == SCM_BOOL_T;
688 Grob::has_extent_callback_b (Axis a) const
690 return gh_procedure_p (dim_cache_[a].dimension_);
694 Grob::has_offset_callback_b (SCM cb, Axis a)const
696 return scm_memq (cb, dim_cache_[a].offset_callbacks_) != SCM_BOOL_F;
700 Grob::set_extent_callback (SCM dc, Axis a)
702 dim_cache_[a].dimension_ =dc;
706 Grob::set_parent (Grob *g, Axis a)
708 dim_cache_[a].parent_l_ = g;
711 MAKE_SCHEME_CALLBACK (Grob,fixup_refpoint,1);
713 Grob::fixup_refpoint (SCM smob)
715 Grob *me = unsmob_grob (smob);
716 for (int a = X_AXIS; a < NO_AXES; a ++)
719 Grob * parent = me->parent_l (ax);
724 if (parent->line_l () != me->line_l () && me->line_l ())
726 Grob * newparent = parent->find_broken_piece (me->line_l ());
727 me->set_parent (newparent, ax);
730 if (Item * i = dynamic_cast<Item*> (me))
732 Item *parenti = dynamic_cast<Item*> (parent);
736 Direction my_dir = i->break_status_dir () ;
737 if (my_dir!= parenti->break_status_dir ())
739 Item *newparent = parenti->find_prebroken_piece (my_dir);
740 me->set_parent (newparent, ax);
750 /****************************************************
752 ****************************************************/
755 IMPLEMENT_UNSMOB (Grob, grob);
756 IMPLEMENT_SMOBS (Grob);
757 IMPLEMENT_DEFAULT_EQUAL_P (Grob);
760 Grob::mark_smob (SCM ses)
762 Grob * s = (Grob*) SCM_CELL_WORD_1 (ses);
763 scm_gc_mark (s->immutable_property_alist_);
764 scm_gc_mark (s->mutable_property_alist_);
766 for (int a =0 ; a < 2; a++)
768 scm_gc_mark (s->dim_cache_[a].offset_callbacks_);
769 scm_gc_mark (s->dim_cache_[a].dimension_);
772 if (s->parent_l (Y_AXIS))
773 scm_gc_mark (s->parent_l (Y_AXIS)->self_scm ());
774 if (s->parent_l (X_AXIS))
775 scm_gc_mark (s->parent_l (X_AXIS)->self_scm ());
778 scm_gc_mark (s->original_l_->self_scm ());
779 return s->do_derived_mark ();
783 Grob::print_smob (SCM s, SCM port, scm_print_state *)
785 Grob *sc = (Grob *) gh_cdr (s);
787 scm_puts ("#<Grob ", port);
788 scm_puts ((char *)sc->name ().ch_C (), port);
791 don't try to print properties, that is too much hassle.
793 scm_puts (" >", port);
798 Grob::do_derived_mark ()
805 ly_set_grob_property (SCM elt, SCM sym, SCM val)
807 Grob * sc = unsmob_grob (elt);
809 if (!gh_symbol_p (sym))
811 error ("Not a symbol");
812 ly_display_scm (sym);
813 return SCM_UNSPECIFIED;
818 sc->set_grob_property (sym, val);
822 error ("Not a score element");
823 ly_display_scm (elt);
826 return SCM_UNSPECIFIED;
831 ly_get_grob_property (SCM elt, SCM sym)
833 Grob * sc = unsmob_grob (elt);
837 return sc->get_grob_property (sym);
841 error ("Not a score element");
842 ly_display_scm (elt);
844 return SCM_UNSPECIFIED;
849 Grob::discretionary_processing ()
856 spanner_get_bound (SCM slur, SCM dir)
858 return dynamic_cast<Spanner*> (unsmob_grob (slur))->get_bound (to_dir (dir))->self_scm ();
863 static SCM interfaces_sym;
867 interfaces_sym = scm_permanent_object (ly_symbol2scm ("interfaces"));
869 scm_make_gsubr ("ly-get-grob-property", 2, 0, 0, (Scheme_function_unknown)ly_get_grob_property);
870 scm_make_gsubr ("ly-set-grob-property", 3, 0, 0, (Scheme_function_unknown)ly_set_grob_property);
871 scm_make_gsubr ("ly-get-spanner-bound", 2 , 0, 0, (Scheme_function_unknown) spanner_get_bound);
875 Grob::has_interface (SCM k)
877 SCM ifs = get_grob_property (interfaces_sym);
879 return scm_memq (k, ifs) != SCM_BOOL_F;
883 Grob::set_interface (SCM k)
885 if (has_interface (k))
889 set_grob_property (interfaces_sym,
890 gh_cons (k, get_grob_property (interfaces_sym)));
895 ADD_SCM_INIT_FUNC (scoreelt, init_functions);
896 IMPLEMENT_TYPE_P (Grob, "ly-grob?");