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--2003 Jan Nieuwenhuizen <janneke@gnu.org>
   7
   8   Revised over good by Han-Wen.
   9 */
  10
  11 #include "molecule.hh"
  12 #include "text-item.hh"
  13 #include "text-spanner.hh"
  14 #include "line-spanner.hh"
  15 #include "spanner.hh"
  16 #include "font-interface.hh"
  17 #include "dimensions.hh"
  18 #include "paper-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, brew_molecule, 1);
  32
  33 /*
  34   TODO: this function is too long
  35 */
  36 SCM
  37 Text_spanner::brew_molecule (SCM smob)
  38 {
  39   Grob *me= unsmob_grob (smob);
  40   Spanner *spanner = dynamic_cast<Spanner*> (me);
  41
  42   /* Ugh, must be same as Hairpin::brew_molecule.  */
  43   Real padding = robust_scm2double ( me->get_grob_property ("if-text-padding"), 0);
  44
  45   Grob *common = spanner->get_bound (LEFT)->common_refpoint (spanner->get_bound (RIGHT), X_AXIS);
  46   Paper_def * paper = me->get_paper();
  47
  48   SCM flare = me->get_grob_property ("bracket-flare");
  49   SCM shorten = me->get_grob_property ("shorten-pair");
  50
  51   Interval span_points;
  52   Drul_array<bool> broken;
  53   Direction d = LEFT;
  54   do
  55     {
  56       Item *b = spanner->get_bound (d);
  57       broken[d] = b->break_status_dir () != CENTER;
  58
  59       if (broken[d])
  60         {
  61           if (d == LEFT)
  62             span_points[d] = spanner->get_broken_left_end_align ();
  63           else
  64             span_points[d] = b->relative_coordinate (common, X_AXIS);
  65         }
  66       else
  67           {
  68             bool encl = to_boolean (me->get_grob_property ("enclose-bounds"));
  69             span_points[d] = b->extent (common, X_AXIS)[encl ? d : -d];
  70
  71             if (is_number_pair (shorten))
  72               span_points -= d * gh_scm2double (index_get_cell (shorten, d));
  73           }
  74
  75       if (is_number_pair (flare))
  76         span_points -= d * gh_scm2double (index_get_cell (flare, d));
  77     }
  78   while (flip (&d) != LEFT);
  79
  80
  81   SCM properties = Font_interface::font_alist_chain (me);
  82   SCM edge_text = me->get_grob_property ("edge-text");
  83   Drul_array<Molecule> edge;
  84   if (gh_pair_p (edge_text))
  85     {
  86       Direction d = LEFT;
  87       do
  88         {
  89           if (!to_boolean (me->get_grob_property ("text-repeat-if-broken"))
  90               && broken[d])
  91             continue;
  92
  93           SCM text = index_get_cell (edge_text, d);
  94
  95           if (Text_item::markup_p (text))
  96             edge[d] = *unsmob_molecule (Text_item::interpret_markup (paper->self_scm (), properties, text));
  97
  98           if (!edge[d].is_empty ())
  99             edge[d].align_to (Y_AXIS, CENTER);
 100         }
 101       while (flip (&d) != LEFT);
 102     }
 103
 104   Drul_array<Real> edge_height = robust_scm2interval (me->get_grob_property ("edge-height"),
 105                                                       Interval (1.0, 1.0));
 106   Drul_array<Molecule> edge_line;
 107     {
 108       Direction d = LEFT;
 109       int dir = to_dir (me->get_grob_property ("direction"));
 110       do
 111         {
 112           if (broken[d])
 113             continue;
 114
 115           Real dx = 0.0;
 116           if (is_number_pair (flare))
 117             dx = gh_scm2double (index_get_cell (flare, d)) * d;
 118
 119           Real dy = - dir * edge_height[d] ;
 120           if (dy)
 121             edge_line[d] = Line_spanner::line_molecule (me, Offset(0,0), Offset (dx, dy));
 122         }
 123       while (flip (&d) != LEFT);
 124     }
 125
 126   Molecule m;
 127   do
 128     {
 129       Interval ext = edge[d].extent (X_AXIS);
 130       if (!ext.is_empty ())
 131         {
 132           edge[d].translate_axis (span_points[d], X_AXIS);
 133           m.add_molecule (edge[d]);
 134           span_points[d] += -d *  ext[-d];
 135         }
 136     }
 137   while (flip (&d) != LEFT);
 138   do
 139     {
 140       if (d* span_points[d] > d * edge[-d].extent(X_AXIS)[d])
 141         {
 142           edge_line[d].translate_axis (span_points[d], X_AXIS);
 143           m.add_molecule (edge_line[d]);
 144         }
 145     }
 146   while (flip (&d) != LEFT);
 147
 148   if (!span_points.is_empty ())
 149     {
 150       Molecule l =Line_spanner::line_molecule (me, Offset (span_points[LEFT], 0),
 151                                                Offset (span_points[RIGHT], 0));
 152       m.add_molecule (l);
 153     }
 154   m.translate_axis (- me->relative_coordinate (common, X_AXIS), X_AXIS);
 155   return m.smobbed_copy ();
 156 }
 157
 158 ADD_INTERFACE (Text_spanner,"text-spanner-interface",
 159                "generic text spanner",
 160                "text-repeat-if-broken dash-period if-text-padding dash-fraction edge-height bracket-flare edge-text shorten-pair style thickness enclose-bounds width-correct");
 161