]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/hyphen-spanner.cc
* lily/include/debug.hh: deprecate.
[lilypond.git] / lily / hyphen-spanner.cc
index af618e87ca33851fb25d5a0637e61f0ee68fe0ab..8231c4b2a6390c56e3a40fca444ee88d99bb57a7 100644 (file)
@@ -5,7 +5,7 @@
 
   (c) 1999 Glen Prideaux <glenprideaux@iname.com>
 
 (adapted from lyric-extender)
+ (adapted from lyric-extender)
 */
 
 #include <math.h>
 #include "molecule.hh"
 #include "paper-def.hh"
 #include "hyphen-spanner.hh"
+#include "paper-column.hh"
 #include "spanner.hh"
 #include "item.hh"
 
-MAKE_SCHEME_SCORE_ELEMENT_CALLBACK(Hyphen_spanner,brew_molecule)
+MAKE_SCHEME_CALLBACK (Hyphen_spanner,brew_molecule,1)
 
 SCM 
 Hyphen_spanner::brew_molecule (SCM smob)
 {
-  Spanner * sp = dynamic_cast<Spanner*> (unsmob_element (smob));
+  Spanner * sp = unsmob_spanner (smob);
 
-  Score_element * common = sp;
+  Grob * common = sp;
   Direction d = LEFT;
   do
     {
-      common = common->common_refpointsp->get_bound (d), X_AXIS);
+      common = common->common_refpoint (sp->get_bound (d), X_AXIS);
     }
   while (flip (&d) != LEFT);
   Interval bounds;
   
   do
     {
-      Real  x = sp->get_bound (d)->relative_coordinate (common, X_AXIS);
-      Interval ext =  sp->get_bound (d)->extent (X_AXIS);
-      bounds[d] = (x + ext[-d]);
+      Interval iv = sp->get_bound (d)->extent (common, X_AXIS);
+
+      bounds[d] = iv.empty_b ()
+       ? sp->get_bound (d)->relative_coordinate (common, X_AXIS)
+       : iv[-d];
     }
   while (flip (&d) != LEFT);
-
   
+  Real lt = sp->paper_l ()->get_var ("linethickness");
+  Real th = gh_scm2double (sp->get_grob_property ("thickness")) * lt ;
+  Real h = gh_scm2double (sp->get_grob_property ("height"));
+
+  // interval?
+  Real l = gh_scm2double (sp->get_grob_property ("minimum-length"));  
+  Real x = gh_scm2double (sp->get_grob_property ("maximum-length"));
+  // The hyphen can exist in the word space of the left lyric ...
+  SCM space =  sp->get_bound (LEFT)->get_grob_property ("word-space");
+  if (gh_number_p (space))
+    {
+      bounds[LEFT] -=  gh_scm2double (space);
+    }
+
+  /*
+    we should probably do something more intelligent when bounds is
+    empty, but at least this doesn't crash.
+  */      
+  Real w  = bounds.empty_b () ? 0 : bounds.length ();
   
-  Real ss = sp->paper_l ()->get_var ("staffspace");
-  Real lt = sp->paper_l ()->get_var ("stafflinethickness");
-  Real th = gh_scm2double (sp->get_elt_property ("thickness")) * lt ;
-  Real h = gh_scm2double (sp->get_elt_property ("height")) * ss;
-  Real l = gh_scm2double (sp->get_elt_property ("minimum-length")) * ss;  
-  Real w  = bounds.length ();
-  /* First try: just make the hyphen take 1/3 of the available space  
-   for length, use a geometric mean of the available space and some minimum
-  */
-  if(l < w)
-    l = sqrt(l*w);
-
-  Box b  (Interval (-l/2,l/2), Interval (h,h+th));
-  Molecule mol (sp->lookup_l ()->filledbox (b));
-  mol.translate_axis (bounds.center ()
-                     -sp->relative_coordinate (common, X_AXIS),
-                     X_AXIS);
-  return mol.create_scheme ();
+  /* for length, use a geometric mean of the available space and some minimum
+   */
+  if (l < w)
+    {
+      l = sqrt (l*w);
+      if (l > x)
+       l = x;
+    }
+  else
+    {
+      /* OK, we have a problem. Usually this means that we're on the
+         first column, and we have a long lyric which extends to near
+         the offset for stuff */
+      /* This test for being on the first column has been shamelessly
+         ripped from spanner.cc */
+      Paper_column *sc = dynamic_cast<Paper_column*> (sp->get_bound (LEFT)->column_l ());
+      if (sc != NULL &&
+         sc->break_status_dir () == RIGHT)
+       {
+         /* We are on the first column, so it's probably harmless to
+             get the minimum length back by extending leftwards into
+             the space under the clef/key sig/time sig */
+         bounds[LEFT] = bounds[RIGHT] - l;
+       }
+      else 
+       {
+         /* We can't get the length desired. Maybe we should warn. */
+         l = w;
+       }
+    }
+  Box b (Interval (-l/2,l/2), Interval (h,h+th));
+  Molecule mol (Lookup::filledbox (b));
+  Real ct = bounds.empty_b () ? 0 : bounds.center () ;
+  mol.translate_axis (ct -sp->relative_coordinate (common, X_AXIS), X_AXIS);
+  return mol.smobbed_copy ();
 }
   
 void
-Hyphen_spanner::set_textitem (Direction d, Score_element* b)
+Hyphen_spanner::set_textitem (Direction d, Grob* b)
 {
   elt_l_->set_bound (d, b);
   elt_l_->add_dependency (b);
@@ -75,3 +113,12 @@ Hyphen_spanner::Hyphen_spanner (Spanner*s)
 {
   elt_l_ = s;
 }
+
+
+
+ADD_INTERFACE (Hyphen_spanner, "lyric-hyphen-interface",
+  "A centred hyphen is a simple line between lyrics used to divide
+syllables.   The length of the hyphen line should stretch based on the
+size of the gap between syllables.",
+  "thickness height minimum-length maximum-length word-space");
+