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>
12 #include "group-interface.hh"
14 #include "paper-score.hh"
15 #include "paper-def.hh"
17 #include "molecule.hh"
18 #include "score-element.hh"
21 #include "line-of-score.hh"
23 #include "paper-column.hh"
24 #include "molecule.hh"
26 #include "paper-outputter.hh"
27 #include "dimension-cache.hh"
28 #include "side-position-interface.hh"
34 remove dynamic_cast<Spanner,Item> and put this code into respective
38 Score_element::Score_element()
40 dim_cache_[X_AXIS] = new Dimension_cache;
41 dim_cache_[Y_AXIS] = new Dimension_cache;
42 dim_cache_[X_AXIS]->elt_l_ = dim_cache_[Y_AXIS]->elt_l_ = this;
47 dim_cache_[X_AXIS]->set_callback (molecule_extent);
48 dim_cache_[Y_AXIS]->set_callback (molecule_extent);
55 element_property_alist_ = SCM_EOL;
60 set_elt_property ("dependencies", SCM_EOL);
61 set_elt_property ("interfaces", SCM_EOL);
65 Score_element::Score_element (Score_element const&s)
67 dim_cache_[X_AXIS] = new Dimension_cache (*s.dim_cache_[X_AXIS]);
68 dim_cache_[Y_AXIS] = new Dimension_cache (*s.dim_cache_[Y_AXIS]);
69 dim_cache_[X_AXIS]->elt_l_ = dim_cache_[Y_AXIS]->elt_l_ = this;
73 original_l_ =(Score_element*) &s;
74 element_property_alist_ = SCM_EOL; // onstack;
76 status_i_ = s.status_i_;
77 lookup_l_ = s.lookup_l_;
78 pscore_l_ = s.pscore_l_;
83 Score_element::~Score_element()
85 assert (status_i_ >=0);
88 delete dim_cache_[X_AXIS];
89 delete dim_cache_[Y_AXIS];
92 // should also have one that takes SCM arg.
94 Score_element::get_elt_property (String nm) const
96 SCM sym = ly_symbol2scm (nm.ch_C());
97 SCM s = scm_assq(sym, element_property_alist_);
104 SCM sym2 = ly_symbol2scm ((name () + ("::" + nm)).ch_C());
107 // should probably check for Type::sym as well.
108 Paper_def * p= pscore_l_->paper_l_;
109 if (p->default_properties_.try_retrieve (sym2, &val))
111 else if (p->default_properties_.try_retrieve (sym, &val))
115 return SCM_UNDEFINED;
119 Score_element::remove_elt_property (String key)
121 SCM s = get_elt_property (key);
122 SCM sym = ly_symbol2scm (key.ch_C());
123 element_property_alist_ = scm_assq_remove_x (element_property_alist_, sym);
131 Score_element::set_elt_property (String k, SCM v)
133 SCM s = ly_symbol2scm (k.ch_C( ));
134 element_property_alist_ = scm_assoc_set_x (element_property_alist_, s, v);
138 Score_element::molecule_extent(Dimension_cache const *c)
140 Score_element *s = dynamic_cast<Score_element*>(c->element_l());
141 Molecule m = s->do_brew_molecule();
142 return m.extent()[c->axis ()];
147 Score_element::print() const
150 DEBUG_OUT << classname(this) << "{\n";
152 if (flower_dstream && !flower_dstream->silent_b ("Score_element"))
153 ly_display_scm (element_property_alist_);
156 DEBUG_OUT << "Copy ";
164 Score_element::paper_l () const
166 return pscore_l_ ? pscore_l_->paper_l_ : 0;
170 Score_element::lookup_l () const
174 Score_element * urg = (Score_element*)this;
175 SCM sz = urg->remove_elt_property ("fontsize");
176 int i = (gh_number_p (sz))
180 urg->lookup_l_ = (Lookup*)pscore_l_->paper_l_->lookup_l (i);
186 Score_element::add_processing()
188 assert (status_i_ >=0);
197 if (get_elt_property ("self-alignment-X") != SCM_UNDEFINED
198 && !dim_cache_[X_AXIS]->off_callback_l_)
200 add_offset_callback (Side_position_interface::aligned_on_self,X_AXIS);
203 if (get_elt_property ("self-alignment-Y") != SCM_UNDEFINED
204 && !dim_cache_[X_AXIS]->off_callback_l_)
207 add_offset_callback (Side_position_interface::aligned_on_self, Y_AXIS);
215 Score_element::calculate_dependencies (int final, int busy,
216 Score_element_method_pointer funcptr)
218 assert (status_i_ >=0);
220 if (status_i_ >= final)
223 assert (status_i_!= busy);
226 for (SCM d= get_elt_property ("dependencies"); d != SCM_EOL; d = gh_cdr (d))
228 unsmob_element (gh_car (d))
229 ->calculate_dependencies (final, busy, funcptr);
237 Score_element::output_processing ()
239 if (to_boolean (get_elt_property ("transparent")))
243 Molecule m (do_brew_molecule ());
244 Offset o (relative_coordinate (0, X_AXIS), relative_coordinate (0, Y_AXIS));
246 SCM s = get_elt_property ("extra-offset");
249 Real il = paper_l ()->get_var ("interline");
250 o[X_AXIS] += il * gh_scm2double (gh_car (s));
251 o[Y_AXIS] += il * gh_scm2double (gh_cdr (s));
254 pscore_l_->outputter_l_->output_molecule (m.expr_, o, classname(this));
263 Score_element::do_break_processing()
268 Score_element::after_line_breaking ()
274 Score_element::before_line_breaking ()
279 Score_element::do_space_processing ()
284 Score_element::do_add_processing()
291 Score_element::do_brew_molecule() const
293 SCM glyph = get_elt_property ("glyph");
294 if (gh_string_p (glyph))
296 return lookup_l ()->afm_find (String (ly_scm2string (glyph)));
309 Score_element::line_l() const
315 Score_element::add_dependency (Score_element*e)
319 Group_interface gi (this, "dependencies");
323 programming_error ("Null dependency added");
330 Do break substitution in S, using CRITERION. Return new value.
331 CRITERION is either a SMOB pointer to the desired line, or a number
332 representing the break direction. Do not modify SRC.
335 Score_element::handle_broken_smobs (SCM src, SCM criterion)
340 Score_element *sc = unsmob_element (src);
343 if (criterion == SCM_UNDEFINED)
344 return SCM_UNDEFINED;
345 else if (gh_number_p (criterion))
347 Item * i = dynamic_cast<Item*> (sc);
348 Direction d = to_dir (criterion);
349 if (i && i->break_status_dir () != d)
351 Item *br = i->find_broken_piece (d);
352 return (br) ? br->self_scm_ : SCM_UNDEFINED;
357 Score_element * ln = unsmob_element ( criterion);
358 Line_of_score * line = dynamic_cast<Line_of_score*> (ln);
359 Score_element * br =0;
360 Line_of_score * dep_line = sc->line_l ();
361 if (dep_line != line)
363 br = sc->find_broken_piece (line);
364 return (br) ? br->self_scm_ : SCM_UNDEFINED;
367 return SCM_UNDEFINED;
370 else if (gh_pair_p (src))
373 UGH! breaks on circular lists.
375 SCM car = handle_broken_smobs (gh_car (src), criterion);
376 SCM cdr = gh_cdr (src);
378 if (car == SCM_UNDEFINED
379 && (gh_pair_p (cdr) || cdr == SCM_EOL))
382 This is tail-recursion, ie.
384 return handle_broken_smobs (cdr, criterion);
386 We don't want to rely on the compiler to do this. */
391 return gh_cons (car, handle_broken_smobs (cdr, criterion));
400 Score_element::handle_broken_dependencies()
402 Spanner * s= dynamic_cast<Spanner*> (this);
403 if (original_l_ && s)
408 for (int i = 0; i< s->broken_into_l_arr_ .size (); i++)
410 Score_element * sc = s->broken_into_l_arr_[i];
411 Line_of_score * l = sc->line_l ();
412 s->broken_into_l_arr_[i]->element_property_alist_ =
413 handle_broken_smobs (element_property_alist_,
414 l ? l->self_scm_ : SCM_UNDEFINED);
418 Line_of_score *line = line_l();
419 element_property_alist_
420 = handle_broken_smobs (element_property_alist_,
421 line ? line->self_scm_ : SCM_UNDEFINED);
429 Score_element::handle_prebroken_dependencies()
431 if (Item*i =dynamic_cast<Item*> (this))
435 element_property_alist_
436 = handle_broken_smobs (original_l_->element_property_alist_,
437 gh_int2scm (i->break_status_dir ()));
443 Score_element::linked_b() const
449 Score_element::do_print () const
454 Score_element::find_broken_piece (Line_of_score*) const
460 Score_element::translate_axis (Real y, Axis a)
462 dim_cache_[a]->translate (y);
466 Score_element::relative_coordinate (Score_element const*e, Axis a) const
468 return dim_cache_[a]->relative_coordinate (e ? e->dim_cache_[a] : 0);
472 Score_element::common_refpoint (Score_element const* s, Axis a) const
474 Dimension_cache *dim = dim_cache_[a]->common_refpoint (s->dim_cache_[a]);
475 return dim ? dim->element_l () : 0;
479 Score_element::set_empty (Axis a)
481 dim_cache_[a]->extent_callback_l_ =0;
485 Score_element::empty_b (Axis a)const
487 return !dim_cache_[a]->extent_callback_l_;
491 Score_element::extent (Axis a) const
493 Dimension_cache const * d = dim_cache_[a];
495 return d->get_dim ();
500 Score_element::parent_l (Axis a) const
502 Dimension_cache*d= dim_cache_[a]->parent_l_;
503 return d ? d->elt_l_ : 0;
507 Score_element::common_refpoint (Link_array<Score_element> gs, Axis a) const
509 Dimension_cache * common = dim_cache_[a];
510 for (int i=0; i < gs.size (); i++)
512 common = common->common_refpoint (gs[i]->dim_cache_[a]);
515 return common->element_l ();
519 Score_element::name () const
521 return classname (this);
525 Score_element::add_offset_callback (Offset_cache_callback cb, Axis a)
527 dim_cache_[a]->off_callbacks_.push (cb);
531 Score_element::has_offset_callback_b (Offset_cache_callback cb, Axis a)const
533 for (int i= dim_cache_[a]->off_callbacks_.size (); i--;)
535 if (dim_cache_[a]->off_callbacks_[i] == cb)
542 Score_element::set_parent (Score_element *g, Axis a)
544 dim_cache_[a]->parent_l_ = g ? g->dim_cache_[a]: 0;
548 Score_element::fixup_refpoint ()
550 for (int a = X_AXIS; a < NO_AXES; a ++)
553 Score_element * parent = parent_l (ax);
558 if (parent->line_l () != line_l ())
560 Score_element * newparent = parent->find_broken_piece (line_l ());
561 set_parent (newparent, ax);
564 programming_error ("Orphaned score-element.");
568 if (Item * i = dynamic_cast<Item*> (this))
570 Item *parenti = dynamic_cast<Item*> (parent);
574 Direction my_dir = i->break_status_dir () ;
575 if (my_dir!= parenti->break_status_dir())
577 Item *newparent = parenti->find_broken_piece (my_dir);
578 set_parent (newparent, ax);
587 /****************************************************
589 ****************************************************/
592 #include "ly-smobs.icc"
594 IMPLEMENT_UNSMOB(Score_element, element);
595 IMPLEMENT_SMOBS(Score_element);
597 Score_element::mark_smob (SCM ses)
599 Score_element * s = SMOB_TO_TYPE (Score_element, ses);
600 if (s->self_scm_ != ses)
602 programming_error ("SMOB marking gone awry");
605 return s->element_property_alist_;
609 Score_element::print_smob (SCM s, SCM port, scm_print_state *)
611 Score_element *sc = (Score_element *) gh_cdr (s);
613 scm_puts ("#<Score_element ", port);
614 scm_puts ((char *)sc->name (), port);
617 don't try to print properties, that is too much hassle.
619 scm_puts (" >", port);
624 Score_element::do_smobify_self ()
629 Score_element::equal_p (SCM a, SCM b)
631 return gh_cdr(a) == gh_cdr(b) ? SCM_BOOL_T : SCM_BOOL_F;
636 Score_element::ly_set_elt_property (SCM elt, SCM sym, SCM val)
638 Score_element * sc = unsmob_element (elt);
640 if (!gh_symbol_p (sym))
642 error ("Not a symbol");
643 ly_display_scm (sym);
644 return SCM_UNDEFINED;
649 sc->element_property_alist_ = scm_assoc_set_x (sc->element_property_alist_, sym, val);
653 error ("Not a score element");
654 ly_display_scm (elt);
657 return SCM_UNDEFINED;
662 Score_element::ly_get_elt_property (SCM elt, SCM sym)
664 Score_element * sc = unsmob_element (elt);
668 SCM s = scm_assq(sym, sc->element_property_alist_);
673 return SCM_UNDEFINED;
677 error ("Not a score element");
678 ly_display_scm (elt);
680 return SCM_UNDEFINED;
687 scm_make_gsubr ("ly-get-elt-property", 2, 0, 0, (SCM(*)(...))Score_element::ly_get_elt_property);
688 scm_make_gsubr ("ly-set-elt-property", 3, 0, 0, (SCM(*)(...))Score_element::ly_set_elt_property);
691 ADD_SCM_INIT_FUNC(scoreelt, init_functions);
694 Score_element::do_breakable_col_processing ()