]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/paper-column.cc
unsmob_pitch -> Pitch::unsmob and related
[lilypond.git] / lily / paper-column.cc
index ac0e1fbde66b1adb2cabd745ddb90e1273d706f8..c6f8f0d742d6676c22478d9573112b113e18db0d 100644 (file)
@@ -1,7 +1,7 @@
 /*
   This file is part of LilyPond, the GNU music typesetter.
 
-  Copyright (C) 1997--2010 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  Copyright (C) 1997--2014 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
@@ -98,15 +98,15 @@ Paper_column::Paper_column (Paper_column const &src)
 
 int
 Paper_column::compare (Grob *const &a,
-                      Grob *const &b)
+                       Grob *const &b)
 {
   return sign (dynamic_cast<Paper_column *> (a)->rank_
-              - dynamic_cast<Paper_column *> (b)->rank_);
+               - dynamic_cast<Paper_column *> (b)->rank_);
 }
 
 bool
 Paper_column::less_than (Grob *const &a,
-                        Grob *const &b)
+                         Grob *const &b)
 {
   Paper_column *pa = dynamic_cast<Paper_column *> (a);
   Paper_column *pb = dynamic_cast<Paper_column *> (b);
@@ -118,7 +118,7 @@ Moment
 Paper_column::when_mom (Grob *me)
 {
   SCM m = me->get_property ("when");
-  if (Moment *when = unsmob_moment (m))
+  if (Moment *when = Moment::unsmob (m))
     return *when;
   return Moment (0);
 }
@@ -128,8 +128,8 @@ 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 (Moment::unsmob (m))
+    s = *Moment::unsmob (m);
   return s != Moment (0);
 }
 
@@ -149,6 +149,10 @@ Paper_column::is_used (Grob *me)
 
   if (to_boolean (me->get_property ("used")))
     return true;
+
+  if (scm_is_pair (me->get_property ("labels")))
+    return true;
+
   return false;
 }
 
@@ -164,14 +168,12 @@ Paper_column::minimum_distance (Grob *left, Grob *right)
   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"));
       if (sp)
-       skys[d] = (*sp)[-d];
+        skys[d] = (*sp)[-d];
     }
-  while (flip (&d) != LEFT);
 
   skys[RIGHT].merge (Separation_item::conditional_skyline (right, left));
 
@@ -194,20 +196,20 @@ Paper_column::break_align_width (Grob *me, SCM align_sym)
       || 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));
+                                            (align_sym == ly_symbol2scm ("staff-bar")
+                                             ? Bar_line::non_empty_barline
+                                             : Break_alignment_interface::has_interface));
   else
     {
       extract_grob_set (me, "elements", elts);
       for (vsize i = 0; i < elts.size (); i++)
-       {
-         if (elts[i]->get_property ("break-align-symbol") == align_sym)
-           {
-             align = elts[i];
-             break;
-           }
-       }
+        {
+          if (elts[i]->get_property ("break-align-symbol") == align_sym)
+            {
+              align = elts[i];
+              break;
+            }
+        }
     }
 
   if (!align)
@@ -217,51 +219,102 @@ Paper_column::break_align_width (Grob *me, SCM align_sym)
 }
 
 /*
-  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.
+*/
+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_SCHEME_CALLBACK (Paper_column, print, 1);
 SCM
 Paper_column::print (SCM p)
 {
-  Paper_column *me = dynamic_cast<Paper_column *> (unsmob_grob (p));
+  Paper_column *me = dynamic_cast<Paper_column *> (Grob::unsmob (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 = Moment::unsmob (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));
+                                                  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);
+                                                   properties,
+                                                   ly_string2scm (when));
+  Stencil t = *Stencil::unsmob (scm_mol);
+  t.scale (1.2, 1.4);
+  t.add_at_edge (Y_AXIS, DOWN, *Stencil::unsmob (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 ())
-       continue;
+      Spring *sp = Spring::unsmob (scm_caar (s));
+      if (!Grob::unsmob (scm_cdar (s))
+          || !Grob::unsmob (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 = Stencil::unsmob (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));
 
@@ -269,15 +322,10 @@ Paper_column::print (SCM p)
       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);
     }
 
