lily/lyric-extender.cc

   1 /*
   2   lyric-extender.cc -- implement Lyric_extender
   3   source file of the GNU LilyPond music typesetter
   4
   5   (c) 1998--2004 Jan Nieuwenhuizen <janneke@gnu.org>
   6   Han-Wen Nienhuys
   7 */
   8
   9 #include <math.h>
  10
  11 #include "box.hh"
  12 #include "warn.hh"
  13 #include "lookup.hh"
  14 #include "stencil.hh"
  15 #include "paper-column.hh"
  16 #include "output-def.hh"
  17 #include "lyric-extender.hh"
  18 #include "note-head.hh"
  19 #include "group-interface.hh"
  20
  21
  22
  23 MAKE_SCHEME_CALLBACK (Lyric_extender, print, 1)
  24 SCM
  25 Lyric_extender::print (SCM smob)
  26 {
  27   Spanner *me = unsmob_spanner (smob);
  28   Item *le = me->get_bound (LEFT);
  29   Item *right_text = unsmob_item (me->get_property ("next"));
  30
  31   Grob *common = le->common_refpoint (right_text, X_AXIS);
  32   common = common->common_refpoint (me->get_bound (RIGHT), X_AXIS);
  33   Real sl = me->get_paper ()->get_dimension (ly_symbol2scm ("linethickness"));
  34   Link_array<Grob> heads (Pointer_group_interface__extract_grobs (me, (Grob*)0,
  35                                                                   "heads"));
  36
  37   if (!heads.size ())
  38     return SCM_EOL;
  39
  40   common = common_refpoint_of_array (heads, common, X_AXIS);
  41
  42   Real left_point = 0.0;
  43   if (le->internal_has_interface (ly_symbol2scm ("lyric-syllable-interface")))
  44     left_point = le->extent (common, X_AXIS)[RIGHT];
  45   else if (heads.size ())
  46     left_point = heads[0]->extent (common, X_AXIS)[LEFT];
  47   else
  48     left_point = le->extent (common, X_AXIS)[RIGHT];
  49
  50   if (isinf (left_point))
  51     return SCM_EOL;
  52
  53   /* It seems that short extenders are even lengthened to go past the
  54      note head, but haven't found a pattern in it yet. --hwn 1/1/04  */
  55   SCM minlen = me->get_property ("minimum-length");
  56   Real right_point
  57     = left_point + (robust_scm2double  (minlen, 0));
  58
  59   if (heads.size ())
  60     right_point = right_point >? heads.top ()->extent (common, X_AXIS)[RIGHT];
  61
  62   Real h = sl * robust_scm2double (me->get_property ("thickness"), 0);
  63   Real pad = 2* h;
  64
  65   if (right_text)
  66     right_point = right_point <? (robust_relative_extent (right_text, common, X_AXIS)[LEFT] - pad);
  67
  68   /* run to end of line. */
  69   right_point = right_point >? (me->get_bound (RIGHT)->extent (common, X_AXIS)[LEFT] - pad);
  70
  71   left_point += pad;
  72
  73   Real w = right_point - left_point;
  74
  75   if (w < 1.5 * h)
  76     return SCM_EOL;
  77
  78   Stencil  mol (Lookup::round_filled_box (Box (Interval (0, w),
  79                                                Interval (0, h)),
  80                                           0.8 * h));
  81   mol.translate_axis (left_point - me->relative_coordinate (common, X_AXIS),
  82                       X_AXIS);
  83   return mol.smobbed_copy ();
  84 }
  85
  86
  87 ADD_INTERFACE (Lyric_extender,"lyric-extender-interface",
  88                "The extender is a simple line at the baseline of the lyric "
  89                "that helps show the length of a melissima (tied/slurred note).",
  90                "next thickness heads");