]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/self-aligment-interface.cc
Cleanup and document scale-layout; mark cloned layout by setting
[lilypond.git] / lily / self-aligment-interface.cc
index ed66d30ef1a87ef8482e42b7ea53972453d5e7b4..47607b096f84ab1fbf4742a26314dca52fa79305 100644 (file)
@@ -1,30 +1,51 @@
 /*
-  self-alignment-interface.cc -- implement Self_alignment_interface
-  source file of the GNU LilyPond music typesetter
+  This file is part of LilyPond, the GNU music typesetter.
 
-  (c) 2004--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  Copyright (C) 2004--2010 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 "self-alignment-interface.hh"
+
 #include "warn.hh"
+#include "paper-column.hh"
+#include "grob.hh"
 
 MAKE_SCHEME_CALLBACK (Self_alignment_interface, y_aligned_on_self, 1);
 SCM
 Self_alignment_interface::y_aligned_on_self (SCM element)
 {
-  return aligned_on_self (unsmob_grob (element), Y_AXIS);
+  return aligned_on_self (unsmob_grob (element), Y_AXIS, false, 0, 0);
 }
 
 MAKE_SCHEME_CALLBACK (Self_alignment_interface, x_aligned_on_self, 1);
 SCM
 Self_alignment_interface::x_aligned_on_self (SCM element)
 {
-  return aligned_on_self (unsmob_grob (element), X_AXIS);
+  return aligned_on_self (unsmob_grob (element), X_AXIS, false, 0, 0);
+}
+
+MAKE_SCHEME_CALLBACK (Self_alignment_interface, pure_y_aligned_on_self, 3);
+SCM
+Self_alignment_interface::pure_y_aligned_on_self (SCM smob, SCM start, SCM end)
+{
+  return aligned_on_self (unsmob_grob (smob), Y_AXIS, true, robust_scm2int (start, 0), robust_scm2int (end, INT_MAX));
 }
 
 SCM
-Self_alignment_interface::aligned_on_self (Grob *me, Axis a)
+Self_alignment_interface::aligned_on_self (Grob *me, Axis a, bool pure, int start, int end)
 {
   SCM sym = (a == X_AXIS) ? ly_symbol2scm ("self-alignment-X")
     : ly_symbol2scm ("self-alignment-Y");
@@ -32,9 +53,9 @@ Self_alignment_interface::aligned_on_self (Grob *me, Axis a)
   SCM align (me->internal_get_property (sym));
   if (scm_is_number (align))
     {
-      Interval ext (me->extent (me, a));
+      Interval ext (me->maybe_pure_extent (me, a, pure, start, end));
       if (ext.is_empty ())
-       programming_error ("can't align on self: empty element");
+       programming_error ("cannot align on self: empty element");
       else
        return scm_from_double (- ext.linear_combination (scm_to_double (align)));
     }
@@ -43,12 +64,18 @@ Self_alignment_interface::aligned_on_self (Grob *me, Axis a)
 
 
 
+SCM
+Self_alignment_interface::centered_on_object (Grob *him, Axis a)
+{
+  return scm_from_double (robust_relative_extent (him, him, a).center ());
+}
+
 
 MAKE_SCHEME_CALLBACK (Self_alignment_interface, centered_on_x_parent, 1);
 SCM
 Self_alignment_interface::centered_on_x_parent (SCM smob)
 {
-  return centered_on_parent (unsmob_grob (smob), X_AXIS);
+  return centered_on_object (unsmob_grob (smob)->get_parent (X_AXIS), X_AXIS);
 }
 
 
@@ -56,16 +83,15 @@ MAKE_SCHEME_CALLBACK (Self_alignment_interface, centered_on_y_parent, 1);
 SCM
 Self_alignment_interface::centered_on_y_parent (SCM smob)
 {
-  return centered_on_parent (unsmob_grob (smob), Y_AXIS);
+  return centered_on_object (unsmob_grob (smob)->get_parent (Y_AXIS), Y_AXIS);
 }
 
+
+MAKE_SCHEME_CALLBACK (Self_alignment_interface, x_centered_on_y_parent, 1);
 SCM
-Self_alignment_interface::centered_on_parent (Grob *me, Axis a)
+Self_alignment_interface::x_centered_on_y_parent (SCM smob)
 {
-  Grob *him = me->get_parent (a);
-  Interval he = him->extent (him, a);
-
-  return scm_from_double (he.is_empty () ? 0.0 : he.center ());
+  return centered_on_object (unsmob_grob (smob)->get_parent (Y_AXIS), X_AXIS);
 }
 
 MAKE_SCHEME_CALLBACK (Self_alignment_interface, aligned_on_x_parent,1);
@@ -86,6 +112,9 @@ SCM
 Self_alignment_interface::aligned_on_parent (Grob *me, Axis a)
 {
   Grob *him = me->get_parent (a);
+  if (Paper_column::has_interface (him))
+    return scm_from_double (0.0);
+    
   Interval he = him->extent (him, a);
 
   SCM sym = (a == X_AXIS) ? ly_symbol2scm ("self-alignment-X")
@@ -100,7 +129,7 @@ Self_alignment_interface::aligned_on_parent (Grob *me, Axis a)
 
   Interval ext (me->extent (me, a));
   if (ext.is_empty ())
-    programming_error ("can't align on self: empty element");
+    programming_error ("cannot align on self: empty element");
   else
     x -= ext.linear_combination (align);
 
@@ -110,23 +139,38 @@ Self_alignment_interface::aligned_on_parent (Grob *me, Axis a)
   return scm_from_double (x);
 }
 
-ADD_INTERFACE (Self_alignment_interface, "self-alignment-interface",
-              "Position this object on itself and/or on its parent. To this end, the following functions "
-              " are provided: \n"
-              "@table @code \n"
-              "@item Self_alignment_interface::aligned_on_self\n"
-              "  Align self on reference point, using @code{self-alignment-X} and "
-              "@code{self-alignment-Y}."
-              "@item Self_alignment_interface::aligned_on_parent\n"
-              "@item Self_alignment_interface::centered_on_parent\n"
-              "  Shift the object so its own reference point is centered on the  "
-              " extent of the parent \n"
-              "@item Self_alignment_interface::centered_on_other_axis_parent\n"
-              " For X-axis, center on the Y-parent, and vice versa.\n "
-              "@end table\n",
+void
+Self_alignment_interface::set_center_parent (Grob *me, Axis a)
+{
+  add_offset_callback (me,
+                      (a==X_AXIS) ? centered_on_x_parent_proc : centered_on_y_parent_proc,
+                      a);
+}
 
+void
+Self_alignment_interface::set_align_self (Grob *me, Axis a)
+{
+  add_offset_callback (me,
+                      (a==X_AXIS) ? x_aligned_on_self_proc : y_aligned_on_self_proc,
+                      a);
+}
+
+ADD_INTERFACE (Self_alignment_interface,
+              "Position this object on itself and/or on its parent.  To this"
+              " end, the following functions are provided:\n"
+              "\n"
+              "@table @code\n"
+              "@item Self_alignment_interface::[xy]_aligned_on_self\n"
+              "Align self on reference point, using"
+              " @code{self-alignment-X} and @code{self-alignment-Y}."
+              "@item Self_alignment_interface::aligned_on_[xy]_parent\n"
+              "@item Self_alignment_interface::centered_on_[xy]_parent\n"
+              "Shift the object so its own reference point is centered on"
+              " the extent of the parent\n"
+              "@end table\n",
 
-              /* porperties */
+              /* properties */
               "self-alignment-X "
-              "self-alignment-Y ");
+              "self-alignment-Y "
+              );