]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/text-spanner.cc
*** empty log message ***
[lilypond.git] / lily / text-spanner.cc
index 127de061a356e6d738e68920da7d5d3249ccfab4..8a4d37b8eacc48d822aafd382152058fdb818a0b 100644 (file)
 /*
-
   text-spanner.cc -- implement Text_spanner
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 2000--2002 Jan Nieuwenhuizen <janneke@gnu.org>
+  (c) 2000--2005 Jan Nieuwenhuizen <janneke@gnu.org>
+
+  Revised over good by Han-Wen. 
 */
 
-#include "molecule.hh"
-#include "text-item.hh"
 #include "text-spanner.hh"
+
+#include "text-item.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"
 
 /*
   TODO:
-    - vertical start / vertical end (fixme-name) |
-    - contination types (vert. star, vert. end)  |-> eat volta-spanner
-    - more styles
-    - more texts/positions
- */
+  - vertical start / vertical end (fixme-name) |
+  - contination types (vert. star, vert. end)  |-> eat volta-bracket
+  - more styles
+  - more texts/positions
+*/
 
-MAKE_SCHEME_CALLBACK (Text_spanner, brew_molecule, 1);
+MAKE_SCHEME_CALLBACK (Text_spanner, print, 1);
 
+/*
+  TODO: this function is too long
+*/
 SCM
-Text_spanner::brew_molecule (SCM smob) 
+Text_spanner::print (SCM smob) 
 {
-  Grob *me= unsmob_grob (smob);
+  Grob *me = unsmob_grob (smob);
   Spanner *spanner = dynamic_cast<Spanner*> (me);
+  
+  /* Ugh, must be same as Hairpin::print.  */
 
-  if (spanner->has_interface (ly_symbol2scm ("piano-pedal-interface")) ) 
-    {
-      setup_pedal_bracket(spanner);
-    }
-
+  Grob *common = spanner->get_bound (LEFT)->common_refpoint (spanner->get_bound (RIGHT), X_AXIS);
+  Output_def * layout = me->get_layout ();
 
-  /* 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;
+  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)
-           // r *= -1; // huh?
-           {
-             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);
        }
+      else
+         {
+           Real encl = robust_scm2double (me->get_property ("enclose-bounds"), 0.0);
+           Interval ext = b->extent (common, X_AXIS);
+           
+           span_points[d] =
+             robust_relative_extent (b, common, X_AXIS).linear_combination (d * encl);
+
+           if (is_number_pair (shorten))
+             span_points -= d * scm_to_double (index_get_cell (shorten, d));
+         }
+      
+      if (is_number_pair (flare))
+       span_points -= d * scm_to_double (index_get_cell (flare, d));
     }
   while (flip (&d) != LEFT);
 
-  // FIXME: ecs tells us -- only for (de)cresc. spanners
-  width += gh_scm2double (me->get_grob_property ("width-correct"));
-  /* /Ugh */
-
 
-  SCM properties = Font_interface::font_alist_chain (me);
-
-  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);
-           }
+         if (broken[d])
+           continue;
+         
+         SCM text = index_get_cell (edge_text, d);
+
+         if (Text_interface::markup_p (text)) 
+           edge[d] = *unsmob_stencil (Text_interface::interpret_markup (layout->self_scm (), properties, text));
+         
+         if (!edge[d].is_empty ())
+           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));
-    }
-
-  width -= shorten[LEFT] + shorten[RIGHT];
   
-  if (width < 0)
-    {
-      me->warning (_ ("Text_spanner too small"));
-      width = 0;
-    }
-
-  /* ugh */
-  Real thick = me->paper_l ()->get_var ("stafflinethickness");  
-  
-  Molecule line = Line_spanner::line_molecule (me, width, 0);
-  
-  Drul_array<Molecule> edge_line;
-  s = me->get_grob_property ("edge-height");
-  SCM ew = me->get_grob_property ("edge-width");
-  if (gh_pair_p (s))
+  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_grob_property ("direction"));
+      int dir = to_dir (me->get_property ("direction"));
       do
        {
-         Real dx = ( gh_pair_p (ew)  ? 
-                     gh_scm2double (index_cell (ew, d)) * - dir  :  
-                     0 );
-         Real dy = gh_scm2double (index_cell (s, d)) * - dir;
+         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)
-           {
-             SCM list = Line_spanner::line_atom (me, dx, dy);
-             Box b (Interval (-thick, 0),
-                    dy > 0
-                    ? Interval (0, dy)
-                    : Interval (dy, 0));
-             edge_line[d] = Molecule (b, list);
-           }
+           edge_line[d] = Line_spanner::line_stencil (me, Offset (0,0), Offset (dx, dy));
        }
       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, 0);
