lily/figured-bass-engraver.cc

   1 /*
   2   figured-bass-engraver.cc -- implement Figured_bass_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2005 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7
   8 */
   9
  10 #include "engraver.hh"
  11
  12 #include "context.hh"
  13 #include "music.hh"
  14 #include "item.hh"
  15 #include "spanner.hh"
  16 #include "axis-group-interface.hh"
  17 #include "align-interface.hh"
  18 #include "pointer-group-interface.hh"
  19 #include "text-interface.hh"
  20 #include "grob-array.hh"
  21
  22
  23 #include "translator.icc"
  24
  25 struct Figure_group
  26 {
  27   Spanner *group_;
  28   Spanner *continuation_line_;
  29
  30   SCM number_;
  31   SCM alteration_;
  32
  33   Item *figure_item_;
  34   Music *current_music_;
  35   bool force_no_continuation_;
  36
  37   Figure_group ()
  38   {
  39     figure_item_ = 0;
  40     force_no_continuation_ = false;
  41     continuation_line_ = 0;
  42     number_ = SCM_EOL;
  43     alteration_ = SCM_EOL;
  44     group_ = 0;
  45     current_music_ = 0;
  46   }
  47   bool is_continuation () const
  48   {
  49     return
  50       current_music_
  51       && !force_no_continuation_
  52       && ly_is_equal (number_,
  53                       current_music_->get_property ("figure"))
  54       && ly_is_equal (alteration_,
  55                       current_music_->get_property ("alteration"));
  56   }
  57 };
  58
  59 struct Figured_bass_engraver : public Engraver
  60 {
  61   TRANSLATOR_DECLARATIONS(Figured_bass_engraver);
  62   void clear_spanners();
  63   void add_brackets ();
  64   void create_grobs ();
  65
  66   void center_continuations (Link_array<Spanner> const &consecutive_lines);
  67   void center_repeated_continuations ();
  68 protected:
  69   Array<Figure_group> groups_;
  70   Spanner *alignment_;
  71   Link_array<Music> new_musics_;
  72   bool continuation_;
  73   bool new_music_found_;
  74
  75   Moment stop_moment_;
  76   Music *rest_event_;
  77
  78   virtual bool try_music (Music *);
  79   virtual void derived_mark () const;
  80
  81   void start_translation_timestep ();
  82   void stop_translation_timestep ();
  83   void process_music ();
  84 };
  85
  86 void
  87 Figured_bass_engraver::derived_mark () const
  88 {
  89   for (int i = 0; i < groups_.size (); i++)
  90     {
  91       scm_gc_mark (groups_[i].number_);
  92       scm_gc_mark (groups_[i].alteration_);
  93     }
  94 }
  95
  96 void
  97 Figured_bass_engraver::stop_translation_timestep ()
  98 {
  99   if (groups_.is_empty ()
 100       || now_mom ().main_part_ < stop_moment_.main_part_)
 101     return ;
 102
 103   bool found = false;
 104   for (int i = 0; !found && i < groups_.size (); i++)
 105     found  = found  || groups_[i].current_music_;
 106
 107   if (!found)
 108     clear_spanners ();
 109 }
 110
 111 Figured_bass_engraver::Figured_bass_engraver ()
 112 {
 113   alignment_ = 0;
 114   continuation_ = false;
 115   rest_event_ = 0;
 116   new_music_found_ = false;
 117 }
 118
 119 void
 120 Figured_bass_engraver::start_translation_timestep ()
 121 {
 122   if (now_mom ().main_part_ < stop_moment_.main_part_)
 123     return ;
 124
 125   rest_event_ = 0;
 126   new_musics_.clear ();
 127   for (int i = 0; i < groups_.size (); i++)
 128     {
 129       groups_[i].current_music_ = 0;
 130     }
 131   continuation_ = false;
 132 }
 133
 134 bool
 135 Figured_bass_engraver::try_music (Music *m)
 136 {
 137   new_music_found_ = true;
 138   if (m->is_mus_type ("rest-event"))
 139     {
 140       rest_event_ = m;
 141       return true;
 142     }
 143   else
 144     {
 145       stop_moment_ = now_mom () + m->get_length ();
 146
 147       SCM fig = m->get_property ("figure");
 148       for (int i = 0; i < groups_.size (); i++)
 149         {
 150           if (!groups_[i].current_music_
 151               && ly_is_equal (groups_[i].number_, fig))
 152             {
 153               groups_[i].current_music_ = m;
 154               groups_[i].force_no_continuation_
 155                 = to_boolean (m->get_property ("no-continuation"));
 156               continuation_ = true;
 157               return true;
 158             }
 159         }
 160
 161       new_musics_.push (m);
 162
 163       return true;
 164     }
 165 }
 166
 167 void
 168 Figured_bass_engraver::center_continuations (Link_array<Spanner> const &consecutive_lines)
 169 {
 170   if (consecutive_lines.size () == 2)
 171     {
 172       Link_array<Grob> left_figs;
 173       for (int j = consecutive_lines.size(); j--;)
 174         left_figs.push (consecutive_lines[j]->get_bound (LEFT));
 175
 176       SCM  ga = Grob_array::make_array ();
 177       unsmob_grob_array (ga)->set_array (left_figs);
 178
 179       for (int j = consecutive_lines.size(); j--;)
 180         consecutive_lines[j]->set_object ("figures",
 181                                           unsmob_grob_array (ga)->smobbed_copy ());
 182     }
 183 }
 184
 185 void
 186 Figured_bass_engraver::center_repeated_continuations ()
 187 {
 188   Link_array<Spanner> consecutive_lines;
 189   for (int i = 0; i <= groups_.size(); i++)
 190     {
 191       if (i < groups_.size ()
 192           && groups_[i].continuation_line_
 193           && (consecutive_lines.is_empty ()
 194               || (consecutive_lines[0]->get_bound(LEFT)->get_column ()
 195                   == groups_[i].continuation_line_->get_bound (LEFT)->get_column ()
 196                   && consecutive_lines[0]->get_bound(RIGHT)->get_column ()
 197                   == groups_[i].continuation_line_->get_bound (RIGHT)->get_column ())))
 198         {
 199           consecutive_lines.push (groups_[i].continuation_line_);
 200         }
 201       else
 202         {
 203           center_continuations (consecutive_lines);
 204           consecutive_lines.clear ();
 205         }
 206     }
 207 }
 208
 209 void
 210 Figured_bass_engraver::clear_spanners ()
 211 {
 212   if (!alignment_)
 213     return;
 214
 215   alignment_ = 0;
 216   if (to_boolean (get_property ("figuredBassCenterContinuations")))
 217     center_repeated_continuations();
 218
 219   groups_.clear ();
 220 }
 221
 222 void
 223 Figured_bass_engraver::add_brackets ()
 224 {
 225   Link_array<Grob> encompass;
 226   bool inside = false;
 227   for (int i = 0; i < groups_.size (); i ++)
 228     {
 229       if (!groups_[i].current_music_)
 230         continue;
 231
 232       if (to_boolean (groups_[i].current_music_->get_property ("bracket-start")))
 233         {
 234           inside = true;
 235         }
 236
 237       if (inside && groups_[i].figure_item_)
 238         encompass.push (groups_[i].figure_item_);
 239
 240        if (to_boolean (groups_[i].current_music_->get_property ("bracket-stop")))
 241         {
 242           inside = false;
 243
 244           Item * brack = make_item ("BassFigureBracket", groups_[i].current_music_->self_scm ());
 245           for (int j = 0; j < encompass.size (); j++)
 246             {
 247               Pointer_group_interface::add_grob (brack,
 248                                                  ly_symbol2scm ("elements"),
 249                                                  encompass[j]);
 250             }
 251           encompass.clear ();
 252         }
 253     }
 254 }
 255
 256 void
 257 Figured_bass_engraver::process_music ()
 258 {
 259   if (rest_event_)
 260     {
 261       clear_spanners ();
 262       return;
 263     }
 264
 265   if (!continuation_
 266       && new_musics_.is_empty ())
 267     {
 268       clear_spanners ();
 269       return;
 270     }
 271
 272   if (!new_music_found_)
 273     return ;
 274
 275   new_music_found_ = false;
 276
 277   /*
 278     Don't need to sync alignments, if we're not using extenders.
 279    */
 280   bool use_extenders = to_boolean (get_property ("useBassFigureExtenders"));
 281   if (!use_extenders)
 282     {
 283       if (to_boolean (get_property ("figuredBassCenterContinuations")))
 284         center_repeated_continuations ();
 285       alignment_ = 0;
 286       for (int i = 0; i < groups_.size (); i++)
 287         {
 288           groups_[i].group_ = 0;
 289           groups_[i].continuation_line_ = 0;
 290         }
 291     }
 292
 293   if (!continuation_)
 294     {
 295       clear_spanners ();
 296     }
 297
 298   int k = 0;
 299   for (int i = 0; i < new_musics_.size (); i++)
 300     {
 301       while (k < groups_.size() &&
 302              groups_[k].current_music_)
 303         k++;
 304
 305       if (k >= groups_.size ())
 306         {
 307           Figure_group group;
 308           groups_.push (group);
 309         }
 310
 311       groups_[k].current_music_ = new_musics_[i];
 312       groups_[k].figure_item_ = 0;
 313       k++;
 314     }
 315
 316   for (int i = 0; i < groups_.size (); i++)
 317     {
 318       if (!groups_[i].is_continuation ())
 319         {
 320           groups_[i].number_ = SCM_BOOL_F;
 321           groups_[i].alteration_ = SCM_BOOL_F;
 322         }
 323     }
 324
 325   if (use_extenders)
 326     {
 327       Array<int> junk_continuations;
 328       for (int i = 0; i < groups_.size(); i++)
 329         {
 330                 Figure_group &group = groups_[i];
 331
 332           if (group.is_continuation ())
 333             {
 334               if (!group.continuation_line_)
 335                 {
 336                   Spanner * line = make_spanner ("BassFigureContinuation", SCM_EOL);
 337                   Item * item = group.figure_item_;
 338                   group.continuation_line_ = line;
 339                   line->set_bound (LEFT, item);
 340
 341                   /*
 342                     Don't add as child. This will cache the wrong
 343                     (pre-break) stencil when callbacks are triggered.
 344                   */
 345                   line->set_parent (group.group_, Y_AXIS);
 346                   Pointer_group_interface::add_grob (line, ly_symbol2scm ("figures"), item);
 347
 348                   group.figure_item_ = 0;
 349                 }
 350             }
 351           else if (group.continuation_line_)
 352             junk_continuations.push (i);
 353         }
 354
 355       /*
 356         Ugh, repeated code.
 357        */
 358       Link_array<Spanner> consecutive;
 359       if (to_boolean (get_property ("figuredBassCenterContinuations")))
 360         {
 361           for (int i = 0; i <= junk_continuations.size (); i++)
 362             {
 363               if (i < junk_continuations.size()
 364                   && (i == 0 || junk_continuations[i-1] == junk_continuations[i] - 1))
 365                 consecutive.push (groups_[junk_continuations[i]].continuation_line_);
 366               else
 367                 {
 368                   center_continuations (consecutive);
 369                   consecutive.clear ();
 370                   if (i < junk_continuations.size ())
 371                     consecutive.push (groups_[junk_continuations[i]].continuation_line_);
 372                 }
 373             }
 374         }
 375       for (int i = 0; i < junk_continuations.size (); i++)
 376         groups_[junk_continuations[i]].continuation_line_ = 0;
 377     }
 378
 379   create_grobs ();
 380   add_brackets ();
 381 }
 382
 383 void
 384 Figured_bass_engraver::create_grobs ()
 385 {
 386   Grob *muscol = dynamic_cast<Item*> (unsmob_grob (get_property ("currentMusicalColumn")));
 387   if (!alignment_)
 388     {
 389       alignment_ = make_spanner ("BassFigureAlignment", SCM_EOL);
 390       alignment_->set_bound (LEFT, muscol);
 391     }
 392   alignment_->set_bound (RIGHT, muscol);
 393
 394   SCM proc = get_property ("figuredBassFormatter");
 395   for (int i = 0; i < groups_.size(); i++)
 396     {
 397       Figure_group &group = groups_[i];
 398
 399       if (group.current_music_)
 400         {
 401           Item *item
 402             = make_item ("BassFigure",
 403                          group.current_music_->self_scm ());
 404
 405
 406           SCM fig = group.current_music_->get_property ("figure");
 407           if (!group.group_)
 408             {
 409               group.group_ = make_spanner ("BassFigureLine", SCM_EOL);
 410               group.group_->set_bound (LEFT, muscol);
 411               Align_interface::add_element (alignment_,
 412                                             group.group_);
 413             }
 414
 415           if (scm_memq (fig, get_property ("implicitBassFigures")) != SCM_BOOL_F)
 416             {
 417               item->set_property ("transparent", SCM_BOOL_T);
 418               item->set_property ("implicit", SCM_BOOL_T);
 419             }
 420
 421           group.number_ = fig;
 422           group.alteration_ = group.current_music_->get_property ("alteration");
 423
 424           SCM text = group.current_music_->get_property ("text");
 425           if (!Text_interface::is_markup (text)
 426               && ly_is_procedure (proc))
 427             {
 428               text = scm_call_3 (proc, fig, group.current_music_->self_scm (),
 429                                  context ()->self_scm ());
 430             }
 431
 432           item->set_property ("text", text);
 433
 434           Axis_group_interface::add_element (group.group_, item);
 435           group.figure_item_ = item;
 436         }
 437
 438       if (group.continuation_line_)
 439         {
 440           /*
 441             UGH should connect to the bass staff, and get the note heads.
 442           */
 443           group.figure_item_->set_property ("transparent", SCM_BOOL_T);
 444           group.continuation_line_->set_bound (RIGHT, group.figure_item_);
 445         }
 446
 447
 448       if (groups_[i].group_)
 449         groups_[i].group_->set_bound (RIGHT, muscol);
 450     }
 451
 452 }
 453
 454 ADD_TRANSLATOR (Figured_bass_engraver,
 455                 /* doc */
 456
 457                 "Make figured bass numbers.",
 458                 /* create */
 459                 "BassFigure "
 460                 "BassFigureAlignment "
 461                 "BassFigureBracket",
 462                 "BassFigureContinuation "
 463                 "BassFigureLine "
 464
 465                 /* accept */
 466                 "bass-figure-event rest-event",
 467
 468                 /* read */
 469                 "figuredBassCenterContinuations "
 470                 "implicitBassFigures "
 471                 "figuredBassFormatter "
 472                 "figuredBassAlterationDirection "
 473                 "useBassFigureExtenders",
 474
 475                 /* write */
 476                 "");