]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/tie.cc
Run grand replace for 2015.
[lilypond.git] / lily / tie.cc
index e8b21d8544bad329473b39445c5e80dadb973cf5..9bffbb3ce18fc2db80adb198c8d74730a929de14 100644 (file)
@@ -1,7 +1,7 @@
 /*
   This file is part of LilyPond, the GNU music typesetter.
 
-  Copyright (C) 1997--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
   LilyPond is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
@@ -60,8 +60,8 @@ Tie::head (Grob *me, Direction d)
       Direction hd = to_dir (me->get_property ("head-direction"));
 
       return (hd == d)
-       ? unsmob_grob (me->get_object ("note-head"))
-       : 0;
+             ? Grob::unsmob (me->get_object ("note-head"))
+             : 0;
     }
 
   Item *it = dynamic_cast<Spanner *> (me)->get_bound (d);
@@ -92,21 +92,19 @@ Tie::get_column_rank (Grob *me, Direction d)
 int
 Tie::get_position (Grob *me)
 {
-  Direction d = LEFT;
-  do
+  for (LEFT_and_RIGHT (d))
     {
       Grob *h = head (me, d);
       if (h)
-       return (int) rint (Staff_symbol_referencer::get_position (h));
+        return (int) rint (Staff_symbol_referencer::get_position (h));
     }
-  while (flip (&d) != LEFT);
 
   /*
     TODO: this is theoretically possible for ties across more than 2
     systems.. We should look at the first broken copy.
 
   */
-  programming_error ("Tie without heads. Suicide");
+  programming_error ("Tie without heads.  Suicide");
   me->suicide ();
   return 0;
 }