-  if (!edge_line[RIGHT].empty_b ())
-    m.add_at_edge (X_AXIS, RIGHT, edge_line[RIGHT], 0);
-  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>
-
-   TODO: Pedal line extending to the end of the note
-*/
-
-void 
-Text_spanner::setup_pedal_bracket(Spanner *s)
-{
-
-  Real thick = s->paper_l ()->get_var ("stafflinethickness");  
-  Real ss = Staff_symbol_referencer::staff_space (s);
-
-  Drul_array<bool> a, broken;
-  Drul_array<Real> height, width, shorten, r;
-
-  // Pedal has an angled left edge \__  or an angled right edge __/ 
-  a[LEFT] = a[RIGHT] = false;
-  SCM al = s->get_grob_property ("angle-left");
-  SCM ar = s->get_grob_property ("angle-right");
-  if (gh_boolean_p (al) )  
-    a[LEFT]   = to_boolean (al);
-  if (gh_boolean_p (ar) )  
-    a[RIGHT]  = to_boolean (ar);
-  
-  height[LEFT] = ( to_boolean (s->get_grob_property ("text-start")) ?
-                  0 :
-                  ss );
-  height[RIGHT] = ss;
-  
-  Direction d = LEFT;
-  Interval e;
-  Real padding = 0;
-  SCM pa = (s->get_grob_property ("if-text-padding"));
-  if (gh_number_p (pa) )
-    padding = gh_scm2double (pa);
-  do {
-    Item *b = s->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]  = (a[d]  ? ss*d/2 :  0);
-    if (broken[d])
-      height[d] =  0;
-  }
-  while (flip (&d) != LEFT);
-  
-  shorten[RIGHT] =  shorten[LEFT]  =  0;
-  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 (s->get_grob_property ("text-start")) )
+  Stencil m;
+  do
     {
-      Grob * textbit = s->get_parent(Y_AXIS);
-      extra_short = padding;
-      if (textbit->has_interface(ly_symbol2scm("piano-pedal-interface")))
-       // for pretty Ped. scripts. 
+      Interval ext = edge[d].extent (X_AXIS);
+      if (!ext.is_empty ())
        {
-         e = textbit->extent(textbit, Y_AXIS);
-         extra_short += e.length();
+         edge[d].translate_axis (span_points[d], X_AXIS);
+         m.add_stencil (edge[d]);
+         span_points[d] += -d *  ext[-d];
        }
-      if (textbit->has_interface(ly_symbol2scm("text-interface"))) 
-       // for plain text, e.g., Sost. Ped.
+    }
+  while (flip (&d) != LEFT);
+  do
+    {
+      if (d* span_points[d] > d * edge[-d].extent (X_AXIS)[d])
        {
-         SCM text  =  textbit->get_grob_property("text"); 
-         if (gh_string_p (text)) {
-           SCM properties = Font_interface::font_alist_chain (s);
-           Molecule mol = Text_item::text2molecule (s, text, properties);
-           extra_short += mol.extent(X_AXIS).length() / 2;
-         }
+         edge_line[d].translate_axis (span_points[d], X_AXIS);
+         m.add_stencil (edge_line[d]);
        }
-      shorten[RIGHT] -= thick;
     }
+  while (flip (&d) != LEFT);
 
-  // Shorten a \____ on the left so that it will touch an adjoining ___/ 
-  shorten[LEFT] += abs(width[LEFT]) * 2   +  extra_short ;
-  
-  if (broken[LEFT]) {
-    shorten[LEFT] -= s->get_broken_left_end_align () ;
-    shorten[RIGHT] -= r[RIGHT];
-  }
-  else 
-    // Shorten bracket on the right so it ends just before the spanned note.
-    shorten[RIGHT]  +=  thick  -  (r[LEFT]  +  r[RIGHT]);
+  if (!span_points.is_empty ())
+    {
+      Stencil l = Line_spanner::line_stencil (me, Offset (span_points[LEFT], 0),
+                                              Offset (span_points[RIGHT], 0));
+      m.add_stencil (l);
+    }
+  m.translate_axis (- me->relative_coordinate (common, X_AXIS), X_AXIS);
+  return m.smobbed_copy ();
+}
 
-  // Hmm. TODO: This should be set in grob-description.scm, but side-positioning
-  // of consecutive brackets only seems to work if direction is +1 within the engraver. 
-  s->set_grob_property ("direction", gh_int2scm(-1)); 
+ADD_INTERFACE (Text_spanner,"text-spanner-interface",
+              "generic text spanner",
+              "dash-period dash-fraction edge-height bracket-flare edge-text shorten-pair style thickness enclose-bounds");
 
-  s->set_grob_property ("edge-height", gh_cons ( gh_double2scm ( height[LEFT] ) , 
-                                                gh_double2scm ( height[RIGHT]) ) );
-  s->set_grob_property ("edge-width",  gh_cons ( gh_double2scm ( width[LEFT]  ), 
-                                                gh_double2scm ( width[RIGHT] ) ));
-  s->set_grob_property ("shorten-pair", gh_cons ( gh_double2scm ( shorten[LEFT] ), 
-                                            gh_double2scm ( shorten[RIGHT] ) ));
-}