/*
- self-alignment-interface.cc
-
- source file of the GNU LilyPond music typesetter
-
- (c) 2004--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ This file is part of LilyPond, the GNU music typesetter.
+
+ 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"
-/* Position centered on parent. */
-MAKE_SCHEME_CALLBACK (Self_alignment_interface, centered_on_parent, 2);
+MAKE_SCHEME_CALLBACK (Self_alignment_interface, y_aligned_on_self, 1);
SCM
-Self_alignment_interface::centered_on_parent (SCM element_smob, SCM axis)
+Self_alignment_interface::y_aligned_on_self (SCM element)
{
- Grob *me = unsmob_grob (element_smob);
- Axis a = (Axis) scm_to_int (axis);
- Grob *him = me->get_parent (a);
- Interval he = him->extent (him, a);
-
- return scm_make_real (he.is_empty () ? 0.0 : he.center ());
+ 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, 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, bool pure, int start, int end)
+{
+ SCM sym = (a == X_AXIS) ? ly_symbol2scm ("self-alignment-X")
+ : ly_symbol2scm ("self-alignment-Y");
+
+ SCM align (me->internal_get_property (sym));
+ if (scm_is_number (align))
+ {
+ Interval ext (me->maybe_pure_extent (me, a, pure, start, end));
+ if (ext.is_empty ())
+ programming_error ("cannot align on self: empty element");
+ else
+ return scm_from_double (- ext.linear_combination (scm_to_double (align)));
+ }
+ return scm_from_double (0.0);
+}
+
+
+
+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_object (unsmob_grob (smob)->get_parent (X_AXIS), X_AXIS);
+}
+
+
+MAKE_SCHEME_CALLBACK (Self_alignment_interface, centered_on_y_parent, 1);
+SCM
+Self_alignment_interface::centered_on_y_parent (SCM smob)
+{
+ 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::x_centered_on_y_parent (SCM smob)
+{
+ return centered_on_object (unsmob_grob (smob)->get_parent (Y_AXIS), X_AXIS);
}
-MAKE_SCHEME_CALLBACK (Self_alignment_interface, aligned_on_parent, 2);
+MAKE_SCHEME_CALLBACK (Self_alignment_interface, aligned_on_x_parent,1);
SCM
-Self_alignment_interface::aligned_on_parent (SCM element_smob, SCM axis)
+Self_alignment_interface::aligned_on_x_parent (SCM smob)
+{
+ return aligned_on_parent (unsmob_grob (smob), X_AXIS);
+}
+
+MAKE_SCHEME_CALLBACK (Self_alignment_interface, aligned_on_y_parent,1);
+SCM
+Self_alignment_interface::aligned_on_y_parent (SCM smob)
+{
+ return aligned_on_parent (unsmob_grob (smob), Y_AXIS);
+}
+
+SCM
+Self_alignment_interface::aligned_on_parent (Grob *me, Axis a)
{
- Grob *me = unsmob_grob (element_smob);
- Axis a = (Axis) scm_to_int (axis);
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")
: ly_symbol2scm ("self-alignment-Y");
SCM align_prop (me->internal_get_property (sym));
if (!scm_is_number (align_prop))
- return scm_int2num (0);
+ return scm_from_int (0);
Real x = 0.0;
Real align = scm_to_double (align_prop);
-
+
Interval ext (me->extent (me, a));
if (ext.is_empty ())
- programming_error ("I'm empty. Can't align on self");
+ programming_error ("cannot align on self: empty element");
else
- x -= ext.linear_combination (align) ;
+ x -= ext.linear_combination (align);
if (!he.is_empty ())
x += he.linear_combination (align);
- return scm_make_real (x);
+ return scm_from_double (x);
}
-/* Position centered on parent. */
-MAKE_SCHEME_CALLBACK (Self_alignment_interface, centered_on_other_axis_parent, 2);
-SCM
-Self_alignment_interface::centered_on_other_axis_parent (SCM element_smob,
- SCM axis)
+void
+Self_alignment_interface::set_center_parent (Grob *me, Axis a)
{
- Grob *me = unsmob_grob (element_smob);
- Axis a = (Axis) scm_to_int (axis);
- Grob *him = me->get_parent (other_axis (a));
- Interval he = him->extent (him, a);
-
- return scm_make_real (he.is_empty () ? 0.0 : he.center ());
+ add_offset_callback (me,
+ (a==X_AXIS) ? centered_on_x_parent_proc : centered_on_y_parent_proc,
+ a);
}
-/** callback that centers the element on itself
- Requires that self-alignment-{X, Y} be set. */
-MAKE_SCHEME_CALLBACK (Self_alignment_interface, aligned_on_self, 2);
-SCM
-Self_alignment_interface::aligned_on_self (SCM element_smob, SCM axis)
+void
+Self_alignment_interface::set_align_self (Grob *me, Axis a)
{
- Grob *me = unsmob_grob (element_smob);
- Axis a = (Axis) scm_to_int (axis);
-
- SCM sym = (a == X_AXIS) ? ly_symbol2scm ("self-alignment-X")
- : ly_symbol2scm ("self-alignment-Y");
-
- SCM align (me->internal_get_property (sym));
- if (scm_is_number (align))
- {
- Interval ext (me->extent (me, a));
- if (ext.is_empty ())
- programming_error ("I'm empty. Can't align on self");
- else
- return scm_make_real (- ext.linear_combination (scm_to_double (align)));
- }
- return scm_make_real (0.0);
+ 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",
-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",
- "self-alignment-X self-alignment-Y");
+ /* properties */
+ "self-alignment-X "
+ "self-alignment-Y "
+ );
projects / lilypond.git / blobdiff