2 score-elem.cc -- implement Grob
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"
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
);
302 transparent retains dimensions of element.
304 if (m
&& to_boolean (get_grob_property ("transparent")))
305 mol
= Molecule (m
->extent_box (), SCM_EOL
).smobbed_copy ();
316 Grob::do_break_processing()
332 Grob::add_dependency (Grob
*e
)
336 Pointer_group_interface ::add_element (this, "dependencies",e
);
340 programming_error ("Null dependency added");
347 Do break substitution in S, using CRITERION. Return new value.
348 CRITERION is either a SMOB pointer to the desired line, or a number
349 representing the break direction. Do not modify SRC.
352 Grob::handle_broken_smobs (SCM src
, SCM criterion
)
355 Grob
*sc
= unsmob_grob (src
);
358 if (gh_number_p (criterion
))
360 Item
* i
= dynamic_cast<Item
*> (sc
);
361 Direction d
= to_dir (criterion
);
362 if (i
&& i
->break_status_dir () != d
)
364 Item
*br
= i
->find_prebroken_piece (d
);
365 return (br
) ? br
->self_scm () : SCM_UNDEFINED
;
371 = dynamic_cast<Line_of_score
*> (unsmob_grob (criterion
));
372 if (sc
->line_l () != line
)
374 sc
= sc
->find_broken_piece (line
);
378 /* now: !sc || (sc && sc->line_l () == line) */
380 return SCM_UNDEFINED
;
382 /* now: sc && sc->line_l () == line */
384 || (sc
->common_refpoint (line
, X_AXIS
)
385 && sc
->common_refpoint (line
, Y_AXIS
)))
387 return sc
->self_scm ();
389 return SCM_UNDEFINED
;
392 else if (gh_pair_p (src
))
394 SCM oldcar
=gh_car (src
);
396 UGH! breaks on circular lists.
398 SCM newcar
= handle_broken_smobs (oldcar
, criterion
);
399 SCM oldcdr
= gh_cdr (src
);
401 if (newcar
== SCM_UNDEFINED
402 && (gh_pair_p (oldcdr
) || oldcdr
== SCM_EOL
))
405 This is tail-recursion, ie.
407 return handle_broken_smobs (cdr, criterion);
409 We don't want to rely on the compiler to do this. Without
410 tail-recursion, this easily crashes with a stack overflow. */
415 SCM newcdr
= handle_broken_smobs (oldcdr
, criterion
);
416 return gh_cons (newcar
, newcdr
);
425 Grob::handle_broken_dependencies()
427 Spanner
* s
= dynamic_cast<Spanner
*> (this);
428 if (original_l_
&& s
)
433 for (int i
= 0; i
< s
->broken_into_l_arr_
.size (); i
++)
435 Grob
* sc
= s
->broken_into_l_arr_
[i
];
436 Line_of_score
* l
= sc
->line_l ();
437 sc
->mutable_property_alist_
=
438 handle_broken_smobs (mutable_property_alist_
,
439 l
? l
->self_scm () : SCM_UNDEFINED
);
444 Line_of_score
*line
= line_l();
446 if (line
&& common_refpoint (line
, X_AXIS
) && common_refpoint (line
, Y_AXIS
))
448 mutable_property_alist_
449 = handle_broken_smobs (mutable_property_alist_
,
450 line
? line
->self_scm () : SCM_UNDEFINED
);
452 else if (dynamic_cast <Line_of_score
*> (this))
454 mutable_property_alist_
= handle_broken_smobs (mutable_property_alist_
,
460 This element is `invalid'; it has been removed from all
461 dependencies, so let's junk the element itself.
463 do not do this for Line_of_score, since that would remove
464 references to the originals of score-elts, which get then GC'd
472 Note that we still want references to this element to be
473 rearranged, and not silently thrown away, so we keep pointers
474 like {broken_into_{drul,array}, original}
479 mutable_property_alist_
= SCM_EOL
;
480 immutable_property_alist_
= SCM_EOL
;
482 set_extent_callback (SCM_EOL
, Y_AXIS
);
483 set_extent_callback (SCM_EOL
, X_AXIS
);
485 for (int a
= X_AXIS
; a
<= Y_AXIS
; a
++)
487 dim_cache_
[a
].offset_callbacks_
= SCM_EOL
;
488 dim_cache_
[a
].offsets_left_
= 0;
493 Grob::handle_prebroken_dependencies()
498 Grob::find_broken_piece (Line_of_score
*) const
504 Grob::translate_axis (Real y
, Axis a
)
506 if (isinf (y
) || isnan (y
))
507 programming_error (_(INFINITY_MSG
));
510 dim_cache_
[a
].offset_
+= y
;
515 Grob::relative_coordinate (Grob
const*refp
, Axis a
) const
521 We catch PARENT_L_ == nil case with this, but we crash if we did
522 not ask for the absolute coordinate (ie. REFP == nil.)
525 if (refp
== dim_cache_
[a
].parent_l_
)
526 return get_offset (a
);
528 return get_offset (a
) + dim_cache_
[a
].parent_l_
->relative_coordinate (refp
, a
);
532 Grob::get_offset (Axis a
) const
534 Grob
*me
= (Grob
*) this;
535 while (dim_cache_
[a
].offsets_left_
)
537 int l
= --me
->dim_cache_
[a
].offsets_left_
;
538 SCM cb
= scm_list_ref (dim_cache_
[a
].offset_callbacks_
, gh_int2scm (l
));
539 SCM retval
= gh_call2 (cb
, self_scm (), gh_int2scm (a
));
541 Real r
= gh_scm2double (retval
);
542 if (isinf (r
) || isnan (r
))
544 programming_error (INFINITY_MSG
);
547 me
->dim_cache_
[a
].offset_
+=r
;
549 return dim_cache_
[a
].offset_
;
553 MAKE_SCHEME_CALLBACK(Grob
,point_dimension_callback
,2);
555 Grob::point_dimension_callback (SCM
, SCM
)
557 return ly_interval2scm ( Interval (0,0));
561 Grob::empty_b (Axis a
)const
563 return ! (gh_pair_p (dim_cache_
[a
].dimension_
) ||
564 gh_procedure_p (dim_cache_
[a
].dimension_
));
575 Grob::extent (Grob
* refp
, Axis a
) const
577 Real x
= relative_coordinate (refp
, a
);
580 Dimension_cache
* d
= (Dimension_cache
*)&dim_cache_
[a
];
582 if (gh_pair_p (d
->dimension_
))
584 else if (gh_procedure_p (d
->dimension_
))
587 FIXME: add doco on types, and should typecheck maybe?
589 d
->dimension_
= gh_call2 (d
->dimension_
, self_scm(), gh_int2scm (a
));
594 if (!gh_pair_p (d
->dimension_
))
597 ext
= ly_scm2interval (d
->dimension_
);
599 SCM extra
= get_grob_property (a
== X_AXIS
606 if (gh_pair_p (extra
))
608 ext
[BIGGER
] += gh_scm2double (gh_cdr (extra
));
609 ext
[SMALLER
] += gh_scm2double (gh_car (extra
));
612 extra
= get_grob_property (a
== X_AXIS
614 : "minimum-extent-Y");
615 if (gh_pair_p (extra
))
617 ext
.unite (Interval (gh_scm2double (gh_car (extra
)),
618 gh_scm2double (gh_cdr (extra
))));
628 Grob::parent_l (Axis a
) const
630 return dim_cache_
[a
].parent_l_
;
634 Grob::common_refpoint (Grob
const* s
, Axis a
) const
637 I don't like the quadratic aspect of this code, but I see no other
638 way. The largest chain of parents might be 10 high or so, so
639 it shouldn't be a real issue. */
640 for (Grob
const *c
= this; c
; c
= c
->dim_cache_
[a
].parent_l_
)
641 for (Grob
const * d
= s
; d
; d
= d
->dim_cache_
[a
].parent_l_
)
650 Grob::common_refpoint (SCM elist
, Axis a
) const
652 Grob
* common
= (Grob
*) this;
653 for (; gh_pair_p (elist
); elist
= gh_cdr (elist
))
655 Grob
* s
= unsmob_grob (gh_car (elist
));
657 common
= common
->common_refpoint (s
, a
);
666 SCM meta
= get_grob_property ("meta");
667 SCM nm
= scm_assoc (ly_symbol2scm ("name"), meta
);
668 nm
= (gh_pair_p (nm
)) ? gh_cdr (nm
) : SCM_EOL
;
669 return gh_string_p (nm
) ?ly_scm2string (nm
) : classname (this);
673 Grob::add_offset_callback (SCM cb
, Axis a
)
675 if (!has_offset_callback_b (cb
, a
))
677 dim_cache_
[a
].offset_callbacks_
= gh_cons (cb
, dim_cache_
[a
].offset_callbacks_
);
678 dim_cache_
[a
].offsets_left_
++;
683 Grob::has_extent_callback_b (SCM cb
, Axis a
)const
685 return scm_equal_p (cb
, dim_cache_
[a
].dimension_
) == SCM_BOOL_T
;
690 Grob::has_extent_callback_b (Axis a
) const
692 return gh_procedure_p (dim_cache_
[a
].dimension_
);
696 Grob::has_offset_callback_b (SCM cb
, Axis a
)const
698 return scm_memq (cb
, dim_cache_
[a
].offset_callbacks_
) != SCM_BOOL_F
;
702 Grob::set_extent_callback (SCM dc
, Axis a
)
704 dim_cache_
[a
].dimension_
=dc
;
708 Grob::set_parent (Grob
*g
, Axis a
)
710 dim_cache_
[a
].parent_l_
= g
;
713 MAKE_SCHEME_CALLBACK(Grob
,fixup_refpoint
,1);
715 Grob::fixup_refpoint (SCM smob
)
717 Grob
*me
= unsmob_grob (smob
);
718 for (int a
= X_AXIS
; a
< NO_AXES
; a
++)
721 Grob
* parent
= me
->parent_l (ax
);
726 if (parent
->line_l () != me
->line_l () && me
->line_l ())
728 Grob
* newparent
= parent
->find_broken_piece (me
->line_l ());
729 me
->set_parent (newparent
, ax
);
732 if (Item
* i
= dynamic_cast<Item
*> (me
))
734 Item
*parenti
= dynamic_cast<Item
*> (parent
);
738 Direction my_dir
= i
->break_status_dir () ;
739 if (my_dir
!= parenti
->break_status_dir())
741 Item
*newparent
= parenti
->find_prebroken_piece (my_dir
);
742 me
->set_parent (newparent
, ax
);
752 /****************************************************
754 ****************************************************/
757 IMPLEMENT_UNSMOB(Grob
, grob
);
758 IMPLEMENT_SMOBS(Grob
);
759 IMPLEMENT_DEFAULT_EQUAL_P(Grob
);
762 Grob::mark_smob (SCM ses
)
764 Grob
* s
= (Grob
*) SCM_CELL_WORD_1(ses
);
765 scm_gc_mark (s
->immutable_property_alist_
);
766 scm_gc_mark (s
->mutable_property_alist_
);
768 for (int a
=0 ; a
< 2; a
++)
770 scm_gc_mark (s
->dim_cache_
[a
].offset_callbacks_
);
771 scm_gc_mark (s
->dim_cache_
[a
].dimension_
);
774 if (s
->parent_l (Y_AXIS
))
775 scm_gc_mark (s
->parent_l (Y_AXIS
)->self_scm ());
776 if (s
->parent_l (X_AXIS
))
777 scm_gc_mark (s
->parent_l (X_AXIS
)->self_scm ());
780 scm_gc_mark (s
->original_l_
->self_scm ());
781 return s
->do_derived_mark ();
785 Grob::print_smob (SCM s
, SCM port
, scm_print_state
*)
787 Grob
*sc
= (Grob
*) gh_cdr (s
);
789 scm_puts ("#<Grob ", port
);
790 scm_puts ((char *)sc
->name ().ch_C(), port
);
793 don't try to print properties, that is too much hassle.
795 scm_puts (" >", port
);
800 Grob::do_derived_mark ()
807 ly_set_grob_property (SCM elt
, SCM sym
, SCM val
)
809 Grob
* sc
= unsmob_grob (elt
);
811 if (!gh_symbol_p (sym
))
813 error ("Not a symbol");
814 ly_display_scm (sym
);
815 return SCM_UNSPECIFIED
;
820 sc
->set_grob_property (sym
, val
);
824 error ("Not a score element");
825 ly_display_scm (elt
);
828 return SCM_UNSPECIFIED
;
833 ly_get_grob_property (SCM elt
, SCM sym
)
835 Grob
* sc
= unsmob_grob (elt
);
839 return sc
->get_grob_property (sym
);
843 error ("Not a score element");
844 ly_display_scm (elt
);
846 return SCM_UNSPECIFIED
;
851 Grob::discretionary_processing()
858 spanner_get_bound (SCM slur
, SCM dir
)
860 return dynamic_cast<Spanner
*> (unsmob_grob (slur
))->get_bound (to_dir (dir
))->self_scm ();
865 static SCM interfaces_sym
;
869 interfaces_sym
= scm_permanent_object (ly_symbol2scm ("interfaces"));
871 scm_make_gsubr ("ly-get-elt-property", 2, 0, 0, (Scheme_function_unknown
)ly_get_grob_property
);
872 scm_make_gsubr ("ly-set-elt-property", 3, 0, 0, (Scheme_function_unknown
)ly_set_grob_property
);
873 scm_make_gsubr ("ly-get-spanner-bound", 2 , 0, 0, (Scheme_function_unknown
) spanner_get_bound
);
877 Grob::has_interface (SCM k
)
879 SCM ifs
= get_grob_property (interfaces_sym
);
881 return scm_memq (k
, ifs
) != SCM_BOOL_F
;
885 Grob::set_interface (SCM k
)
887 if (has_interface (k
))
891 set_grob_property (interfaces_sym
,
892 gh_cons (k
, get_grob_property (interfaces_sym
)));
897 ADD_SCM_INIT_FUNC(scoreelt
, init_functions
);
898 IMPLEMENT_TYPE_P(Grob
, "ly-grob?");