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