lily/fingering-engraver.cc

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