lily/ottava-bracket.cc

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