lily/self-alignment-interface.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2004--2015 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 (Grob::unsmob (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 (Grob::unsmob (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 (Grob::unsmob (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 align = (a == X_AXIS)
  53           ? me->get_property ("self-alignment-X")
  54           : me->get_property ("self-alignment-Y");
  55   if (scm_is_number (align))
  56     {
  57       Interval ext (me->maybe_pure_extent (me, a, pure, start, end));
  58       // Empty extent doesn't mean an error - we simply don't align such grobs.
  59       // However, empty extent and non-empty stencil would be suspicious.
  60       if (!ext.is_empty ())
  61         return scm_from_double (- ext.linear_combination (scm_to_double (align)));
  62       else if (me->get_stencil ())
  63         warning (me->name () + " has empty extent and non-empty stencil.");
  64     }
  65   return scm_from_double (0.0);
  66 }
  67
  68 SCM
  69 Self_alignment_interface::centered_on_object (Grob *him, Axis a)
  70 {
  71   return scm_from_double (robust_relative_extent (him, him, a).center ());
  72 }
  73
  74 MAKE_SCHEME_CALLBACK (Self_alignment_interface, centered_on_x_parent, 1);
  75 SCM
  76 Self_alignment_interface::centered_on_x_parent (SCM smob)
  77 {
  78   return centered_on_object (Grob::unsmob (smob)->get_parent (X_AXIS), X_AXIS);
  79 }
  80
  81 MAKE_SCHEME_CALLBACK (Self_alignment_interface, centered_on_y_parent, 1);
  82 SCM
  83 Self_alignment_interface::centered_on_y_parent (SCM smob)
  84 {
  85   return centered_on_object (Grob::unsmob (smob)->get_parent (Y_AXIS), Y_AXIS);
  86 }
  87
  88 MAKE_SCHEME_CALLBACK (Self_alignment_interface, aligned_on_x_parent, 1);
  89 SCM
  90 Self_alignment_interface::aligned_on_x_parent (SCM smob)
  91 {
  92   return aligned_on_parent (Grob::unsmob (smob), X_AXIS);
  93 }
  94
  95 MAKE_SCHEME_CALLBACK (Self_alignment_interface, aligned_on_y_parent, 1);
  96 SCM
  97 Self_alignment_interface::aligned_on_y_parent (SCM smob)
  98 {
  99   return aligned_on_parent (Grob::unsmob (smob), Y_AXIS);
 100 }
 101
 102 SCM
 103 Self_alignment_interface::aligned_on_parent (Grob *me, Axis a)
 104 {
 105   Grob *him = me->get_parent (a);
 106   Interval he;
 107   if (Paper_column::has_interface (him))
 108       /*
 109         PaperColumn extents aren't reliable (they depend on size and alignment
 110         of PaperColumn's children), so we align on NoteColumn instead.
 111         This happens e.g. for lyrics without associatedVoice.
 112       */
 113     he = Paper_column::get_interface_extent
 114               (him, ly_symbol2scm ("note-column-interface"), a);
 115   else
 116     {
 117       if (to_boolean (me->get_property ("X-align-on-main-noteheads"))
 118           && Note_column::has_interface (him))
 119         he = Note_column::calc_main_extent(him);
 120       else
 121         he = him->extent (him, a);
 122     }
 123
 124   SCM self_align = (a == X_AXIS)
 125           ? me->get_property ("self-alignment-X")
 126           : me->get_property ("self-alignment-Y");
 127
 128   SCM par_align = (a == X_AXIS)
 129           ? me->get_property ("parent-alignment-X")
 130           : me->get_property ("parent-alignment-Y");
 131
 132   if (par_align == SCM_EOL)
 133       par_align = self_align;
 134
 135   Real x = 0.0;
 136   Interval ext (me->extent (me, a));
 137
 138   if (scm_is_number (self_align))
 139     {
 140       // Empty extent doesn't mean an error - we simply don't align such grobs.
 141       // However, empty extent and non-empty stencil would be suspicious.
 142       if (!ext.is_empty ())
 143         x -= ext.linear_combination (scm_to_double (self_align));
 144       else if (me->get_stencil ())
 145         warning (me->name () + " has empty extent and non-empty stencil.");
 146     }
 147
 148   if (scm_is_number (par_align))
 149     {
 150       // See comment above.
 151       if (!he.is_empty ())
 152         x += he.linear_combination (scm_to_double (par_align));
 153       else if (him->get_stencil ())
 154         warning (him->name () + " has empty extent and non-empty stencil.");
 155     }
 156
 157   return scm_from_double (x);
 158 }
 159
 160 void
 161 Self_alignment_interface::set_aligned_on_parent (Grob *me, Axis a)
 162 {
 163   add_offset_callback (me,
 164                        (a == X_AXIS) ? aligned_on_x_parent_proc : aligned_on_y_parent_proc,
 165                        a);
 166 }
 167
 168 ADD_INTERFACE (Self_alignment_interface,
 169                "Position this object on itself and/or on its parent.  To this"
 170                " end, the following functions are provided:\n"
 171                "\n"
 172                "@table @code\n"
 173                "@item Self_alignment_interface::[xy]_aligned_on_self\n"
 174                "Align self on reference point, using"
 175                " @code{self-alignment-X} and @code{self-alignment-Y}."
 176                "@item Self_alignment_interface::aligned_on_[xy]_parent\n"
 177                "@item Self_alignment_interface::centered_on_[xy]_parent\n"
 178                "Shift the object so its own reference point is centered on"
 179                " the extent of the parent\n"
 180                "@end table\n",
 181
 182                /* properties */
 183                "parent-alignment-X "
 184                "parent-alignment-Y "
 185                "self-alignment-X "
 186                "self-alignment-Y "
 187                "X-align-on-main-noteheads "
 188               );