]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/text-spanner.cc
* The grand 2005-2006 replace.
[lilypond.git] / lily / text-spanner.cc
index acbabdc56e7629a432d936575c8ac6ba89f1c202..bcaf49098bd2fbb2dd663dd6a1e0ff4a6f8212cc 100644 (file)
@@ -1,21 +1,22 @@
 /*
+  text-spanner.cc -- implement Text_spanner
 
-text-spanner.cc -- implement Text_spanner
+  source file of the GNU LilyPond music typesetter
 
-source file of the GNU LilyPond music typesetter
+  (c) 2000--2006 Jan Nieuwenhuizen <janneke@gnu.org>
 
-(c) 2000--2002 Jan Nieuwenhuizen <janneke@gnu.org>
+  Revised over good by Han-Wen.
 */
 
-#include "molecule.hh"
-#include "text-item.hh"
 #include "text-spanner.hh"
+
+#include "text-interface.hh"
 #include "line-spanner.hh"
 #include "spanner.hh"
 #include "font-interface.hh"
 #include "dimensions.hh"
-#include "paper-def.hh"
-#include "debug.hh"
+#include "output-def.hh"
+#include "warn.hh"
 #include "paper-column.hh"
 #include "staff-symbol-referencer.hh"
 
@@ -27,271 +28,137 @@ source file of the GNU LilyPond music typesetter
   - more texts/positions
 */
 
-MAKE_SCHEME_CALLBACK (Text_spanner, brew_molecule, 1);
+MAKE_SCHEME_CALLBACK (Text_spanner, print, 1);
 
 /*
-  TODO: this function is too long, too hairy.
-
-  TODO: document this. What the heck is happening here?
+  TODO: this function is too long
 */
 SCM
-Text_spanner::brew_molecule (SCM smob) 
+Text_spanner::print (SCM smob)
 {
-  Grob *me= unsmob_grob (smob);
-  Spanner *spanner = dynamic_cast<Spanner*> (me);
-  
-  if (spanner->internal_has_interface (ly_symbol2scm ("piano-pedal-interface")))
-    {
-      setup_pedal_bracket(spanner);
-    }
+  Grob *me = unsmob_grob (smob);
+  Spanner *spanner = dynamic_cast<Spanner *> (me);
 
-  /* Ugh, must be same as Hairpin::brew_molecule.  */
-  Real padding = gh_scm2double (me->get_grob_property ("if-text-padding"));
-  Real broken_left =  spanner->get_broken_left_end_align ();
-  Real width = spanner->spanner_length ();
-  width -= broken_left;
+  /* Ugh, must be same as Hairpin::print.  */
 
+  Grob *common = spanner->get_bound (LEFT)->common_refpoint (spanner->get_bound (RIGHT), X_AXIS);
+  Output_def *layout = me->layout ();
+
+  SCM flare = me->get_property ("bracket-flare");
+  SCM shorten = me->get_property ("shorten-pair");
+
+  Interval span_points;
   Drul_array<bool> broken;
-  Drul_array<Real> extra_off;
   Direction d = LEFT;
   do
     {
-      extra_off [d]=0;
       Item *b = spanner->get_bound (d);
       broken[d] = b->break_status_dir () != CENTER;
 
-      if (!broken [d])
+      if (broken[d])
        {
-
-         Interval e = b->extent (b, X_AXIS);
-         Real r = 0.0;
-         if (!e.empty_b ())
-           r = e[-d] + padding;
-
-         /* Text spanners such as ottava, should span from outer limits of
-            noteheads, iso (de)cresc. spanners that span the inner space */
-         if (me->get_grob_property ("outer") != SCM_EOL)
-           {
-             width -= d * r;
-           }
+         if (d == LEFT)
+           span_points[d] = spanner->get_broken_left_end_align ();
          else
-           {
-             width += d * r;
-             extra_off[d] = r;
-           }
+           span_points[d] = b->relative_coordinate (common, X_AXIS);
        }
-    }
-  while (flip (&d) != LEFT);
+      else
+       {
+         Real encl = robust_scm2double (me->get_property ("enclose-bounds"), 0.0);
+         Interval ext = b->extent (common, X_AXIS);
 
-  // FIXME: ecs tells us -- only for (de)cresc. spanners
-  width += gh_scm2double (me->get_grob_property ("width-correct"));
-  /* /Ugh */
+         span_points[d]
+           = robust_relative_extent (b, common, X_AXIS).linear_combination (d * encl);
 
-  // who is ecs? --hwn
+         if (is_number_pair (shorten))
+           span_points -= d * scm_to_double (index_get_cell (shorten, d));
+       }
 
-  SCM properties = Font_interface::font_alist_chain (me);
+      if (is_number_pair (flare))
+       span_points -= d * scm_to_double (index_get_cell (flare, d));
+    }
+  while (flip (&d) != LEFT);
 