@@ -125,26 +123,24 @@ Direction
 Tie::get_default_dir (Grob *me)
 {
   Drul_array<Grob *> stems;
-  Direction d = LEFT;
-  do
+  for (LEFT_and_RIGHT (d))
     {
       Grob *one_head = head (me, d);
       if (!one_head && dynamic_cast<Spanner *> (me))
-       one_head = Tie::head (dynamic_cast<Spanner *> (me)->broken_neighbor (d), d);
+        one_head = Tie::head (dynamic_cast<Spanner *> (me)->broken_neighbor (d), d);
 
       Grob *stem = one_head ? Rhythmic_head::get_stem (one_head) : 0;
       if (stem)
-       stem = Stem::is_invisible (stem) ? 0 : stem;
+        stem = Stem::is_invisible (stem) ? 0 : stem;
 
       stems[d] = stem;
     }
-  while (flip (&d) != LEFT);
 
   if (stems[LEFT] && stems[RIGHT])
     {
       if (get_grob_direction (stems[LEFT]) == UP
-         && get_grob_direction (stems[RIGHT]) == UP)
-       return DOWN;
+          && get_grob_direction (stems[RIGHT]) == UP)
+        return DOWN;
     }
   else if (stems[LEFT] || stems[RIGHT])
     {
@@ -161,13 +157,13 @@ MAKE_SCHEME_CALLBACK (Tie, calc_direction, 1);
 SCM
 Tie::calc_direction (SCM smob)
 {
-  Grob *me = unsmob_grob (smob);
+  Grob *me = Grob::unsmob (smob);
   Grob *yparent = me->get_parent (Y_AXIS);
   if ((Tie_column::has_interface (yparent)
        || Semi_tie_column::has_interface (yparent))
-      && unsmob_grob_array (yparent->get_object ("ties"))
-      //      && unsmob_grob_array (yparent->get_object ("ties"))->size () > 1
-      )
+      && Grob_array::is_smob (yparent->get_object ("ties"))
+      //      && Grob_array::unsmob (yparent->get_object ("ties"))->size () > 1
+     )
     {
       /* trigger positioning. */
       (void) yparent->get_property ("positioning-done");
@@ -189,7 +185,6 @@ Tie::get_default_control_points (Grob *me_grob)
   Tie_formatting_problem problem;
   problem.from_tie (me);
 
-  Tie_specification spec = problem.get_tie_specification (0);
   if (!me->is_live ())
     return SCM_EOL;
 
@@ -197,14 +192,14 @@ Tie::get_default_control_points (Grob *me_grob)
     = problem.generate_optimal_configuration ();
 
   return get_control_points (me, problem.common_x_refpoint (),
-                            conf[0], problem.details_);
+                             conf[0], problem.details_);
 }
 
 SCM
 Tie::get_control_points (Grob *me,
-                        Grob *common,
-                        Tie_configuration const &conf,
-                        Tie_details const &details)
+                         Grob *common,
+                         Tie_configuration const &conf,
+                         Tie_details const &details)
 {
   Bezier b = conf.get_transformed_bezier (details);
   b.translate (Offset (- me->relative_coordinate (common, X_AXIS), 0));
@@ -213,7 +208,7 @@ Tie::get_control_points (Grob *me,
   for (int i = 4; i--;)
     {
       if (!b.control_[i].is_sane ())
-       programming_error ("Insane offset");
+        programming_error ("Insane offset");
       controls = scm_cons (ly_offset2scm (b.control_[i]), controls);
     }
   return controls;
@@ -223,20 +218,20 @@ MAKE_SCHEME_CALLBACK (Tie, calc_control_points, 1);
 SCM
 Tie::calc_control_points (SCM smob)
 {
-  Grob *me = unsmob_grob (smob);
+  Grob *me = Grob::unsmob (smob);
 
   Grob *yparent = me->get_parent (Y_AXIS);
   if ((Tie_column::has_interface (yparent)
        || Semi_tie_column::has_interface (yparent))
-      && unsmob_grob_array (yparent->get_object ("ties")))
+      && Grob_array::is_smob (yparent->get_object ("ties")))
     {
       extract_grob_set (yparent, "ties", ties);
       if (me->original () && ties.size () == 1
-         && !to_dir (me->get_property_data ("direction")))
-       {
-         assert (ties[0] == me);
-         set_grob_direction (me, Tie::get_default_dir (me));
-       }
+          && !to_dir (me->get_property_data ("direction")))
+        {
+          assert (ties[0] == me);
+          set_grob_direction (me, Tie::get_default_dir (me));
+        }
       /* trigger positioning. */
       (void) yparent->get_property ("positioning-done");
     }
@@ -255,7 +250,7 @@ MAKE_SCHEME_CALLBACK (Tie, print, 1);
 SCM
 Tie::print (SCM smob)
 {
-  Grob *me = unsmob_grob (smob);
+  Grob *me = Grob::unsmob (smob);
 
   SCM cp = me->get_property ("control-points");
 
@@ -275,9 +270,9 @@ Tie::print (SCM smob)
 
   SCM dash_definition = me->get_property ("dash-definition");
   a = Lookup::slur (b,
-                   get_grob_direction (me) * base_thick,
-                   line_thick,
-                   dash_definition);
+                    get_grob_direction (me) * base_thick,
+                    line_thick,
+                    dash_definition);
 
 #if DEBUG_TIE_SCORING
   SCM annotation = me->get_property ("annotation");
@@ -286,16 +281,16 @@ Tie::print (SCM smob)
       string str;
       SCM properties = Font_interface::text_font_alist_chain (me);
 
-      Stencil tm = *unsmob_stencil (Text_interface::interpret_markup
-                                   (me->layout ()->self_scm (), properties,
-                                    annotation));
+      Stencil tm = *Stencil::unsmob (Text_interface::interpret_markup
+                                    (me->layout ()->self_scm (), properties,
+                                     annotation));
       tm.translate (Offset (b.control_[3][X_AXIS] + 0.5,
-                           b.control_[0][Y_AXIS] * 2));
+                            b.control_[0][Y_AXIS] * 2));
       tm = tm.in_color (1, 0, 0);
 
       /*
-       It would be nice if we could put this in a different layer,
-       but alas, this must be done with a Tie override.
+        It would be nice if we could put this in a different layer,
+        but alas, this must be done with a Tie override.
       */
       a.add_stencil (tm);
     }
