lily/fingering-engraver.cc

   1 /*
   2   fingering-engraver.cc -- implement Fingering_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1998--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #include "engraver.hh"
  10 #include "pitch.hh"
  11 #include "rhythmic-head.hh"
  12 #include "self-alignment-interface.hh"
  13 #include "side-position-interface.hh"
  14 #include "stem.hh"
  15 #include "stream-event.hh"
  16 #include "item.hh"
  17
  18 #include "translator.icc"
  19
  20 class Fingering_engraver : public Engraver
  21 {
  22   vector<Stream_event*> events_;
  23   vector<Item*> fingerings_;
  24
  25 public:
  26   TRANSLATOR_DECLARATIONS (Fingering_engraver);
  27 protected:
  28   void stop_translation_timestep ();
  29   void process_music ();
  30   DECLARE_TRANSLATOR_LISTENER (fingering);
  31   DECLARE_TRANSLATOR_LISTENER (stroke_finger);
  32   DECLARE_ACKNOWLEDGER (rhythmic_head);
  33   DECLARE_ACKNOWLEDGER (stem);
  34
  35 private:
  36   void make_script (Direction, Stream_event *, int);
  37 };
  38
  39 IMPLEMENT_TRANSLATOR_LISTENER (Fingering_engraver, fingering);
  40 void
  41 Fingering_engraver::listen_fingering (Stream_event *ev)
  42 {
  43   events_.push_back (ev);
  44 }
  45
  46 IMPLEMENT_TRANSLATOR_LISTENER (Fingering_engraver, stroke_finger);
  47 void
  48 Fingering_engraver::listen_stroke_finger (Stream_event *ev)
  49 {
  50   /*
  51     FIXME: should do something.
  52
  53     This function is mainly here to shut up a warning
  54    */
  55   (void)ev;
  56 }
  57
  58 void
  59 Fingering_engraver::acknowledge_stem (Grob_info inf)
  60 {
  61   for (vsize i = 0; i < fingerings_.size (); i++)
  62     Side_position_interface::add_support (fingerings_[i], inf.grob ());
  63 }
  64
  65 void
  66 Fingering_engraver::acknowledge_rhythmic_head (Grob_info inf)
  67 {
  68   for (vsize i = 0; i < fingerings_.size (); i++)
  69     {
  70       Grob *t = fingerings_[i];
  71       Side_position_interface::add_support (t, inf.grob ());
  72       if (!t->get_parent (X_AXIS))
  73         t->set_parent (inf.grob (), X_AXIS);
  74     }
  75 }
  76
  77 void
  78 Fingering_engraver::process_music ()
  79 {
  80   for (vsize i = events_.size (); i--;)
  81     {
  82       SCM dir = events_[i]->get_property ("direction");
  83       make_script (to_dir (dir), events_[i], i);
  84     }
  85 }
  86
  87 void
  88 Fingering_engraver::make_script (Direction d, Stream_event *r, int i)
  89 {
  90   Item *fingering = make_item ("Fingering", r->self_scm ());
  91
  92   /*
  93     Huh, what's this for? --hwn.
  94
  95     junkme.
  96   */
  97   SCM pitch = r->get_property ("pitch");
  98   if (unsmob_pitch (pitch))
  99     fingering->set_property ("pitch", pitch);
 100
 101   /*
 102     We can't fold these definitions into define-grobs since
 103     fingerings for chords need different settings.
 104   */
 105   Side_position_interface::set_axis (fingering, Y_AXIS);
 106   Self_alignment_interface::set_align_self (fingering, X_AXIS);
 107   Self_alignment_interface::set_center_parent (fingering, X_AXIS);
 108
 109   // Hmm
 110   int priority = 200;
 111   SCM s = fingering->get_property ("script-priority");
 112   if (scm_is_number (s))
 113     priority = scm_to_int (s);
 114
 115   /* See script-engraver.cc */
 116   priority += i;
 117
 118   fingering->set_property ("script-priority", scm_from_int (priority));
 119
 120   if (!is_direction (fingering->get_property_data ("direction")))
 121     {
 122       if (d)
 123         fingering->set_property ("direction", scm_from_int (d));
 124       else
 125         fingering->set_property ("direction", scm_from_int (RIGHT));
 126     }
 127
 128   fingerings_.push_back (fingering);
 129 }
 130
 131 void
 132 Fingering_engraver::stop_translation_timestep ()
 133 {
 134   if (!fingerings_.size ())
 135     return;
 136
 137   fingerings_.clear ();
 138   events_.clear ();
 139 }
 140
 141 Fingering_engraver::Fingering_engraver ()
 142 {
 143 }
 144
 145 ADD_ACKNOWLEDGER (Fingering_engraver, rhythmic_head);
 146 ADD_ACKNOWLEDGER (Fingering_engraver, stem);
 147
 148 ADD_TRANSLATOR (Fingering_engraver,
 149                 /* doc */
 150                 "Create fingering scripts.",
 151
 152                 /* create */
 153                 "Fingering ",
 154
 155                 /* read */
 156                 "",
 157
 158                 /* write */
 159                 ""
 160                 );