lily/tuplet-spanner.cc

   1 /*
   2   plet-spanner.cc -- implement Tuplet_spanner
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c)  1997--2000 Jan Nieuwenhuizen <janneke@gnu.org>
   7 */
   8
   9
  10 #include "beam.hh"
  11 #include "box.hh"
  12 #include "debug.hh"
  13 #include "font-interface.hh"
  14 #include "molecule.hh"
  15 #include "paper-column.hh"
  16 #include "paper-def.hh"
  17 #include "text-item.hh"
  18 #include "tuplet-spanner.hh"
  19 #include "stem.hh"
  20 #include "note-column.hh"
  21 #include "dimensions.hh"
  22 #include "group-interface.hh"
  23 #include "directional-element-interface.hh"
  24 #include "spanner.hh"
  25
  26 void
  27 Tuplet_spanner::set_interface (Grob*me)
  28 {
  29   me->set_interface (ly_symbol2scm ("tuplet-bracket"));
  30 }
  31
  32 /*
  33   TODO.
  34  */
  35
  36 MAKE_SCHEME_CALLBACK(Tuplet_spanner,brew_molecule,1);
  37
  38 SCM
  39 Tuplet_spanner::brew_molecule (SCM smob)
  40 {
  41   Grob *me= unsmob_grob (smob);
  42   Molecule  mol;
  43
  44   // Default behaviour: number always, bracket when no beam!
  45   bool par_beam = to_boolean (me->get_grob_property ("parallel-beam"));
  46   bool bracket_visibility = !par_beam;
  47   bool number_visibility = true;
  48
  49   SCM bracket = me->get_grob_property ("tuplet-bracket-visibility");
  50   if (gh_boolean_p (bracket))
  51     {
  52       bracket_visibility = gh_scm2bool (bracket);
  53     }
  54   else if (bracket == ly_symbol2scm ("if-no-beam"))
  55     bracket_visibility = !par_beam;
  56
  57   SCM numb = me->get_grob_property ("tuplet-number-visibility");
  58   if (gh_boolean_p (numb))
  59     {
  60       number_visibility = gh_scm2bool (numb);
  61     }
  62   else if (bracket == ly_symbol2scm ("if-no-beam"))
  63     number_visibility = !par_beam;
  64
  65   if (gh_pair_p (me->get_grob_property ("columns")))
  66     {
  67       Link_array<Grob> column_arr=
  68         Pointer_group_interface__extract_elements (me, (Grob*)0, "columns");
  69
  70       Real ncw = column_arr.top ()->extent(column_arr.top (), X_AXIS).length ();
  71       Real w = dynamic_cast<Spanner*>(me)->spanner_length () + ncw;
  72
  73       Real staff_space = 1.0;
  74       Direction dir = Directional_element_interface::get (me);
  75       Real dy = gh_scm2double (me->get_grob_property ("delta-y"));
  76       SCM number = me->get_grob_property ("text");
  77       if (gh_string_p (number) && number_visibility)
  78         {
  79           SCM properties = Font_interface::font_alist_chain (me);
  80           Molecule num = Text_item::text2molecule (me, number, properties);
  81           num.align_to (X_AXIS, CENTER);
  82           num.translate_axis (w/2, X_AXIS);
  83           num.align_to (Y_AXIS, CENTER);
  84           num.translate_axis (dir * staff_space, Y_AXIS);
  85
  86           num.translate_axis (dy/2, Y_AXIS);
  87
  88           mol.add_molecule (num);
  89         }
  90
  91       if (bracket_visibility)
  92         {
  93           Real  lt =  me->paper_l ()->get_var ("stafflinethickness");
  94
  95           SCM thick = me->get_grob_property ("thick");
  96           SCM gap = me->get_grob_property ("number-gap");
  97
  98           SCM at =gh_list(ly_symbol2scm ("tuplet"),
  99                           gh_double2scm (1.0),
 100                           gap,
 101                           gh_double2scm (w),
 102                           gh_double2scm (dy),
 103                           gh_double2scm (gh_scm2double (thick)* lt),
 104                           gh_int2scm (dir),
 105                           SCM_UNDEFINED);
 106
 107           Box b;
 108           mol.add_molecule (Molecule (b, at));
 109         }
 110     }
 111   return mol.smobbed_copy ();
 112 }
 113
 114
 115
 116
 117 /*
 118   use first -> last note for slope, and then correct for disturbing
 119   notes in between.  */
 120 void
 121 Tuplet_spanner::calc_position_and_height (Grob*me,Real *offset, Real * dy)
 122 {
 123   Link_array<Grob> column_arr=
 124     Pointer_group_interface__extract_elements (me, (Grob*)0, "columns");
 125
 126
 127   Grob * commony = me->common_refpoint (me->get_grob_property ("columns"), Y_AXIS);
 128   Grob * commonx = me->common_refpoint (me->get_grob_property ("columns"), X_AXIS);
 129
 130   Direction d = Directional_element_interface::get (me);
 131
 132   /*
 133     Use outer non-rest columns to determine slope
 134    */
 135   int l = 0;
 136   while (l <column_arr.size() && Note_column::rest_b(column_arr[l]))
 137     l ++;
 138
 139   int r = column_arr.size ()- 1;
 140   while (r >= l && Note_column::rest_b(column_arr[r]))
 141     r--;
 142
 143   if (l < r)
 144     {
 145       *dy = column_arr[r]->extent (commony, Y_AXIS) [d]
 146         - column_arr[l]->extent (commony, Y_AXIS) [d] ;
 147     }
 148   else
 149     * dy = 0;
 150
 151
 152   *offset = - d * infinity_f;
 153
 154   if (!column_arr.size ())
 155     return;
 156
 157   Real x0 = column_arr[0]->relative_coordinate (commonx, X_AXIS);
 158   Real x1 = column_arr.top ()->relative_coordinate (commonx, X_AXIS);
 159
 160   Real factor = column_arr.size () > 1 ? 1/(x1 - x0) : 1.0;
 161
 162   for (int i = 0; i < column_arr.size ();  i++)
 163     {
 164       Real notey = column_arr[i]->extent (commony, Y_AXIS)[d]
 165         - me->relative_coordinate (commony, Y_AXIS);
 166
 167       Real x = column_arr[i]->relative_coordinate (commonx, X_AXIS) - x0;
 168       Real tuplety =  *dy * x * factor;
 169
 170       if (notey * d > (*offset + tuplety) * d)
 171         *offset = notey - tuplety;
 172     }
 173 }
 174
 175 /*
 176   use first -> last note for slope,
 177 */
 178 void
 179 Tuplet_spanner::calc_dy (Grob*me,Real * dy)
 180 {
 181   Link_array<Grob> column_arr=
 182     Pointer_group_interface__extract_elements (me, (Grob*)0, "columns");
 183
 184   /*
 185     ugh. refps.
 186    */
 187   Direction d = Directional_element_interface::get (me);
 188   *dy = column_arr.top ()->extent (column_arr.top (), Y_AXIS) [d]
 189     - column_arr[0]->extent (column_arr[0], Y_AXIS) [d];
 190 }
 191 MAKE_SCHEME_CALLBACK(Tuplet_spanner,after_line_breaking,1);
 192
 193 SCM
 194 Tuplet_spanner::after_line_breaking (SCM smob)
 195 {
 196   Grob * me = unsmob_grob (smob);
 197   Link_array<Note_column> column_arr=
 198     Pointer_group_interface__extract_elements (me, (Note_column*)0, "columns");
 199   Spanner *sp = dynamic_cast<Spanner*> (me);
 200
 201
 202   if (!column_arr.size ())
 203     {
 204       me->suicide ();
 205       return SCM_UNSPECIFIED;
 206     }
 207
 208   Direction d = Directional_element_interface::get (me);
 209   if (!d)
 210     {
 211       d = Tuplet_spanner::get_default_dir (me);
 212       Directional_element_interface::set (me, d);
 213
 214     }
 215   Real dy, offset;
 216
 217   calc_position_and_height (me,&offset,&dy);
 218
 219   me->set_grob_property ("delta-y", gh_double2scm (dy));
 220
 221   me->translate_axis (offset, Y_AXIS);
 222
 223   if (scm_ilength (me->get_grob_property ("beams")) == 1)
 224     {
 225       SCM bs = me->get_grob_property ("beams");
 226       Grob *b = unsmob_grob (gh_car (bs));
 227       Spanner * beam_l = dynamic_cast<Spanner *> (b);
 228       if (!sp->broken_b ()
 229           && sp->get_bound (LEFT)->column_l () == beam_l->get_bound (LEFT)->column_l ()
 230           && sp->get_bound (RIGHT)->column_l () == beam_l->get_bound (RIGHT)->column_l ())
 231         me->set_grob_property ("parallel-beam", SCM_BOOL_T);
 232     }
 233   return SCM_UNSPECIFIED;
 234 }
 235
 236
 237 Direction
 238 Tuplet_spanner::get_default_dir (Grob*me)
 239 {
 240   Direction d = UP;
 241   SCM dir_sym =me->get_grob_property ("dir-forced");
 242   if (isdir_b (dir_sym))
 243     {
 244       d= to_dir (dir_sym);
 245       if (d != CENTER)
 246         return d;
 247     }
 248
 249   d = UP ;
 250   for (SCM s = me->get_grob_property ("columns"); gh_pair_p (s); s = gh_cdr (s))
 251     {
 252       Grob * nc = unsmob_grob (gh_car (s));
 253       if (Note_column::dir (nc) < 0)
 254         {
 255           d = DOWN;
 256           break;
 257         }
 258     }
 259
 260   return d;
 261 }
 262
 263 void
 264 Tuplet_spanner::add_beam (Grob*me, Grob *b)
 265 {
 266   me->add_dependency (b);
 267   Pointer_group_interface::add_element (me, "beams",b);
 268 }
 269
 270 void
 271 Tuplet_spanner::add_column (Grob*me, Item*n)
 272 {
 273   Pointer_group_interface::add_element (me, "columns",n);
 274   me->add_dependency (n);
 275
 276   add_bound_item (dynamic_cast<Spanner*> (me), n);
 277 }
 278
 279