lily/self-alignment-interface.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2004--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include "self-alignment-interface.hh"
  21
  22 #include "grob.hh"
  23 #include "paper-column.hh"
  24 #include "warn.hh"
  25
  26 MAKE_SCHEME_CALLBACK (Self_alignment_interface, y_aligned_on_self, 1);
  27 SCM
  28 Self_alignment_interface::y_aligned_on_self (SCM element)
  29 {
  30   return aligned_on_self (unsmob_grob (element), Y_AXIS, false, 0, 0);
  31 }
  32
  33 MAKE_SCHEME_CALLBACK (Self_alignment_interface, x_aligned_on_self, 1);
  34 SCM
  35 Self_alignment_interface::x_aligned_on_self (SCM element)
  36 {
  37   return aligned_on_self (unsmob_grob (element), X_AXIS, false, 0, 0);
  38 }
  39
  40 MAKE_SCHEME_CALLBACK (Self_alignment_interface, pure_y_aligned_on_self, 3);
  41 SCM
  42 Self_alignment_interface::pure_y_aligned_on_self (SCM smob, SCM start, SCM end)
  43 {
  44   return aligned_on_self (unsmob_grob (smob), Y_AXIS, true, robust_scm2int (start, 0), robust_scm2int (end, INT_MAX));
  45 }
  46
  47 SCM
  48 Self_alignment_interface::aligned_on_self (Grob *me, Axis a, bool pure, int start, int end)
  49 {
  50   SCM sym = (a == X_AXIS) ? ly_symbol2scm ("self-alignment-X")
  51             : ly_symbol2scm ("self-alignment-Y");
  52
  53   SCM align (me->internal_get_property (sym));
  54   if (scm_is_number (align))
  55     {
  56       Interval ext (me->maybe_pure_extent (me, a, pure, start, end));
  57       if (ext.is_empty ())
  58         programming_error ("cannot align on self: empty element");
  59       else
  60         return scm_from_double (- ext.linear_combination (scm_to_double (align)));
  61     }
  62   return scm_from_double (0.0);
  63 }
  64
  65 SCM
  66 Self_alignment_interface::centered_on_object (Grob *him, Axis a)
  67 {
  68   return scm_from_double (robust_relative_extent (him, him, a).center ());
  69 }
  70
  71 MAKE_SCHEME_CALLBACK (Self_alignment_interface, centered_on_x_parent, 1);
  72 SCM
  73 Self_alignment_interface::centered_on_x_parent (SCM smob)
  74 {
  75   return centered_on_object (unsmob_grob (smob)->get_parent (X_AXIS), X_AXIS);
  76 }
  77
  78 MAKE_SCHEME_CALLBACK (Self_alignment_interface, centered_on_y_parent, 1);
  79 SCM
  80 Self_alignment_interface::centered_on_y_parent (SCM smob)
  81 {
  82   return centered_on_object (unsmob_grob (smob)->get_parent (Y_AXIS), Y_AXIS);
  83 }
  84
  85 MAKE_SCHEME_CALLBACK (Self_alignment_interface, x_centered_on_y_parent, 1);
  86 SCM
  87 Self_alignment_interface::x_centered_on_y_parent (SCM smob)
  88 {
  89   return centered_on_object (unsmob_grob (smob)->get_parent (Y_AXIS), X_AXIS);
  90 }
  91
  92 MAKE_SCHEME_CALLBACK (Self_alignment_interface, aligned_on_x_parent, 1);
  93 SCM
  94 Self_alignment_interface::aligned_on_x_parent (SCM smob)
  95 {
  96   return aligned_on_parent (unsmob_grob (smob), X_AXIS);
  97 }
  98
  99 MAKE_SCHEME_CALLBACK (Self_alignment_interface, aligned_on_y_parent, 1);
 100 SCM
 101 Self_alignment_interface::aligned_on_y_parent (SCM smob)
 102 {
 103   return aligned_on_parent (unsmob_grob (smob), Y_AXIS);
 104 }
 105
 106 SCM
 107 Self_alignment_interface::aligned_on_parent (Grob *me, Axis a)
 108 {
 109   Grob *him = me->get_parent (a);
 110   if (Paper_column::has_interface (him))
 111     return scm_from_double (0.0);
 112
 113   Interval he = him->extent (him, a);
 114
 115   SCM sym = (a == X_AXIS) ? ly_symbol2scm ("self-alignment-X")
 116             : ly_symbol2scm ("self-alignment-Y");
 117   SCM align_prop (me->internal_get_property (sym));
 118
 119   if (!scm_is_number (align_prop))
 120     return scm_from_int (0);
 121
 122   Real x = 0.0;
 123   Real align = scm_to_double (align_prop);
 124
 125   Interval ext (me->extent (me, a));
 126   if (ext.is_empty ())
 127     programming_error ("cannot align on self: empty element");
 128   else
 129     x -= ext.linear_combination (align);
 130
 131   if (!he.is_empty ())
 132     x += he.linear_combination (align);
 133
 134   return scm_from_double (x);
 135 }
 136
 137 void
 138 Self_alignment_interface::set_center_parent (Grob *me, Axis a)
 139 {
 140   add_offset_callback (me,
 141                        (a == X_AXIS) ? centered_on_x_parent_proc : centered_on_y_parent_proc,
 142                        a);
 143 }
 144
 145 void
 146 Self_alignment_interface::set_align_self (Grob *me, Axis a)
 147 {
 148   add_offset_callback (me,
 149                        (a == X_AXIS) ? x_aligned_on_self_proc : y_aligned_on_self_proc,
 150                        a);
 151 }
 152
 153 ADD_INTERFACE (Self_alignment_interface,
 154                "Position this object on itself and/or on its parent.  To this"
 155                " end, the following functions are provided:\n"
 156                "\n"
 157                "@table @code\n"
 158                "@item Self_alignment_interface::[xy]_aligned_on_self\n"
 159                "Align self on reference point, using"
 160                " @code{self-alignment-X} and @code{self-alignment-Y}."
 161                "@item Self_alignment_interface::aligned_on_[xy]_parent\n"
 162                "@item Self_alignment_interface::centered_on_[xy]_parent\n"
 163                "Shift the object so its own reference point is centered on"
 164                " the extent of the parent\n"
 165                "@end table\n",
 166
 167                /* properties */
 168                "self-alignment-X "
 169                "self-alignment-Y "
 170               );