lily/fingering-engraver.cc

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