]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/text-spanner.cc
Compile fix.
[lilypond.git] / lily / text-spanner.cc
index cfd1bd292fecabd81a96106eca9ffeaef7c705f7..8a7efdc6d3b46f7cdb6f25516da3aa0d7aed5ce9 100644 (file)
 /*
-  text-spanner.cc -- implement Text_spanner
 
-  source file of the GNU LilyPond music typesetter
+text-spanner.cc -- implement Text_spanner
 
-  (c) 2000 Jan Nieuwenhuizen <janneke@gnu.org>
+source file of the GNU LilyPond music typesetter
+
+(c) 2000--2002 Jan Nieuwenhuizen <janneke@gnu.org>
 */
 
 #include "molecule.hh"
 #include "text-item.hh"
 #include "text-spanner.hh"
+#include "line-spanner.hh"
 #include "spanner.hh"
-#include "lookup.hh"
+#include "font-interface.hh"
 #include "dimensions.hh"
 #include "paper-def.hh"
-#include "debug.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
-    - style: hairpin ?
- */
+  - 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);
 
+/*
+  TODO: this function is too long, too hairy.
+
+  TODO: document this. What the heck is happening here?
+*/
 SCM
 Text_spanner::brew_molecule (SCM smob) 
 {
-  Score_element *me= unsmob_element (smob);
+  Grob *me= unsmob_grob (smob);
   Spanner *spanner = dynamic_cast<Spanner*> (me);
-
-  Real staff_space = Staff_symbol_referencer::staff_space (me);
-  Real thickness = me->paper_l ()->get_var ("stafflinethickness");  
   
+  if (spanner->internal_has_interface (ly_symbol2scm ("piano-pedal-interface")))
+    {
+      setup_pedal_bracket(spanner);
+    }
+
+  /* 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;
 
   Drul_array<bool> broken;
+  Drul_array<Real> extra_off;
   Direction d = LEFT;
   do
     {
-      Paper_column* s = dynamic_cast<Paper_column*>(spanner->get_bound (d)); // UGH
-      broken[d] = (!s->musical_b ());
+      extra_off [d]=0;
+      Item *b = spanner->get_bound (d);
+      broken[d] = b->break_status_dir () != CENTER;
+
+      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;
+           }
+         else
+           {
+             width += d * r;
+             extra_off[d] = r;
+           }
+       }
     }
   while (flip (&d) != LEFT);
-  
-#if 0
-  SCM s = me->get_elt_property ("text-style");
 
-  String text_style = "italic";
-  if (gh_string_p (s))
-    text_style = ly_scm2string (s);
-#endif
+  // FIXME: ecs tells us -- only for (de)cresc. spanners
+  width += gh_scm2double (me->get_grob_property ("width-correct"));
+  /* /Ugh */
 
-  SCM properties = gh_append2 (me->immutable_property_alist_,
-                              me->mutable_property_alist_);
-  SCM edge_text = me->get_elt_property ("edge-text");
+  // who is ecs? --hwn
+
+  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))
     {
       Direction d = LEFT;
       do
        {
-         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);
+         /*  Don't repeat edge text for broken end */
+         if (!broken[d])
+           {
+             SCM text = index_get_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_elt_property ("shorten");
+  SCM s = me->get_grob_property ("shorten-pair");
   if (gh_pair_p (s))
     {
-      shorten[LEFT] = gh_scm2double (gh_car (s)) * staff_space;
-      shorten[RIGHT] = gh_scm2double (gh_cdr (s)) * staff_space;
+      shorten[LEFT] = gh_scm2double (ly_car (s));
+      shorten[RIGHT] = gh_scm2double (ly_cdr (s));
     }
 
-  Real broken_left =  spanner->get_broken_left_end_align ();
-  Real width = spanner->spanner_length ();
-  Score_element *bnd = spanner->get_bound (RIGHT);
-  width += bnd->extent (bnd, X_AXIS).length ();
-  width -= broken_left;
   width -= shorten[LEFT] + shorten[RIGHT];
-  width -= edge[LEFT].extent (X_AXIS).length ()
-    + edge[RIGHT].extent (X_AXIS).length ();
-
+  
   if (width < 0)
     {
-      warning (_ ("Text_spanner too small"));
+      me->warning (_ ("Text_spanner too small"));
       width = 0;
     }
 
+  /* ugh */
+  
+  Real thick = me->get_paper ()->get_var ("linethickness");  
+  SCM st = me->get_grob_property ("thickness");
+  if (gh_number_p (st))
+    {
+      thick *=  gh_scm2double (st);
 
-  String type = "dashed-line";
-  s = me->get_elt_property ("type");
-  if (gh_string_p (s))
-    type = ly_scm2string (s);
-
-  Molecule line;
+    }
+  Molecule line = Line_spanner::line_molecule (me, thick, width, 0);
+  
   Drul_array<Molecule> edge_line;
-  if (type == "line"
-      || type == "dashed-line"
-      || type == "dotted-line")
+  s = me->get_grob_property ("edge-height");
+  SCM ew = me->get_grob_property ("edge-widen");
+  if (gh_pair_p (s))
     {
-      Real thick = thickness;
-      s = me->get_elt_property ("line-thickness");
-      if (gh_number_p (s))
-       thick *= gh_scm2double (s);
-  
-      // maybe these should be in line-thickness?
-      Real length = staff_space;
-      s = me->get_elt_property ("dash-length");
-      if (gh_number_p (s))
-       length = gh_scm2double (s) * staff_space;
-
-      Real period = 2 * length + thick;
-      s = me->get_elt_property ("dash-period");
-      if (gh_number_p (s))
-       period = gh_scm2double (s) * staff_space;
-      
-      if (type == "dotted-line")
-       length = thick;
-       
-      if (type == "line")
-       length = period + thick;
-
-      Real on = length - thick;
-      Real off = period - on;
-
-      SCM list = gh_list (ly_symbol2scm ("dashed-line"),
-                         gh_double2scm (thick),
-                         gh_double2scm (on),
-                         gh_double2scm (off),
-                         gh_double2scm (width),
-                         gh_double2scm (0),
-                         SCM_UNDEFINED);
-
-      Box b (Interval (0, width), Interval (-thick / 2, thick / 2));
-      line = Molecule (b, list);
-
-      s = me->get_elt_property ("edge-height");
-      if (gh_pair_p (s))
+      Direction d = LEFT;
+      int dir = to_dir (me->get_grob_property ("direction"));
+      do
        {
-         Direction d = LEFT;
-         int dir = to_dir (me->get_elt_property ("direction"));
-         do
+         Real dx = ( gh_pair_p (ew)  ? 
+                     gh_scm2double (index_get_cell (ew, d)) * d :  
+                     0 );
+         Real dy = gh_scm2double (index_get_cell (s, d)) * - dir;
+         if (dy)
            {
-             Real dy = gh_scm2double (index_cell (s, d)) * - dir;
-             if (dy)
-               {
-                 SCM list = gh_list (ly_symbol2scm ("dashed-line"),
-                                     gh_double2scm (thick),
-                                     gh_double2scm (on),
-                                     gh_double2scm (off),
-                                     gh_double2scm (0),
-                                     gh_double2scm (dy),
-                                     SCM_UNDEFINED);
-                 
-                 Box b (Interval (0, thick),
-                        dy > 0
-                        ? Interval (0, dy)
-                        : Interval (dy, 0));
-                 edge_line[d] = Molecule (b, list);
-               }
+             edge_line[d] = Line_spanner::line_molecule (me, thick, dx, dy);
            }
-         while (flip (&d) != LEFT);
        }
+      while (flip (&d) != LEFT);
     }
-
+  
   Molecule m;
   if (!edge[LEFT].empty_b ())
     m = edge[LEFT];
@@ -182,14 +170,128 @@ Text_spanner::brew_molecule (SCM smob)
   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);
+    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], 0);
+    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, X_AXIS);
+  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->get_paper ()->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);
+
+  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_get_cell (ew, d));
+      if ( !broken[d] && (ly_number_pair_p (eh) ) )
+       height[d] += gh_scm2double (index_get_cell (eh, d));
+      if ( ly_number_pair_p (sp) )
+       shorten[d] +=  gh_scm2double (index_get_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")))
+       {
+         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;
+             }
+           }
+       }
+      shorten[RIGHT] -= thick;
+    }
+
+  shorten[LEFT] += extra_short ;
+  
+  if (broken[LEFT])
+    {
+      shorten[LEFT]  -=  me->get_broken_left_end_align () ;
+      shorten[RIGHT]  +=  abs(width[RIGHT])  +  thick  -  r[RIGHT];
+    }
 
-  return m.create_scheme ();
+  else
+    {
+      // 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]);
+    }
+
+  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));
 }
 
 
+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",
+              "generic text spanner",
+              "dash-period if-text-padding dash-length edge-height edge-widen edge-text shorten-pair type thickness outer width-correct");
+