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 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   void listen_fingering (Stream_event *);
  42   void acknowledge_rhythmic_head (Grob_info);
  43   void acknowledge_stem (Grob_info);
  44   void acknowledge_flag (Grob_info);
  45
  46 private:
  47   void make_script (Direction, Stream_event *, int);
  48 };
  49
  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_flag (Grob_info inf)
  65 {
  66   for (vsize i = 0; i < fingerings_.size (); i++)
  67     Side_position_interface::add_support (fingerings_[i], inf.grob ());
  68 }
  69
  70 void
  71 Fingering_engraver::acknowledge_rhythmic_head (Grob_info inf)
  72 {
  73   for (vsize i = 0; i < fingerings_.size (); i++)
  74     {
  75       Grob *t = fingerings_[i];
  76       Side_position_interface::add_support (t, inf.grob ());
  77       if (!t->get_parent (X_AXIS))
  78         t->set_parent (inf.grob (), X_AXIS);
  79     }
  80 }
  81
  82 void
  83 Fingering_engraver::process_music ()
  84 {
  85   for (vsize i = events_.size (); i--;)
  86     {
  87       SCM dir = events_[i]->get_property ("direction");
  88       make_script (to_dir (dir), events_[i], i);
  89     }
  90 }
  91
  92 void
  93 Fingering_engraver::make_script (Direction d, Stream_event *r, int i)
  94 {
  95   Item *fingering = make_item ("Fingering", r->self_scm ());
  96
  97   /*
  98     Huh, what's this for? --hwn.
  99
 100     junkme.
 101   */
 102   SCM pitch = r->get_property ("pitch");
 103   if (unsmob<Pitch> (pitch))
 104     fingering->set_property ("pitch", pitch);
 105
 106   /*
 107     We can't fold these definitions into define-grobs since
 108     fingerings for chords need different settings.
 109   */
 110   Side_position_interface::set_axis (fingering, Y_AXIS);
 111   Self_alignment_interface::set_aligned_on_parent (fingering, X_AXIS);
 112
 113   // Hmm
 114   int priority = 200;
 115   SCM s = fingering->get_property ("script-priority");
 116   if (scm_is_number (s))
 117     priority = scm_to_int (s);
 118
 119   /* See script-engraver.cc */
 120   priority += i;
 121
 122   fingering->set_property ("script-priority", scm_from_int (priority));
 123
 124   if (d)
 125     fingering->set_property ("direction", scm_from_int (d));
 126   else if (!is_direction (fingering->get_property_data ("direction")))
 127     fingering->set_property ("direction", scm_from_int (UP));
 128
 129   fingerings_.push_back (fingering);
 130 }
 131
 132 void
 133 Fingering_engraver::stop_translation_timestep ()
 134 {
 135   fingerings_.clear ();
 136   events_.clear ();
 137 }
 138
 139 Fingering_engraver::Fingering_engraver (Context *c)
 140   : Engraver (c)
 141 {
 142 }
 143
 144
 145 void
 146 Fingering_engraver::boot ()
 147 {
 148   ADD_LISTENER (Fingering_engraver, fingering);
 149   ADD_ACKNOWLEDGER (Fingering_engraver, rhythmic_head);
 150   ADD_ACKNOWLEDGER (Fingering_engraver, stem);
 151   ADD_ACKNOWLEDGER (Fingering_engraver, flag);
 152 }
 153
 154 ADD_TRANSLATOR (Fingering_engraver,
 155                 /* doc */
 156                 "Create fingering scripts.",
 157
 158                 /* create */
 159                 "Fingering ",
 160
 161                 /* read */
 162                 "",
 163
 164                 /* write */
 165                 ""
 166                );