-  SCM edge_text = me->get_grob_property ("edge-text");
-  Drul_array<Molecule> edge;
-  if (gh_pair_p (edge_text))
+  SCM properties = Font_interface::text_font_alist_chain (me);
+  SCM edge_text = me->get_property ("edge-text");
+  Drul_array<Stencil> edge;
+  if (scm_is_pair (edge_text))
     {
       Direction d = LEFT;
       do
        {
-         /*  Don't repeat edge text for broken end */
-         if (!broken[d])
-           {
-             SCM text = index_cell (edge_text, d);
-             edge[d] = Text_item::text2molecule (me, text, properties);
-             if (!edge[d].empty_b ())
-               edge[d].align_to (Y_AXIS, CENTER);
-           }
-       }
-      while (flip (&d) != LEFT);
-    }
-  width -= edge[LEFT].extent (X_AXIS).length ()
-    + edge[RIGHT].extent (X_AXIS).length ();
-
-  Drul_array<Real> shorten;
-  shorten[LEFT] = 0;
-  shorten[RIGHT] = 0;
-
-  SCM s = me->get_grob_property ("shorten-pair");
-  if (gh_pair_p (s))
-    {
-      shorten[LEFT] = gh_scm2double (ly_car (s));
-      shorten[RIGHT] = gh_scm2double (ly_cdr (s));
-    }
+         if (broken[d])
+           continue;
 
-  width -= shorten[LEFT] + shorten[RIGHT];
-  
-  if (width < 0)
-    {
-      me->warning (_ ("Text_spanner too small"));
-      width = 0;
-    }
+         SCM text = index_get_cell (edge_text, d);
 
-  /* ugh */
-  
-  Real thick = me->paper_l ()->get_var ("linethickness");  
-  SCM st = me->get_grob_property ("thickness");
-  if (gh_number_p (st))
-    {
-      thick *=  gh_scm2double (st);
+         if (Text_interface::is_markup (text))
+           edge[d] = *unsmob_stencil (Text_interface::interpret_markup (layout->self_scm (), properties, text));
 
-    }
-  Molecule line = Line_spanner::line_molecule (me, thick, width, 0);
-  
-  Drul_array<Molecule> edge_line;
-  s = me->get_grob_property ("edge-height");
-  SCM ew = me->get_grob_property ("edge-widen");
-  if (gh_pair_p (s))
-    {
-      Direction d = LEFT;
-      int dir = to_dir (me->get_grob_property ("direction"));
-      do
-       {
-         Real dx = ( gh_pair_p (ew)  ? 
-                     gh_scm2double (index_cell (ew, d)) * d :  
-                     0 );
-         Real dy = gh_scm2double (index_cell (s, d)) * - dir;
-         if (dy)
-           {
-             edge_line[d] = Line_spanner::line_molecule (me, thick, dx, dy);
-           }
+         if (!edge[d].is_empty ())
+           edge[d].align_to (Y_AXIS, CENTER);
        }
       while (flip (&d) != LEFT);
     }
