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
193 URG junkthis, caching is clumsy.
197 Score_element * urg = (Score_element*)this;
198 SCM sz = urg->remove_elt_property ("font-size");
199 int i = (gh_number_p (sz))
203 urg->lookup_l_ = (Lookup*)pscore_l_->paper_l_->lookup_l (i);
209 Score_element::add_processing()
211 assert (status_i_ >=0);
220 Score_element::calculate_dependencies (int final, int busy, SCM funcname)
222 assert (status_i_ >=0);
224 if (status_i_ >= final)
227 if (status_i_== busy)
229 programming_error ("Element is busy, come back later");
235 for (SCM d= get_elt_property ("dependencies"); gh_pair_p (d); d = gh_cdr (d))
237 unsmob_element (gh_car (d))
238 ->calculate_dependencies (final, busy, funcname);
242 String s = ly_symbol2string (funcname);
243 SCM proc = get_elt_property (s.ch_C());
244 if (gh_procedure_p (proc))
245 gh_call1 (proc, this->self_scm ());
252 Score_element::get_molecule () const
254 SCM proc = get_elt_property ("molecule-callback");
257 if (gh_procedure_p (proc))
258 mol = gh_apply (proc, gh_list (this->self_scm (), SCM_UNDEFINED));
261 SCM origin =get_elt_property ("origin");
262 if (!unsmob_input (origin))
263 origin =ly_symbol2scm ("no-origin");
268 mol = gh_cons (gh_list (origin, gh_car (mol), SCM_UNDEFINED), gh_cdr (mol));
272 return create_molecule (mol);
282 Score_element::do_break_processing()
288 Score_element::do_add_processing()
293 MAKE_SCHEME_CALLBACK(Score_element,brew_molecule)
299 Score_element::brew_molecule (SCM smob)
301 Score_element * sc = unsmob_element (smob);
302 SCM glyph = sc->get_elt_property ("glyph");
303 if (gh_string_p (glyph))
305 return sc->lookup_l ()->afm_find (String (ly_scm2string (glyph))).create_scheme ();
315 Score_element::line_l() const
321 Score_element::add_dependency (Score_element*e)
325 Pointer_group_interface gi (this, "dependencies");
329 programming_error ("Null dependency added");
336 Do break substitution in S, using CRITERION. Return new value.
337 CRITERION is either a SMOB pointer to the desired line, or a number
338 representing the break direction. Do not modify SRC.
341 Score_element::handle_broken_smobs (SCM src, SCM criterion)
344 Score_element *sc = unsmob_element (src);
347 if (gh_number_p (criterion))
349 Item * i = dynamic_cast<Item*> (sc);
350 Direction d = to_dir (criterion);
351 if (i && i->break_status_dir () != d)
353 Item *br = i->find_prebroken_piece (d);
354 return (br) ? br->self_scm () : SCM_UNDEFINED;
360 = dynamic_cast<Line_of_score*> (unsmob_element (criterion));
361 if (sc->line_l () != line)
363 sc = sc->find_broken_piece (line);
367 /* now: !sc || (sc && sc->line_l () == line) */
369 return SCM_UNDEFINED;
371 /* now: sc && sc->line_l () == line */
373 || (sc->common_refpoint (line, X_AXIS)
374 && sc->common_refpoint (line, Y_AXIS)))
376 return sc->self_scm ();
378 return SCM_UNDEFINED;
381 else if (gh_pair_p (src))
383 SCM oldcar =gh_car (src);
385 UGH! breaks on circular lists.
387 SCM newcar = handle_broken_smobs (oldcar, criterion);
388 SCM oldcdr = gh_cdr (src);
390 if (newcar == SCM_UNDEFINED
391 && (gh_pair_p (oldcdr) || oldcdr == SCM_EOL))
394 This is tail-recursion, ie.
396 return handle_broken_smobs (cdr, criterion);
398 We don't want to rely on the compiler to do this. Without
399 tail-recursion, this easily crashes with a stack overflow. */
404 SCM newcdr = handle_broken_smobs (oldcdr, criterion);
405 return gh_cons (newcar, newcdr);
414 Score_element::handle_broken_dependencies()
416 Spanner * s= dynamic_cast<Spanner*> (this);
417 if (original_l_ && s)
422 for (int i = 0; i< s->broken_into_l_arr_ .size (); i++)
424 Score_element * sc = s->broken_into_l_arr_[i];
425 Line_of_score * l = sc->line_l ();
426 sc->mutable_property_alist_ =
427 handle_broken_smobs (mutable_property_alist_,
428 l ? l->self_scm () : SCM_UNDEFINED);
433 Line_of_score *line = line_l();
435 if (line && common_refpoint (line, X_AXIS) && common_refpoint (line, Y_AXIS))
437 mutable_property_alist_
438 = handle_broken_smobs (mutable_property_alist_,
439 line ? line->self_scm () : SCM_UNDEFINED);
441 else if (dynamic_cast <Line_of_score*> (this))
443 mutable_property_alist_ = handle_broken_smobs (mutable_property_alist_,
449 This element is `invalid'; it has been removed from all
450 dependencies, so let's junk the element itself.
452 do not do this for Line_of_score, since that would remove
453 references to the originals of score-elts, which get then GC'd
461 Note that we still want references to this element to be
462 rearranged, and not silently thrown away, so we keep pointers
463 like {broken_into_{drul,array}, original}
466 Score_element::suicide ()
468 mutable_property_alist_ = SCM_EOL;
469 immutable_property_alist_ = SCM_EOL;
470 set_extent_callback (0, Y_AXIS);
471 set_extent_callback (0, X_AXIS);
473 for (int a= X_AXIS; a <= Y_AXIS; a++)
475 dim_cache_[a].off_callbacks_.clear ();
480 Score_element::handle_prebroken_dependencies()
485 Score_element::find_broken_piece (Line_of_score*) const
491 Score_element::translate_axis (Real y, Axis a)
493 if (isinf (y) || isnan (y))
494 programming_error (_(INFINITY_MSG));
497 dim_cache_[a].offset_ += y;
502 Score_element::relative_coordinate (Score_element const*refp, Axis a) const
508 We catch PARENT_L_ == nil case with this, but we crash if we did
509 not ask for the absolute coordinate (ie. REFP == nil.)
512 if (refp == dim_cache_[a].parent_l_)
513 return get_offset (a);
515 return get_offset (a) + dim_cache_[a].parent_l_->relative_coordinate (refp, a);
519 Score_element::get_offset (Axis a) const
521 Score_element *me = (Score_element*) this;
522 while (dim_cache_[a].off_callbacks_.size ())
524 Offset_callback c = dim_cache_[a].off_callbacks_[0];
525 me->dim_cache_[a].off_callbacks_.del (0);
526 Real r = (*c) (me,a );
527 if (isinf (r) || isnan (r))
529 programming_error (INFINITY_MSG);
532 me->dim_cache_[a].offset_ +=r;
534 return dim_cache_[a].offset_;
539 Score_element::point_dimension_callback (Score_element* , Axis)
541 return Interval (0,0);
545 Score_element::empty_b (Axis a)const
547 return !dim_cache_[a].extent_callback_l_;
551 Score_element::extent (Axis a) const
553 Dimension_cache * d = (Dimension_cache *)&dim_cache_[a];
554 if (!d->extent_callback_l_)
556 d->dim_.set_empty ();
558 else if (!d->valid_b_)
560 d->dim_= (*d->extent_callback_l_ ) ((Score_element*)this, a);
564 Interval ext = d->dim_;
569 SCM extra = get_elt_property (a == X_AXIS
576 Real s = paper_l ()->get_var ("staffspace");
577 if (gh_pair_p (extra))
579 ext[BIGGER] += s * gh_scm2double (gh_cdr (extra));
580 ext[SMALLER] += s * gh_scm2double (gh_car (extra));
583 extra = get_elt_property (a == X_AXIS
585 : "minimum-extent-Y");
586 if (gh_pair_p (extra))
588 ext.unite (Interval (s * gh_scm2double (gh_car (extra)),
589 s * gh_scm2double (gh_cdr (extra))));
597 Score_element::parent_l (Axis a) const
599 return dim_cache_[a].parent_l_;
603 Score_element::common_refpoint (Score_element const* s, Axis a) const
606 I don't like the quadratic aspect of this code, but I see no other
607 way. The largest chain of parents might be 10 high or so, so
608 it shouldn't be a real issue. */
609 for (Score_element const *c = this; c; c = c->dim_cache_[a].parent_l_)
610 for (Score_element const * d = s; d; d = d->dim_cache_[a].parent_l_)
612 return (Score_element*)d;
619 Score_element::common_refpoint (SCM elist, Axis a) const
621 Score_element * common = (Score_element*) this;
622 for (; gh_pair_p (elist); elist = gh_cdr (elist))
624 Score_element * s = unsmob_element (gh_car (elist));
626 common = common->common_refpoint (s, a);
633 Score_element::name () const
635 return classname (this);
639 Score_element::add_offset_callback (Offset_callback cb, Axis a)
641 dim_cache_[a].off_callbacks_.push (cb);
645 Score_element::has_extent_callback_b (Extent_callback cb, Axis a)const
647 return cb == dim_cache_[a].extent_callback_l_;
652 Score_element::has_extent_callback_b (Axis a) const
654 return dim_cache_[a].extent_callback_l_;
658 Score_element::has_offset_callback_b (Offset_callback cb, Axis a)const
660 for (int i= dim_cache_[a].off_callbacks_.size (); i--;)
662 if (dim_cache_[a].off_callbacks_[i] == cb)
669 Score_element::set_extent_callback (Dim_cache_callback dc, Axis a)
671 dim_cache_[a].extent_callback_l_ = dc ;
676 Score_element::set_parent (Score_element *g, Axis a)
678 dim_cache_[a].parent_l_ = g;
681 MAKE_SCHEME_CALLBACK(Score_element,fixup_refpoint);
683 Score_element::fixup_refpoint (SCM smob)
685 Score_element *me = unsmob_element (smob);
686 for (int a = X_AXIS; a < NO_AXES; a ++)
689 Score_element * parent = me->parent_l (ax);
694 if (parent->line_l () != me->line_l () && me->line_l ())
696 Score_element * newparent = parent->find_broken_piece (me->line_l ());
697 me->set_parent (newparent, ax);
700 if (Item * i = dynamic_cast<Item*> (me))
702 Item *parenti = dynamic_cast<Item*> (parent);
706 Direction my_dir = i->break_status_dir () ;
707 if (my_dir!= parenti->break_status_dir())
709 Item *newparent = parenti->find_prebroken_piece (my_dir);
710 me->set_parent (newparent, ax);
720 /****************************************************
722 ****************************************************/
725 IMPLEMENT_UNSMOB(Score_element, element);
726 IMPLEMENT_SMOBS(Score_element);
727 IMPLEMENT_DEFAULT_EQUAL_P(Score_element);
730 Score_element::mark_smob (SCM ses)
732 Score_element * s = (Score_element*) SCM_CELL_WORD_1(ses);
733 scm_gc_mark (s->immutable_property_alist_);
734 scm_gc_mark (s->mutable_property_alist_);
736 if (s->parent_l (Y_AXIS))
737 scm_gc_mark (s->parent_l (Y_AXIS)->self_scm ());
738 if (s->parent_l (X_AXIS))
739 scm_gc_mark (s->parent_l (X_AXIS)->self_scm ());
742 scm_gc_mark (s->original_l_->self_scm ());
743 return s->do_derived_mark ();
747 Score_element::print_smob (SCM s, SCM port, scm_print_state *)
749 Score_element *sc = (Score_element *) gh_cdr (s);
751 scm_puts ("#<Score_element ", port);
752 scm_puts ((char *)sc->name (), port);
755 don't try to print properties, that is too much hassle.
757 scm_puts (" >", port);
762 Score_element::do_derived_mark ()
769 ly_set_elt_property (SCM elt, SCM sym, SCM val)
771 Score_element * sc = unsmob_element (elt);
773 if (!gh_symbol_p (sym))
775 error ("Not a symbol");
776 ly_display_scm (sym);
777 return SCM_UNSPECIFIED;
782 sc->set_elt_property (sym, val);
786 error ("Not a score element");
787 ly_display_scm (elt);
790 return SCM_UNSPECIFIED;
795 ly_get_elt_property (SCM elt, SCM sym)
797 Score_element * sc = unsmob_element (elt);
801 return sc->get_elt_property (sym);
805 error ("Not a score element");
806 ly_display_scm (elt);
808 return SCM_UNSPECIFIED;
813 Score_element::discretionary_processing()
820 spanner_get_bound (SCM slur, SCM dir)
822 return dynamic_cast<Spanner*> (unsmob_element (slur))->get_bound (to_dir (dir))->self_scm ();
827 static SCM interfaces_sym;
832 interfaces_sym = scm_permanent_object (ly_symbol2scm ("interfaces"));
834 scm_make_gsubr ("ly-get-elt-property", 2, 0, 0, (SCM(*)(...))ly_get_elt_property);
835 scm_make_gsubr ("ly-set-elt-property", 3, 0, 0, (SCM(*)(...))ly_set_elt_property);
836 scm_make_gsubr ("ly-get-spanner-bound", 2 , 0, 0, (SCM(*)(...)) spanner_get_bound);
840 Score_element::has_interface (SCM k)
842 // if (mutable_property_alist_ == SCM_EOL)
845 SCM ifs = get_elt_property (interfaces_sym);
847 return scm_memq (k, ifs) != SCM_BOOL_F;
851 Score_element::set_interface (SCM k)
853 if (has_interface (k))
857 set_elt_property (interfaces_sym,
858 gh_cons (k, get_elt_property (interfaces_sym)));
863 ADD_SCM_INIT_FUNC(scoreelt, init_functions);