lily/score-element.cc

   1 /*
   2   score-elem.cc -- implement Score_element
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c)  1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9
  10 #include <string.h>
  11
  12 #include "group-interface.hh"
  13 #include "misc.hh"
  14 #include "paper-score.hh"
  15 #include "paper-def.hh"
  16 #include "lookup.hh"
  17 #include "molecule.hh"
  18 #include "score-element.hh"
  19 #include "debug.hh"
  20 #include "spanner.hh"
  21 #include "line-of-score.hh"
  22 #include "item.hh"
  23 #include "paper-column.hh"
  24 #include "molecule.hh"
  25 #include "misc.hh"
  26 #include "paper-outputter.hh"
  27 #include "dimension-cache.hh"
  28 #include "side-position-interface.hh"
  29 #include "item.hh"
  30 /*
  31 TODO:
  32
  33 remove dynamic_cast<Spanner,Item> and put this code into respective
  34   subclass.
  35 */
  36
  37 Score_element::Score_element()
  38 {
  39   dim_cache_[X_AXIS] = new Dimension_cache;
  40   dim_cache_[Y_AXIS] = new Dimension_cache;
  41   dim_cache_[X_AXIS]->elt_l_ = dim_cache_[Y_AXIS]->elt_l_ = this;
  42
  43   // junkme.
  44   used_b_ = false;
  45
  46   dim_cache_[X_AXIS]->set_extent_callback (molecule_extent);
  47   dim_cache_[Y_AXIS]->set_extent_callback (molecule_extent);
  48   used_b_ = false;
  49   pscore_l_=0;
  50   lookup_l_ =0;
  51   status_i_ = 0;
  52   self_scm_ = SCM_EOL;
  53   original_l_ = 0;
  54   element_property_alist_ = SCM_EOL;
  55
  56   smobify_self ();
  57
  58
  59   set_elt_property ("dependencies", SCM_EOL);
  60   set_elt_property ("interfaces", SCM_EOL);
  61 }
  62
  63
  64 Score_element::Score_element (Score_element const&s)
  65 {
  66   dim_cache_[X_AXIS] = new Dimension_cache (*s.dim_cache_[X_AXIS]);
  67   dim_cache_[Y_AXIS] = new Dimension_cache (*s.dim_cache_[Y_AXIS]);
  68   dim_cache_[X_AXIS]->elt_l_ = dim_cache_[Y_AXIS]->elt_l_ = this;
  69
  70   self_scm_ = SCM_EOL;
  71   used_b_ = true;
  72   original_l_ =(Score_element*) &s;
  73   element_property_alist_ = SCM_EOL; // onstack;
  74
  75   status_i_ = s.status_i_;
  76   lookup_l_ = s.lookup_l_;
  77   pscore_l_ = s.pscore_l_;
  78
  79   smobify_self ();
  80 }
  81
  82 Score_element::~Score_element()
  83 {
  84   assert (status_i_ >=0);
  85   status_i_  = -1;
  86
  87   delete dim_cache_[X_AXIS];
  88   delete dim_cache_[Y_AXIS];
  89 }
  90
  91 // should also have one that takes SCM arg.
  92 SCM
  93 Score_element::get_elt_property (String nm) const
  94 {
  95   SCM sym =  ly_symbol2scm (nm.ch_C());
  96   SCM s = scm_assq(sym, element_property_alist_);
  97
  98   if (s != SCM_BOOL_F)
  99     return gh_cdr (s);
 100
 101   if (pscore_l_)
 102     {
 103       SCM sym2 = ly_symbol2scm ((name () + ("::" + nm)).ch_C());
 104       SCM val;
 105
 106       // should probably check for Type::sym as well.
 107       Paper_def * p= pscore_l_->paper_l_;
 108       if (p->default_properties_.try_retrieve (sym2, &val))
 109         return val;
 110       else if (p->default_properties_.try_retrieve (sym, &val))
 111         return val;
 112     }
 113
 114   return SCM_UNDEFINED;
 115 }
 116
 117 SCM
 118 Score_element::remove_elt_property (String key)
 119 {
 120   SCM s = get_elt_property (key);
 121   SCM sym = ly_symbol2scm (key.ch_C());
 122   element_property_alist_ =  scm_assq_remove_x (element_property_alist_, sym);
 123   return s;
 124 }
 125
 126 /*
 127   UGH. assoc vs. assq
 128  */
 129 void
 130 Score_element::set_elt_property (String k, SCM v)
 131 {
 132   SCM s = ly_symbol2scm (k.ch_C( ));
 133   element_property_alist_ = scm_assoc_set_x (element_property_alist_, s, v);
 134 }
 135
 136 Interval
 137 Score_element::molecule_extent (Dimension_cache const *c)
 138 {
 139   Score_element *s = dynamic_cast<Score_element*>(c->element_l());
 140   Molecule m = s->do_brew_molecule();
 141   return m.extent()[c->axis ()];
 142 }
 143
 144 Interval
 145 Score_element::preset_extent (Dimension_cache const *c)
 146 {
 147   Score_element *s = dynamic_cast<Score_element*>(c->element_l());
 148   SCM ext = s->get_elt_property ((c->axis () == X_AXIS)
 149                                  ? "extent-X"
 150                                  : "extent-Y");
 151
 152   if (gh_pair_p (ext))
 153     {
 154       Real l = gh_scm2double (gh_car (ext));
 155       Real r = gh_scm2double (gh_cdr (ext));
 156       l *= s->paper_l ()->get_var ("staffspace");
 157       r *= s->paper_l ()->get_var ("staffspace");
 158       return Interval (l, r);
 159     }
 160
 161   return Interval ();
 162 }
 163
 164
 165 void
 166 Score_element::print() const
 167 {
 168 #ifndef NPRINT
 169   DEBUG_OUT << classname(this) << "{\n";
 170
 171   if (flower_dstream && !flower_dstream->silent_b ("Score_element"))
 172     ly_display_scm (element_property_alist_);
 173
 174   if (original_l_)
 175     DEBUG_OUT << "Copy ";
 176   do_print();
 177
 178   DEBUG_OUT <<  "}\n";
 179 #endif
 180 }
 181
 182 Paper_def*
 183 Score_element::paper_l ()  const
 184 {
 185  return pscore_l_ ? pscore_l_->paper_l_ : 0;
 186 }
 187
 188 Lookup const *
 189 Score_element::lookup_l () const
 190 {
 191   if (!lookup_l_)
 192     {
 193       Score_element * urg = (Score_element*)this;
 194       SCM sz = urg->remove_elt_property ("fontsize");
 195       int i = (gh_number_p (sz))
 196         ? gh_scm2int  (sz)
 197         : 0;
 198
 199       urg->lookup_l_ =  (Lookup*)pscore_l_->paper_l_->lookup_l (i);
 200     }
 201   return lookup_l_;
 202 }
 203
 204 void
 205 Score_element::add_processing()
 206 {
 207   assert (status_i_ >=0);
 208   if (status_i_)
 209     return;
 210   status_i_ ++;
 211
 212 #if 0
 213     /*
 214     UGH. UGH. UGH.
 215    */
 216   if (get_elt_property ("self-alignment-X") != SCM_UNDEFINED
 217       && !dim_cache_[X_AXIS]->off_callback_l_)
 218     {
 219       add_offset_callback (Side_position_interface::aligned_on_self,X_AXIS);
 220     }
 221
 222   if (get_elt_property ("self-alignment-Y") != SCM_UNDEFINED
 223       && !dim_cache_[X_AXIS]->off_callback_l_)
 224
 225     {
 226       add_offset_callback (Side_position_interface::aligned_on_self, Y_AXIS);
 227     }
 228 #endif
 229
 230   do_add_processing();
 231 }
 232
 233 void
 234 Score_element::calculate_dependencies (int final, int busy,
 235                                        Score_element_method_pointer funcptr)
 236 {
 237   assert (status_i_ >=0);
 238
 239   if (status_i_ >= final)
 240     return;
 241
 242   assert (status_i_!= busy);
 243   status_i_= busy;
 244
 245   for (SCM d=  get_elt_property ("dependencies"); d != SCM_EOL; d = gh_cdr (d))
 246     {
 247       unsmob_element (gh_car (d))
 248         ->calculate_dependencies (final, busy, funcptr);
 249     }
 250
 251   (this->*funcptr)();
 252   status_i_= final;
 253 }
 254
 255 void
 256 Score_element::output_processing ()
 257 {
 258   if (to_boolean  (get_elt_property ("transparent")))
 259     return;
 260
 261
 262   Molecule m (do_brew_molecule ());
 263   Offset o (relative_coordinate (0, X_AXIS), relative_coordinate (0, Y_AXIS));
 264
 265   SCM s = get_elt_property ("extra-offset");
 266   if (gh_pair_p (s))
 267     {
 268       Real il = paper_l ()->get_var ("interline");
 269       o[X_AXIS] += il * gh_scm2double (gh_car (s));
 270       o[Y_AXIS] += il * gh_scm2double (gh_cdr (s));
 271     }
 272
 273   pscore_l_->outputter_l_->output_molecule (m.expr_, o, classname(this));
 274 }
 275
 276 /*
 277
 278   VIRTUAL STUBS
 279
 280  */
 281 void
 282 Score_element::do_break_processing()
 283 {
 284 }
 285
 286 void
 287 Score_element::after_line_breaking ()
 288 {
 289 }
 290
 291
 292 void
 293 Score_element::before_line_breaking ()
 294 {
 295 }
 296
 297 void
 298 Score_element::do_space_processing ()
 299 {
 300 }
 301
 302 void
 303 Score_element::do_add_processing()
 304 {
 305 }
 306
 307
 308
 309 Molecule
 310 Score_element::do_brew_molecule() const
 311 {
 312   SCM glyph = get_elt_property ("glyph");
 313   if (gh_string_p (glyph))
 314     {
 315       return lookup_l ()->afm_find (String (ly_scm2string (glyph)));
 316
 317     }
 318   else
 319     {
 320       Molecule m ;
 321       m.set_empty (true);
 322       return m;
 323     }
 324 }
 325
 326
 327 Line_of_score *
 328 Score_element::line_l() const
 329 {
 330   return 0;
 331 }
 332
 333 void
 334 Score_element::add_dependency (Score_element*e)
 335 {
 336   if (e)
 337     {
 338       Group_interface gi (this, "dependencies");
 339       gi.add_element (e);
 340     }
 341   else
 342     programming_error ("Null dependency added");
 343 }
 344
 345
 346
 347
 348 /**
 349       Do break substitution in S, using CRITERION. Return new value.
 350       CRITERION is either a SMOB pointer to the desired line, or a number
 351       representing the break direction. Do not modify SRC.
 352 */
 353 SCM
 354 Score_element::handle_broken_smobs (SCM src, SCM criterion)
 355 {
 356  again:
 357
 358
 359   Score_element *sc = unsmob_element (src);
 360   if (sc)
 361     {
 362       if (criterion == SCM_UNDEFINED)
 363         return SCM_UNDEFINED;
 364       else if (gh_number_p (criterion))
 365         {
 366           Item * i = dynamic_cast<Item*> (sc);
 367           Direction d = to_dir (criterion);
 368           if (i && i->break_status_dir () != d)
 369             {
 370               Item *br = i->find_broken_piece (d);
 371               return  (br) ? br->self_scm_ : SCM_UNDEFINED;
 372             }
 373         }
 374       else
 375         {
 376           Score_element * ln = unsmob_element ( criterion);
 377           Line_of_score * line = dynamic_cast<Line_of_score*> (ln);
 378           Score_element * br =0;
 379           Line_of_score * dep_line = sc->line_l ();
 380           if (dep_line != line)
 381             {
 382               br = sc->find_broken_piece (line);
 383               return  (br) ?  br->self_scm_ : SCM_UNDEFINED;
 384             }
 385           if (!dep_line)
 386             return SCM_UNDEFINED;
 387         }
 388     }
 389   else if (gh_pair_p (src))
 390     {
 391       /*
 392         UGH! breaks on circular lists.
 393       */
 394       SCM car = handle_broken_smobs (gh_car (src), criterion);
 395       SCM cdr = gh_cdr (src);
 396
 397       if (car == SCM_UNDEFINED
 398           && (gh_pair_p (cdr) || cdr == SCM_EOL))
 399         {
 400           /*
 401             This is tail-recursion, ie.
 402
 403             return handle_broken_smobs (cdr, criterion);
 404
 405             We don't want to rely on the compiler to do this.  */
 406           src =  cdr;
 407           goto again;
 408         }
 409
 410       return gh_cons (car, handle_broken_smobs (cdr, criterion));
 411     }
 412   else
 413     return src;
 414
 415   return src;
 416 }
 417
 418 void
 419 Score_element::handle_broken_dependencies()
 420 {
 421   Spanner * s= dynamic_cast<Spanner*> (this);
 422   if (original_l_ && s)
 423     return;
 424
 425   if (s)
 426     {
 427       for (int i = 0;  i< s->broken_into_l_arr_ .size (); i++)
 428         {
 429           Score_element * sc = s->broken_into_l_arr_[i];
 430           Line_of_score * l = sc->line_l ();
 431           s->broken_into_l_arr_[i]->element_property_alist_ =
 432             handle_broken_smobs (element_property_alist_,
 433                                  l ? l->self_scm_ : SCM_UNDEFINED);
 434         }
 435     }
 436
 437   Line_of_score *line = line_l();
 438   element_property_alist_
 439     = handle_broken_smobs (element_property_alist_,
 440                            line ? line->self_scm_ : SCM_UNDEFINED);
 441 }
 442
 443
 444 /*
 445   TODO: cleanify.
 446  */
 447 void
 448 Score_element::handle_prebroken_dependencies()
 449 {
 450   if (Item*i =dynamic_cast<Item*> (this))
 451     {
 452       if (original_l_)
 453         {
 454           element_property_alist_
 455             = handle_broken_smobs (original_l_->element_property_alist_,
 456                                gh_int2scm (i->break_status_dir ()));
 457         }
 458     }
 459 }
 460
 461 bool
 462 Score_element::linked_b() const
 463 {
 464   return used_b_;
 465 }
 466
 467 void
 468 Score_element::do_print () const
 469 {
 470 }
 471
 472 Score_element*
 473 Score_element::find_broken_piece (Line_of_score*) const
 474 {
 475   return 0;
 476 }
 477
 478 void
 479 Score_element::translate_axis (Real y, Axis a)
 480 {
 481   dim_cache_[a]->translate (y);
 482 }
 483
 484 Real
 485 Score_element::relative_coordinate (Score_element const*e, Axis a) const
 486 {
 487   return dim_cache_[a]->relative_coordinate (e ? e->dim_cache_[a] : 0);
 488 }
 489
 490 Score_element *
 491 Score_element::common_refpoint (Score_element const* s, Axis a) const
 492 {
 493   Dimension_cache *dim = dim_cache_[a]->common_refpoint (s->dim_cache_[a]);
 494   return  dim ? dim->element_l () : 0;
 495 }
 496
 497 void
 498 Score_element::set_empty (Axis a)
 499 {
 500   dim_cache_[a]->extent_callback_l_ =0;
 501 }
 502
 503 bool
 504 Score_element::empty_b (Axis a)const
 505 {
 506   return !dim_cache_[a]->extent_callback_l_;
 507 }
 508
 509 Interval
 510 Score_element::extent (Axis a) const
 511 {
 512   Dimension_cache const * d = dim_cache_[a];
 513   Interval ext = d->get_dim ();
 514
 515
 516   SCM extra = get_elt_property (a == X_AXIS ? "extra-extent-X"
 517                                 : "extra-extent-Y");
 518
 519
 520   /*
 521     signs ?
 522    */
 523   Real s = paper_l ()->get_var ("staffspace");
 524   if (gh_pair_p (extra))
 525     {
 526       ext[BIGGER] +=  s * gh_scm2double (gh_cdr (extra));
 527       ext[SMALLER] +=  s * gh_scm2double (gh_car (extra));
 528     }
 529
 530   extra = get_elt_property (a == X_AXIS
 531                                 ? "minimum-extent-X"
 532                                 : "minimum-extent-Y");
 533   if (gh_pair_p (extra))
 534     {
 535       ext.unite (Interval (s * gh_scm2double (gh_car (extra)),
 536                            s * gh_scm2double (gh_cdr (extra))));
 537
 538     }
 539
 540   return ext;
 541 }
 542
 543
 544 Score_element*
 545 Score_element::parent_l (Axis a) const
 546 {
 547   Dimension_cache*d= dim_cache_[a]->parent_l_;
 548   return d ? d->elt_l_ : 0;
 549 }
 550
 551 Score_element *
 552 Score_element::common_refpoint (Link_array<Score_element> gs, Axis a) const
 553 {
 554   Dimension_cache * common = dim_cache_[a];
 555   for (int i=0; i < gs.size (); i++)
 556     {
 557       common = common->common_refpoint (gs[i]->dim_cache_[a]);
 558     }
 559
 560   return common->element_l ();
 561 }
 562
 563 char const *
 564 Score_element::name () const
 565 {
 566   return classname (this);
 567 }
 568
 569 void
 570 Score_element::add_offset_callback (Offset_cache_callback cb, Axis a)
 571 {
 572   dim_cache_[a]->off_callbacks_.push (cb);
 573 }
 574
 575 bool
 576 Score_element::has_offset_callback_b (Offset_cache_callback cb, Axis a)const
 577 {
 578   for (int i= dim_cache_[a]->off_callbacks_.size (); i--;)
 579     {
 580       if (dim_cache_[a]->off_callbacks_[i] == cb)
 581         return true;
 582     }
 583   return false;
 584 }
 585
 586 void
 587 Score_element::set_parent (Score_element *g, Axis a)
 588 {
 589   dim_cache_[a]->parent_l_ = g ? g->dim_cache_[a]: 0;
 590 }
 591
 592 void
 593 Score_element::fixup_refpoint ()
 594 {
 595   for (int a = X_AXIS; a < NO_AXES; a ++)
 596     {
 597       Axis ax = (Axis)a;
 598       Score_element * parent = parent_l (ax);
 599
 600       if (!parent)
 601         continue;
 602
 603       if (parent->line_l () != line_l () && line_l ())
 604         {
 605           Score_element * newparent = parent->find_broken_piece (line_l ());
 606           set_parent (newparent, ax);
 607           if (!newparent)
 608             {
 609               programming_error ("Orphaned score-element.");
 610             }
 611         }
 612
 613       if (Item * i  = dynamic_cast<Item*> (this))
 614         {
 615           Item *parenti = dynamic_cast<Item*> (parent);
 616
 617           if (parenti && i)
 618             {
 619               Direction  my_dir = i->break_status_dir () ;
 620               if (my_dir!= parenti->break_status_dir())
 621                 {
 622                   Item *newparent =  parenti->find_broken_piece (my_dir);
 623                   set_parent (newparent, ax);
 624                 }
 625             }
 626         }
 627     }
 628 }
 629
 630
 631
 632 /****************************************************
 633   SMOB funcs
 634  ****************************************************/
 635
 636
 637 #include "ly-smobs.icc"
 638
 639 IMPLEMENT_UNSMOB(Score_element, element);
 640 IMPLEMENT_SMOBS(Score_element);
 641 SCM
 642 Score_element::mark_smob (SCM ses)
 643 {
 644   Score_element * s = SMOB_TO_TYPE (Score_element, ses);
 645   if (s->self_scm_ != ses)
 646     {
 647       programming_error ("SMOB marking gone awry");
 648       return SCM_EOL;
 649     }
 650   return s->element_property_alist_;
 651 }
 652
 653 int
 654 Score_element::print_smob (SCM s, SCM port, scm_print_state *)
 655 {
 656   Score_element *sc = (Score_element *) gh_cdr (s);
 657
 658   scm_puts ("#<Score_element ", port);
 659   scm_puts ((char *)sc->name (), port);
 660
 661   /*
 662     don't try to print properties, that is too much hassle.
 663    */
 664   scm_puts (" >", port);
 665   return 1;
 666 }
 667
 668 void
 669 Score_element::do_smobify_self ()
 670 {
 671 }
 672
 673 SCM
 674 Score_element::equal_p (SCM a, SCM b)
 675 {
 676   return gh_cdr(a) == gh_cdr(b) ? SCM_BOOL_T : SCM_BOOL_F;
 677 }
 678
 679
 680 SCM
 681 Score_element::ly_set_elt_property (SCM elt, SCM sym, SCM val)
 682 {
 683   Score_element * sc = unsmob_element (elt);
 684
 685   if (!gh_symbol_p (sym))
 686     {
 687       error ("Not a symbol");
 688       ly_display_scm (sym);
 689       return SCM_UNDEFINED;
 690     }
 691
 692   if (sc)
 693     {
 694       sc->element_property_alist_ = scm_assoc_set_x (sc->element_property_alist_, sym, val);
 695     }
 696   else
 697     {
 698       error ("Not a score element");
 699       ly_display_scm (elt);
 700     }
 701
 702   return SCM_UNDEFINED;
 703 }
 704
 705
 706 SCM
 707 Score_element::ly_get_elt_property (SCM elt, SCM sym)
 708 {
 709   Score_element * sc = unsmob_element (elt);
 710
 711   if (sc)
 712     {
 713       SCM s = scm_assq(sym, sc->element_property_alist_);
 714
 715       if (s != SCM_BOOL_F)
 716         return gh_cdr (s);
 717       else
 718         return SCM_UNDEFINED;
 719     }
 720   else
 721     {
 722       error ("Not a score element");
 723       ly_display_scm (elt);
 724     }
 725   return SCM_UNDEFINED;
 726 }
 727
 728
 729 static void
 730 init_functions ()
 731 {
 732   scm_make_gsubr ("ly-get-elt-property", 2, 0, 0, (SCM(*)(...))Score_element::ly_get_elt_property);
 733   scm_make_gsubr ("ly-set-elt-property", 3, 0, 0, (SCM(*)(...))Score_element::ly_set_elt_property);
 734 }
 735
 736 ADD_SCM_INIT_FUNC(scoreelt, init_functions);
 737
 738 void
 739 Score_element::do_breakable_col_processing ()
 740 {
 741 }