lily/note-column.cc

   1 /*
   2   note-column.cc -- implement Note_column
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9 #include "note-column.hh"
  10
  11 #include <math.h>               // ceil
  12
  13 #include "axis-group-interface.hh"
  14 #include "stem.hh"
  15 #include "warn.hh"
  16 #include "output-def.hh"
  17 #include "staff-symbol-referencer.hh"
  18 #include "rest.hh"
  19 #include "note-head.hh"
  20 #include "accidental-placement.hh"
  21
  22 /*
  23   TODO: figure out if we can prune this class. This is just an
  24   annoying layer between (rest)collision & (note-head + stem)
  25 */
  26
  27 bool
  28 Note_column::has_rests (Grob *me)
  29 {
  30   return unsmob_grob (me->get_object ("rest"));
  31 }
  32
  33 int
  34 Note_column::shift_compare (Grob *const &p1, Grob *const &p2)
  35 {
  36   SCM s1 = p1->get_property ("horizontal-shift");
  37   SCM s2 = p2->get_property ("horizontal-shift");
  38
  39   int h1 = (scm_is_number (s1)) ? scm_to_int (s1) : 0;
  40   int h2 = (scm_is_number (s2)) ? scm_to_int (s2) : 0;
  41   return h1 - h2;
  42 }
  43
  44 Item *
  45 Note_column::get_stem (Grob *me)
  46 {
  47   SCM s = me->get_object ("stem");
  48   return unsmob_item (s);
  49 }
  50
  51 Slice
  52 Note_column::head_positions_interval (Grob *me)
  53 {
  54   Slice iv;
  55
  56   iv.set_empty ();
  57
  58   extract_grob_set (me, "note-heads", heads);
  59   for (int i = 0; i < heads.size(); i++)
  60     {
  61       Grob *se = heads[i];
  62
  63       int j = Staff_symbol_referencer::get_rounded_position (se);
  64       iv.unite (Slice (j, j));
  65     }
  66   return iv;
  67 }
  68
  69 Direction
  70 Note_column::dir (Grob *me)
  71 {
  72   Grob *stem = unsmob_grob (me->get_object ("stem"));
  73   if (stem && Stem::has_interface (stem))
  74     return Stem::get_direction (stem);
  75   else if (scm_is_pair (me->get_object ("note-heads")))
  76     return (Direction)sign (head_positions_interval (me).center ());
  77
  78   programming_error ("note column without heads and stem");
  79   return CENTER;
  80 }
  81
  82 void
  83 Note_column::set_stem (Grob *me, Grob *stem)
  84 {
  85   me->set_object ("stem", stem->self_scm ());
  86   me->add_dependency (stem);
  87   Axis_group_interface::add_element (me, stem);
  88 }
  89
  90 Grob *
  91 Note_column::get_rest (Grob *me)
  92 {
  93   return unsmob_grob (me->get_object ("rest"));
  94 }
  95
  96 void
  97 Note_column::add_head (Grob *me, Grob *h)
  98 {
  99   bool both = false;
 100   if (Rest::has_interface (h))
 101     {
 102       extract_grob_set (me, "note-heads", heads);
 103       if (heads.size ())
 104         both = true;
 105       else
 106         me->set_object ("rest", h->self_scm ());
 107     }
 108   else if (Note_head::has_interface (h))
 109     {
 110       if (unsmob_grob (me->get_object ("rest")))
 111         both = true;
 112       Pointer_group_interface::add_grob (me, ly_symbol2scm ("note-heads"), h);
 113     }
 114
 115   if (both)
 116     me->warning (_ ("can't have note heads and rests together on a stem"));
 117   else
 118     Axis_group_interface::add_element (me, h);
 119 }
 120
 121 /**
 122    translate the rest symbols vertically by amount DY, but only if
 123    they have no staff-position set.
 124 */
 125 void
 126 Note_column::translate_rests (Grob *me, int dy)
 127 {
 128   Grob *r = unsmob_grob (me->get_object ("rest"));
 129   if (r && !scm_is_number (r->get_property ("staff-position")))
 130     {
 131       r->translate_axis (dy * Staff_symbol_referencer::staff_space (r) / 2.0, Y_AXIS);
 132       Grob *p = r->get_parent (Y_AXIS);
 133       p->flush_extent_cache (Y_AXIS);
 134     }
 135 }
 136
 137 void
 138 Note_column::set_dotcol (Grob *me, Grob *d)
 139 {
 140   Axis_group_interface::add_element (me, d);
 141 }
 142
 143 Grob *
 144 Note_column::first_head (Grob *me)
 145 {
 146   Grob *st = get_stem (me);
 147   return st ? Stem::first_head (st) : 0;
 148 }
 149
 150 /*
 151   Return the first Accidentals grob that we find in a note-head.
 152 */
 153 Grob *
 154 Note_column::accidentals (Grob *me)
 155 {
 156   extract_grob_set (me, "note-heads", heads);
 157   Grob *acc = 0;
 158   for (int i = 0; i < heads.size(); i++)
 159     {
 160       Grob *h = heads[i];
 161       acc = h ? unsmob_grob (h->get_object ("accidental-grob")) : 0;
 162       if (acc)
 163         break;
 164     }
 165
 166   if (!acc)
 167     return 0;
 168
 169   if (Accidental_placement::has_interface (acc->get_parent (X_AXIS)))
 170     return acc->get_parent (X_AXIS);
 171
 172   /* compatibility. */
 173   return acc;
 174 }
 175
 176 ADD_INTERFACE (Note_column, "note-column-interface",
 177                "Stem and noteheads combined",
 178                "arpeggio note-heads rest-collision rest horizontal-shift stem accidentals force-hshift");
 179