lily/note-head-line-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 #include "pointer-group-interface.hh"
  22 #include "stem.hh"
  23 #include "rhythmic-head.hh"
  24 #include "side-position-interface.hh"
  25 #include "staff-symbol-referencer.hh"
  26 #include "context.hh"
  27 #include "spanner.hh"
  28 #include "item.hh"
  29
  30 /**
  31    Create line-spanner grobs for lines that connect note heads.
  32
  33    TODO: have the line commit suicide if the notes are connected with
  34    either slur or beam.
  35 */
  36 class Note_head_line_engraver : public Engraver
  37 {
  38 public:
  39   TRANSLATOR_DECLARATIONS (Note_head_line_engraver);
  40
  41 protected:
  42   void acknowledge_rhythmic_head (Grob_info);
  43   void process_acknowledged ();
  44   void stop_translation_timestep ();
  45
  46 private:
  47   Spanner *line_;
  48   Context *last_staff_;
  49   bool follow_;
  50   Grob *head_;
  51   Grob *last_head_;
  52 };
  53
  54 Note_head_line_engraver::Note_head_line_engraver (Context *c)
  55   : Engraver (c)
  56 {
  57   line_ = 0;
  58   follow_ = false;
  59   head_ = 0;
  60   last_head_ = 0;
  61   last_staff_ = 0;
  62 }
  63
  64 void
  65 Note_head_line_engraver::acknowledge_rhythmic_head (Grob_info info)
  66 {
  67   head_ = info.grob ();
  68   Context *tr = find_context_above (context (), ly_symbol2scm ("Staff"));
  69   if (tr
  70       && tr != last_staff_
  71       && to_boolean (get_property ("followVoice")))
  72     {
  73       if (last_head_)
  74         follow_ = true;
  75     }
  76   last_staff_ = tr;
  77 }
  78
  79 void
  80 Note_head_line_engraver::process_acknowledged ()
  81 {
  82   if (!line_ && follow_ && last_head_ && head_)
  83     {
  84       /* TODO: Don't follow if there's a beam.
  85
  86       We can't do beam-stuff here, since beam doesn't exist yet.
  87       Should probably store follow_ in line_, and suicide at some
  88       later point */
  89       if (follow_)
  90         line_ = make_spanner ("VoiceFollower", head_->self_scm ());
  91
  92       line_->set_bound (LEFT, last_head_);
  93       line_->set_bound (RIGHT, head_);
  94
  95       follow_ = false;
  96     }
  97 }
  98
  99 void
 100 Note_head_line_engraver::stop_translation_timestep ()
 101 {
 102   line_ = 0;
 103   if (head_)
 104     last_head_ = head_;
 105   head_ = 0;
 106 }
 107
 108 #include "translator.icc"
 109
 110 void
 111 Note_head_line_engraver::boot ()
 112 {
 113   ADD_ACKNOWLEDGER (Note_head_line_engraver, rhythmic_head);
 114 }
 115
 116 ADD_TRANSLATOR (Note_head_line_engraver,
 117                 /* doc */
 118                 "Engrave a line between two note heads in a staff"
 119                 " switch if @code{followVoice} is set.",
 120
 121                 /* create */
 122                 "VoiceFollower ",
 123
 124                 /* read */
 125                 "followVoice ",
 126
 127                 /* write */
 128                 ""
 129                );