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;
62 set_elt_property ("dependencies", SCM_EOL);
64 if (get_elt_property ("interfaces") == SCM_UNDEFINED)
65 set_elt_property ("interfaces", SCM_EOL);
69 Score_element::Score_element (Score_element const&s)
70 : dim_cache_ (s.dim_cache_)
72 original_l_ =(Score_element*) &s;
73 immutable_property_alist_ = s.immutable_property_alist_;
74 mutable_property_alist_ = SCM_EOL;
76 status_i_ = s.status_i_;
77 lookup_l_ = s.lookup_l_;
78 pscore_l_ = s.pscore_l_;
83 Score_element::~Score_element()
86 do nothing scm-ish and no unprotecting here.
92 Score_element::get_elt_property (const char *nm) const
94 SCM sym = ly_symbol2scm (nm);
95 return get_elt_property (sym);
99 Score_element::get_elt_property (SCM sym) const
101 SCM s = scm_sloppy_assq(sym, mutable_property_alist_);
105 s = scm_sloppy_assq (sym, immutable_property_alist_);
106 return (s == SCM_BOOL_F) ? SCM_EOL : gh_cdr (s);
110 Remove the value associated with KEY, and return it. The result is
111 that a next call will yield SCM_UNDEFINED (and not the underlying
115 Score_element::remove_elt_property (const char* key)
117 SCM val = get_elt_property (key);
119 set_elt_property (key, SCM_EOL);
124 Score_element::set_elt_property (const char* k, SCM v)
126 SCM s = ly_symbol2scm (k);
127 set_elt_property (s, v);
131 Puts the k, v in the immutable_property_alist_, which is convenient for
132 storing variables that are needed during the breaking process. (eg.
133 Line_of_score::rank : int )
136 Score_element::set_immutable_elt_property (const char*k, SCM v)
138 SCM s = ly_symbol2scm (k);
139 set_immutable_elt_property (s, v);
143 Score_element::set_immutable_elt_property (SCM s, SCM v)
145 immutable_property_alist_ = gh_cons (gh_cons (s,v), mutable_property_alist_);
146 mutable_property_alist_ = scm_assq_remove_x (mutable_property_alist_, s);
149 Score_element::set_elt_property (SCM s, SCM v)
151 mutable_property_alist_ = scm_assq_set_x (mutable_property_alist_, s, v);
156 Score_element::molecule_extent (Score_element *s, Axis a)
158 Molecule m = s->get_molecule ();
163 Score_element::preset_extent (Score_element *s , Axis a)
165 SCM ext = s->get_elt_property ((a == X_AXIS)
171 Real l = gh_scm2double (gh_car (ext));
172 Real r = gh_scm2double (gh_cdr (ext));
173 l *= s->paper_l ()->get_var ("staffspace");
174 r *= s->paper_l ()->get_var ("staffspace");
175 return Interval (l, r);
184 Score_element::paper_l () const
186 return pscore_l_ ? pscore_l_->paper_l_ : 0;
190 Score_element::lookup_l () const
194 Score_element * urg = (Score_element*)this;
195 SCM sz = urg->remove_elt_property ("fontsize");
196 int i = (gh_number_p (sz))
200 urg->lookup_l_ = (Lookup*)pscore_l_->paper_l_->lookup_l (i);
206 Score_element::add_processing()
208 assert (status_i_ >=0);
217 Score_element::calculate_dependencies (int final, int busy, SCM funcname)
219 assert (status_i_ >=0);
221 if (status_i_ >= final)
224 if (status_i_== busy)
226 programming_error ("Element is busy, come back later");
232 for (SCM d= get_elt_property ("dependencies"); gh_pair_p (d); d = gh_cdr (d))
234 unsmob_element (gh_car (d))
235 ->calculate_dependencies (final, busy, funcname);
239 String s = ly_symbol2string (funcname);
240 SCM proc = get_elt_property (s.ch_C());
241 if (gh_procedure_p (proc))
242 gh_call1 (proc, this->self_scm ());
249 Score_element::get_molecule () const
251 SCM proc = get_elt_property ("molecule-callback");
254 if (gh_procedure_p (proc))
255 mol = gh_apply (proc, gh_list (this->self_scm (), SCM_UNDEFINED));
258 SCM origin =get_elt_property ("origin");
259 if (!unsmob_input (origin))
260 origin =ly_symbol2scm ("no-origin");
265 mol = gh_cons (gh_list (origin, gh_car (mol), SCM_UNDEFINED), gh_cdr (mol));
269 return create_molecule (mol);
279 Score_element::do_break_processing()
285 Score_element::do_add_processing()
290 MAKE_SCHEME_CALLBACK(Score_element,brew_molecule)
296 Score_element::brew_molecule (SCM smob)
298 Score_element * sc = unsmob_element (smob);
299 SCM glyph = sc->get_elt_property ("glyph");
300 if (gh_string_p (glyph))
302 return sc->lookup_l ()->afm_find (String (ly_scm2string (glyph))).create_scheme ();
312 Score_element::line_l() const
318 Score_element::add_dependency (Score_element*e)
322 Pointer_group_interface gi (this, "dependencies");
326 programming_error ("Null dependency added");
333 Do break substitution in S, using CRITERION. Return new value.
334 CRITERION is either a SMOB pointer to the desired line, or a number
335 representing the break direction. Do not modify SRC.
338 Score_element::handle_broken_smobs (SCM src, SCM criterion)
341 Score_element *sc = unsmob_element (src);
344 if (gh_number_p (criterion))
346 Item * i = dynamic_cast<Item*> (sc);
347 Direction d = to_dir (criterion);
348 if (i && i->break_status_dir () != d)
350 Item *br = i->find_prebroken_piece (d);
351 return (br) ? br->self_scm () : SCM_UNDEFINED;
357 = dynamic_cast<Line_of_score*> (unsmob_element (criterion));
358 if (sc->line_l () != line)
360 sc = sc->find_broken_piece (line);
364 /* now: !sc || (sc && sc->line_l () == line) */
366 return SCM_UNDEFINED;
368 /* now: sc && sc->line_l () == line */
370 || (sc->common_refpoint (line, X_AXIS)
371 && sc->common_refpoint (line, Y_AXIS)))
373 return sc->self_scm ();
375 return SCM_UNDEFINED;
378 else if (gh_pair_p (src))
380 SCM oldcar =gh_car (src);
382 UGH! breaks on circular lists.
384 SCM newcar = handle_broken_smobs (oldcar, criterion);
385 SCM oldcdr = gh_cdr (src);
387 if (newcar == SCM_UNDEFINED
388 && (gh_pair_p (oldcdr) || oldcdr == SCM_EOL))
391 This is tail-recursion, ie.
393 return handle_broken_smobs (cdr, criterion);
395 We don't want to rely on the compiler to do this. Without
396 tail-recursion, this easily crashes with a stack overflow. */
401 SCM newcdr = handle_broken_smobs (oldcdr, criterion);
402 return gh_cons (newcar, newcdr);
411 Score_element::handle_broken_dependencies()
413 Spanner * s= dynamic_cast<Spanner*> (this);
414 if (original_l_ && s)
419 for (int i = 0; i< s->broken_into_l_arr_ .size (); i++)
421 Score_element * sc = s->broken_into_l_arr_[i];
422 Line_of_score * l = sc->line_l ();
423 sc->mutable_property_alist_ =
424 handle_broken_smobs (mutable_property_alist_,
425 l ? l->self_scm () : SCM_UNDEFINED);
430 Line_of_score *line = line_l();
432 if (line && common_refpoint (line, X_AXIS) && common_refpoint (line, Y_AXIS))
434 mutable_property_alist_
435 = handle_broken_smobs (mutable_property_alist_,
436 line ? line->self_scm () : SCM_UNDEFINED);
438 else if (dynamic_cast <Line_of_score*> (this))
440 mutable_property_alist_ = handle_broken_smobs (mutable_property_alist_,
446 This element is `invalid'; it has been removed from all
447 dependencies, so let's junk the element itself.
449 do not do this for Line_of_score, since that would remove
450 references to the originals of score-elts, which get then GC'd
458 Note that we still want references to this element to be
459 rearranged, and not silently thrown away, so we keep pointers
460 like {broken_into_{drul,array}, original}
463 Score_element::suicide ()
465 mutable_property_alist_ = SCM_EOL;
466 immutable_property_alist_ = SCM_EOL;
467 set_extent_callback (0, Y_AXIS);
468 set_extent_callback (0, X_AXIS);
470 for (int a= X_AXIS; a <= Y_AXIS; a++)
472 dim_cache_[a].off_callbacks_.clear ();
477 Score_element::handle_prebroken_dependencies()
482 Score_element::find_broken_piece (Line_of_score*) const
488 Score_element::translate_axis (Real y, Axis a)
490 if (isinf (y) || isnan (y))
491 programming_error (_(INFINITY_MSG));
494 dim_cache_[a].offset_ += y;
499 Score_element::relative_coordinate (Score_element const*refp, Axis a) const
505 We catch PARENT_L_ == nil case with this, but we crash if we did
506 not ask for the absolute coordinate (ie. REFP == nil.)
509 if (refp == dim_cache_[a].parent_l_)
510 return get_offset (a);
512 return get_offset (a) + dim_cache_[a].parent_l_->relative_coordinate (refp, a);
516 Score_element::get_offset (Axis a) const
518 Score_element *me = (Score_element*) this;
519 while (dim_cache_[a].off_callbacks_.size ())
521 Offset_callback c = dim_cache_[a].off_callbacks_[0];
522 me->dim_cache_[a].off_callbacks_.del (0);
523 Real r = (*c) (me,a );
524 if (isinf (r) || isnan (r))
526 programming_error (INFINITY_MSG);
529 me->dim_cache_[a].offset_ +=r;
531 return dim_cache_[a].offset_;
536 Score_element::point_dimension_callback (Score_element* , Axis)
538 return Interval (0,0);
542 Score_element::empty_b (Axis a)const
544 return !dim_cache_[a].extent_callback_l_;
548 Score_element::extent (Axis a) const
550 Dimension_cache * d = (Dimension_cache *)&dim_cache_[a];
551 if (!d->extent_callback_l_)
553 d->dim_.set_empty ();
555 else if (!d->valid_b_)
557 d->dim_= (*d->extent_callback_l_ ) ((Score_element*)this, a);
561 Interval ext = d->dim_;
566 SCM extra = get_elt_property (a == X_AXIS
573 Real s = paper_l ()->get_var ("staffspace");
574 if (gh_pair_p (extra))
576 ext[BIGGER] += s * gh_scm2double (gh_cdr (extra));
577 ext[SMALLER] += s * gh_scm2double (gh_car (extra));
580 extra = get_elt_property (a == X_AXIS
582 : "minimum-extent-Y");
583 if (gh_pair_p (extra))
585 ext.unite (Interval (s * gh_scm2double (gh_car (extra)),
586 s * gh_scm2double (gh_cdr (extra))));
594 Score_element::parent_l (Axis a) const
596 return dim_cache_[a].parent_l_;
600 Score_element::common_refpoint (Score_element const* s, Axis a) const
603 I don't like the quadratic aspect of this code, but I see no other
604 way. The largest chain of parents might be 10 high or so, so
605 it shouldn't be a real issue. */
606 for (Score_element const *c = this; c; c = c->dim_cache_[a].parent_l_)
607 for (Score_element const * d = s; d; d = d->dim_cache_[a].parent_l_)
609 return (Score_element*)d;
616 Score_element::common_refpoint (SCM elist, Axis a) const
618 Score_element * common = (Score_element*) this;
619 for (; gh_pair_p (elist); elist = gh_cdr (elist))
621 Score_element * s = unsmob_element (gh_car (elist));
623 common = common->common_refpoint (s, a);
630 Score_element::name () const
632 return classname (this);
636 Score_element::add_offset_callback (Offset_callback cb, Axis a)
638 dim_cache_[a].off_callbacks_.push (cb);
642 Score_element::has_extent_callback_b (Extent_callback cb, Axis a)const
644 return cb == dim_cache_[a].extent_callback_l_;
649 Score_element::has_extent_callback_b (Axis a) const
651 return dim_cache_[a].extent_callback_l_;
655 Score_element::has_offset_callback_b (Offset_callback cb, Axis a)const
657 for (int i= dim_cache_[a].off_callbacks_.size (); i--;)
659 if (dim_cache_[a].off_callbacks_[i] == cb)
666 Score_element::set_extent_callback (Dim_cache_callback dc, Axis a)
668 dim_cache_[a].extent_callback_l_ = dc ;
673 Score_element::set_parent (Score_element *g, Axis a)
675 dim_cache_[a].parent_l_ = g;
678 MAKE_SCHEME_CALLBACK(Score_element,fixup_refpoint);
680 Score_element::fixup_refpoint (SCM smob)
682 Score_element *me = unsmob_element (smob);
683 for (int a = X_AXIS; a < NO_AXES; a ++)
686 Score_element * parent = me->parent_l (ax);
691 if (parent->line_l () != me->line_l () && me->line_l ())
693 Score_element * newparent = parent->find_broken_piece (me->line_l ());
694 me->set_parent (newparent, ax);
697 if (Item * i = dynamic_cast<Item*> (me))
699 Item *parenti = dynamic_cast<Item*> (parent);
703 Direction my_dir = i->break_status_dir () ;
704 if (my_dir!= parenti->break_status_dir())
706 Item *newparent = parenti->find_prebroken_piece (my_dir);
707 me->set_parent (newparent, ax);
717 /****************************************************
719 ****************************************************/
722 IMPLEMENT_UNSMOB(Score_element, element);
723 IMPLEMENT_SMOBS(Score_element);
724 IMPLEMENT_DEFAULT_EQUAL_P(Score_element);
727 Score_element::mark_smob (SCM ses)
729 Score_element * s = (Score_element*) SCM_CELL_WORD_1(ses);
730 scm_gc_mark (s->immutable_property_alist_);
731 scm_gc_mark (s->mutable_property_alist_);
733 if (s->parent_l (Y_AXIS))
734 scm_gc_mark (s->parent_l (Y_AXIS)->self_scm ());
735 if (s->parent_l (X_AXIS))
736 scm_gc_mark (s->parent_l (X_AXIS)->self_scm ());
739 scm_gc_mark (s->original_l_->self_scm ());
740 return s->do_derived_mark ();
744 Score_element::print_smob (SCM s, SCM port, scm_print_state *)
746 Score_element *sc = (Score_element *) gh_cdr (s);
748 scm_puts ("#<Score_element ", port);
749 scm_puts ((char *)sc->name (), port);
752 don't try to print properties, that is too much hassle.
754 scm_puts (" >", port);
759 Score_element::do_derived_mark ()
766 ly_set_elt_property (SCM elt, SCM sym, SCM val)
768 Score_element * sc = unsmob_element (elt);
770 if (!gh_symbol_p (sym))
772 error ("Not a symbol");
773 ly_display_scm (sym);
774 return SCM_UNSPECIFIED;
779 sc->set_elt_property (sym, val);
783 error ("Not a score element");
784 ly_display_scm (elt);
787 return SCM_UNSPECIFIED;
792 ly_get_elt_property (SCM elt, SCM sym)
794 Score_element * sc = unsmob_element (elt);
798 return sc->get_elt_property (sym);
802 error ("Not a score element");
803 ly_display_scm (elt);
805 return SCM_UNSPECIFIED;
810 Score_element::discretionary_processing()
817 spanner_get_bound (SCM slur, SCM dir)
819 return dynamic_cast<Spanner*> (unsmob_element (slur))->get_bound (to_dir (dir))->self_scm ();
824 static SCM interfaces_sym;
829 interfaces_sym = scm_permanent_object (ly_symbol2scm ("interfaces"));
831 scm_make_gsubr ("ly-get-elt-property", 2, 0, 0, (SCM(*)(...))ly_get_elt_property);
832 scm_make_gsubr ("ly-set-elt-property", 3, 0, 0, (SCM(*)(...))ly_set_elt_property);
833 scm_make_gsubr ("ly-get-spanner-bound", 2 , 0, 0, (SCM(*)(...)) spanner_get_bound);
837 Score_element::has_interface (SCM k)
839 if (mutable_property_alist_ == SCM_EOL)
842 SCM ifs = get_elt_property (interfaces_sym);
844 return scm_memq (k, ifs) != SCM_BOOL_F;
848 Score_element::set_interface (SCM k)
850 if (has_interface (k))
854 set_elt_property (interfaces_sym,
855 gh_cons (k, get_elt_property (interfaces_sym)));
860 ADD_SCM_INIT_FUNC(scoreelt, init_functions);