]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/cluster.cc
unsmob_pitch -> Pitch::unsmob and related
[lilypond.git] / lily / cluster.cc
index b089e5cb5a3df58720a0c734f1c801b14a41ad29..b1e1f6aec106ccd336a7426f8c750978aaa746da 100644 (file)
@@ -1,32 +1,39 @@
 /*
-  cluster.cc -- implement Cluster
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 2002--2014 Juergen Reuter <reuter@ipd.uka.de>
+  Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 2002--2005 Juergen Reuter <reuter@ipd.uka.de>
+  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.
 
-  Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  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 "cluster.hh"
-
-#include <cstdio>
-using namespace std;
-
-#include "spanner.hh"
+#include "international.hh"
 #include "item.hh"
-#include "pitch.hh"
-#include "staff-symbol-referencer.hh"
 #include "lookup.hh"
 #include "output-def.hh"
-#include "warn.hh"
+#include "pitch.hh"
 #include "pointer-group-interface.hh"
+#include "spanner.hh"
+#include "staff-symbol-referencer.hh"
+#include "warn.hh"
 
 /*
   TODO: Add support for cubic spline segments.
-*/
+ */
 Stencil
-brew_cluster_piece (Grob *me, Array<Offset> bottom_points, Array<Offset> top_points)
+brew_cluster_piece (Grob *me, vector<Offset> bottom_points, vector<Offset> top_points)
 {
   Real blotdiameter = Staff_symbol_referencer::staff_space (me) / 2;
 
@@ -37,7 +44,7 @@ brew_cluster_piece (Grob *me, Array<Offset> bottom_points, Array<Offset> top_poi
   Offset hvpadding = 0.5 * hpadding + vpadding;
 
   SCM shape_scm = me->get_property ("style");
-  String shape;
+  string shape;
 
   if (scm_is_symbol (shape_scm))
     shape = ly_symbol2string (shape_scm);
@@ -49,76 +56,88 @@ brew_cluster_piece (Grob *me, Array<Offset> bottom_points, Array<Offset> top_poi
     }
 
   Stencil out;
-  Array<Offset> points;
+  vector<Offset> points;
   points.clear ();
   int size = bottom_points.size ();
-  if (String::compare (shape, "leftsided-stairs") == 0)
+  if (shape == "leftsided-stairs")
     {
       for (int i = 0; i < size - 1; i++)
-       {
-         Box box;
-         box.add_point (bottom_points[i] - hvpadding);
-         box.add_point (Offset (top_points[i + 1][X_AXIS],
-                                top_points[i][Y_AXIS]) + hvpadding);
-         out.add_stencil (Lookup::round_filled_box (box, blotdiameter));
-       }
+        {
+          Box box;
+          box.add_point (bottom_points[i] - hvpadding);
+          box.add_point (Offset (top_points[i + 1][X_AXIS],
+                                 top_points[i][Y_AXIS]) + hvpadding);
+          out.add_stencil (Lookup::round_filled_box (box, blotdiameter));
+        }
     }
-  else if (String::compare (shape, "rightsided-stairs") == 0)
+  else if (shape == "rightsided-stairs")
     {
       for (int i = 0; i < size - 1; i++)
-       {
-         Box box;
-         box.add_point (Offset (bottom_points[i][X_AXIS],
-                                bottom_points[i + 1][Y_AXIS]) - hvpadding);
-         box.add_point (top_points[i + 1] + hvpadding);
-         out.add_stencil (Lookup::round_filled_box (box, blotdiameter));
-       }
+        {
+          Box box;
+          box.add_point (Offset (bottom_points[i][X_AXIS],
+                                 bottom_points[i + 1][Y_AXIS]) - hvpadding);
+          box.add_point (top_points[i + 1] + hvpadding);
+          out.add_stencil (Lookup::round_filled_box (box, blotdiameter));
+        }
     }
-  else if (String::compare (shape, "centered-stairs") == 0)
+  else if (shape == "centered-stairs")
     {
       Real left_xmid = bottom_points[0][X_AXIS];
       for (int i = 0; i < size - 1; i++)
-       {
-         Real right_xmid
-           = 0.5 * (bottom_points[i][X_AXIS] + bottom_points[i + 1][X_AXIS]);
-         Box box;
-         box.add_point (Offset (left_xmid, bottom_points[i][Y_AXIS])
-                        - hvpadding);
-         box.add_point (Offset (right_xmid, top_points[i][Y_AXIS])
-                        + hvpadding);
-         out.add_stencil (Lookup::round_filled_box (box, blotdiameter));
-         left_xmid = right_xmid;
-       }
+        {
+          Real right_xmid
+            = 0.5 * (bottom_points[i][X_AXIS] + bottom_points[i + 1][X_AXIS]);
+          Box box;
+          box.add_point (Offset (left_xmid, bottom_points[i][Y_AXIS])
+                         - hvpadding);
+          box.add_point (Offset (right_xmid, top_points[i][Y_AXIS])
+                         + hvpadding);
+          out.add_stencil (Lookup::round_filled_box (box, blotdiameter));
+          left_xmid = right_xmid;
+        }
       Real right_xmid = bottom_points[size - 1][X_AXIS];
       Box box;
       box.add_point (Offset (left_xmid, bottom_points[size - 1][Y_AXIS])
-                    - hvpadding);
+                     - hvpadding);
       box.add_point (Offset (right_xmid, top_points[size - 1][Y_AXIS])
-                    + hvpadding);
+                     + hvpadding);
       out.add_stencil (Lookup::round_filled_box (box, blotdiameter));
     }
