2 score-elem.cc -- implement Score_element
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--1999 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"
31 Score_element::Score_element()
34 dim_cache_[X_AXIS] = new Dimension_cache;
35 dim_cache_[Y_AXIS] = new Dimension_cache;
36 dim_cache_[X_AXIS]->elt_l_ = dim_cache_[Y_AXIS]->elt_l_ = this;
40 dim_cache_[X_AXIS]->set_callback (molecule_extent);
41 dim_cache_[Y_AXIS]->set_callback (molecule_extent);
48 element_property_alist_ = SCM_EOL;
53 set_elt_property ("dependencies", SCM_EOL);
56 SCM ly_deep_copy (SCM);
63 return gh_cons (ly_deep_copy (gh_car (l)), ly_deep_copy (gh_cdr (l)));
70 Score_element::Score_element (Score_element const&s)
72 dim_cache_[X_AXIS] = new Dimension_cache (*s.dim_cache_[X_AXIS]);
73 dim_cache_[Y_AXIS] = new Dimension_cache (*s.dim_cache_[Y_AXIS]);
74 dim_cache_[X_AXIS]->elt_l_ = dim_cache_[Y_AXIS]->elt_l_ = this;
78 original_l_ =(Score_element*) &s;
81 should protect because smobify_self () might trigger GC.
83 element_property_alist_ = scm_protect_object (ly_deep_copy (s.element_property_alist_));
86 status_i_ = s.status_i_;
87 lookup_l_ = s.lookup_l_;
88 pscore_l_ = s.pscore_l_;
93 Score_element::~Score_element()
96 assert (status_i_ >=0);
99 delete dim_cache_[X_AXIS];
100 delete dim_cache_[Y_AXIS];
105 Score_element::get_real (String s) const
107 return gh_scm2double (get_elt_property (s));
111 Score_element::set_real (String s, Real r)
113 set_elt_property (s, gh_double2scm (r));
116 // should also have one that takes SCM arg.
118 Score_element::get_elt_property (String nm) const
120 SCM sym = ly_symbol2scm (nm.ch_C());
121 SCM s = scm_assq(sym, element_property_alist_);
128 SCM sym2 = ly_symbol2scm ((name () + ("::" + nm)).ch_C());
131 // should probably check for Type::sym as well.
132 Paper_def * p= pscore_l_->paper_l_;
133 if (p->default_properties_.try_retrieve (sym2, &val))
135 else if (p->default_properties_.try_retrieve (sym, &val))
139 return SCM_UNDEFINED;
143 Score_element::remove_elt_property (String key)
145 SCM s = get_elt_property (key);
146 SCM sym = ly_symbol2scm (key.ch_C());
147 element_property_alist_ = scm_assq_remove_x (element_property_alist_, sym);
155 Score_element::set_elt_property (String k, SCM v)
157 SCM s = ly_symbol2scm (k.ch_C( ));
158 element_property_alist_ = scm_assoc_set_x (element_property_alist_, s, v);
162 Score_element::molecule_extent(Dimension_cache const *c)
164 Score_element *s = dynamic_cast<Score_element*>(c->element_l());
165 Molecule*m = s->do_brew_molecule_p();
166 return m->extent()[c->axis ()];
171 Score_element::print() const
174 DEBUG_OUT << classname(this) << "{\n";
176 if (flower_dstream && !flower_dstream->silent_b ("Score_element"))
177 ly_display_scm (element_property_alist_);
180 DEBUG_OUT << "Copy ";
188 Score_element::paper_l () const
190 return pscore_l_ ? pscore_l_->paper_l_ : 0;
194 Score_element::lookup_l () const
198 Score_element * urg = (Score_element*)this;
199 SCM sz = urg->remove_elt_property ("fontsize");
200 int i = (gh_number_p (sz))
204 urg->lookup_l_ = (Lookup*)pscore_l_->paper_l_->lookup_l (i);
210 Score_element::add_processing()
212 assert (status_i_ >=0);
221 if (get_elt_property ("self-alignment-X") != SCM_UNDEFINED
222 && !dim_cache_[X_AXIS]->off_callback_l_)
224 dim_cache_[X_AXIS]->off_callbacks_.push (Side_position_interface::self_alignment);
227 if (get_elt_property ("self-alignment-Y") != SCM_UNDEFINED
228 && !dim_cache_[X_AXIS]->off_callback_l_)
231 dim_cache_[Y_AXIS]->set_offset_callback (Side_position_interface::self_alignment);
239 Score_element::calculate_dependencies (int final, int busy,
240 Score_element_method_pointer funcptr)
242 assert (status_i_ >=0);
244 if (status_i_ >= final)
247 assert (status_i_!= busy);
250 Link_array<Score_element> dependency_arr =
251 Group_interface__extract_elements (this, (Score_element*)0, "dependencies");
253 for (int i=0; i < dependency_arr.size(); i++)
254 dependency_arr[i]->calculate_dependencies (final, busy, funcptr);
256 Link_array<Score_element> extra (get_extra_dependencies());
257 for (int i=0; i < extra.size(); i++)
258 extra[i]->calculate_dependencies (final, busy, funcptr);
265 Score_element::output_processing ()
267 if (to_boolean (get_elt_property ("transparent")))
270 // we're being silly here.
274 output_p_ = do_brew_molecule_p ();
275 Offset o (relative_coordinate (0, X_AXIS), relative_coordinate (0, Y_AXIS));
277 SCM s = get_elt_property ("extra-offset");
280 Real il = paper_l ()->get_var ("interline");
281 o[X_AXIS] += il * gh_scm2double (gh_car (s));
282 o[Y_AXIS] += il * gh_scm2double (gh_cdr (s));
285 pscore_l_->outputter_l_->output_molecule (output_p_,
299 Score_element::do_break_processing()
304 Score_element::do_post_processing()
309 Score_element::do_breakable_col_processing()
311 handle_prebroken_dependencies();
315 Score_element::do_pre_processing()
320 Score_element::do_space_processing ()
325 Score_element::do_add_processing()
332 Score_element::do_brew_molecule_p() const
336 Molecule a (lookup_l ()->fill (Box (emp,emp)));
337 return new Molecule (a);
342 Score_element::line_l() const
348 Score_element::add_dependency (Score_element*e)
352 Group_interface gi (this, "dependencies");
356 programming_error ("Null dependency added");
363 Do break substitution in S, using CRITERION. Return new value.
364 CRITERION is either a SMOB pointer to the desired line, or a number
365 representing the break direction. */
367 Score_element::handle_broken_smobs (SCM s, SCM criterion)
372 Score_element *sc = unsmob_element ( s);
375 if (criterion == SCM_UNDEFINED)
376 return SCM_UNDEFINED;
377 else if (gh_number_p (criterion))
379 Item * i = dynamic_cast<Item*> (sc);
380 Direction d = to_dir (criterion);
381 if (i && i->break_status_dir () != d)
383 Item *br = i->find_broken_piece (d);
384 return (br) ? br->self_scm_ : SCM_UNDEFINED;
389 Score_element * ln = unsmob_element ( criterion);
390 Line_of_score * line = dynamic_cast<Line_of_score*> (ln);
391 Score_element * br =0;
392 Line_of_score * dep_line = sc->line_l ();
393 if (dep_line != line)
395 br = sc->find_broken_piece (line);
396 return (br) ? br->self_scm_ : SCM_UNDEFINED;
399 return SCM_UNDEFINED;
402 else if (gh_pair_p (s))
405 UGH! breaks on circular lists.
407 SCM car = handle_broken_smobs (gh_car (s), criterion);
408 SCM cdr = gh_cdr (s);
410 if (car == SCM_UNDEFINED
411 && (gh_pair_p (cdr) || cdr == SCM_EOL))
414 This is tail-recursion, ie.
416 return handle_broken_smobs (cdr, criterion);
418 We don't want to rely on the compiler to do this. */
423 gh_set_car_x (s, car);
424 gh_set_cdr_x (s, handle_broken_smobs (cdr, criterion));
431 Score_element::handle_broken_dependencies()
433 Line_of_score *line = line_l();
434 element_property_alist_ = handle_broken_smobs (element_property_alist_,
435 line ? line->self_scm_ : SCM_UNDEFINED);
446 Score_element::handle_prebroken_dependencies()
448 if (Item*i =dynamic_cast<Item*> (this))
450 element_property_alist_
451 = handle_broken_smobs (element_property_alist_,
452 gh_int2scm (i->break_status_dir ()));
460 Link_array<Score_element>
461 Score_element::get_extra_dependencies() const
463 Link_array<Score_element> empty;
468 Score_element::linked_b() const
474 Score_element::do_print () const
479 Score_element::find_broken_piece (Line_of_score*) const
485 Score_element::mark_smob (SCM ses)
487 void * mp = (void*) gh_cdr(ses);
488 Score_element * s = (Score_element*) mp;
490 if (s->self_scm_ != ses)
492 programming_error ("SMOB marking gone awry");
495 return s->element_property_alist_;
500 Score_element::print_smob (SCM s, SCM port, scm_print_state *)
502 Score_element *sc = (Score_element *) gh_cdr (s);
504 scm_puts ("#<Score_element ", port);
505 scm_puts ((char *)sc->name (), port);
507 // scm_puts (" properties = ", port);
508 // scm_display (sc->element_property_alist_, port);
509 scm_puts (" >", port);
514 Score_element::do_smobify_self ()
516 scm_unprotect_object (element_property_alist_); // ugh
518 #include "ly-smobs.icc"
519 IMPLEMENT_SMOBS(Score_element);
522 Score_element::equal_p (SCM a, SCM b)
524 return gh_cdr(a) == gh_cdr(b) ? SCM_BOOL_T : SCM_BOOL_F;
528 Score_element::translate_axis (Real y, Axis a)
530 dim_cache_[a]->translate (y);
534 Score_element::relative_coordinate (Score_element const*e, Axis a) const
536 return dim_cache_[a]->relative_coordinate (e ? e->dim_cache_[a] : 0);
540 Score_element::common_refpoint (Score_element const* s, Axis a) const
542 Dimension_cache *dim = dim_cache_[a]->common_refpoint (s->dim_cache_[a]);
544 programming_error ("No common reference point");
545 return dim ? dim->element_l () : 0;
549 Score_element::set_empty (Axis a)
551 dim_cache_[a]->callback_l_ =0;
555 Score_element::empty_b (Axis a)const
557 return !dim_cache_[a]->callback_l_;
561 Score_element::extent (Axis a) const
563 Dimension_cache const * d = dim_cache_[a];
565 return d->get_dim ();
569 unsmob_element (SCM s)
571 if (SMOB_IS_TYPE_B (Score_element, s))
572 return SMOB_TO_TYPE(Score_element,s);
579 Score_element::parent_l (Axis a) const
581 Dimension_cache*d= dim_cache_[a]->parent_l_;
582 return d ? d->elt_l_ : 0;
586 Score_element::common_refpoint (Link_array<Score_element> gs, Axis a) const
588 Dimension_cache * common = dim_cache_[a];
589 for (int i=0; i < gs.size (); i++)
591 common = common->common_refpoint (gs[i]->dim_cache_[a]);
594 return common->element_l ();
598 Score_element::name () const
600 return classname (this);
605 Score_element::set_parent (Score_element *g, Axis a)
607 dim_cache_[a]->parent_l_ = g ? g->dim_cache_[a]: 0;
611 Score_element::fixup_refpoint ()
613 for (int a = X_AXIS; a < NO_AXES; a ++)
616 Score_element * par = parent_l (ax);
621 if (par->line_l () != line_l ())
623 Score_element * newpar = par->find_broken_piece (line_l ());
624 set_parent (newpar, ax);
627 if (Item * i = dynamic_cast<Item*> (this))
629 Item *pari = dynamic_cast<Item*> (par);
633 Direction my_dir = i->break_status_dir () ;
634 if (my_dir!= pari->break_status_dir())
636 Item *newpar = pari->find_broken_piece (my_dir);
637 set_parent (newpar, ax);