@@ -305,18 +300,112 @@ Tie::print (SCM smob)
 }
 
 ADD_INTERFACE (Tie,
-              "A horizontal curve connecting two noteheads.",
-
-              /* properties */
-              "annotation "
-              "avoid-slur "    //  UGH.
-              "control-points "
-              "dash-definition "
-              "details "
-              "direction "
-              "head-direction "
-              "line-thickness "
-              "neutral-direction "
-              "staff-position "
-              "thickness "
-              );
+               "A tie - a horizontal curve connecting two noteheads.\n"
+               "\n"
+               "The following properties may be set in the @code{details}"
+               " list.\n"
+               "\n"
+               "@table @code\n"
+               "@item height-limit\n"
+               "The maximum height allowed for this tie.\n"
+               "@item ratio\n"
+               "Parameter for tie shape. The higher this number, the"
+               " quicker the slur attains its height-limit.\n"
+               "@item between-length-limit\n"
+               "This detail is currently unused.\n"
+               "@item wrong-direction-offset-penalty\n"
+               "Demerit for ties that are offset in the wrong"
+               " direction.\n"
+               "@item min-length\n"
+               "If the tie is shorter than this amount (in"
+               " staff-spaces) an increasingly large length penalty is"
+               " incurred.\n"
+               "@item min-length-penalty-factor\n"
+               "Demerit factor for tie lengths shorter than"
+               " @code{min-length}.\n"
+               "@item center-staff-line-clearance\n"
+               "If the center of the tie is closer to a staff line"
+               " than this amount, an increasingly large staff line"
+               " collision penalty is incurred.\n"
+               "@item tip-staff-line-clearance\n"
+               "If the tips of the tie are closer to a staff line"
+               " than this amount, an increasingly large staff line"
+               " collision penalty is incurred.\n"
+               "@item staff-line-collision-penalty\n"
+               "Demerit factor for ties whose tips or center come"
+               " close to staff lines.\n"
+               "@item dot-collision-clearance\n"
+               "If the tie comes closer to a dot than this amount, an"
+               " increasingly large dot collision penalty is incurred.\n"
+               "@item dot-collision-penalty\n"
+               "Demerit factor for ties which come close to dots.\n"
+               "@item note-head-gap\n"
+               "The distance (in staff-spaces) by which the ends of"
+               " the tie are offset horizontally from the center"
+               " line through the note head.\n"
+               "@item stem-gap\n"
+               "The distance (in staff-spaces) by which the ends of"
+               " the tie are offset horizontally from a stem which"
+               " is on the same side of the note head as the tie.\n"
+               "@item tie-column-monotonicity-penalty\n"
+               "Demerit if the y-position of this tie in the set of"
+               " ties being considered is less than the y-position"
+               " of the previous tie.\n"
+               "@item tie-tie-collision-distance\n"
+               "If this tie is closer than this amount to the previous"
+               " tie in the set being considered, an increasingly"
+               " large tie-tie collision penalty is incurred.\n"
+               "@item tie-tie-collision-penalty\n"
+               "Demerit factor for a tie in the set being considered"
+               " which is close to the previous one.\n"
+               "@item horizontal-distance-penalty-factor\n"
+               "Demerit factor for ties in the set being considered"
+               " which are horizontally distant from the note heads.\n"
+               "@item vertical-distance-penalty-factor\n"
+               "Demerit factor for ties in the set being considered"
+               " which are vertically distant from the note heads.\n"
+               "@item same-dir-as-stem-penalty\n"
+               "Demerit if tie is on the same side as a stem or on the"
+               " opposite side to the one specified.\n"
+               "@item intra-space-threshold\n"
+               "If the tie's height (in half staff-spaces) is less than"
+               " this it is positioned between two adjacent staff"
+               " lines; otherwise it is positioned to straddle a staff"
+               " line further from the note heads.\n"
+               "@item outer-tie-length-symmetry-penalty-factor\n"
+               "Demerit factor for ties horizontally positioned"
+               " unsymmetrically with respect to the two note heads.\n"
+               "@item outer-tie-vertical-distance-symmetry-penalty-factor\n"
+               "Demerit factor for ties vertically positioned"
+               " unsymmetrically with respect to the two note heads.\n"
+               "@item outer-tie-vertical-gap\n"
+               "Amount (in half staff-spaces) by which a tie is moved"
+               " away from the note heads if it is closer to either"
+               " of them than 0.25 half staff-spaces.\n"
+               "@item skyline-padding\n"
+               "Padding of the skylines around note heads in chords.\n"
+               "@item single-tie-region-size\n"
+               "The number of candidate ties to generate when only a"
+               " single tie is required.  Successive candidates differ"
+               " in their initial vertical position by half a"
+               " staff-space.\n"
+               "@item multi-tie-region-size\n"
+               "The number of variations that are tried for the"
+               " extremal ties in a chord.  Variations differ in their"
+               " initial vertical position by half a staff-space.\n"
+
+               "@end table\n",
+
+               /* properties */
+               "annotation "
+               "avoid-slur "    //  UGH.
+               "control-points "
+               "dash-definition "
+               "details "
+               "direction "
+               "head-direction "
+               "line-thickness "
+               "neutral-direction "
+               "staff-position "
+               "thickness "
+              );