@@ -285,13 +333,33 @@ Paper_column::print (SCM p)
        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 = Grob::unsmob (scm_caar (s));
       if (!other || other->get_system () != me->get_system ())
-       continue;
+        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 = Stencil::unsmob (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));
 
@@ -299,18 +367,10 @@ Paper_column::print (SCM p)
       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);
@@ -329,10 +389,10 @@ MAKE_SCHEME_CALLBACK (Paper_column, before_line_breaking, 1);
 SCM
 Paper_column::before_line_breaking (SCM grob)
 {
-  Grob *me = unsmob_grob (grob);
+  Grob *me = Grob::unsmob (grob);
 
   SCM bbm = me->get_object ("bounded-by-me");
-  Grob_array *ga = unsmob_grob_array (bbm);
+  Grob_array *ga = Grob_array::unsmob (bbm);
   if (!ga)
     return SCM_UNSPECIFIED;
 
@@ -343,8 +403,8 @@ Paper_column::before_line_breaking (SCM grob)
       Grob *g = array[i];
 
       if (!g || !g->is_live ())
-       /* UGH . potentially quadratic. */
-       array.erase (array.begin () + i);
+        /* UGH . potentially quadratic. */
+        array.erase (array.begin () + i);
     }
 
   return SCM_UNSPECIFIED;
@@ -368,47 +428,47 @@ Paper_column::is_extraneous_column_from_ligature (Grob *me)
   for (vsize i = 0; i < elts.size (); i++)
     {
       if (Rhythmic_head::has_interface (elts[i]))
-       {
-         has_notehead = true;
-         if (dynamic_cast<Item *> (elts[i])->get_column () == me)
-           return false;
-       }
+        {
+          has_notehead = true;
+          if (dynamic_cast<Item *> (elts[i])->get_column () == me)
+            return false;
+        }
     }
   return has_notehead;
 }
 
 ADD_INTERFACE (Paper_column,
-              "@code{Paper_column} objects form the top-most X@tie{}parents"
-              " for items.  There are two types of columns: musical and"
-              " non-musical, to which musical and non-musical objects are"
-              " attached respectively.  The spacing engine determines the"
-              " X@tie{}positions of these objects.\n"
-              "\n"
-              "They are numbered, the first (leftmost) is column@tie{}0."
-              "  Numbering happens before line breaking, and columns are not"
-              " renumbered after line breaking.  Since many columns go"
-              " unused, you should only use the rank field to get ordering"
-              " information.  Two adjacent columns may have non-adjacent"
-              " numbers.",
-
-              /* properties */
-              "between-cols "
-              "bounded-by-me "
-              "full-measure-extra-space "
-              "grace-spacing "
-              "labels "
-              "line-break-system-details "
-              "line-break-penalty "
-              "line-break-permission "
-              "maybe-loose "
-              "page-break-penalty "
-              "page-break-permission "
-              "page-turn-penalty "
-              "page-turn-permission "
-              "rhythmic-location "
-              "shortest-playing-duration "
-              "shortest-starter-duration "
-              "spacing "
-              "used "
-              "when ");
+               "@code{Paper_column} objects form the top-most X@tie{}parents"
+               " for items.  There are two types of columns: musical and"
+               " non-musical, to which musical and non-musical objects are"
+               " attached respectively.  The spacing engine determines the"
+               " X@tie{}positions of these objects.\n"
+               "\n"
+               "They are numbered, the first (leftmost) is column@tie{}0."
+               "  Numbering happens before line breaking, and columns are not"
+               " renumbered after line breaking.  Since many columns go"
+               " unused, you should only use the rank field to get ordering"
+               " information.  Two adjacent columns may have non-adjacent"
+               " numbers.",
+
+               /* properties */
+               "between-cols "
+               "bounded-by-me "
+               "full-measure-extra-space "
+               "grace-spacing "
+               "labels "
+               "line-break-system-details "
+               "line-break-penalty "
+               "line-break-permission "
+               "maybe-loose "
+               "page-break-penalty "
+               "page-break-permission "
+               "page-turn-penalty "
+               "page-turn-permission "
+               "rhythmic-location "
+               "shortest-playing-duration "
+               "shortest-starter-duration "
+               "spacing "
+               "used "
+               "when ");