-  
-  Molecule m;
-  if (!edge[LEFT].empty_b ())
-    m = edge[LEFT];
-
-  if (!edge_line[LEFT].empty_b ())
-    m.add_at_edge (X_AXIS, RIGHT, edge_line[LEFT], 0);
-  if (!line.empty_b ())
-    m.add_at_edge (X_AXIS, RIGHT, line,
-                  edge_line[LEFT].empty_b () ? 0 : -thick/2);
-  if (!edge_line[RIGHT].empty_b ())
-    m.add_at_edge (X_AXIS, RIGHT, edge_line[RIGHT], -thick/2);
-  if (!edge[RIGHT].empty_b ())
-    m.add_at_edge (X_AXIS, RIGHT, edge[RIGHT], 0);
-  m.translate_axis (broken_left + extra_off[LEFT] + shorten[LEFT], X_AXIS);
-
-  return m.smobbed_copy ();
-}
-
-
-
-
-/* 
-   Piano pedal brackets are a special case of a text spanner.
-   Pedal up-down (restart) indicated by the angled right and left edges 
-   of consecutive pedals touching exactly to form an __/\__
-   Chris Jackson <chris@fluffhouse.org.uk>
-*/
-
-void 
-Text_spanner::setup_pedal_bracket(Spanner *me)
-{
-
-  Real thick = me->paper_l ()->get_var ("linethickness");  
-  SCM st = me->get_grob_property ("thickness");
-  if (gh_number_p (st))
-    {
-      thick *=  gh_scm2double (st);
-    }  
-
-  Drul_array<bool> broken;
-  Drul_array<Real> height, width, shorten, r;
-
-  SCM pa = me->get_grob_property ("if-text-padding");
-  SCM ew = me->get_grob_property ("edge-widen");
-  SCM eh = me->get_grob_property ("edge-height");
-  SCM sp = me->get_grob_property ("shorten-pair");
-  
-  Direction d = LEFT;
-  Interval e;
-  Real padding = 0;
-
-  if (gh_number_p (pa) )
-    padding = gh_scm2double (pa);
 
+  Drul_array<Real> edge_height = robust_scm2interval (me->get_property ("edge-height"),
+                                                     Interval (0.0, 0.0));
+  Drul_array<Stencil> edge_line;
+  {
+    Direction d = LEFT;
+    int dir = to_dir (me->get_property ("direction"));
+    do
+      {
+       if (broken[d])
+         continue;
+
+       Real dx = 0.0;
+       if (is_number_pair (flare))
+         dx = scm_to_double (index_get_cell (flare, d)) * d;
+
+       Real dy = -dir * edge_height[d];
+       if (dy)
+         edge_line[d] = Line_spanner::line_stencil (me, Offset (0, 0), Offset (dx, dy));
+      }
+    while (flip (&d) != LEFT);
+  }
+
+  Stencil m;
   do
     {
-      Item *b = me->get_bound (d);
-
-      e = b->extent (b, X_AXIS);
-      if (!e.empty_b ())
-       r[d] = d * (e[-d] + padding);
-
-      broken[d] = b->break_status_dir () != CENTER;
-      width[d]  =  0;
-      height[d] =  0;
-      shorten[d] = 0;
-      if ( ly_number_pair_p (ew) )
-       width[d] +=  gh_scm2double (index_cell (ew, d));
-      if ( !broken[d] && (ly_number_pair_p (eh) ) )
-       height[d] += gh_scm2double (index_cell (eh, d));
-      if ( ly_number_pair_p (sp) )
-       shorten[d] +=  gh_scm2double (index_cell (sp, d));
-    }
-  while (flip (&d) != LEFT);
-  
-  Real extra_short = 0;
-  // For 'Mixed' style pedals, i.e.  a bracket preceded by text:  Ped._____|
-  // need to shorten by the extent of the text grob
-  if ( to_boolean (me->get_grob_property ("text-start")) )
-    {
-      height[LEFT] = 0;
-      extra_short = padding;
-      if (Grob *textbit = unsmob_grob (me->get_grob_property("pedal-text")))
+      Interval ext = edge[d].extent (X_AXIS);
+      if (!ext.is_empty ())
        {
-         if (textbit->internal_has_interface(ly_symbol2scm("text-interface")))
-           // for plain text, e.g., Sost. Ped.
-           {
-             SCM text  =  textbit->get_grob_property("text"); 
-             if (gh_string_p (text)) {
-               SCM properties = Font_interface::font_alist_chain (me);
-               Molecule mol = Text_item::text2molecule (me, text, properties);
-               extra_short += mol.extent(X_AXIS).length() / 2;
-             }
-           }
+         Real pad = robust_scm2double (me->get_property ("bound-padding"), 0.0);
+         edge[d].translate_axis (span_points[d], X_AXIS);
+         m.add_stencil (edge[d]);
+         span_points[d] += -d * (ext[-d] + pad);
        }
-      shorten[RIGHT] -= thick;
     }
+  while (flip (&d) != LEFT);
 
-  shorten[LEFT] += extra_short ;
-  
-  if (broken[LEFT])
+  do
     {
-      shorten[LEFT]  -=  me->get_broken_left_end_align () ;
-      shorten[RIGHT]  +=  abs(width[RIGHT])  +  thick  -  r[RIGHT];
+      if (d * span_points[d] > d * edge[-d].extent (X_AXIS)[d])
+       {
+         edge_line[d].translate_axis (span_points[d], X_AXIS);
+         m.add_stencil (edge_line[d]);
+       }
     }
+  while (flip (&d) != LEFT);
 
-  else
+  if (!span_points.is_empty ())
     {
-      // Shorten a ____/ on the right so that it will touch an adjoining \___
-      shorten[RIGHT]  +=  abs(width[LEFT])  +  abs(width[RIGHT])  +  thick;
-      // Also shorten so that it ends just before the spanned note.
-      shorten[RIGHT]  -=  (r[LEFT]  +  r[RIGHT]);
+      Stencil l = Line_spanner::line_stencil (me,
+                                             Offset (span_points[LEFT], 0),
+                                             Offset (span_points[RIGHT], 0));
+      m.add_stencil (l);
     }
-
-  me->set_grob_property ("edge-height", ly_interval2scm (height));
-  me->set_grob_property ("edge-widen",  ly_interval2scm(width));
-  me->set_grob_property ("shorten-pair", ly_interval2scm (shorten));
+  m.translate_axis (- me->relative_coordinate (common, X_AXIS), X_AXIS);
+  return m.smobbed_copy ();
 }
 
-
-struct Pianopedal
-{
-  static bool has_interface (Grob*);
-};
-ADD_INTERFACE (Pianopedal,"piano-pedal-interface",
-              "",
-              "pedal-type edge-widen edge-height shorten-pair text-start left-widen right-widen pedal-text");
-
-ADD_INTERFACE (Text_spanner,"text-spanner-interface",
+ADD_INTERFACE (Text_spanner, "text-spanner-interface",
               "generic text spanner",
-              "dash-period if-text-padding dash-length edge-height edge-widen edge-text shorten-pair type thickness outer width-correct");
+              "bound-padding dash-period dash-fraction edge-height bracket-flare edge-text shorten-pair style thickness enclose-bounds");