lily/glissando-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2000--2015 Jan Nieuwenhuizen <janneke@gnu.org>
   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
  22 #include "international.hh"
  23 #include "pointer-group-interface.hh"
  24 #include "rhythmic-head.hh"
  25 #include "spanner.hh"
  26 #include "stream-event.hh"
  27 #include "warn.hh"
  28 #include "item.hh"
  29
  30 #include "translator.icc"
  31
  32 class Glissando_engraver : public Engraver
  33 {
  34 public:
  35   TRANSLATOR_DECLARATIONS (Glissando_engraver);
  36
  37 protected:
  38   void listen_glissando (Stream_event *);
  39   void acknowledge_note_column (Grob_info);
  40   virtual void finalize ();
  41
  42   void stop_translation_timestep ();
  43   void process_music ();
  44
  45 private:
  46   vector<Spanner *> lines_;
  47   vector<Spanner *> kill_me_;
  48   bool start_glissandi_;
  49   bool stop_glissandi_;
  50
  51   Stream_event *event_;
  52   vector<vsize> note_column_1;
  53   vector<vsize> note_column_2;
  54 };
  55
  56 Glissando_engraver::Glissando_engraver (Context *c)
  57   : Engraver (c)
  58 {
  59   event_ = 0;
  60   start_glissandi_ = false;
  61   stop_glissandi_ = false;
  62 }
  63
  64 void
  65 Glissando_engraver::listen_glissando (Stream_event *ev)
  66 {
  67   ASSIGN_EVENT_ONCE (event_, ev);
  68 }
  69
  70 void
  71 Glissando_engraver::process_music ()
  72 {
  73   if (event_)
  74     start_glissandi_ = true;
  75 }
  76
  77 void
  78 Glissando_engraver::acknowledge_note_column (Grob_info info)
  79 {
  80   Grob *g = info.grob ();
  81   if (to_boolean (g->get_property ("glissando-skip")))
  82     return;
  83
  84   if (stop_glissandi_)
  85     {
  86       extract_grob_set (g, "note-heads", note_heads);
  87       int glissando_index = 0;
  88       for (vsize i = 0; i < note_column_1.size (); i++)
  89         {
  90           if (note_column_2[i] >= note_heads.size ())
  91             {
  92               kill_me_.push_back (lines_[i]);
  93               announce_end_grob (lines_[i], SCM_EOL);
  94             }
  95           else
  96             {
  97               lines_[i]->set_bound (RIGHT, note_heads[note_column_2[i]]);
  98               lines_[i]->set_property ("glissando-index", scm_from_int (glissando_index));
  99               glissando_index++;
 100               announce_end_grob (lines_[i], note_heads[note_column_2[i]]->self_scm ());
 101             }
 102         }
 103       lines_.clear ();
 104       note_column_1.clear ();
 105       note_column_2.clear ();
 106       stop_glissandi_ = false;
 107     }
 108
 109   if (start_glissandi_)
 110     {
 111       extract_grob_set (g, "note-heads", note_heads);
 112       SCM map = get_property ("glissandoMap");
 113       if (scm_is_null (map))
 114         for (vsize i = 0; i < note_heads.size (); i++)
 115           {
 116             note_column_1.push_back (i);
 117             note_column_2.push_back (i);
 118           }
 119       else
 120         for (SCM m = map; scm_is_pair (m); m = scm_cdr (m))
 121           {
 122             SCM candidate = scm_car (m);
 123             if (!scm_is_pair (candidate))
 124               continue;
 125             int n1 = robust_scm2int (scm_car (candidate), -1);
 126             int n2 = robust_scm2int (scm_cdr (candidate), -1);
 127             if ((n1 < 0) || (n2 < 0) || (size_t (n1) >= note_heads.size ()))
 128               continue;
 129             note_column_1.push_back (vsize (n1));
 130             note_column_2.push_back (vsize (n2));
 131           }
 132       for (vsize i = 0; i < note_column_1.size (); i++)
 133         {
 134           lines_.push_back (make_spanner ("Glissando", event_->self_scm ()));
 135           lines_.back ()->set_bound (LEFT, note_heads[note_column_1[i]]);
 136         }
 137     }
 138 }
 139
 140 void
 141 Glissando_engraver::stop_translation_timestep ()
 142 {
 143   if (start_glissandi_)
 144     {
 145       if (stop_glissandi_)
 146         programming_error ("overwriting glissando");
 147       stop_glissandi_ = true;
 148       start_glissandi_ = false;
 149     }
 150   event_ = 0;
 151 }
 152
 153 void
 154 Glissando_engraver::finalize ()
 155 {
 156   if (!lines_.empty ())
 157     {
 158       string msg = _ ("unterminated glissando");
 159
 160       if (event_)
 161         event_->origin ()->warning (msg);
 162       else
 163         warning (msg);
 164
 165       for (vsize i = 0; i < lines_.size (); i++)
 166         lines_[i]->suicide ();
 167     }
 168
 169   for (vsize i = 0; i < kill_me_.size (); i++)
 170     kill_me_[i]->suicide ();
 171 }
 172
 173 void
 174 Glissando_engraver::boot ()
 175 {
 176   ADD_LISTENER (Glissando_engraver, glissando);
 177   ADD_ACKNOWLEDGER (Glissando_engraver, note_column);
 178 }
 179
 180 ADD_TRANSLATOR (Glissando_engraver,
 181                 /* doc */
 182                 "Engrave glissandi.",
 183
 184                 /* create */
 185                 "Glissando ",
 186
 187                 /* read */
 188                 "glissandoMap ",
 189
 190                 /* write */
 191                 ""
 192                );