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