lily/note-head-line-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2000--2014 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   DECLARE_ACKNOWLEDGER (rhythmic_head);
  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 ()
  55 {
  56   line_ = 0;
  57   follow_ = false;
  58   head_ = 0;
  59   last_head_ = 0;
  60   last_staff_ = 0;
  61 }
  62
  63 void
  64 Note_head_line_engraver::acknowledge_rhythmic_head (Grob_info info)
  65 {
  66   head_ = info.grob ();
  67   Context *tr = context ();
  68
  69   while (tr && !tr->is_alias (ly_symbol2scm ("Staff")))
  70     tr = tr->get_parent_context ();
  71
  72   if (tr
  73       && tr->is_alias (ly_symbol2scm ("Staff")) && tr != last_staff_
  74       && to_boolean (get_property ("followVoice")))
  75     {
  76       if (last_head_)
  77         follow_ = true;
  78     }
  79   last_staff_ = tr;
  80 }
  81
  82 void
  83 Note_head_line_engraver::process_acknowledged ()
  84 {
  85   if (!line_ && follow_ && last_head_ && head_)
  86     {
  87       /* TODO: Don't follow if there's a beam.
  88
  89       We can't do beam-stuff here, since beam doesn't exist yet.
  90       Should probably store follow_ in line_, and suicide at some
  91       later point */
  92       if (follow_)
  93         line_ = make_spanner ("VoiceFollower", head_->self_scm ());
  94
  95       line_->set_bound (LEFT, last_head_);
  96       line_->set_bound (RIGHT, head_);
  97
  98       follow_ = false;
  99     }
 100 }
 101
 102 void
 103 Note_head_line_engraver::stop_translation_timestep ()
 104 {
 105   line_ = 0;
 106   if (head_)
 107     last_head_ = head_;
 108   head_ = 0;
 109 }
 110
 111 #include "translator.icc"
 112
 113 ADD_ACKNOWLEDGER (Note_head_line_engraver, rhythmic_head);
 114 ADD_TRANSLATOR (Note_head_line_engraver,
 115                 /* doc */
 116                 "Engrave a line between two note heads, for example a"
 117                 " glissando.  If @code{followVoice} is set, staff switches"
 118                 " also generate a line.",
 119
 120                 /* create */
 121                 "Glissando "
 122                 "VoiceFollower ",
 123
 124                 /* read */
 125                 "followVoice ",
 126
 127                 /* write */
 128                 ""
 129                );