]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/slur-scoring.cc
Run `make grand-replace'.
[lilypond.git] / lily / slur-scoring.cc
index 71a6470b0c2f124b58907f6ff2e33b9734c74625..1973102650a063d3cefdc9cd9b7e14896abee52e 100644 (file)
@@ -3,28 +3,30 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1996--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  (c) 1996--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
   Jan Nieuwenhuizen <janneke@gnu.org>
 */
 
 
 #include "slur-scoring.hh"
-#include "libc-extension.hh"
-#include "slur-configuration.hh"
+
+#include "accidental-interface.hh"
 #include "beam.hh"
 #include "directional-element-interface.hh"
-#include "pointer-group-interface.hh"
-#include "slur.hh"
+#include "libc-extension.hh"
+#include "main.hh"
 #include "note-column.hh"
 #include "output-def.hh"
+#include "paper-column.hh"
 #include "pitch.hh"
+#include "pointer-group-interface.hh"
+#include "slur-configuration.hh"
+#include "slur.hh"
 #include "spanner.hh"
 #include "staff-symbol-referencer.hh"
 #include "staff-symbol.hh"
 #include "stem.hh"
 #include "warn.hh"
-#include "paper-column.hh"
-#include "accidental-interface.hh"
 
 /*
   TODO:
@@ -64,94 +66,6 @@ Slur_score_state::~Slur_score_state ()
   junk_pointers (configurations_);
 }
 
-Real
-get_detail (SCM alist, SCM sym)
-{
-  SCM entry = scm_assq (sym, alist);
-  return robust_scm2double (scm_is_pair (entry)
-                           ? scm_cdr (entry)
-                           : SCM_EOL,
-                           0.0);
-}
-
-void
-Slur_score_parameters::fill (Grob *me)
-{
-  SCM details = me->get_property ("details");
-
-  region_size_
-    = (int) get_detail (details, ly_symbol2scm ("region-size"));
-  head_encompass_penalty_
-    = get_detail (details, ly_symbol2scm ("head-encompass-penalty"));
-  stem_encompass_penalty_
-    = get_detail (details, ly_symbol2scm ("stem-encompass-penalty"));
-  closeness_factor_
-    = get_detail (details, ly_symbol2scm ("closeness-factor"));
-  edge_attraction_factor_
-    = get_detail (details, ly_symbol2scm ("edge-attraction-factor"));
-  same_slope_penalty_
-    = get_detail (details, ly_symbol2scm ("same-slope-penalty"));
-  steeper_slope_factor_
-    = get_detail (details, ly_symbol2scm ("steeper-slope-factor"));
-  non_horizontal_penalty_
-    = get_detail (details, ly_symbol2scm ("non-horizontal-penalty"));
-  max_slope_
-    = get_detail (details, ly_symbol2scm ("max-slope"));
-  max_slope_factor_
-    = get_detail (details, ly_symbol2scm ("max-slope-factor"));
-  free_head_distance_
-    = get_detail (details, ly_symbol2scm ("free-head-distance"));
-  absolute_closeness_measure_
-    = get_detail (details, ly_symbol2scm ("absolute-closeness-measure"));
-  extra_object_collision_penalty_
-    = get_detail (details, ly_symbol2scm ("extra-object-collision-penalty"));
-  accidental_collision_
-    = get_detail (details, ly_symbol2scm ("accidental-collision"));
-  extra_encompass_free_distance_
-    = get_detail (details, ly_symbol2scm ("extra-encompass-free-distance"));
-  head_slur_distance_factor_
-    = get_detail (details, ly_symbol2scm ("head-slur-distance-factor"));
-  head_slur_distance_max_ratio_
-    = get_detail (details, ly_symbol2scm ("head-slur-distance-max-ratio"));
-  free_slur_distance_
-    = get_detail (details, ly_symbol2scm ("free-slur-distance"));
-  edge_slope_exponent_
-    = get_detail (details, ly_symbol2scm ("edge-slope-exponent"));
-}
-
-Real
-broken_trend_y (Slur_score_state const &state, Direction hdir)
-{
-  /* A broken slur should maintain the same vertical trend
-     the unbroken slur would have had.  */
-  Real by = 0.0;
-  if (Spanner *mother = dynamic_cast<Spanner *> (state.slur_->original ()))
-    {
-      int k = broken_spanner_index (state.slur_);
-      int j = k + hdir;
-      if (j < 0 || j >= mother->broken_intos_.size ())
-       return by;
-
-      Grob *neighbor = mother->broken_intos_[j];
-      Spanner *common_mother
-       = dynamic_cast<Spanner *> (state.common_[Y_AXIS]->original ());
-      int common_k
-       = broken_spanner_index (dynamic_cast<Spanner *> (state.common_[Y_AXIS]));
-      int common_j = common_k + hdir;
-
-      if (common_j < 0 || common_j >= common_mother->broken_intos_.size ())
-       return by;
-
-      Grob *common_next_system = common_mother->broken_intos_[common_j];
-
-      SCM last_point = scm_car (scm_last_pair (neighbor->get_property ("control-points")));
-
-      return scm_to_double (scm_cdr (last_point))
-       + neighbor->relative_coordinate (common_next_system, Y_AXIS);
-    }
-  return by;
-}
-
 /*
   copy slur dir forwards across line break.
 */
@@ -161,14 +75,8 @@ Slur_score_state::set_next_direction ()
   if (extremes_[RIGHT].note_column_)
     return;
 
-  if (Spanner *mother = dynamic_cast<Spanner *> (slur_->original ()))
+  if (Grob *neighbor = slur_->broken_neighbor (RIGHT))
     {
-      int k = broken_spanner_index (slur_);
-      int j = k + 1;
-      if (j < 0 || j >= mother->broken_intos_.size ())
-       return;
-
-      Grob *neighbor = mother->broken_intos_[j];
       set_grob_direction (neighbor, dir_);
     }
 }
@@ -284,15 +192,16 @@ Slur_score_state::fill (Grob *me)
   slur_ = dynamic_cast<Spanner *> (me);
   columns_
     = internal_extract_grob_array (me, ly_symbol2scm ("note-columns"));
-
+  
   if (columns_.empty ())
     {
       me->suicide ();
       return;
     }
 
+  Slur::replace_breakable_encompass_objects (me);
   staff_space_ = Staff_symbol_referencer::staff_space (me);
-  Real lt = me->layout ()->get_dimension (ly_symbol2scm ("linethickness"));
+  Real lt = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
   thickness_ = robust_scm2double (me->get_property ("thickness"), 1.0) * lt;
 
   dir_ = get_grob_direction (me);
@@ -364,7 +273,7 @@ Slur_score_state::fill (Grob *me)
 }
 
 
-MAKE_SCHEME_CALLBACK(Slur, calc_control_points, 1)
+MAKE_SCHEME_CALLBACK (Slur, calc_control_points, 1)
 SCM
 Slur::calc_control_points (SCM smob)
 {
@@ -405,49 +314,82 @@ Slur_score_state::get_best_curve ()
   Real opt = 1e6;
 
 #if DEBUG_SLUR_SCORING
+  bool debug_slurs = to_boolean (slur_->layout ()
+                                ->lookup_variable (ly_symbol2scm ("debug-slur-scoring")));
   SCM inspect_quants = slur_->get_property ("inspect-quants");
-  if (to_boolean (slur_->layout ()
-                 ->lookup_variable (ly_symbol2scm ("debug-slur-scoring")))
-      && scm_is_pair (inspect_quants))
+  SCM inspect_index = slur_->get_property ("inspect-index");
+  if (debug_slurs
+      && scm_is_integer (inspect_index))
+    {
+      opt_idx = scm_to_int (inspect_index);
+      configurations_[opt_idx]->calculate_score (*this);
+      opt = configurations_[opt_idx]->score ();
+    }
+  else if (debug_slurs
+          && scm_is_pair (inspect_quants))
     {
       opt_idx = get_closest_index (inspect_quants);
-      configurations_[opt_idx]->score (*this);
-      opt = configurations_[opt_idx]->score_;
+      configurations_[opt_idx]->calculate_score (*this);
+      opt = configurations_[opt_idx]->score ();
     }
   else
 #endif
     {
       for (vsize i = 0; i < configurations_.size (); i++)
-       configurations_[i]->score (*this);
+       configurations_[i]->calculate_score (*this);
       for (vsize i = 0; i < configurations_.size (); i++)
        {
-         if (configurations_[i]->score_ < opt)
+         if (configurations_[i]->score () < opt)
            {
-             opt = configurations_[i]->score_;
+             opt = configurations_[i]->score ();
              opt_idx = i;
            }
        }
     }
 
 #if DEBUG_SLUR_SCORING
-  if (opt_idx >= 0)
+  if (debug_slurs)
     {
-      configurations_[opt_idx]->score_card_ += to_string ("=%.2f", opt);
-      configurations_[opt_idx]->score_card_ += to_string ("i%d", opt_idx);
+      string total;
+      if (opt_idx >= 0)
+       {
+         total = configurations_[opt_idx]->card ();
+         total += to_string (" TOTAL=%.2f idx=%d", configurations_[opt_idx]->score (), opt_idx); 
+       }
+      else
+       {
+         total = "no sol?";
+       }
+  
+      slur_->set_property ("quant-score",
+                          ly_string2scm (total));
     }
-  else
+#endif
+
+  if (opt_idx < 0)
     {
-      programming_error ("No optimal slur found. Guessing 0.");
       opt_idx = 0;
+      programming_error ("No optimal slur found. Guessing 0.");
     }
   
-  // debug quanting
-  slur_->set_property ("quant-score",
-                      scm_makfrom0str (configurations_[opt_idx]->score_card_.c_str ()));
+  return configurations_[opt_idx]->curve_;
+}
 
-#endif
+Grob *
+Slur_score_state::breakable_bound_item (Direction d) const
+{
+  Grob *col = slur_->get_bound (d)->get_column ();
 
-  return configurations_[opt_idx]->curve_;
+  extract_grob_set (slur_, "encompass-objects", extra_encompasses);
+
+  for (vsize i = 0; i < extra_encompasses.size (); i++)
+    {
+      Item *item = dynamic_cast<Item*> (extra_encompasses[i]);
+      if (item && col == item->get_column ())
+       return item;
+    }
+
+  return 0;
 }
 
 int
@@ -468,7 +410,7 @@ Slur_score_state::get_closest_index (SCM inspect_quants) const
        }
     }
   if (mindist > 1e5)
-    programming_error ("can't not find quant");
+    programming_error ("cannot find quant");
   return opt_idx;
 }
 
@@ -488,7 +430,7 @@ Slur_score_state::get_y_attachment_range () const
        {
          end_ys[d] = dir_
            * max (max (dir_ * (base_attachments_[d][Y_AXIS]
-                                         + parameters_.region_size_ * dir_),
+                               + parameters_.region_size_ * dir_),
                        dir_ * (dir_ + extremes_[d].note_column_->extent (common_[Y_AXIS], Y_AXIS)[dir_])),
                   dir_ * base_attachments_[-d][Y_AXIS]);
        }
@@ -562,11 +504,18 @@ Slur_score_state::get_base_attachments () const
     {
       if (!extremes_[d].note_column_)
        {
-         Real x, y;
-         if (d == RIGHT)
-           x = extremes_[d].bound_->extent (common_[X_AXIS], X_AXIS)[d];
+         Real x = 0;
+         Real y = 0;
+
+         if (Grob *g = breakable_bound_item (d))
+           {
+             x = robust_relative_extent (g, common_[X_AXIS], X_AXIS)[RIGHT];
+           }
+         else if (d == RIGHT)
+           x = robust_relative_extent (extremes_[d].bound_, common_[X_AXIS], X_AXIS)[d];
          else
            x = slur_->get_broken_left_end_align ();
+         
          Grob *col = (d == LEFT) ? columns_[0] : columns_.back ();
 
          if (extremes_[-d].bound_ != col)
@@ -631,11 +580,11 @@ Slur_score_state::move_away_from_staffline (Real y,
   return y;
 }
 
-std::vector<Offset>
+vector<Offset>
 Slur_score_state::generate_avoid_offsets () const
 {
-  std::vector<Offset> avoid;
-  Link_array__Grob_ encompasses = columns_;
+  vector<Offset> avoid;
+  vector<Grob*> encompasses = columns_;
 
   for (vsize i = 0; i < encompasses.size (); i++)
     {
@@ -672,7 +621,7 @@ Slur_score_state::generate_avoid_offsets () const
 
          if (!xe.is_empty ()
              && !ye.is_empty ())
-           avoid.push_back (Offset (xe.center(), ye[dir_]));
+           avoid.push_back (Offset (xe.center (), ye[dir_]));
        }
     }  
   return avoid;
@@ -684,15 +633,15 @@ Slur_score_state::generate_curves () const
   Real r_0 = robust_scm2double (slur_->get_property ("ratio"), 0.33);
   Real h_inf = staff_space_ * scm_to_double (slur_->get_property ("height-limit"));
 
-  std::vector<Offset> avoid = generate_avoid_offsets ();
+  vector<Offset> avoid = generate_avoid_offsets ();
   for (vsize i = 0; i < configurations_.size (); i++)
     configurations_[i]->generate_curve (*this, r_0, h_inf, avoid);
 }
 
-Link_array__Slur_configuration_
+vector<Slur_configuration*>
 Slur_score_state::enumerate_attachments (Drul_array<Real> end_ys) const
 {
-  Link_array__Slur_configuration_ scores;
+  vector<Slur_configuration*> scores;
 
   Drul_array<Offset> os;
   os[LEFT] = base_attachments_[LEFT];
@@ -780,11 +729,11 @@ Slur_score_state::enumerate_attachments (Drul_array<Real> end_ys) const
   return scores;
 }
 
-std::vector<Extra_collision_info>
+vector<Extra_collision_info>
 Slur_score_state::get_extra_encompass_infos () const
 {
   extract_grob_set (slur_, "encompass-objects", encompasses);
-  std::vector<Extra_collision_info> collision_infos;
+  vector<Extra_collision_info> collision_infos;
   for (vsize i = encompasses.size (); i--;)
     {
       if (Slur::has_interface (encompasses[i]))
@@ -797,7 +746,7 @@ Slur_score_state::get_extra_encompass_infos () const
 
          for (int k = 0; k < 3; k++)
            {
-             Direction hdir = Direction (k / 2 - 1);
+             Direction hdir = Direction (k - 1);
 
              /*
                Only take bound into account if small slur starts
@@ -816,7 +765,7 @@ Slur_score_state::get_extra_encompass_infos () const
              Interval xext (-1, 1);
              xext = xext * (thickness_ * 2) + z[X_AXIS];
              Extra_collision_info info (small_slur,
-                                        k - 1.0,
+                                        hdir,
                                         xext,
                                         yext,
                                         parameters_.extra_object_collision_penalty_);
@@ -834,34 +783,21 @@ Slur_score_state::get_extra_encompass_infos () const
          if (Accidental_interface::has_interface (g))
            {
              penalty = parameters_.accidental_collision_;
-             /* Begin copy accidental.cc */
-             bool parens = false;
-             if (to_boolean (g->get_property ("cautionary")))
-               {
-                 SCM cstyle = g->get_property ("cautionary-style");
-                 parens = ly_is_equal (cstyle, ly_symbol2scm ("parentheses"));
-               }
 
-             SCM accs = g->get_property ("accidentals");
+             Rational alt = ly_scm2rational (g->get_property ("alteration"));
              SCM scm_style = g->get_property ("style");
              if (!scm_is_symbol (scm_style)
-                 && !parens
-                 && scm_ilength (accs) == 1)
+                 && !to_boolean (g->get_property ("parenthesized"))
+                 && !to_boolean (g->get_property ("restore-first")))
                {
                  /* End copy accidental.cc */
-                 switch (scm_to_int (scm_car (accs)))
-                   {
-                   case FLAT:
-                   case DOUBLE_FLAT:
-                     xp = LEFT;
-                     break;
-                   case SHARP:
-                     xp = 0.5 * dir_;
-                     break;
-                   case NATURAL:
-                     xp = -dir_;
-                     break;
-                   }
+                 if (alt == FLAT_ALTERATION
+                     || alt == DOUBLE_FLAT_ALTERATION)
+                   xp = LEFT;
+                 else if (alt == SHARP_ALTERATION)
+                   xp = 0.5 * dir_;
+                 else if (alt == NATURAL_ALTERATION)
+                   xp = -dir_;
                }
            }