lily/text-spanner.cc

   1 /*
   2   text-spanner.cc -- implement Text_spanner
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2000--2005 Jan Nieuwenhuizen <janneke@gnu.org>
   7
   8   Revised over good by Han-Wen.
   9 */
  10
  11 #include "text-spanner.hh"
  12
  13 #include "text-item.hh"
  14 #include "line-spanner.hh"
  15 #include "spanner.hh"
  16 #include "font-interface.hh"
  17 #include "dimensions.hh"
  18 #include "output-def.hh"
  19 #include "warn.hh"
  20 #include "paper-column.hh"
  21 #include "staff-symbol-referencer.hh"
  22
  23 /*
  24   TODO:
  25   - vertical start / vertical end (fixme-name) |
  26   - contination types (vert. star, vert. end)  |-> eat volta-bracket
  27   - more styles
  28   - more texts/positions
  29 */
  30
  31 MAKE_SCHEME_CALLBACK (Text_spanner, print, 1);
  32
  33 /*
  34   TODO: this function is too long
  35 */
  36 SCM
  37 Text_spanner::print (SCM smob)
  38 {
  39   Grob *me = unsmob_grob (smob);
  40   Spanner *spanner = dynamic_cast<Spanner*> (me);
  41
  42   /* Ugh, must be same as Hairpin::print.  */
  43
  44   Grob *common = spanner->get_bound (LEFT)->common_refpoint (spanner->get_bound (RIGHT), X_AXIS);
  45   Output_def * layout = me->get_layout ();
  46
  47   SCM flare = me->get_property ("bracket-flare");
  48   SCM shorten = me->get_property ("shorten-pair");
  49
  50   Interval span_points;
  51   Drul_array<bool> broken;
  52   Direction d = LEFT;
  53   do
  54     {
  55       Item *b = spanner->get_bound (d);
  56       broken[d] = b->break_status_dir () != CENTER;
  57
  58       if (broken[d])
  59         {
  60           if (d == LEFT)
  61             span_points[d] = spanner->get_broken_left_end_align ();
  62           else
  63             span_points[d] = b->relative_coordinate (common, X_AXIS);
  64         }
  65       else
  66           {
  67             Real encl = robust_scm2double (me->get_property ("enclose-bounds"), 0.0);
  68             Interval ext = b->extent (common, X_AXIS);
  69
  70             span_points[d] =
  71               robust_relative_extent (b, common, X_AXIS).linear_combination (d * encl);
  72
  73             if (is_number_pair (shorten))
  74               span_points -= d * scm_to_double (index_get_cell (shorten, d));
  75           }
  76
  77       if (is_number_pair (flare))
  78         span_points -= d * scm_to_double (index_get_cell (flare, d));
  79     }
  80   while (flip (&d) != LEFT);
  81
  82
  83   SCM properties = Font_interface::text_font_alist_chain (me);
  84   SCM edge_text = me->get_property ("edge-text");
  85   Drul_array<Stencil> edge;
  86   if (scm_is_pair (edge_text))
  87     {
  88       Direction d = LEFT;
  89       do
  90         {
  91           if (broken[d])
  92             continue;
  93
  94           SCM text = index_get_cell (edge_text, d);
  95
  96           if (Text_interface::markup_p (text))
  97             edge[d] = *unsmob_stencil (Text_interface::interpret_markup (layout->self_scm (), properties, text));
  98
  99           if (!edge[d].is_empty ())
 100             edge[d].align_to (Y_AXIS, CENTER);
 101         }
 102       while (flip (&d) != LEFT);
 103     }
 104
 105   Drul_array<Real> edge_height = robust_scm2interval (me->get_property ("edge-height"),
 106                                                       Interval (0.0, 0.0));
 107   Drul_array<Stencil> edge_line;
 108     {
 109       Direction d = LEFT;
 110       int dir = to_dir (me->get_property ("direction"));
 111       do
 112         {
 113           if (broken[d])
 114             continue;
 115
 116           Real dx = 0.0;
 117           if (is_number_pair (flare))
 118             dx = scm_to_double (index_get_cell (flare, d)) * d;
 119
 120           Real dy = - dir * edge_height[d] ;
 121           if (dy)
 122             edge_line[d] = Line_spanner::line_stencil (me, Offset (0, 0), Offset (dx, dy));
 123         }
 124       while (flip (&d) != LEFT);
 125     }
 126
 127   Stencil m;
 128   do
 129     {
 130       Interval ext = edge[d].extent (X_AXIS);
 131       if (!ext.is_empty ())
 132         {
 133           edge[d].translate_axis (span_points[d], X_AXIS);
 134           m.add_stencil (edge[d]);
 135           span_points[d] += -d *  ext[-d];
 136         }
 137     }
 138   while (flip (&d) != LEFT);
 139   do
 140     {
 141       if (d* span_points[d] > d * edge[-d].extent (X_AXIS)[d])
 142         {
 143           edge_line[d].translate_axis (span_points[d], X_AXIS);
 144           m.add_stencil (edge_line[d]);
 145         }
 146     }
 147   while (flip (&d) != LEFT);
 148
 149   if (!span_points.is_empty ())
 150     {
 151       Stencil l = Line_spanner::line_stencil (me, Offset (span_points[LEFT], 0),
 152                                                Offset (span_points[RIGHT], 0));
 153       m.add_stencil (l);
 154     }
 155   m.translate_axis (- me->relative_coordinate (common, X_AXIS), X_AXIS);
 156   return m.smobbed_copy ();
 157 }
 158
 159 ADD_INTERFACE (Text_spanner, "text-spanner-interface",
 160                "generic text spanner",
 161                "dash-period dash-fraction edge-height bracket-flare edge-text shorten-pair style thickness enclose-bounds");
 162