2 score-elem.cc -- implement Score_element
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2000 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"
20 #include "molecule.hh"
21 #include "score-element.hh"
24 #include "line-of-score.hh"
26 #include "paper-column.hh"
27 #include "molecule.hh"
29 #include "paper-outputter.hh"
30 #include "dimension-cache.hh"
31 #include "side-position-interface.hh"
34 #include "ly-smobs.icc"
39 remove dynamic_cast<Spanner,Item> and put this code into respective
44 #define INFINITY_MSG "Infinity or NaN encountered"
46 Score_element::Score_element(SCM basicprops)
49 fixme: default should be no callback.
51 set_extent_callback (molecule_extent_proc, X_AXIS);
52 set_extent_callback (molecule_extent_proc, Y_AXIS) ;
58 immutable_property_alist_ = basicprops;
59 mutable_property_alist_ = SCM_EOL;
63 dim_cache_[X_AXIS].offset_callbacks_
64 = get_elt_property ("X-offset-callbacks");
65 dim_cache_[Y_AXIS].offset_callbacks_
66 = get_elt_property ("Y-offset-callbacks");
68 dim_cache_[X_AXIS].offsets_left_ = scm_ilength (dim_cache_[X_AXIS].offset_callbacks_);
69 dim_cache_[Y_AXIS].offsets_left_ = scm_ilength (dim_cache_[Y_AXIS].offset_callbacks_);
71 SCM cb = get_elt_property ("X-extent-callback");
73 dim_cache_[X_AXIS].dimension_ = cb;
75 cb = get_elt_property ("Y-extent-callback");
77 dim_cache_[Y_AXIS].dimension_ = cb;
81 Score_element::Score_element (Score_element const&s)
82 : dim_cache_ (s.dim_cache_)
84 original_l_ =(Score_element*) &s;
85 immutable_property_alist_ = s.immutable_property_alist_;
86 mutable_property_alist_ = SCM_EOL;
88 status_i_ = s.status_i_;
89 lookup_l_ = s.lookup_l_;
90 pscore_l_ = s.pscore_l_;
95 Score_element::~Score_element()
98 do nothing scm-ish and no unprotecting here.
104 Score_element::get_elt_property (const char *nm) const
106 SCM sym = ly_symbol2scm (nm);
107 return get_elt_property (sym);
111 Score_element::get_elt_property (SCM sym) const
113 SCM s = scm_sloppy_assq(sym, mutable_property_alist_);
117 s = scm_sloppy_assq (sym, immutable_property_alist_);
118 return (s == SCM_BOOL_F) ? SCM_EOL : gh_cdr (s);
122 Remove the value associated with KEY, and return it. The result is
123 that a next call will yield SCM_UNDEFINED (and not the underlying
127 Score_element::remove_elt_property (const char* key)
129 SCM val = get_elt_property (key);
131 set_elt_property (key, SCM_EOL);
136 Score_element::set_elt_property (const char* k, SCM v)
138 SCM s = ly_symbol2scm (k);
139 set_elt_property (s, v);
143 Puts the k, v in the immutable_property_alist_, which is convenient for
144 storing variables that are needed during the breaking process. (eg.
145 Line_of_score::rank : int )
148 Score_element::set_immutable_elt_property (const char*k, SCM v)
150 SCM s = ly_symbol2scm (k);
151 set_immutable_elt_property (s, v);
155 Score_element::set_immutable_elt_property (SCM s, SCM v)
157 immutable_property_alist_ = gh_cons (gh_cons (s,v), mutable_property_alist_);
158 mutable_property_alist_ = scm_assq_remove_x (mutable_property_alist_, s);
161 Score_element::set_elt_property (SCM s, SCM v)
163 mutable_property_alist_ = scm_assq_set_x (mutable_property_alist_, s, v);
167 MAKE_SCHEME_CALLBACK(Score_element,molecule_extent,2);
169 Score_element::molecule_extent (SCM element_smob, SCM scm_axis)
171 Score_element *s = unsmob_element (element_smob);
172 Axis a = (Axis) gh_scm2int (scm_axis);
174 Molecule m = s->get_molecule ();
175 return ly_interval2scm ( m.extent(a));
178 MAKE_SCHEME_CALLBACK(Score_element,preset_extent,2);
181 Score_element::preset_extent (SCM element_smob, SCM scm_axis)
183 Score_element *s = unsmob_element (element_smob);
184 Axis a = (Axis) gh_scm2int (scm_axis);
186 SCM ext = s->get_elt_property ((a == X_AXIS)
192 Real l = gh_scm2double (gh_car (ext));
193 Real r = gh_scm2double (gh_cdr (ext));
194 l *= s->paper_l ()->get_var ("staffspace");
195 r *= s->paper_l ()->get_var ("staffspace");
196 return ly_interval2scm (Interval (l, r));
199 return ly_interval2scm ( Interval ());
205 Score_element::paper_l () const
207 return pscore_l_ ? pscore_l_->paper_l_ : 0;
211 Score_element::lookup_l () const
214 URG junkthis, caching is clumsy.
218 Score_element * urg = (Score_element*)this;
219 SCM sz = urg->remove_elt_property ("font-size");
220 int i = (gh_number_p (sz))
224 urg->lookup_l_ = (Lookup*)pscore_l_->paper_l_->lookup_l (i);
230 Score_element::calculate_dependencies (int final, int busy, SCM funcname)
232 assert (status_i_ >=0);
234 if (status_i_ >= final)
237 if (status_i_== busy)
239 programming_error ("Element is busy, come back later");
245 for (SCM d= get_elt_property ("dependencies"); gh_pair_p (d); d = gh_cdr (d))
247 unsmob_element (gh_car (d))
248 ->calculate_dependencies (final, busy, funcname);
252 String s = ly_symbol2string (funcname);
253 SCM proc = get_elt_property (s.ch_C());
254 if (gh_procedure_p (proc))
255 gh_call1 (proc, this->self_scm ());
262 Score_element::get_molecule () const
264 SCM proc = get_elt_property ("molecule-callback");
267 if (gh_procedure_p (proc))
268 mol = gh_apply (proc, gh_list (this->self_scm (), SCM_UNDEFINED));
271 SCM origin =get_elt_property ("origin");
272 if (!unsmob_input (origin))
273 origin =ly_symbol2scm ("no-origin");
278 mol = gh_cons (gh_list (origin, gh_car (mol), SCM_UNDEFINED), gh_cdr (mol));
282 Molecule m (create_molecule (mol));
285 This is almost the same as setting molecule-callback to #f, but
286 this retains the dimensions of this element, which means that you
287 can erase elements individually. */
288 if (to_boolean (get_elt_property ("transparent")))
289 m = Molecule (m.extent_box (), SCM_EOL);
301 Score_element::do_break_processing()
309 MAKE_SCHEME_CALLBACK(Score_element,brew_molecule,1)
315 Score_element::brew_molecule (SCM smob)
317 Score_element * sc = unsmob_element (smob);
318 SCM glyph = sc->get_elt_property ("glyph");
319 if (gh_string_p (glyph))
321 return sc->lookup_l ()->afm_find (String (ly_scm2string (glyph))).create_scheme ();
331 Score_element::line_l() const
337 Score_element::add_dependency (Score_element*e)
341 Pointer_group_interface gi (this, "dependencies");
345 programming_error ("Null dependency added");
352 Do break substitution in S, using CRITERION. Return new value.
353 CRITERION is either a SMOB pointer to the desired line, or a number
354 representing the break direction. Do not modify SRC.
357 Score_element::handle_broken_smobs (SCM src, SCM criterion)
360 Score_element *sc = unsmob_element (src);
363 if (gh_number_p (criterion))
365 Item * i = dynamic_cast<Item*> (sc);
366 Direction d = to_dir (criterion);
367 if (i && i->break_status_dir () != d)
369 Item *br = i->find_prebroken_piece (d);
370 return (br) ? br->self_scm () : SCM_UNDEFINED;
376 = dynamic_cast<Line_of_score*> (unsmob_element (criterion));
377 if (sc->line_l () != line)
379 sc = sc->find_broken_piece (line);
383 /* now: !sc || (sc && sc->line_l () == line) */
385 return SCM_UNDEFINED;
387 /* now: sc && sc->line_l () == line */
389 || (sc->common_refpoint (line, X_AXIS)
390 && sc->common_refpoint (line, Y_AXIS)))
392 return sc->self_scm ();
394 return SCM_UNDEFINED;
397 else if (gh_pair_p (src))
399 SCM oldcar =gh_car (src);
401 UGH! breaks on circular lists.
403 SCM newcar = handle_broken_smobs (oldcar, criterion);
404 SCM oldcdr = gh_cdr (src);
406 if (newcar == SCM_UNDEFINED
407 && (gh_pair_p (oldcdr) || oldcdr == SCM_EOL))
410 This is tail-recursion, ie.
412 return handle_broken_smobs (cdr, criterion);
414 We don't want to rely on the compiler to do this. Without
415 tail-recursion, this easily crashes with a stack overflow. */
420 SCM newcdr = handle_broken_smobs (oldcdr, criterion);
421 return gh_cons (newcar, newcdr);
430 Score_element::handle_broken_dependencies()
432 Spanner * s= dynamic_cast<Spanner*> (this);
433 if (original_l_ && s)
438 for (int i = 0; i< s->broken_into_l_arr_ .size (); i++)
440 Score_element * sc = s->broken_into_l_arr_[i];
441 Line_of_score * l = sc->line_l ();
442 sc->mutable_property_alist_ =
443 handle_broken_smobs (mutable_property_alist_,
444 l ? l->self_scm () : SCM_UNDEFINED);
449 Line_of_score *line = line_l();
451 if (line && common_refpoint (line, X_AXIS) && common_refpoint (line, Y_AXIS))
453 mutable_property_alist_
454 = handle_broken_smobs (mutable_property_alist_,
455 line ? line->self_scm () : SCM_UNDEFINED);
457 else if (dynamic_cast <Line_of_score*> (this))
459 mutable_property_alist_ = handle_broken_smobs (mutable_property_alist_,
465 This element is `invalid'; it has been removed from all
466 dependencies, so let's junk the element itself.
468 do not do this for Line_of_score, since that would remove
469 references to the originals of score-elts, which get then GC'd
477 Note that we still want references to this element to be
478 rearranged, and not silently thrown away, so we keep pointers
479 like {broken_into_{drul,array}, original}
482 Score_element::suicide ()
484 mutable_property_alist_ = SCM_EOL;
485 immutable_property_alist_ = SCM_EOL;
487 set_extent_callback (SCM_EOL, Y_AXIS);
488 set_extent_callback (SCM_EOL, X_AXIS);
490 for (int a= X_AXIS; a <= Y_AXIS; a++)
492 dim_cache_[a].offset_callbacks_ = SCM_EOL;
493 dim_cache_[a].offsets_left_ = 0;
498 Score_element::handle_prebroken_dependencies()
503 Score_element::find_broken_piece (Line_of_score*) const
509 Score_element::translate_axis (Real y, Axis a)
511 if (isinf (y) || isnan (y))
512 programming_error (_(INFINITY_MSG));
515 dim_cache_[a].offset_ += y;
520 Score_element::relative_coordinate (Score_element const*refp, Axis a) const
526 We catch PARENT_L_ == nil case with this, but we crash if we did
527 not ask for the absolute coordinate (ie. REFP == nil.)
530 if (refp == dim_cache_[a].parent_l_)
531 return get_offset (a);
533 return get_offset (a) + dim_cache_[a].parent_l_->relative_coordinate (refp, a);
537 Score_element::get_offset (Axis a) const
539 Score_element *me = (Score_element*) this;
540 while (dim_cache_[a].offsets_left_)
542 int l = --me->dim_cache_[a].offsets_left_;
543 SCM cb = scm_list_ref (dim_cache_[a].offset_callbacks_, gh_int2scm (l));
544 SCM retval = gh_call2 (cb, self_scm (), gh_int2scm (a));
546 Real r = gh_scm2double (retval);
547 if (isinf (r) || isnan (r))
549 programming_error (INFINITY_MSG);
552 me->dim_cache_[a].offset_ +=r;
554 return dim_cache_[a].offset_;
558 MAKE_SCHEME_CALLBACK(Score_element,point_dimension_callback,2);
560 Score_element::point_dimension_callback (SCM , SCM )
562 return ly_interval2scm ( Interval (0,0));
566 Score_element::empty_b (Axis a)const
568 return ! (gh_pair_p (dim_cache_[a].dimension_ ) ||
569 gh_procedure_p (dim_cache_[a].dimension_ ));
573 Score_element::extent (Axis a) const
575 Dimension_cache * d = (Dimension_cache *)&dim_cache_[a];
577 if (gh_pair_p (d->dimension_))
579 else if (gh_procedure_p (d->dimension_))
582 FIXME: add doco on types, and should typecheck maybe?
584 d->dimension_= gh_call2 (d->dimension_, self_scm(), gh_int2scm (a));
589 ext = ly_scm2interval (d->dimension_);
591 SCM extra = get_elt_property (a == X_AXIS
598 Real s = paper_l ()->get_var ("staffspace");
599 if (gh_pair_p (extra))
601 ext[BIGGER] += s * gh_scm2double (gh_cdr (extra));
602 ext[SMALLER] += s * gh_scm2double (gh_car (extra));
605 extra = get_elt_property (a == X_AXIS
607 : "minimum-extent-Y");
608 if (gh_pair_p (extra))
610 ext.unite (Interval (s * gh_scm2double (gh_car (extra)),
611 s * gh_scm2double (gh_cdr (extra))));
619 Score_element::parent_l (Axis a) const
621 return dim_cache_[a].parent_l_;
625 Score_element::common_refpoint (Score_element const* s, Axis a) const
628 I don't like the quadratic aspect of this code, but I see no other
629 way. The largest chain of parents might be 10 high or so, so
630 it shouldn't be a real issue. */
631 for (Score_element const *c = this; c; c = c->dim_cache_[a].parent_l_)
632 for (Score_element const * d = s; d; d = d->dim_cache_[a].parent_l_)
634 return (Score_element*)d;
641 Score_element::common_refpoint (SCM elist, Axis a) const
643 Score_element * common = (Score_element*) this;
644 for (; gh_pair_p (elist); elist = gh_cdr (elist))
646 Score_element * s = unsmob_element (gh_car (elist));
648 common = common->common_refpoint (s, a);
655 Score_element::name () const
657 SCM nm = get_elt_property ("name");
659 return nm == SCM_EOL ? classname (this) :ly_scm2string (nm) ;
663 Score_element::add_offset_callback (SCM cb, Axis a)
665 if (!has_offset_callback_b (cb, a))
667 dim_cache_[a].offset_callbacks_ = gh_cons (cb, dim_cache_[a].offset_callbacks_ );
668 dim_cache_[a].offsets_left_ ++;
673 Score_element::has_extent_callback_b (SCM cb, Axis a)const
675 return scm_equal_p (cb, dim_cache_[a].dimension_);
680 Score_element::has_extent_callback_b (Axis a) const
682 return gh_procedure_p (dim_cache_[a].dimension_);
686 Score_element::has_offset_callback_b (SCM cb, Axis a)const
688 return scm_memq (cb, dim_cache_[a].offset_callbacks_) != SCM_BOOL_F;
692 Score_element::set_extent_callback (SCM dc, Axis a)
694 dim_cache_[a].dimension_ =dc;
698 Score_element::set_parent (Score_element *g, Axis a)
700 dim_cache_[a].parent_l_ = g;
703 MAKE_SCHEME_CALLBACK(Score_element,fixup_refpoint,1);
705 Score_element::fixup_refpoint (SCM smob)
707 Score_element *me = unsmob_element (smob);
708 for (int a = X_AXIS; a < NO_AXES; a ++)
711 Score_element * parent = me->parent_l (ax);
716 if (parent->line_l () != me->line_l () && me->line_l ())
718 Score_element * newparent = parent->find_broken_piece (me->line_l ());
719 me->set_parent (newparent, ax);
722 if (Item * i = dynamic_cast<Item*> (me))
724 Item *parenti = dynamic_cast<Item*> (parent);
728 Direction my_dir = i->break_status_dir () ;
729 if (my_dir!= parenti->break_status_dir())
731 Item *newparent = parenti->find_prebroken_piece (my_dir);
732 me->set_parent (newparent, ax);
742 /****************************************************
744 ****************************************************/
747 IMPLEMENT_UNSMOB(Score_element, element);
748 IMPLEMENT_SMOBS(Score_element);
749 IMPLEMENT_DEFAULT_EQUAL_P(Score_element);
752 Score_element::mark_smob (SCM ses)
754 Score_element * s = (Score_element*) SCM_CELL_WORD_1(ses);
755 scm_gc_mark (s->immutable_property_alist_);
756 scm_gc_mark (s->mutable_property_alist_);
758 for (int a =0 ; a < 2; a++)
760 scm_gc_mark (s->dim_cache_[a].offset_callbacks_);
761 scm_gc_mark (s->dim_cache_[a].dimension_);
764 if (s->parent_l (Y_AXIS))
765 scm_gc_mark (s->parent_l (Y_AXIS)->self_scm ());
766 if (s->parent_l (X_AXIS))
767 scm_gc_mark (s->parent_l (X_AXIS)->self_scm ());
770 scm_gc_mark (s->original_l_->self_scm ());
771 return s->do_derived_mark ();
775 Score_element::print_smob (SCM s, SCM port, scm_print_state *)
777 Score_element *sc = (Score_element *) gh_cdr (s);
779 scm_puts ("#<Score_element ", port);
780 scm_puts ((char *)sc->name ().ch_C(), port);
783 don't try to print properties, that is too much hassle.
785 scm_puts (" >", port);
790 Score_element::do_derived_mark ()
797 ly_set_elt_property (SCM elt, SCM sym, SCM val)
799 Score_element * sc = unsmob_element (elt);
801 if (!gh_symbol_p (sym))
803 error ("Not a symbol");
804 ly_display_scm (sym);
805 return SCM_UNSPECIFIED;
810 sc->set_elt_property (sym, val);
814 error ("Not a score element");
815 ly_display_scm (elt);
818 return SCM_UNSPECIFIED;
823 ly_get_elt_property (SCM elt, SCM sym)
825 Score_element * sc = unsmob_element (elt);
829 return sc->get_elt_property (sym);
833 error ("Not a score element");
834 ly_display_scm (elt);
836 return SCM_UNSPECIFIED;
841 Score_element::discretionary_processing()
848 spanner_get_bound (SCM slur, SCM dir)
850 return dynamic_cast<Spanner*> (unsmob_element (slur))->get_bound (to_dir (dir))->self_scm ();
855 static SCM interfaces_sym;
859 interfaces_sym = scm_permanent_object (ly_symbol2scm ("interfaces"));
861 scm_make_gsubr ("ly-get-elt-property", 2, 0, 0, (Scheme_function_unknown)ly_get_elt_property);
862 scm_make_gsubr ("ly-set-elt-property", 3, 0, 0, (Scheme_function_unknown)ly_set_elt_property);
863 scm_make_gsubr ("ly-get-spanner-bound", 2 , 0, 0, (Scheme_function_unknown) spanner_get_bound);
867 Score_element::has_interface (SCM k)
869 SCM ifs = get_elt_property (interfaces_sym);
871 return scm_memq (k, ifs) != SCM_BOOL_F;
875 Score_element::set_interface (SCM k)
877 if (has_interface (k))
881 set_elt_property (interfaces_sym,
882 gh_cons (k, get_elt_property (interfaces_sym)));
887 ADD_SCM_INIT_FUNC(scoreelt, init_functions);