/*
This file is part of LilyPond, the GNU music typesetter.
- Copyright (C) 1997--2012 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
#include "font-interface.hh"
#include "grob-array.hh"
#include "lookup.hh"
-#include "lookup.hh"
#include "moment.hh"
#include "output-def.hh"
#include "paper-score.hh"
Paper_column::when_mom (Grob *me)
{
SCM m = me->get_property ("when");
- if (Moment *when = unsmob_moment (m))
+ if (Moment *when = unsmob<Moment> (m))
return *when;
return Moment (0);
}
-bool
-Paper_column::is_loose (Grob *g)
-{
- return (scm_is_pair (g->get_object ("between-cols")));
-}
-
bool
Paper_column::is_musical (Grob *me)
{
SCM m = me->get_property ("shortest-starter-duration");
Moment s (0);
- if (unsmob_moment (m))
- s = *unsmob_moment (m);
+ if (unsmob<Moment> (m))
+ s = *unsmob<Moment> (m);
return s != Moment (0);
}
Drul_array<Grob *> cols (left, right);
Drul_array<Skyline> skys = Drul_array<Skyline> (Skyline (RIGHT), Skyline (LEFT));
- Direction d = LEFT;
- do
+ for (LEFT_and_RIGHT (d))
{
- Skyline_pair *sp = Skyline_pair::unsmob (cols[d]->get_property ("horizontal-skylines"));
+ Skyline_pair *sp = unsmob<Skyline_pair> (cols[d]->get_property ("horizontal-skylines"));
if (sp)
skys[d] = (*sp)[-d];
}
- while (flip (&d) != LEFT);
skys[RIGHT].merge (Separation_item::conditional_skyline (right, left));
}
Interval
-Paper_column::break_align_width (Grob *me, SCM align_sym)
+Paper_column::break_align_width (Grob *me, SCM align_syms)
{
Grob *p = me->get_parent (X_AXIS);
+ if (scm_is_symbol (align_syms))
+ align_syms = scm_list_1 (align_syms);
+
if (is_musical (me))
{
me->programming_error ("tried to get break-align-width of a musical column");
}
Grob *align = 0;
- if (align_sym == ly_symbol2scm ("staff-bar")
- || align_sym == ly_symbol2scm ("break-alignment"))
- align
- = Pointer_group_interface::find_grob (me, ly_symbol2scm ("elements"),
- (align_sym == ly_symbol2scm ("staff-bar")
- ? Bar_line::non_empty_barline
- : Break_alignment_interface::has_interface));
- else
+ for (;!align && scm_is_pair (align_syms); align_syms = scm_cdr (align_syms))
{
- extract_grob_set (me, "elements", elts);
- for (vsize i = 0; i < elts.size (); i++)
+ SCM align_sym = scm_car (align_syms);
+ if (scm_is_eq (align_sym, ly_symbol2scm ("staff-bar"))
+ || scm_is_eq (align_sym, ly_symbol2scm ("break-alignment")))
+ align = Pointer_group_interface::find_grob
+ (me, ly_symbol2scm ("elements"),
+ (scm_is_eq (align_sym, ly_symbol2scm ("staff-bar"))
+ ? Bar_line::non_empty_barline
+ : has_interface<Break_alignment_interface>));
+ else
{
- if (elts[i]->get_property ("break-align-symbol") == align_sym)
+ extract_grob_set (me, "elements", elts);
+ for (vsize i = 0; i < elts.size (); i++)
{
- align = elts[i];
- break;
+ if (elts[i]->get_property ("break-align-symbol") == align_sym
+ && !elts[i]->extent (elts[i], X_AXIS).is_empty ())
+ {
+ align = elts[i];
+ break;
+ }
}
}
}
}
/*
- Print a vertical line and the rank number, to aid debugging.
+ Loop through elements of a PaperColumn, find all grobs implementing specified
+ interface and return their combined extent.
*/
-MAKE_SCHEME_CALLBACK (Paper_column, print, 1);
+Interval
+Paper_column::get_interface_extent (Grob *column, SCM iface, Axis a)
+{
+ Interval extent = Interval (0, 0);
+ extract_grob_set (column, "elements", elts);
+
+ for (vsize i = 0; i < elts.size (); i++)
+ if (elts[i]->internal_has_interface (iface))
+ extent.unite (robust_relative_extent (elts[i], elts[i], a));
+
+ return extent;
+}
+
+/*
+ Print a:
+ - vertical line,
+ - the rank number,
+ - rank moment,
+ - blue arrow representing ideal distance,
+ - red arrow representing minimum distance
+ to aid debugging. To turn this on, simply add
+ \override Score.PaperColumn #'stencil = #ly:paper-column::print
+ \override Score.NonMusicalPaperColumn #'stencil = #ly:paper-column::print
+ to your score.
+ Also, as of 2013-10-16 there's a switch in Frescobaldi that turns this on.
+*/
+MAKE_DOCUMENTED_SCHEME_CALLBACK (Paper_column, print, 1,
+ "Optional stencil for @code{PaperColumn} or"
+ "@code{NonMusicalPaperColumn}.\n"
+ "Draws the @code{rank number} of each column,"
+ " its moment in time, a blue arrow showing the"
+ " ideal distance, and a red arrow showing the"
+ " minimum distance between columns.");
SCM
Paper_column::print (SCM p)
{
- Paper_column *me = dynamic_cast<Paper_column *> (unsmob_grob (p));
+ Paper_column *me = unsmob<Paper_column> (p);
- string r = to_string (Paper_column::get_rank (me));
+ string r = ::to_string (Paper_column::get_rank (me));
- Moment *mom = unsmob_moment (me->get_property ("when"));
+ Moment *mom = unsmob<Moment> (me->get_property ("when"));
string when = mom ? mom->to_string () : "?/?";
Font_metric *musfont = Font_interface::get_default_font (me);
SCM properties = Font_interface::text_font_alist_chain (me);
-
SCM scm_mol = Text_interface::interpret_markup (me->layout ()->self_scm (),
properties,
ly_string2scm (r));
SCM when_mol = Text_interface::interpret_markup (me->layout ()->self_scm (),
properties,
ly_string2scm (when));
- Stencil t = *unsmob_stencil (scm_mol);
- t.add_at_edge (Y_AXIS, DOWN, *unsmob_stencil (when_mol), 0.1);
- t.align_to (X_AXIS, CENTER);
+ Stencil t = *unsmob<Stencil> (scm_mol);
+ t.scale (1.2, 1.4);
+ t.add_at_edge (Y_AXIS, DOWN, *unsmob<Stencil> (when_mol), 0.1);
+ t.align_to (X_AXIS, LEFT);
+ // compensate for font serifs and half letter-distance
+ t.translate (Offset (-0.1, 0));
t.align_to (Y_AXIS, DOWN);
- Stencil l = Lookup::filled_box (Box (Interval (-0.01, 0.01),
- Interval (-2, -1)));
+ Stencil l = Lookup::filled_box (Box (Interval (0, 0.02),
+ Interval (-8, -1)));
- SCM small_letters = scm_cons (scm_acons (ly_symbol2scm ("font-size"),
- scm_from_int (-6), SCM_EOL),
- properties);
+ Real small_pad = 0.15;
+ Real big_pad = 0.35;
+ // number of printed arrows from *both* loops
int j = 0;
+
for (SCM s = me->get_object ("ideal-distances");
scm_is_pair (s); s = scm_cdr (s))
{
- Spring *sp = unsmob_spring (scm_caar (s));
- if (!unsmob_grob (scm_cdar (s))
- || !unsmob_grob (scm_cdar (s))->get_system ())
+ Spring *sp = unsmob<Spring> (scm_caar (s));
+ if (!unsmob<Grob> (scm_cdar (s))
+ || !unsmob<Grob> (scm_cdar (s))->get_system ())
continue;
j++;
- Real y = -j * 1 - 3;
+
+ Stencil arrowhead (musfont->find_by_name ("arrowheads.open.01"));
+ // initial scaling; it will also scale with font-size.
+ arrowhead.scale (1, 1.66);
+ Real head_len = arrowhead.extent (X_AXIS).length ();
+
+ SCM stil = Text_interface::interpret_markup (me->layout ()->self_scm (),
+ properties,
+ ly_string2scm (String_convert::form_string ("%5.2lf", sp->distance ())));
+ Stencil *number_stc = unsmob<Stencil> (stil);
+ number_stc->scale (1, 1.1);
+ Real num_height = number_stc->extent (Y_AXIS).length ();
+ Real num_len = number_stc->extent (X_AXIS).length ();
+ number_stc->align_to (Y_AXIS, DOWN);
+
+ // arrow's y-coord relative to the top of l stencil:
+ Real y = -2.5;
+ y -= j * (num_height + small_pad + big_pad);
+ // horizontally center number on the arrow, excluding arrowhead.
+ Offset num_off = Offset ((sp->distance () - num_len - head_len) / 2,
+ y + small_pad);
+
vector<Offset> pts;
pts.push_back (Offset (0, y));
pts.push_back (p2);
Stencil id_stencil = Lookup::points_to_line_stencil (0.1, pts);
- Stencil head (musfont->find_by_name ("arrowheads.open.01"));
-
- SCM distance_stc = Text_interface::interpret_markup (me->layout ()->self_scm (),
- small_letters,
- ly_string2scm (String_convert::form_string ("%5.2lf", sp->distance ())));
-
- id_stencil.add_stencil (unsmob_stencil (distance_stc)->translated (Offset (sp->distance () / 3, y + 1)));
- id_stencil.add_stencil (head.translated (p2));
- id_stencil = id_stencil.in_color (0, 0, 1);
+ id_stencil.add_stencil (arrowhead.translated (p2));
+ id_stencil.add_stencil (number_stc->translated (num_off));
+ // use a lighter shade of blue so it will remain legible on black background.
+ id_stencil = id_stencil.in_color (0.2, 0.4, 1);
l.add_stencil (id_stencil);
}
scm_is_pair (s); s = scm_cdr (s))
{
Real dist = scm_to_double (scm_cdar (s));
- Grob *other = unsmob_grob (scm_caar (s));
+ Grob *other = unsmob<Grob> (scm_caar (s));
if (!other || other->get_system () != me->get_system ())
continue;
j++;
- Real y = -j * 1.0 - 3.5;
+ Stencil arrowhead (musfont->find_by_name ("arrowheads.open.01"));
+ // initial scaling; it will also scale with font-size.
+ arrowhead.scale (1, 1.66);
+ Real head_len = arrowhead.extent (X_AXIS).length ();
+
+ SCM stil = Text_interface::interpret_markup (me->layout ()->self_scm (),
+ properties,
+ ly_string2scm (String_convert::form_string ("%5.2lf", dist)));
+ Stencil *number_stc = unsmob<Stencil> (stil);
+ number_stc->scale (1, 1.1);
+ Real num_height = number_stc->extent (Y_AXIS).length ();
+ Real num_len = number_stc->extent (X_AXIS).length ();
+ number_stc->align_to (Y_AXIS, UP);
+
+ // arrow's y-coord relative to the top of l stencil:
+ Real y = -3;
+ y -= j * (num_height + small_pad + big_pad);
+ // horizontally center number on the arrow, excluding arrowhead.
+ Offset num_off = Offset ((dist - num_len - head_len) / 2,
+ y - small_pad);
+
vector<Offset> pts;
pts.push_back (Offset (0, y));
pts.push_back (p2);
Stencil id_stencil = Lookup::points_to_line_stencil (0.1, pts);
- Stencil head (musfont->find_by_name ("arrowheads.open.0M1"));
- head.translate_axis (y, Y_AXIS);
- id_stencil.add_stencil (head);
-
- SCM distance_stc = Text_interface::interpret_markup (me->layout ()->self_scm (),
- small_letters,
- ly_string2scm (String_convert::form_string ("%5.2lf",
- dist)));
-
- id_stencil.add_stencil (unsmob_stencil (distance_stc)->translated (Offset (dist / 3, y - 1)));
-
- id_stencil = id_stencil.in_color (1, 0, 0);
+ id_stencil.add_stencil (arrowhead.translated (p2));
+ id_stencil.add_stencil (number_stc->translated (num_off));
+ // use a lighter shade of red so it will remain legible on black background.
+ id_stencil = id_stencil.in_color (1, 0.25, 0.25);
l.add_stencil (id_stencil);
}
t.add_stencil (l);
return t.smobbed_copy ();
}
+static bool grob_is_live (const Grob *g)
+{
+ return g && g->is_live ();
+}
+
/*
This is all too hairy. We use bounded-by-me to make sure that some
columns are kept "alive". Unfortunately, when spanners are suicided,
SCM
Paper_column::before_line_breaking (SCM grob)
{
- Grob *me = unsmob_grob (grob);
-
- SCM bbm = me->get_object ("bounded-by-me");
- Grob_array *ga = unsmob_grob_array (bbm);
- if (!ga)
- return SCM_UNSPECIFIED;
+ Grob *me = unsmob<Grob> (grob);
- vector<Grob *> &array (ga->array_reference ());
-
- for (vsize i = array.size (); i--;)
- {
- Grob *g = array[i];
-
- if (!g || !g->is_live ())
- /* UGH . potentially quadratic. */
- array.erase (array.begin () + i);
- }
+ if (Grob_array *ga = unsmob<Grob_array> (me->get_object ("bounded-by-me")))
+ ga->filter (grob_is_live);
return SCM_UNSPECIFIED;
}
bool has_notehead = false;
for (vsize i = 0; i < elts.size (); i++)
{
- if (Rhythmic_head::has_interface (elts[i]))
+ if (has_interface<Rhythmic_head> (elts[i]))
{
has_notehead = true;
if (dynamic_cast<Item *> (elts[i])->get_column () == me)