-  else if (String::compare (shape, "ramp") == 0)
+  else if (shape == "ramp")
     {
-      points.push (bottom_points[0] - vpadding + hpadding);
+      points.push_back (bottom_points[0] - vpadding + hpadding);
       for (int i = 1; i < size - 1; i++)
-       points.push (bottom_points[i] - vpadding);
-      points.push (bottom_points[size - 1] - vpadding - hpadding);
-      points.push (top_points[size - 1] + vpadding - hpadding);
+        points.push_back (bottom_points[i] - vpadding);
+      points.push_back (bottom_points[size - 1] - vpadding - hpadding);
+      points.push_back (top_points[size - 1] + vpadding - hpadding);
       for (int i = size - 2; i > 0; i--)
-       points.push (top_points[i] + vpadding);
-      points.push (top_points[0] + vpadding + hpadding);
+        points.push_back (top_points[i] + vpadding);
+      points.push_back (top_points[0] + vpadding + hpadding);
       out.add_stencil (Lookup::round_filled_polygon (points, blotdiameter));
     }
   else
-    me->warning (_f ("unknown cluster style `%s'", shape.to_str0 ()));
+    me->warning (_f ("unknown cluster style `%s'", shape.c_str ()));
   return out;
 }
 
+MAKE_SCHEME_CALLBACK (Cluster, calc_cross_staff, 1);
+SCM
+Cluster::calc_cross_staff (SCM smob)
+{
+  Grob *me = Grob::unsmob (smob);
+
+  extract_grob_set (me, "columns", cols);
+  Grob *commony = common_refpoint_of_array (cols, me, Y_AXIS);
+
+  return scm_from_bool (commony != me->get_parent (Y_AXIS));
+}
+
 MAKE_SCHEME_CALLBACK (Cluster, print, 1);
 SCM
 Cluster::print (SCM smob)
 {
-  Grob *me = unsmob_grob (smob);
+  Grob *me = Grob::unsmob (smob);
 
   Spanner *spanner = dynamic_cast<Spanner *> (me);
   if (!spanner)
@@ -132,8 +151,8 @@ Cluster::print (SCM smob)
 
   Grob *commonx = left_bound->common_refpoint (right_bound, X_AXIS);
 
-  Link_array<Grob> const &cols = extract_grob_array (me, "columns");
-  if (cols.is_empty ())
+  vector<Grob *> const &cols = extract_grob_array (me, "columns");
+  if (cols.empty ())
     {
       me->warning (_ ("junking empty cluster"));
       me->suicide ();
@@ -143,8 +162,8 @@ Cluster::print (SCM smob)
 
   commonx = common_refpoint_of_array (cols, commonx, X_AXIS);
   Grob *commony = common_refpoint_of_array (cols, me, Y_AXIS);
-  Array<Offset> bottom_points;
-  Array<Offset> top_points;
+  vector<Offset> bottom_points;
+  vector<Offset> top_points;
 
   Real left_coord = left_bound->relative_coordinate (commonx, X_AXIS);
 
@@ -153,79 +172,80 @@ Cluster::print (SCM smob)
     line with the center of the note heads?
 
   */
-  for (int i = 0; i < cols.size (); i++)
+  for (vsize i = 0; i < cols.size (); i++)
     {
       Grob *col = cols[i];
 
       Interval yext = col->extent (commony, Y_AXIS);
 
       Real x = col->relative_coordinate (commonx, X_AXIS) - left_coord;
-      bottom_points.push (Offset (x, yext[DOWN]));
-      top_points.push (Offset (x, yext[UP]));
+      bottom_points.push_back (Offset (x, yext[DOWN]));
+      top_points.push_back (Offset (x, yext[UP]));
     }
 
   /*
     Across a line break we anticipate on the next pitches.
   */
-  if (spanner->original_)
+  if (Spanner *next = spanner->broken_neighbor (RIGHT))
     {
-      Spanner *orig = dynamic_cast<Spanner *> (spanner->original_);
-
-      if (spanner->get_break_index () < orig->broken_intos_.size () - 1)
-       {
-         Spanner *next = orig->broken_intos_[spanner->get_break_index () + 1];
-         Link_array<Grob> const &next_cols = extract_grob_array (next, "columns");
-         if (next_cols.size () > 0)
-           {
-             Grob *next_commony = common_refpoint_of_array (next_cols, next, Y_AXIS);
-             Grob *col = next_cols[0];
-
-             Interval v = col->extent (next_commony, Y_AXIS);
-             Real x = right_bound->relative_coordinate (commonx, X_AXIS) - left_coord;
-
-             bottom_points.insert (Offset (x, v[DOWN]), 0);
-             top_points.insert (Offset (x, v[UP]), 0);
-           }
-       }
+      extract_grob_set (next, "columns", next_cols);
+      if (next_cols.size () > 0)
+        {
+          Grob *next_commony = common_refpoint_of_array (next_cols, next, Y_AXIS);
+          Grob *col = next_cols[0];
+
+          Interval v = col->extent (next_commony, Y_AXIS);
+          Real x = right_bound->relative_coordinate (commonx, X_AXIS) - left_coord;
+
+          bottom_points.push_back (Offset (x, v[DOWN]));
+          top_points.push_back (Offset (x, v[UP]));
+        }
     }
 
-  bottom_points.reverse ();
-  top_points.reverse ();
-
   Stencil out = brew_cluster_piece (me, bottom_points, top_points);
   out.translate_axis (- me->relative_coordinate (commony, Y_AXIS), Y_AXIS);
   return out.smobbed_copy ();
 }
 
-ADD_INTERFACE (Cluster, "cluster-interface",
-              "A graphically drawn musical cluster. "
-              "\n\n"
-              "@code{padding} adds to the vertical extent of the shape (top and "
-              "bottom). \n\n"
-              "The property @code{style} controls the shape of cluster segments.  Valid values "
-              "include @code{leftsided-stairs}, @code{rightsided-stairs}, @code{centered-stairs}, "
-              "and @code{ramp}.\n",
-              "style padding columns");
+ADD_INTERFACE (Cluster,
+               "A graphically drawn musical cluster.\n"
+               "\n"
+               "@code{padding} adds to the vertical extent of the shape (top"
+               " and bottom).\n"
+               "\n"
+               "The property @code{style} controls the shape of cluster"
+               " segments.  Valid values include @code{leftsided-stairs},"
+               " @code{rightsided-stairs}, @code{centered-stairs}, and"
+               " @code{ramp}.\n",
+
+               /* properties */
+               "style "
+               "padding "
+               "columns "
+              );
 
 struct Cluster_beacon
 {
 public:
-  DECLARE_SCHEME_CALLBACK (height, (SCM, SCM));
-  static bool has_interface (Grob *);
+  DECLARE_SCHEME_CALLBACK (height, (SCM));
+  DECLARE_GROB_INTERFACE ();
 };
 
-MAKE_SCHEME_CALLBACK (Cluster_beacon, height, 2);
+MAKE_SCHEME_CALLBACK (Cluster_beacon, height, 1);
 SCM
-Cluster_beacon::height (SCM g, SCM)
+Cluster_beacon::height (SCM g)
 {
-  Grob *me = unsmob_grob (g);
+  Grob *me = Grob::unsmob (g);
   Interval v = robust_scm2interval (me->get_property ("positions"),
-                                   Interval (0, 0));
+                                    Interval (0, 0));
   return ly_interval2scm (Staff_symbol_referencer::staff_space (me) * 0.5 * v);
 }
 
 ADD_INTERFACE (Cluster_beacon,
-              "cluster-beacon-interface",
-              "A place holder for the cluster spanner to determine the vertical "
-              "extents of a cluster spanner at this X position.",
-              "positions");
+               "A place holder for the cluster spanner to determine the"
+               " vertical extents of a cluster spanner at this"
+               " X@tie{}position.",
+
+               /* properties */
+               "positions "
+              );