lily/bar-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5   Jan Nieuwenhuizen <janneke@gnu.org>
   6
   7   LilyPond is free software: you can redistribute it and/or modify
   8   it under the terms of the GNU General Public License as published by
   9   the Free Software Foundation, either version 3 of the License, or
  10   (at your option) any later version.
  11
  12   LilyPond is distributed in the hope that it will be useful,
  13   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15   GNU General Public License for more details.
  16
  17   You should have received a copy of the GNU General Public License
  18   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #include "context.hh"
  22 #include "score-engraver.hh"
  23 #include "warn.hh"
  24 #include "item.hh"
  25 #include "spanner.hh"
  26
  27 #include "translator.icc"
  28
  29 /*
  30   generate bars. Either user ("|:"), or default (new measure)
  31 */
  32 class Bar_engraver : public Engraver
  33 {
  34 public:
  35   TRANSLATOR_DECLARATIONS (Bar_engraver);
  36
  37 protected:
  38   void stop_translation_timestep ();
  39   void process_acknowledged ();
  40
  41   DECLARE_END_ACKNOWLEDGER (spanner);
  42
  43 private:
  44   void create_bar ();
  45
  46   Item *bar_;
  47   vector<Spanner *> spanners_;
  48 };
  49
  50 Bar_engraver::Bar_engraver ()
  51 {
  52   bar_ = 0;
  53 }
  54
  55 void
  56 Bar_engraver::create_bar ()
  57 {
  58   if (!bar_)
  59     {
  60       bar_ = make_item ("BarLine", SCM_EOL);
  61       SCM gl = get_property ("whichBar");
  62       if (scm_equal_p (gl, bar_->get_property ("glyph")) != SCM_BOOL_T)
  63         bar_->set_property ("glyph", gl);
  64     }
  65 }
  66
  67 /*
  68   Bar_engraver should come *after* any engravers that
  69   modify whichBar
  70
  71   This is a little hairy : whichBar may be set by
  72   Repeat_acknowledge_engraver::process_music, which is at score
  73   context. This means that grobs could should be created after
  74   process_music. We do stuff process_acknowledged (), just to be
  75   on the safe side.
  76 */
  77
  78 void
  79 Bar_engraver::process_acknowledged ()
  80 {
  81   if (!bar_ && scm_is_string (get_property ("whichBar")))
  82     create_bar ();
  83
  84   if (bar_)
  85     for (vsize i = 0; i < spanners_.size (); i++)
  86       spanners_[i]->set_bound (RIGHT, bar_);
  87 }
  88
  89 /*
  90   lines may only be broken if there is a barline in all staves
  91 */
  92 void
  93 Bar_engraver::stop_translation_timestep ()
  94 {
  95   if (!bar_)
  96     context ()->get_score_context ()->set_property ("forbidBreak", SCM_BOOL_T);
  97
  98   bar_ = 0;
  99   spanners_.clear ();
 100 }
 101
 102 void
 103 Bar_engraver::acknowledge_end_spanner (Grob_info gi)
 104 {
 105   Grob *g = gi.grob ();
 106
 107   if (to_boolean (g->get_property ("to-barline")))
 108     spanners_.push_back (dynamic_cast<Spanner *> (g));
 109 }
 110
 111 ADD_END_ACKNOWLEDGER (Bar_engraver, spanner);
 112
 113 ADD_TRANSLATOR (Bar_engraver,
 114                 /* doc */
 115                 "Create barlines.  This engraver is controlled through the"
 116                 " @code{whichBar} property.  If it has no bar line to create,"
 117                 " it will forbid a linebreak at this point.  This engraver"
 118                 " is required to trigger the creation of clefs at the start"
 119                 " of systems.",
 120
 121                 /* create */
 122                 "BarLine ",
 123
 124                 /* read */
 125                 "whichBar ",
 126
 127                 /* write */
 128                 "forbidBreak "
 129                );