lily/span-bar-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--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 "item.hh"
  21 #include "engraver.hh"
  22 #include "pointer-group-interface.hh"
  23 #include "lily-imports.hh"
  24
  25 #include "translator.icc"
  26
  27 using std::vector;
  28
  29 /**
  30
  31 Make bars that span multiple "staves". Catch bars, and span a
  32 Span_bar over them if we find more than 2 bars.  Vertical alignment
  33 of staves changes the appearance of spanbars.  It is up to the
  34 aligner (Vertical_align_engraver, in this case, to add extra
  35 dependencies to the spanbars.
  36 */
  37 class Span_bar_engraver : public Engraver
  38 {
  39   Item *spanbar_;
  40   bool make_spanbar_;
  41   vector<Item *> bars_;
  42
  43 public:
  44   TRANSLATOR_DECLARATIONS (Span_bar_engraver);
  45 protected:
  46   DECLARE_ACKNOWLEDGER (bar_line);
  47   void stop_translation_timestep ();
  48   void process_acknowledged ();
  49 };
  50
  51 Span_bar_engraver::Span_bar_engraver ()
  52 {
  53   spanbar_ = 0;
  54   make_spanbar_ = false;
  55 }
  56
  57 void
  58 Span_bar_engraver::acknowledge_bar_line (Grob_info i)
  59 {
  60   int depth = i.origin_contexts (this).size ();
  61   if (depth && !i.grob ()->internal_has_interface (ly_symbol2scm ("span-bar-interface")))
  62     {
  63       Item *it = dynamic_cast<Item *> (i.grob ());
  64       bars_.push_back (it);
  65
  66       if (bars_.size () >= 2 && !spanbar_)
  67         make_spanbar_ = true;
  68     }
  69 }
  70
  71 void
  72 Span_bar_engraver::process_acknowledged ()
  73 {
  74   if (make_spanbar_)
  75     {
  76       spanbar_ = make_item ("SpanBar", SCM_EOL);
  77
  78       spanbar_->set_parent (bars_[0], X_AXIS);
  79       for (vsize i = 0; i < bars_.size (); i++)
  80         Pointer_group_interface::add_grob (spanbar_, ly_symbol2scm ("elements"), bars_[i]);
  81       make_spanbar_ = false;
  82     }
  83 }
  84
  85 void
  86 Span_bar_engraver::stop_translation_timestep ()
  87 {
  88   if (spanbar_)
  89     {
  90       SCM vis = bars_[0]->get_property ("break-visibility");
  91       if (ly_is_equal (spanbar_->get_property ("break-visibility"), vis))
  92         spanbar_->set_property ("break-visibility", vis);
  93       Lily::span_bar_notify_grobs_of_my_existence (spanbar_->self_scm ());
  94       spanbar_ = 0;
  95     }
  96   bars_.resize (0);
  97 }
  98
  99 ADD_ACKNOWLEDGER (Span_bar_engraver, bar_line);
 100 ADD_TRANSLATOR (Span_bar_engraver,
 101                 /* doc */
 102                 "Make cross-staff bar lines: It catches all normal bar lines"
 103                 " and draws a single span bar across them.",
 104
 105                 /* create */
 106                 "SpanBar ",
 107
 108                 /* read */
 109                 "",
 110
 111                 /* write */
 112                 ""
 113                );