lily/self-alignment-interface.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2004--2014 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 "note-column.hh"
  24 #include "paper-column.hh"
  25 #include "pointer-group-interface.hh"
  26 #include "warn.hh"
  27
  28 MAKE_SCHEME_CALLBACK (Self_alignment_interface, y_aligned_on_self, 1);
  29 SCM
  30 Self_alignment_interface::y_aligned_on_self (SCM element)
  31 {
  32   return aligned_on_self (unsmob_grob (element), Y_AXIS, false, 0, 0);
  33 }
  34
  35 MAKE_SCHEME_CALLBACK (Self_alignment_interface, x_aligned_on_self, 1);
  36 SCM
  37 Self_alignment_interface::x_aligned_on_self (SCM element)
  38 {
  39   return aligned_on_self (unsmob_grob (element), X_AXIS, false, 0, 0);
  40 }
  41
  42 MAKE_SCHEME_CALLBACK (Self_alignment_interface, pure_y_aligned_on_self, 3);
  43 SCM
  44 Self_alignment_interface::pure_y_aligned_on_self (SCM smob, SCM start, SCM end)
  45 {
  46   return aligned_on_self (unsmob_grob (smob), Y_AXIS, true, robust_scm2int (start, 0), robust_scm2int (end, INT_MAX));
  47 }
  48
  49 SCM
  50 Self_alignment_interface::aligned_on_self (Grob *me, Axis a, bool pure, int start, int end)
  51 {
  52   SCM sym = (a == X_AXIS) ? ly_symbol2scm ("self-alignment-X")
  53             : ly_symbol2scm ("self-alignment-Y");
  54
  55   SCM align (me->internal_get_property (sym));
  56   if (scm_is_number (align))
  57     {
  58       Interval ext (me->maybe_pure_extent (me, a, pure, start, end));
  59       // Empty extent doesn't mean an error - we simply don't align such grobs.
  60       // However, empty extent and non-empty stencil would be suspicious.
  61       if (!ext.is_empty ())
  62         return scm_from_double (- ext.linear_combination (scm_to_double (align)));
  63       else if (me->get_stencil ())
  64         warning (me->name () + " has empty extent and non-empty stencil.");
  65     }
  66   return scm_from_double (0.0);
  67 }
  68
  69 SCM
  70 Self_alignment_interface::centered_on_object (Grob *him, Axis a)
  71 {
  72   return scm_from_double (robust_relative_extent (him, him, a).center ());
  73 }
  74
  75 MAKE_SCHEME_CALLBACK (Self_alignment_interface, centered_on_x_parent, 1);
  76 SCM
  77 Self_alignment_interface::centered_on_x_parent (SCM smob)
  78 {
  79   return centered_on_object (unsmob_grob (smob)->get_parent (X_AXIS), X_AXIS);
  80 }
  81
  82 MAKE_SCHEME_CALLBACK (Self_alignment_interface, centered_on_y_parent, 1);
  83 SCM
  84 Self_alignment_interface::centered_on_y_parent (SCM smob)
  85 {
  86   return centered_on_object (unsmob_grob (smob)->get_parent (Y_AXIS), Y_AXIS);
  87 }
  88
  89 MAKE_SCHEME_CALLBACK (Self_alignment_interface, aligned_on_x_parent, 1);
  90 SCM
  91 Self_alignment_interface::aligned_on_x_parent (SCM smob)
  92 {
  93   return aligned_on_parent (unsmob_grob (smob), X_AXIS);
  94 }
  95
  96 MAKE_SCHEME_CALLBACK (Self_alignment_interface, aligned_on_y_parent, 1);
  97 SCM
  98 Self_alignment_interface::aligned_on_y_parent (SCM smob)
  99 {
 100   return aligned_on_parent (unsmob_grob (smob), Y_AXIS);
 101 }
 102
 103 SCM
 104 Self_alignment_interface::aligned_on_parent (Grob *me, Axis a)
 105 {
 106   Grob *him = me->get_parent (a);
 107   Interval he;
 108   if (Paper_column::has_interface (him))
 109       /*
 110         PaperColumn extents aren't reliable (they depend on size and alignment
 111         of PaperColumn's children), so we align on NoteColumn instead.
 112         This happens e.g. for lyrics without associatedVoice.
 113       */
 114     he = Paper_column::get_interface_extent
 115               (him, ly_symbol2scm ("note-column-interface"), a);
 116   else
 117     he = him->extent (him, a);
 118
 119   SCM sym = (a == X_AXIS) ? ly_symbol2scm ("self-alignment-X")
 120             : ly_symbol2scm ("self-alignment-Y");
 121   SCM align_prop (me->internal_get_property (sym));
 122
 123   if (!scm_is_number (align_prop))
 124     return scm_from_int (0);
 125
 126   Real x = 0.0;
 127   Real align = scm_to_double (align_prop);
 128
 129   Interval ext (me->extent (me, a));
 130
 131   // Empty extent doesn't mean an error - we simply don't align such grobs.
 132   // However, empty extent and non-empty stencil would be suspicious.
 133   if (!ext.is_empty ())
 134     x -= ext.linear_combination (align);
 135   else if (me->get_stencil ())
 136     warning (me->name () + " has empty extent and non-empty stencil.");
 137
 138   // See comment above.
 139   if (!he.is_empty ())
 140     x += he.linear_combination (align);
 141   else if (him->get_stencil ())
 142     warning (him->name () + " has empty extent and non-empty stencil.");
 143
 144   return scm_from_double (x);
 145 }
 146
 147 void
 148 Self_alignment_interface::set_aligned_on_parent (Grob *me, Axis a)
 149 {
 150   add_offset_callback (me,
 151                        (a == X_AXIS) ? aligned_on_x_parent_proc : aligned_on_y_parent_proc,
 152                        a);
 153 }
 154
 155 ADD_INTERFACE (Self_alignment_interface,
 156                "Position this object on itself and/or on its parent.  To this"
 157                " end, the following functions are provided:\n"
 158                "\n"
 159                "@table @code\n"
 160                "@item Self_alignment_interface::[xy]_aligned_on_self\n"
 161                "Align self on reference point, using"
 162                " @code{self-alignment-X} and @code{self-alignment-Y}."
 163                "@item Self_alignment_interface::aligned_on_[xy]_parent\n"
 164                "@item Self_alignment_interface::centered_on_[xy]_parent\n"
 165                "Shift the object so its own reference point is centered on"
 166                " the extent of the parent\n"
 167                "@end table\n",
 168
 169                /* properties */
 170                "self-alignment-X "
 171                "self-alignment-Y "
 172               );