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, X_AXIS);
52 set_extent_callback (molecule_extent, 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_);
73 Score_element::Score_element (Score_element const&s)
74 : dim_cache_ (s.dim_cache_)
76 original_l_ =(Score_element*) &s;
77 immutable_property_alist_ = s.immutable_property_alist_;
78 mutable_property_alist_ = SCM_EOL;
80 status_i_ = s.status_i_;
81 lookup_l_ = s.lookup_l_;
82 pscore_l_ = s.pscore_l_;
87 Score_element::~Score_element()
90 do nothing scm-ish and no unprotecting here.
96 Score_element::get_elt_property (const char *nm) const
98 SCM sym = ly_symbol2scm (nm);
99 return get_elt_property (sym);
103 Score_element::get_elt_property (SCM sym) const
105 SCM s = scm_sloppy_assq(sym, mutable_property_alist_);
109 s = scm_sloppy_assq (sym, immutable_property_alist_);
110 return (s == SCM_BOOL_F) ? SCM_EOL : gh_cdr (s);
114 Remove the value associated with KEY, and return it. The result is
115 that a next call will yield SCM_UNDEFINED (and not the underlying
119 Score_element::remove_elt_property (const char* key)
121 SCM val = get_elt_property (key);
123 set_elt_property (key, SCM_EOL);
128 Score_element::set_elt_property (const char* k, SCM v)
130 SCM s = ly_symbol2scm (k);
131 set_elt_property (s, v);
135 Puts the k, v in the immutable_property_alist_, which is convenient for
136 storing variables that are needed during the breaking process. (eg.
137 Line_of_score::rank : int )
140 Score_element::set_immutable_elt_property (const char*k, SCM v)
142 SCM s = ly_symbol2scm (k);
143 set_immutable_elt_property (s, v);
147 Score_element::set_immutable_elt_property (SCM s, SCM v)
149 immutable_property_alist_ = gh_cons (gh_cons (s,v), mutable_property_alist_);
150 mutable_property_alist_ = scm_assq_remove_x (mutable_property_alist_, s);
153 Score_element::set_elt_property (SCM s, SCM v)
155 mutable_property_alist_ = scm_assq_set_x (mutable_property_alist_, s, v);
160 Score_element::molecule_extent (Score_element *s, Axis a)
162 Molecule m = s->get_molecule ();
167 Score_element::preset_extent (Score_element *s , Axis a)
169 SCM ext = s->get_elt_property ((a == X_AXIS)
175 Real l = gh_scm2double (gh_car (ext));
176 Real r = gh_scm2double (gh_cdr (ext));
177 l *= s->paper_l ()->get_var ("staffspace");
178 r *= s->paper_l ()->get_var ("staffspace");
179 return Interval (l, r);
188 Score_element::paper_l () const
190 return pscore_l_ ? pscore_l_->paper_l_ : 0;
194 Score_element::lookup_l () const
197 URG junkthis, caching is clumsy.
201 Score_element * urg = (Score_element*)this;
202 SCM sz = urg->remove_elt_property ("font-size");
203 int i = (gh_number_p (sz))
207 urg->lookup_l_ = (Lookup*)pscore_l_->paper_l_->lookup_l (i);
213 Score_element::add_processing()
215 assert (status_i_ >=0);
224 Score_element::calculate_dependencies (int final, int busy, SCM funcname)
226 assert (status_i_ >=0);
228 if (status_i_ >= final)
231 if (status_i_== busy)
233 programming_error ("Element is busy, come back later");
239 for (SCM d= get_elt_property ("dependencies"); gh_pair_p (d); d = gh_cdr (d))
241 unsmob_element (gh_car (d))
242 ->calculate_dependencies (final, busy, funcname);
246 String s = ly_symbol2string (funcname);
247 SCM proc = get_elt_property (s.ch_C());
248 if (gh_procedure_p (proc))
249 gh_call1 (proc, this->self_scm ());
256 Score_element::get_molecule () const
258 SCM proc = get_elt_property ("molecule-callback");
261 if (gh_procedure_p (proc))
262 mol = gh_apply (proc, gh_list (this->self_scm (), SCM_UNDEFINED));
265 SCM origin =get_elt_property ("origin");
266 if (!unsmob_input (origin))
267 origin =ly_symbol2scm ("no-origin");
272 mol = gh_cons (gh_list (origin, gh_car (mol), SCM_UNDEFINED), gh_cdr (mol));
276 Molecule m (create_molecule (mol));
279 This is almost the same as setting molecule-callback to #f, but
280 this retains the dimensions of this element, which means that you
281 can erase elements individually. */
282 if (to_boolean (get_elt_property ("transparent")))
283 m = Molecule (m.extent_box (), SCM_EOL);
295 Score_element::do_break_processing()
301 Score_element::do_add_processing()
306 MAKE_SCHEME_CALLBACK(Score_element,brew_molecule,1)
312 Score_element::brew_molecule (SCM smob)
314 Score_element * sc = unsmob_element (smob);
315 SCM glyph = sc->get_elt_property ("glyph");
316 if (gh_string_p (glyph))
318 return sc->lookup_l ()->afm_find (String (ly_scm2string (glyph))).create_scheme ();
328 Score_element::line_l() const
334 Score_element::add_dependency (Score_element*e)
338 Pointer_group_interface gi (this, "dependencies");
342 programming_error ("Null dependency added");
349 Do break substitution in S, using CRITERION. Return new value.
350 CRITERION is either a SMOB pointer to the desired line, or a number
351 representing the break direction. Do not modify SRC.
354 Score_element::handle_broken_smobs (SCM src, SCM criterion)
357 Score_element *sc = unsmob_element (src);
360 if (gh_number_p (criterion))
362 Item * i = dynamic_cast<Item*> (sc);
363 Direction d = to_dir (criterion);
364 if (i && i->break_status_dir () != d)
366 Item *br = i->find_prebroken_piece (d);
367 return (br) ? br->self_scm () : SCM_UNDEFINED;
373 = dynamic_cast<Line_of_score*> (unsmob_element (criterion));
374 if (sc->line_l () != line)
376 sc = sc->find_broken_piece (line);
380 /* now: !sc || (sc && sc->line_l () == line) */
382 return SCM_UNDEFINED;
384 /* now: sc && sc->line_l () == line */
386 || (sc->common_refpoint (line, X_AXIS)
387 && sc->common_refpoint (line, Y_AXIS)))
389 return sc->self_scm ();
391 return SCM_UNDEFINED;
394 else if (gh_pair_p (src))
396 SCM oldcar =gh_car (src);
398 UGH! breaks on circular lists.
400 SCM newcar = handle_broken_smobs (oldcar, criterion);
401 SCM oldcdr = gh_cdr (src);
403 if (newcar == SCM_UNDEFINED
404 && (gh_pair_p (oldcdr) || oldcdr == SCM_EOL))
407 This is tail-recursion, ie.
409 return handle_broken_smobs (cdr, criterion);
411 We don't want to rely on the compiler to do this. Without
412 tail-recursion, this easily crashes with a stack overflow. */
417 SCM newcdr = handle_broken_smobs (oldcdr, criterion);
418 return gh_cons (newcar, newcdr);
427 Score_element::handle_broken_dependencies()
429 Spanner * s= dynamic_cast<Spanner*> (this);
430 if (original_l_ && s)
435 for (int i = 0; i< s->broken_into_l_arr_ .size (); i++)
437 Score_element * sc = s->broken_into_l_arr_[i];
438 Line_of_score * l = sc->line_l ();
439 sc->mutable_property_alist_ =
440 handle_broken_smobs (mutable_property_alist_,
441 l ? l->self_scm () : SCM_UNDEFINED);
446 Line_of_score *line = line_l();
448 if (line && common_refpoint (line, X_AXIS) && common_refpoint (line, Y_AXIS))
450 mutable_property_alist_
451 = handle_broken_smobs (mutable_property_alist_,
452 line ? line->self_scm () : SCM_UNDEFINED);
454 else if (dynamic_cast <Line_of_score*> (this))
456 mutable_property_alist_ = handle_broken_smobs (mutable_property_alist_,
462 This element is `invalid'; it has been removed from all
463 dependencies, so let's junk the element itself.
465 do not do this for Line_of_score, since that would remove
466 references to the originals of score-elts, which get then GC'd
474 Note that we still want references to this element to be
475 rearranged, and not silently thrown away, so we keep pointers
476 like {broken_into_{drul,array}, original}
479 Score_element::suicide ()
481 mutable_property_alist_ = SCM_EOL;
482 immutable_property_alist_ = SCM_EOL;
483 set_extent_callback (0, Y_AXIS);
484 set_extent_callback (0, X_AXIS);
486 for (int a= X_AXIS; a <= Y_AXIS; a++)
488 dim_cache_[a].offset_callbacks_ = SCM_EOL;
489 dim_cache_[a].offsets_left_ = 0;
494 Score_element::handle_prebroken_dependencies()
499 Score_element::find_broken_piece (Line_of_score*) const
505 Score_element::translate_axis (Real y, Axis a)
507 if (isinf (y) || isnan (y))
508 programming_error (_(INFINITY_MSG));
511 dim_cache_[a].offset_ += y;
516 Score_element::relative_coordinate (Score_element const*refp, Axis a) const
522 We catch PARENT_L_ == nil case with this, but we crash if we did
523 not ask for the absolute coordinate (ie. REFP == nil.)
526 if (refp == dim_cache_[a].parent_l_)
527 return get_offset (a);
529 return get_offset (a) + dim_cache_[a].parent_l_->relative_coordinate (refp, a);
533 Score_element::get_offset (Axis a) const
535 Score_element *me = (Score_element*) this;
536 while (dim_cache_[a].offsets_left_)
538 int l = --me->dim_cache_[a].offsets_left_;
539 SCM cb = scm_list_ref (dim_cache_[a].offset_callbacks_, gh_int2scm (l));
540 SCM retval = gh_call2 (cb, self_scm (), gh_int2scm (a));
542 Real r = gh_scm2double (retval);
543 if (isinf (r) || isnan (r))
545 programming_error (INFINITY_MSG);
548 me->dim_cache_[a].offset_ +=r;
550 return dim_cache_[a].offset_;
555 Score_element::point_dimension_callback (Score_element* , Axis)
557 return Interval (0,0);
561 Score_element::empty_b (Axis a)const
563 return !dim_cache_[a].extent_callback_l_;
567 Score_element::extent (Axis a) const
569 Dimension_cache * d = (Dimension_cache *)&dim_cache_[a];
570 if (!d->extent_callback_l_)
572 d->dim_.set_empty ();
574 else if (!d->valid_b_)
576 d->dim_= (*d->extent_callback_l_ ) ((Score_element*)this, a);
580 Interval ext = d->dim_;
585 SCM extra = get_elt_property (a == X_AXIS
592 Real s = paper_l ()->get_var ("staffspace");
593 if (gh_pair_p (extra))
595 ext[BIGGER] += s * gh_scm2double (gh_cdr (extra));
596 ext[SMALLER] += s * gh_scm2double (gh_car (extra));
599 extra = get_elt_property (a == X_AXIS
601 : "minimum-extent-Y");
602 if (gh_pair_p (extra))
604 ext.unite (Interval (s * gh_scm2double (gh_car (extra)),
605 s * gh_scm2double (gh_cdr (extra))));
613 Score_element::parent_l (Axis a) const
615 return dim_cache_[a].parent_l_;
619 Score_element::common_refpoint (Score_element const* s, Axis a) const
622 I don't like the quadratic aspect of this code, but I see no other
623 way. The largest chain of parents might be 10 high or so, so
624 it shouldn't be a real issue. */
625 for (Score_element const *c = this; c; c = c->dim_cache_[a].parent_l_)
626 for (Score_element const * d = s; d; d = d->dim_cache_[a].parent_l_)
628 return (Score_element*)d;
635 Score_element::common_refpoint (SCM elist, Axis a) const
637 Score_element * common = (Score_element*) this;
638 for (; gh_pair_p (elist); elist = gh_cdr (elist))
640 Score_element * s = unsmob_element (gh_car (elist));
642 common = common->common_refpoint (s, a);
649 Score_element::name () const
651 SCM nm = get_elt_property ("name");
653 return nm == SCM_EOL ? classname (this) :ly_scm2string (nm) ;
657 Score_element::add_offset_callback (SCM cb, Axis a)
659 dim_cache_[a].offset_callbacks_ = gh_cons (cb, dim_cache_[a].offset_callbacks_ );
660 dim_cache_[a].offsets_left_ ++;
664 Score_element::has_extent_callback_b (Extent_callback cb, Axis a)const
666 return cb == dim_cache_[a].extent_callback_l_;
671 Score_element::has_extent_callback_b (Axis a) const
673 return dim_cache_[a].extent_callback_l_;
677 Score_element::has_offset_callback_b (SCM cb, Axis a)const
679 return scm_memq (cb, dim_cache_[a].offset_callbacks_) != SCM_BOOL_F;
683 Score_element::set_extent_callback (Dim_cache_callback dc, Axis a)
685 dim_cache_[a].extent_callback_l_ = dc ;
690 Score_element::set_parent (Score_element *g, Axis a)
692 dim_cache_[a].parent_l_ = g;
695 MAKE_SCHEME_CALLBACK(Score_element,fixup_refpoint,1);
697 Score_element::fixup_refpoint (SCM smob)
699 Score_element *me = unsmob_element (smob);
700 for (int a = X_AXIS; a < NO_AXES; a ++)
703 Score_element * parent = me->parent_l (ax);
708 if (parent->line_l () != me->line_l () && me->line_l ())
710 Score_element * newparent = parent->find_broken_piece (me->line_l ());
711 me->set_parent (newparent, ax);
714 if (Item * i = dynamic_cast<Item*> (me))
716 Item *parenti = dynamic_cast<Item*> (parent);
720 Direction my_dir = i->break_status_dir () ;
721 if (my_dir!= parenti->break_status_dir())
723 Item *newparent = parenti->find_prebroken_piece (my_dir);
724 me->set_parent (newparent, ax);
734 /****************************************************
736 ****************************************************/
739 IMPLEMENT_UNSMOB(Score_element, element);
740 IMPLEMENT_SMOBS(Score_element);
741 IMPLEMENT_DEFAULT_EQUAL_P(Score_element);
744 Score_element::mark_smob (SCM ses)
746 Score_element * s = (Score_element*) SCM_CELL_WORD_1(ses);
747 scm_gc_mark (s->immutable_property_alist_);
748 scm_gc_mark (s->mutable_property_alist_);
749 scm_gc_mark (s->dim_cache_[X_AXIS].offset_callbacks_);
750 scm_gc_mark (s->dim_cache_[Y_AXIS].offset_callbacks_);
752 if (s->parent_l (Y_AXIS))
753 scm_gc_mark (s->parent_l (Y_AXIS)->self_scm ());
754 if (s->parent_l (X_AXIS))
755 scm_gc_mark (s->parent_l (X_AXIS)->self_scm ());
758 scm_gc_mark (s->original_l_->self_scm ());
759 return s->do_derived_mark ();
763 Score_element::print_smob (SCM s, SCM port, scm_print_state *)
765 Score_element *sc = (Score_element *) gh_cdr (s);
767 scm_puts ("#<Score_element ", port);
768 scm_puts ((char *)sc->name ().ch_C(), port);
771 don't try to print properties, that is too much hassle.
773 scm_puts (" >", port);
778 Score_element::do_derived_mark ()
785 ly_set_elt_property (SCM elt, SCM sym, SCM val)
787 Score_element * sc = unsmob_element (elt);
789 if (!gh_symbol_p (sym))
791 error ("Not a symbol");
792 ly_display_scm (sym);
793 return SCM_UNSPECIFIED;
798 sc->set_elt_property (sym, val);
802 error ("Not a score element");
803 ly_display_scm (elt);
806 return SCM_UNSPECIFIED;
811 ly_get_elt_property (SCM elt, SCM sym)
813 Score_element * sc = unsmob_element (elt);
817 return sc->get_elt_property (sym);
821 error ("Not a score element");
822 ly_display_scm (elt);
824 return SCM_UNSPECIFIED;
829 Score_element::discretionary_processing()
836 spanner_get_bound (SCM slur, SCM dir)
838 return dynamic_cast<Spanner*> (unsmob_element (slur))->get_bound (to_dir (dir))->self_scm ();
843 static SCM interfaces_sym;
847 interfaces_sym = scm_permanent_object (ly_symbol2scm ("interfaces"));
849 scm_make_gsubr ("ly-get-elt-property", 2, 0, 0, (Scheme_function_unknown)ly_get_elt_property);
850 scm_make_gsubr ("ly-set-elt-property", 3, 0, 0, (Scheme_function_unknown)ly_set_elt_property);
851 scm_make_gsubr ("ly-get-spanner-bound", 2 , 0, 0, (Scheme_function_unknown) spanner_get_bound);
855 Score_element::has_interface (SCM k)
857 // if (mutable_property_alist_ == SCM_EOL)
860 SCM ifs = get_elt_property (interfaces_sym);
862 return scm_memq (k, ifs) != SCM_BOOL_F;
866 Score_element::set_interface (SCM k)
868 if (has_interface (k))
872 set_elt_property (interfaces_sym,
873 gh_cons (k, get_elt_property (interfaces_sym)));
878 ADD_SCM_INIT_FUNC(scoreelt, init_functions);