lily/ottava-bracket.cc

   1 /*
   2   ottava-bracket.cc -- implement Ottava_bracket
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2004--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #include "text-interface.hh"
  10 #include "spanner.hh"
  11 #include "font-interface.hh"
  12 #include "dimensions.hh"
  13 #include "output-def.hh"
  14 #include "warn.hh"
  15 #include "paper-column.hh"
  16 #include "staff-symbol-referencer.hh"
  17 #include "note-column.hh"
  18 #include "directional-element-interface.hh"
  19 #include "tuplet-bracket.hh"
  20 #include "rhythmic-head.hh"
  21 #include "pointer-group-interface.hh"
  22
  23 struct Ottava_bracket
  24 {
  25   DECLARE_SCHEME_CALLBACK (print, (SCM));
  26   DECLARE_GROB_INTERFACE ();
  27 };
  28
  29 /*
  30   TODO: the string for ottava shoudl depend on the available space, ie.
  31
  32   Long: 15ma        Short: 15ma    Empty: 15
  33   8va                8va            8
  34   8va bassa          8ba            8
  35 */
  36 MAKE_SCHEME_CALLBACK (Ottava_bracket, print, 1);
  37 SCM
  38 Ottava_bracket::print (SCM smob)
  39 {
  40   Spanner *me = dynamic_cast<Spanner *> (unsmob_grob (smob));
  41   Interval span_points;
  42
  43   Grob *common = me->get_bound (LEFT)->common_refpoint (me->get_bound (RIGHT), X_AXIS);
  44   Output_def *layout = me->layout ();
  45
  46   Drul_array<bool> broken;
  47   Direction d = LEFT;
  48   do
  49     {
  50       Item *b = me->get_bound (d);
  51       broken[d] = (b->break_status_dir () != CENTER);
  52
  53       if (Note_column::has_interface (b))
  54         {
  55           extract_grob_set (b, "note-heads", heads);
  56           common = common_refpoint_of_array (heads, common, X_AXIS);
  57           for (vsize i = 0; i < heads.size (); i++)
  58             {
  59               Grob *h = heads[i];
  60               Grob *dots = Rhythmic_head::get_dots (h);
  61               if (dots)
  62                 common = dots->common_refpoint (common, X_AXIS);
  63             }
  64         }
  65     }
  66   while (flip (&d) != LEFT);
  67
  68   SCM properties = Font_interface::text_font_alist_chain (me);
  69   SCM markup = me->get_property ("text");
  70   Stencil text;
  71   if (Text_interface::is_markup (markup))
  72     text = *unsmob_stencil (Text_interface::interpret_markup (layout->self_scm (),
  73                                                               properties, markup));
  74
  75   Drul_array<Real> shorten = robust_scm2interval (me->get_property ("shorten-pair"),
  76                                                   Interval (0, 0));
  77
  78   /*
  79     TODO: we should check if there are ledgers, and modify length of
  80     the spanner to that.
  81   */
  82   do
  83     {
  84       Item *b = me->get_bound (d);
  85
  86       Interval ext;
  87       if (Note_column::has_interface (b))
  88         {
  89           extract_grob_set (b, "note-heads", heads);
  90           for (vsize i = 0; i < heads.size (); i++)
  91             {
  92               Grob *h = heads[i];
  93               ext.unite (h->extent (common, X_AXIS));
  94               Grob *dots = Rhythmic_head::get_dots (h);
  95
  96               if (dots && d == RIGHT)
  97                 ext.unite (dots->extent (common, X_AXIS));
  98             }
  99         }
 100
 101       if (ext.is_empty ())
 102         ext = robust_relative_extent (b, common, X_AXIS);
 103
 104       if (broken[d])
 105         {
 106           span_points[d] = b->extent (common, X_AXIS)[RIGHT];
 107           shorten[d] = 0.;
 108         }
 109
 110       else
 111         span_points[d] = ext[d];
 112     }
 113   while (flip (&d) != LEFT);
 114
 115   /*
 116     0.3 is ~ italic correction.
 117   */
 118   Real text_size = text.extent (X_AXIS).is_empty ()
 119     ? 0.0 : text.extent (X_AXIS)[RIGHT] + 0.3;
 120
 121   span_points[LEFT]
 122     = min (span_points[LEFT],
 123            (span_points[RIGHT] - text_size
 124             - robust_scm2double (me->get_property ("minimum-length"), -1.0)));
 125
 126   Interval bracket_span_points = span_points;
 127   bracket_span_points[LEFT] += text_size;
 128
 129   Drul_array<Real> edge_height = robust_scm2interval (me->get_property ("edge-height"),
 130                                                       Interval (1.0, 1.0));
 131
 132   Drul_array<Real> flare = robust_scm2interval (me->get_property ("bracket-flare"),
 133                                                 Interval (0, 0));
 134
 135   do
 136     {
 137       edge_height[d] *= -get_grob_direction (me);
 138       if (broken[d])
 139         edge_height[d] = 0.0;
 140     }
 141   while (flip(&d) != LEFT);
 142
 143   Stencil b;
 144   Interval empty;
 145   if (!bracket_span_points.is_empty () && bracket_span_points.length () > 0.001)
 146     b = Tuplet_bracket::make_bracket (me,
 147                                       Y_AXIS, Offset (bracket_span_points.length (), 0),
 148                                       edge_height,
 149                                       empty,
 150                                       flare, shorten);
 151
 152   /*
 153     The vertical lines should not take space, for the following scenario:
 154
 155     8 -----+
 156     o  |
 157     |
 158     |
 159
 160
 161     Just a small amount, yes.  In tight situations, it is even
 162     possible to center the `8' directly below the note, dropping the
 163     ottava line completely...
 164
 165   */
 166
 167   b = Stencil (Box (b.extent (X_AXIS),
 168                     Interval (0.1, 0.1)),
 169                b.expr ());
 170
 171   b.translate_axis (bracket_span_points[LEFT], X_AXIS);
 172   text.translate_axis (span_points[LEFT], X_AXIS);
 173   text.align_to (Y_AXIS, CENTER);
 174   b.add_stencil (text);
 175
 176   b.translate_axis (- me->relative_coordinate (common, X_AXIS), X_AXIS);
 177
 178   return b.smobbed_copy ();
 179 }
 180
 181 ADD_INTERFACE (Ottava_bracket,
 182                "An ottava bracket.",
 183
 184                /* properties */
 185                "edge-height "
 186                "bracket-flare "
 187                "shorten-pair "
 188                "minimum-length "
 189                );
 190