]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/lyric-extender.cc
Doc-es: various updates.
[lilypond.git] / lily / lyric-extender.cc
index a36706581428a04d20d97a128169dd7e0b506223..8afe2c5569200d48a8a4caec55c460e0af91ee8f 100644 (file)
 /*
-  lyric-extender.cc -- implement Lyric_extender
-  source file of the GNU LilyPond music typesetter
+  This file is part of LilyPond, the GNU music typesetter.
 
-  (c) 1998--2004 Jan Nieuwenhuizen <janneke@gnu.org>
+  Copyright (C) 1998--2015 Jan Nieuwenhuizen <janneke@gnu.org>
   Han-Wen Nienhuys
+
+  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 <math.h>
+#include "lyric-extender.hh"
 
-#include "box.hh"
+#include "system.hh"
+#include "item.hh"
 #include "warn.hh"
 #include "lookup.hh"
-#include "stencil.hh"
-#include "paper-column.hh"
-#include "paper-def.hh"
-#include "lyric-extender.hh"
+#include "output-def.hh"
 #include "note-head.hh"
-#include "group-interface.hh"
+#include "pointer-group-interface.hh"
 
-bool
-Lyric_extender::is_visible (Grob *gr)
+MAKE_SCHEME_CALLBACK (Lyric_extender, print, 1);
+SCM
+Lyric_extender::print (SCM smob)
 {
-  Spanner*me = dynamic_cast<Spanner*> (gr);
-
-  SCM heads = me->get_property ("heads");
-  int l = scm_ilength (heads);
-  if (l == 0)
-    return false;
-  
-  return true;
-}
+  Spanner *me = unsmob<Spanner> (smob);
+  Item *left_edge = me->get_bound (LEFT);
+  Item *right_text = unsmob<Item> (me->get_object ("next"));
 
-MAKE_SCHEME_CALLBACK (Lyric_extender,print,1)
-SCM 
-Lyric_extender::print (SCM smob) 
-{
-  Spanner *me = unsmob_spanner (smob);
-  Item *l = me->get_bound (LEFT);
-  Item *r = me->get_bound (RIGHT);
-  Grob *common = l->common_refpoint (r, X_AXIS);
-  
+  Grob *common = left_edge;
+
+  if (right_text)
+    common = common->common_refpoint (right_text, X_AXIS);
 
-  Real sl = me->get_paper ()->get_realvar (ly_symbol2scm ("linethickness"));  
+  common = common->common_refpoint (me->get_bound (RIGHT), X_AXIS);
+  common = common->common_refpoint (me->get_system (), X_AXIS);
 
-  Link_array<Grob> heads (Pointer_group_interface__extract_grobs (me, (Grob*)0,
-                                                                 "heads"));
+  Real sl = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
 
-  if (!heads.size () && r->break_status_dir () == CENTER)
+  extract_grob_set (me, "heads", heads);
+
+  if (!heads.size ())
     return SCM_EOL;
 
   common = common_refpoint_of_array (heads, common, X_AXIS);
-  
+
   Real left_point = 0.0;
-  if (l->internal_has_interface (ly_symbol2scm ("lyric-syllable-interface")))
-    left_point = l->extent (common, X_AXIS)[RIGHT];
-  else
+  if (left_edge->internal_has_interface (ly_symbol2scm ("lyric-syllable-interface")))
+    left_point = left_edge->extent (common, X_AXIS)[RIGHT];
+  else if (heads.size ())
     left_point = heads[0]->extent (common, X_AXIS)[LEFT];
+  else
+    left_point = left_edge->extent (common, X_AXIS)[RIGHT];
 
   if (isinf (left_point))
     return SCM_EOL;
 
-  /*
-    It seems that short extenders are even lengthened to go past the
-    note head, but haven't found a pattern in it yet. --hwn 1/1/04
-    
-   */
-  SCM minlen =  me->get_property ("minimum-length");
+  /* It seems that short extenders are even lengthened to go past the
+     note head, but haven't found a pattern in it yet. --hwn 1/1/04  */
+  SCM minlen = me->get_property ("minimum-length");
   Real right_point
-    = left_point + (robust_scm2double  (minlen,0));
+    = left_point + (robust_scm2double (minlen, 0));
 
-  Spanner *orig = dynamic_cast<Spanner*> (me->original_);
-  bool last_line = orig
-    && (me->get_break_index () == orig->broken_intos_.size() - 2)
-    && !Lyric_extender::is_visible (orig->broken_intos_.top ());
-    
+  right_point = min (right_point, me->get_system ()->get_bound (RIGHT)->relative_coordinate (common, X_AXIS));
 
   if (heads.size ())
-    right_point = right_point >? heads.top ()->extent (common, X_AXIS)[RIGHT];
+    right_point = max (right_point, heads.back ()->extent (common, X_AXIS)[RIGHT]);
 
   Real h = sl * robust_scm2double (me->get_property ("thickness"), 0);
-  Real pad = 2* h;
-
-  if (r->internal_has_interface (ly_symbol2scm ("lyric-syllable-interface")))
-    right_point = right_point <? (r->extent (common, X_AXIS)[LEFT] - pad);
-  else if (Note_head::has_interface (r))
-    ; 
-  else if (!last_line)
-    {
-      /*
-       run to end of line.
-       */
-      right_point = right_point >? (r->extent (common, X_AXIS)[LEFT] - pad);
-    }
-  
-  if (isinf (right_point))
-    {
-      programming_error ("Right point of extender not defined?");
-      right_point = r->relative_coordinate (common, X_AXIS);
-    }  
-
-  left_point += pad;
+  Drul_array<Real> paddings (robust_scm2double (me->get_property ("left-padding"), h),
+                             robust_scm2double (me->get_property ("right-padding"), h));
 
+  if (right_text)
+    right_point = min (right_point, (robust_relative_extent (right_text, common, X_AXIS)[LEFT] - paddings[RIGHT]));
+
+  /* run to end of line. */
+  if (me->get_bound (RIGHT)->break_status_dir ())
+    right_point = max (right_point, (robust_relative_extent (me->get_bound (RIGHT), common, X_AXIS)[LEFT] - paddings[RIGHT]));
+
+  left_point += paddings[LEFT];
   Real w = right_point - left_point;
 
   if (w < 1.5 * h)
     return SCM_EOL;
-  
-  Stencil  mol (Lookup::round_filled_box (Box (Interval (0,w), Interval (0,h)),
-                                          0.8 * h));
-  mol.translate_axis (left_point - me->relative_coordinate (common, X_AXIS), X_AXIS);
+
+  Stencil mol (Lookup::round_filled_box (Box (Interval (0, w),
+                                              Interval (0, h)),
+                                         0.8 * h));
+  mol.translate_axis (left_point - me->relative_coordinate (common, X_AXIS),
+                      X_AXIS);
   return mol.smobbed_copy ();
 }
 
-
-ADD_INTERFACE (Lyric_extender,"lyric-extender-interface",
-  "The extender is a simple line at the baseline of the lyric "
-  " that helps show the length of a melissima (tied/slurred note).",
-  "thickness heads");
+ADD_INTERFACE (Lyric_extender,
+               "The extender is a simple line at the baseline of the lyric"
+               " that helps show the length of a melisma (a tied or slurred"
+               " note).",
+
+               /* properties */
+               "heads "
+               "left-padding "
+               "next "
+               "right-padding "
+               "thickness "
+              );