lily/fingering-engraver.cc

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