/*
- tie.cc -- implement Tie
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
+ Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
- (c) 1997--2007 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
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ LilyPond is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
*/
#include "tie.hh"
#include "paper-column.hh"
#include "pointer-group-interface.hh"
#include "rhythmic-head.hh"
+#include "semi-tie.hh"
#include "spanner.hh"
#include "staff-symbol-referencer.hh"
#include "stem.hh"
#include "warn.hh"
#include "semi-tie-column.hh"
-
bool
-Tie::less (Grob *const &s1, Grob *const &s2)
+Tie::less (Grob *g1, Grob *g2)
{
- return Tie::get_position (s1) < Tie::get_position (s2);
+ Spanner *s1 = dynamic_cast<Spanner *> (g1);
+ if (!s1)
+ {
+ g1->programming_error ("grob is not a tie");
+ return false;
+ }
+
+ Spanner *s2 = dynamic_cast<Spanner *> (g2);
+ if (!s2)
+ {
+ g2->programming_error ("grob is not a tie");
+ return true;
+ }
+
+ return get_position (s1) < get_position (s2);
}
void
-Tie::set_head (Grob *me, Direction d, Grob *h)
+Tie::set_head (Spanner *me, Direction d, Grob *h)
{
- dynamic_cast<Spanner *> (me)->set_bound (d, h);
+ me->set_bound (d, h);
}
-Grob *
-Tie::head (Grob *me, Direction d)
+Item *
+Tie::head (Spanner *me, Direction d)
{
- if (is_direction (me->get_property ("head-direction")))
- {
- Direction hd = to_dir (me->get_property ("head-direction"));
-
- return (hd == d)
- ? unsmob_grob (me->get_object ("note-head"))
- : 0;
- }
-
- Item *it = dynamic_cast<Spanner*> (me)->get_bound (d);
- if (Note_head::has_interface (it))
- return it;
- else
- return 0;
+ Item *it = me->get_bound (d);
+ return has_interface<Note_head> (it) ? it : 0;
}
int
-Tie::get_column_rank (Grob *me, Direction d)
+Tie::get_column_rank (Spanner *me, Direction d)
{
- Spanner *span = dynamic_cast<Spanner *> (me);
- Grob *h = head (me, d);
- if (!h)
- h = span->get_bound (d);
-
- Grob *col = dynamic_cast<Item *> (h)->get_column ();
- return Paper_column::get_rank (col);
+ return Paper_column::get_rank (me->get_bound (d)->get_column ());
}
int
-Tie::get_position (Grob *me)
+Tie::get_position (Spanner *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.
- 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;
}
(what about linebreaks? )
*/
Direction
-Tie::get_default_dir (Grob *me)
+Tie::get_default_dir (Spanner *me)
{
- Drul_array<Grob*> stems;
- Direction d = LEFT;
- do
+ Drul_array<Grob *> stems;
+ 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);
-
- Grob *stem = one_head ? Rhythmic_head::get_stem (one_head) : 0;
- if (stem)
- stem = Stem::is_invisible (stem) ? 0 : stem;
+ if (!one_head)
+ one_head = head (me->broken_neighbor (d), d);
- stems[d] = stem;
+ Grob *stem = one_head ? Rhythmic_head::get_stem (one_head) : 0;
+ stems[d] = (stem && !Stem::is_invisible (stem)) ? stem : 0;
}
- while (flip (&d)!= LEFT);
-
+
if (stems[LEFT] && stems[RIGHT])
{
if (get_grob_direction (stems[LEFT]) == UP
- && get_grob_direction (stems[RIGHT]) == UP)
- return DOWN;
- }
- else if (stems[LEFT] || stems[RIGHT])
- {
- Grob *s = stems[LEFT] ? stems[LEFT] : stems[RIGHT];
- return -get_grob_direction (s);
+ && get_grob_direction (stems[RIGHT]) == UP)
+ return DOWN;
+
+ // And why not return UP if both stems are DOWN?
+
+ // And when stems conflict, why fall directly through to using
+ // neutral-direction without considering get_position (me)?
}
+ else if (stems[LEFT])
+ return -get_grob_direction (stems[LEFT]);
+ else if (stems[RIGHT])
+ return -get_grob_direction (stems[RIGHT]);
else if (int p = get_position (me))
return Direction (sign (p));
-
- return to_dir (me->get_property("neutral-direction"));
-}
+ return to_dir (me->get_property ("neutral-direction"));
+}
MAKE_SCHEME_CALLBACK (Tie, calc_direction, 1);
SCM
Tie::calc_direction (SCM smob)
{
- Grob *me = unsmob_grob (smob);
+ // In this method, Tie and Semi_tie require the same logic with different
+ // types. It might be clearer to use a template.
+ Grob *me = unsmob<Grob> (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
- )
+ if ((has_interface<Tie_column> (yparent)
+ || has_interface<Semi_tie_column> (yparent))
+ && unsmob<Grob_array> (yparent->get_object ("ties"))
+ // && unsmob<Grob_array> (yparent->get_object ("ties"))->size () > 1
+ )
{
/* trigger positioning. */
(void) yparent->get_property ("positioning-done");
return me->get_property_data ("direction");
}
- else
- return scm_from_int (Tie::get_default_dir (me));
-}
+ programming_error ("no Tie_column or Semi_tie_column. Killing grob.");
+ me->suicide ();
+ return scm_from_int (CENTER);
+}
SCM
-Tie::get_default_control_points (Grob *me_grob)
+Tie::get_default_control_points (Spanner *me)
{
- Spanner *me = dynamic_cast<Spanner*> (me_grob);
- Grob *common = me;
- common = me->get_bound (LEFT)->common_refpoint (common, X_AXIS);
- common = me->get_bound (RIGHT)->common_refpoint (common, X_AXIS);
-
+ Grob *common = me;
+ common = me->get_bound (LEFT)->common_refpoint (common, X_AXIS);
+ common = me->get_bound (RIGHT)->common_refpoint (common, X_AXIS);
+
Tie_formatting_problem problem;
problem.from_tie (me);
-
- Tie_specification spec = problem.get_tie_specification (0);
+
if (!me->is_live ())
return SCM_EOL;
-
Ties_configuration conf
= 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));
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;
SCM
Tie::calc_control_points (SCM smob)
{
- Grob *me = unsmob_grob (smob);
+ Spanner *me = LY_ASSERT_SMOB(Spanner, smob, 1);
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")))
+ if ((has_interface<Tie_column> (yparent)
+ || has_interface<Semi_tie_column> (yparent))
+ && unsmob<Grob_array> (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));
-
- }
+ 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));
+ }
/* trigger positioning. */
(void) yparent->get_property ("positioning-done");
}
SCM cp = me->get_property_data ("control-points");
if (!scm_is_pair (cp))
- {
- cp = get_default_control_points (me);
- }
+ cp = get_default_control_points (me);
return cp;
}
/*
TODO: merge with Slur::print.
- */
+*/
MAKE_SCHEME_CALLBACK (Tie, print, 1);
SCM
Tie::print (SCM smob)
{
- Grob *me = unsmob_grob (smob);
-
+ Grob *me = unsmob<Grob> (smob);
+
SCM cp = me->get_property ("control-points");
Real staff_thick = Staff_symbol_referencer::line_thickness (me);
Stencil a;
- SCM p = me->get_property ("dash-period");
- SCM f = me->get_property ("dash-fraction");
- if (scm_is_number (p) && scm_is_number (f))
- a = Lookup::dashed_slur (b,
- line_thick,
- robust_scm2double (p, 1.0),
- robust_scm2double (f, 0));
- else
- a = Lookup::slur (b,
- get_grob_direction (me) * base_thick,
- line_thick);
+ SCM dash_definition = me->get_property ("dash-definition");
+ a = Lookup::slur (b,
+ get_grob_direction (me) * base_thick,
+ line_thick,
+ dash_definition);
#if DEBUG_TIE_SCORING
SCM annotation = me->get_property ("annotation");
- if (!scm_is_string (annotation))
- {
- SCM debug = me->layout ()->lookup_variable (ly_symbol2scm ("debug-tie-scoring"));
- if (to_boolean (debug))
- annotation = me->get_property ("quant-score");
- }
if (scm_is_string (annotation))
{
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 = *unsmob<Stencil> (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);
}
#endif
}
ADD_INTERFACE (Tie,
- "A horizontal curve connecting two noteheads.",
-
- /* properties */
- "annotation "
- "avoid-slur " // UGH.
- "control-points "
- "dash-fraction "
- "dash-period "
- "details "
- "direction "
- "head-direction "
- "line-thickness "
- "neutral-direction "
- "quant-score "
- "separation-item "
- "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 "
+ );
projects / lilypond.git / blobdiff