lily/accidental-placement.cc

   1 /*
   2   accidental-placement.cc -- implement Accidental_placement
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2002--2005 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9
  10
  11 #include "accidental-placement.hh"
  12 #include "skyline.hh"
  13 #include "music.hh"
  14 #include "pitch.hh"
  15 #include "warn.hh"
  16 #include "note-column.hh"
  17 #include "pointer-group-interface.hh"
  18 #include "note-collision.hh"
  19 #include "accidental-interface.hh"
  20
  21
  22 void
  23 Accidental_placement::add_accidental (Grob *me, Grob *a)
  24 {
  25   a->set_parent (me, X_AXIS);
  26   a->set_property ("X-offset", Grob::x_parent_positioning_proc);
  27   SCM cause = a->get_parent (Y_AXIS)->get_property ("cause");
  28
  29   Music *mcause = unsmob_music (cause);
  30   if (!mcause)
  31     {
  32       programming_error ("note head has no music cause");
  33       return;
  34     }
  35
  36   Pitch *p = unsmob_pitch (mcause->get_property ("pitch"));
  37
  38   int n = p->get_notename ();
  39
  40   SCM accs = me->get_object ("accidental-grobs");
  41   SCM key = scm_from_int (n);
  42   SCM entry = scm_assq (key, accs);
  43   if (entry == SCM_BOOL_F)
  44     entry = SCM_EOL;
  45   else
  46     entry = scm_cdr (entry);
  47
  48   entry = scm_cons (a->self_scm (), entry);
  49
  50   accs = scm_assq_set_x (accs, key, entry);
  51
  52   me->set_object ("accidental-grobs", accs);
  53 }
  54
  55 /*
  56   Split into break reminders.
  57 */
  58 void
  59 Accidental_placement::split_accidentals (Grob *accs,
  60                                          Link_array<Grob> *break_reminder,
  61                                          Link_array<Grob> *real_acc)
  62 {
  63   for (SCM acs = accs->get_object ("accidental-grobs"); scm_is_pair (acs);
  64        acs = scm_cdr (acs))
  65     for (SCM s = scm_cdar (acs); scm_is_pair (s); s = scm_cdr (s))
  66       {
  67         Grob *a = unsmob_grob (scm_car (s));
  68
  69         if (unsmob_grob (a->get_object ("tie")))
  70           break_reminder->push (a);
  71         else
  72           real_acc->push (a);
  73       }
  74 }
  75
  76 /*
  77   Accidentals are special, because they appear and disappear after
  78   ties at will.
  79 */
  80 Interval
  81 Accidental_placement::get_relevant_accidental_extent (Grob *me,
  82                                                       Item *item_col,
  83                                                       Grob *left_object)
  84 {
  85   Link_array<Grob> br, ra;
  86   Link_array<Grob> *which = 0;
  87
  88   Accidental_placement::split_accidentals (me, &br, &ra);
  89   br.concat (ra);
  90
  91   if (dynamic_cast<Item *> (left_object)->break_status_dir () == RIGHT)
  92     which = &br;
  93   else
  94     which = &ra;
  95
  96   Interval extent;
  97   for (int i = 0; i < which->size (); i++)
  98     extent.unite (which->elem (i)->extent (item_col, X_AXIS));
  99
 100   if (!extent.is_empty ())
 101     {
 102       Real p = robust_scm2double (me->get_property ("left-padding"), 0.2);
 103       extent[LEFT] -= p;
 104     }
 105
 106   return extent;
 107 }
 108
 109 struct Accidental_placement_entry
 110 {
 111   Array<Skyline_entry> left_skyline_;
 112   Array<Skyline_entry> right_skyline_;
 113   Interval vertical_extent_;
 114   Array<Box> extents_;
 115   Link_array<Grob> grobs_;
 116   Real offset_;
 117   int notename_;
 118   Accidental_placement_entry ()
 119   {
 120     offset_ = 0.0;
 121     notename_ = -1;
 122   }
 123 };
 124
 125 static Interval all_accidental_vertical_extent;
 126 Real ape_priority (Accidental_placement_entry const *a)
 127 {
 128   return a->vertical_extent_[UP];
 129 }
 130
 131 int ape_compare (Accidental_placement_entry *const &a,
 132                  Accidental_placement_entry *const &b)
 133 {
 134   return sign (ape_priority (a) - ape_priority (b));
 135 }
 136
 137 int ape_rcompare (Accidental_placement_entry *const &a,
 138                   Accidental_placement_entry *const &b)
 139 {
 140   return -sign (ape_priority (a) - ape_priority (b));
 141 }
 142
 143 /*
 144   TODO: should favor
 145
 146   b
 147   b
 148
 149   placement
 150 */
 151 void
 152 stagger_apes (Link_array<Accidental_placement_entry> *apes)
 153 {
 154   Link_array<Accidental_placement_entry> asc = *apes;
 155
 156   asc.sort (&ape_compare);
 157
 158   apes->clear ();
 159
 160   int i = 0;
 161   int parity = 1;
 162   while (i < asc.size ())
 163     {
 164       Accidental_placement_entry *a = 0;
 165       if (parity)
 166         a = asc.pop ();
 167       else
 168         a = asc[i++];
 169
 170       apes->push (a);
 171       parity = !parity;
 172     }
 173
 174   apes->reverse ();
 175 }
 176
 177 /*
 178   This routine computes placements of accidentals. During
 179   add_accidental (), accidentals are already grouped by note, so that
 180   octaves are placed above each other; they form columns. Then the
 181   columns are sorted: the biggest columns go closest to the note.
 182   Then the columns are spaced as closely as possible (using skyline
 183   spacing).
 184
 185
 186   TODO: more advanced placement. Typically, the accs should be placed
 187   to form a C shape, like this
 188
 189
 190   ##
 191   b b
 192   # #
 193   b
 194   b b
 195
 196   The naturals should be left of the C as well; they should
 197   be separate accs.
 198
 199   Note that this placement problem looks NP hard, so we just use a
 200   simple strategy, not an optimal choice.
 201 */
 202
 203 /*
 204   TODO: there should be more space in the following situation
 205
 206
 207   Natural + downstem
 208
 209   *
 210   *  |_
 211   *  | |    X
 212   *  |_|   |
 213   *    |   |
 214   *
 215
 216 */
 217
 218 MAKE_SCHEME_CALLBACK(Accidental_placement, calc_positioning_done, 1);
 219 SCM
 220 Accidental_placement::calc_positioning_done (SCM smob)
 221 {
 222   Grob *me = unsmob_grob (smob);
 223   if (!me->is_live ())
 224     return SCM_BOOL_T;
 225
 226   SCM accs = me->get_object ("accidental-grobs");
 227   if (!scm_is_pair (accs))
 228     return SCM_BOOL_T;
 229
 230   /*
 231     TODO: there is a bug in this code. If two accs are on the same
 232     Y-position, they share an Ape, and will be printed in overstrike.
 233   */
 234   Link_array<Accidental_placement_entry> apes;
 235   for (SCM s = accs; scm_is_pair (s); s = scm_cdr (s))
 236     {
 237       Accidental_placement_entry *ape = new Accidental_placement_entry;
 238       ape->notename_ = scm_to_int (scm_caar (s));
 239
 240       for (SCM t = scm_cdar (s); scm_is_pair (t); t = scm_cdr (t))
 241         ape->grobs_.push (unsmob_grob (scm_car (t)));
 242
 243       apes.push (ape);
 244     }
 245
 246   Grob *common[] = {me, 0};
 247
 248   /*
 249     First we must extract *all* pointers. We can only determine
 250     extents if we're sure that we've found the right common refpoint
 251   */
 252   Link_array<Grob> note_cols, heads;
 253   for (int i = apes.size (); i--;)
 254     {
 255       Accidental_placement_entry *ape = apes[i];
 256       for (int j = ape->grobs_.size (); j--;)
 257         {
 258           Grob *a = ape->grobs_[j];
 259
 260           if (common[Y_AXIS])
 261             common[Y_AXIS] = common[Y_AXIS]->common_refpoint (a, Y_AXIS);
 262           else
 263             common[Y_AXIS] = a;
 264
 265           Grob *head = a->get_parent (Y_AXIS);
 266
 267           Grob *col = head->get_parent (X_AXIS);
 268           if (Note_column::has_interface (col))
 269             note_cols.push (col);
 270           else
 271             heads.push (head);
 272         }
 273     }
 274
 275   /*
 276     This is a little kludgy: to get all notes, we look if there are
 277     collisions as well.
 278   */
 279   for (int i = note_cols.size (); i--;)
 280     {
 281       Grob *c = note_cols[i]->get_parent (X_AXIS);
 282       if (Note_collision_interface::has_interface (c))
 283         {
 284           extract_grob_set (c, "elements", gs);
 285
 286           note_cols.concat (gs);
 287         }
 288     }
 289
 290   for (int i = note_cols.size (); i--;)
 291     heads.concat (extract_grob_array (note_cols[i], "note-heads"));
 292
 293   heads.default_sort ();
 294   heads.uniq ();
 295   common[Y_AXIS] = common_refpoint_of_array (heads, common[Y_AXIS], Y_AXIS);
 296
 297   for (int i = apes.size (); i--;)
 298     {
 299       Accidental_placement_entry *ape = apes[i];
 300       ape->left_skyline_ = empty_skyline (LEFT);
 301       ape->right_skyline_ = empty_skyline (RIGHT);
 302
 303       for (int j = apes[i]->grobs_.size (); j--;)
 304         {
 305           Grob *a = apes[i]->grobs_[j];
 306
 307           Array<Box> boxes = Accidental_interface::accurate_boxes (a, common);
 308
 309           ape->extents_.concat (boxes);
 310           for (int j = boxes.size (); j--;)
 311             {
 312               insert_extent_into_skyline (&ape->left_skyline_, boxes[j], Y_AXIS, LEFT);
 313               insert_extent_into_skyline (&ape->right_skyline_, boxes[j], Y_AXIS, RIGHT);
 314             }
 315         }
 316     }
 317
 318   Interval total;
 319   for (int i = apes.size (); i--;)
 320     {
 321       Interval y;
 322
 323       for (int j = apes[i]->extents_.size (); j--;)
 324         y.unite (apes[i]->extents_[j][Y_AXIS]);
 325       apes[i]->vertical_extent_ = y;
 326       total.unite (y);
 327     }
 328   all_accidental_vertical_extent = total;
 329   stagger_apes (&apes);
 330
 331   Accidental_placement_entry *head_ape = new Accidental_placement_entry;
 332   common[X_AXIS] = common_refpoint_of_array (heads, common[X_AXIS], X_AXIS);
 333   Array<Skyline_entry> head_skyline (empty_skyline (LEFT));
 334   Array<Box> head_extents;
 335   for (int i = heads.size (); i--;)
 336     {
 337       Box b (heads[i]->extent (common[X_AXIS], X_AXIS),
 338              heads[i]->extent (common[Y_AXIS], Y_AXIS));
 339
 340       insert_extent_into_skyline (&head_skyline, b, Y_AXIS, LEFT);
 341     }
 342
 343   head_ape->left_skyline_ = head_skyline;
 344   head_ape->offset_ = 0.0;
 345
 346   Real padding = robust_scm2double (me->get_property ("padding"), 0.2);
 347
 348   Array<Skyline_entry> left_skyline = head_ape->left_skyline_;
 349   heighten_skyline (&left_skyline,
 350                     -robust_scm2double (me->get_property ("right-padding"), 0));
 351   /*
 352     Add accs entries right-to-left.
 353   */
 354   for (int i = apes.size (); i-- > 0;)
 355     {
 356       Real offset
 357         = -skyline_meshing_distance (apes[i]->right_skyline_, left_skyline);
 358       if (isinf (offset))
 359         offset = (i < apes.size () - 1) ? apes[i + 1]->offset_ : 0.0;
 360       else
 361         offset -= padding;
 362
 363       apes[i]->offset_ = offset;
 364
 365       Array<Skyline_entry> new_left_skyline = apes[i]->left_skyline_;
 366       heighten_skyline (&new_left_skyline, apes[i]->offset_);
 367       merge_skyline (&new_left_skyline, left_skyline, LEFT);
 368       left_skyline = new_left_skyline;
 369     }
 370
 371   for (int i = apes.size (); i--;)
 372     {
 373       Accidental_placement_entry *ape = apes[i];
 374       for (int j = ape->grobs_.size (); j--;)
 375         ape->grobs_[j]->translate_axis (ape->offset_, X_AXIS);
 376     }
 377
 378   Interval left_extent, right_extent;
 379   Accidental_placement_entry *ape = apes[0];
 380
 381   for (int i = ape->extents_.size (); i--;)
 382     left_extent.unite (ape->offset_ + ape->extents_[i][X_AXIS]);
 383
 384   ape = apes.top ();
 385   for (int i = ape->extents_.size (); i--;)
 386     right_extent.unite (ape->offset_ + ape->extents_[i][X_AXIS]);
 387
 388   left_extent[LEFT] -= robust_scm2double (me->get_property ("left-padding"), 0);
 389   Interval width (left_extent[LEFT], right_extent[RIGHT]);
 390
 391   SCM scm_width = ly_interval2scm (width);
 392   me->flush_extent_cache (X_AXIS);
 393   me->set_property ("X-extent", scm_width);
 394
 395   for (int i = apes.size (); i--;)
 396     delete apes[i];
 397
 398   return SCM_BOOL_T;
 399 }
 400
 401 ADD_INTERFACE (Accidental_placement,
 402                "accidental-placement-interface",
 403                "Resolve accidental collisions.",
 404
 405                /* properties */
 406                "accidental-grobs "
 407                "left-padding "
 408                "padding "
 409                "positioning-done "
 410                "right-padding ")