/*
- bar-engraver.cc -- implement Bar_engraver
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
-
- (c) 1997, 1998, 1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
Jan Nieuwenhuizen <janneke@gnu.org>
+
+ LilyPond is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ LilyPond is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
*/
-#include "bar-engraver.hh"
-#include "bar.hh"
-#include "musical-request.hh"
-#include "multi-measure-rest.hh"
-#include "command-request.hh"
-#include "time-description.hh"
-#include "engraver-group.hh"
-#include "repeated-music.hh"
+#include "context.hh"
+#include "score-engraver.hh"
+#include "warn.hh"
+#include "item.hh"
+#include "spanner.hh"
-Bar_engraver::Bar_engraver()
-{
- bar_p_ =0;
- do_post_move_processing();
-}
+#include "translator.icc"
-bool
-Bar_engraver::do_try_music (Music*r_l)
+/*
+ generate bars. Either user ("|:"), or default (new measure)
+*/
+class Bar_engraver : public Engraver
{
- if (Bar_req * b= dynamic_cast <Bar_req *> (r_l))
- {
- if (bar_req_l_ && bar_req_l_->equal_b (b)) // huh?
- return false;
-
- bar_req_l_ = b;
+public:
+ TRANSLATOR_DECLARATIONS (Bar_engraver);
- return true;
- }
-
- return false;
+protected:
+ void stop_translation_timestep ();
+ void process_acknowledged ();
-}
+ void acknowledge_end_spanner (Grob_info);
-void
-Bar_engraver::acknowledge_element (Score_element_info i)
+private:
+ void create_bar ();
+
+ Item *bar_;
+ vector<Spanner *> spanners_;
+};
+
+Bar_engraver::Bar_engraver (Context *c)
+ : Engraver (c)
{
- if (Bar *b = dynamic_cast<Bar *> (i.elem_l_))
- {
- // only bar-engraver should create bars
- assert (0);
- }
+ bar_ = 0;
}
void
Bar_engraver::create_bar ()
{
- if (!bar_p_)
+ if (!bar_)
{
- bar_p_ = new Bar;
- bar_p_->break_priority_i_ = 0;
- // urg: "" != empty...
- String default_type = get_property ("defaultBarType", 0);
- if (default_type.length_i ())
- {
- bar_p_->type_str_ = default_type;
- }
- announce_element (Score_element_info (bar_p_, bar_req_l_));
+ bar_ = make_item ("BarLine", SCM_EOL);
+ SCM gl = get_property ("whichBar");
+ if (!ly_is_equal (gl, bar_->get_property ("glyph")))
+ bar_->set_property ("glyph", gl);
}
}
+/*
+ Bar_engraver should come *after* any engravers that
+ modify whichBar
+
+ This is a little hairy : whichBar may be set by
+ Repeat_acknowledge_engraver::process_music, which is at score
+ context. This means that grobs could should be created after
+ process_music. We do stuff process_acknowledged (), just to be
+ on the safe side.
+*/
+
void
-Bar_engraver::request_bar (String type_str)
+Bar_engraver::process_acknowledged ()
{
-#if 0 // will dump core at announce_element (invalid daddy_grav_l_...)
- create_bar ();
-#else
- if (!bar_p_)
- {
- bar_p_ = new Bar;
- bar_p_->break_priority_i_ = 0;
- // urg: "" != empty...
- String default_type = get_property ("defaultBarType", 0);
- if (default_type.length_i ())
- {
- bar_p_->type_str_ = default_type;
- }
- }
-#endif
- if (((type_str == "|:") && (bar_p_->type_str_ == ":|"))
- || ((type_str == ":|") && (bar_p_->type_str_ == "|:")))
- bar_p_->type_str_ = ":|:";
- else
- bar_p_->type_str_ = type_str;
-}
+ if (!bar_ && scm_is_string (get_property ("whichBar")))
+ create_bar ();
-void
-Bar_engraver::do_creation_processing ()
-{
- create_bar ();
- bar_p_->type_str_ = "";
- Scalar prop = get_property ("barAuto", 0);
- auto_create_bar_b_ = prop.to_bool ();
+ if (bar_)
+ for (vsize i = 0; i < spanners_.size (); i++)
+ spanners_[i]->set_bound (RIGHT, bar_);
}
+/*
+ lines may only be broken if there is a barline in all staves
+*/
void
-Bar_engraver::do_removal_processing ()
+Bar_engraver::stop_translation_timestep ()
{
- if (bar_p_)
- {
- typeset_element (bar_p_);
- bar_p_ =0;
- }
-}
+ if (!bar_)
+ context ()->get_score_context ()->set_property ("forbidBreak", SCM_BOOL_T);
-void
-Bar_engraver::do_process_requests()
-{
- Time_description const *time = get_staff_info().time_C_;
- if (bar_req_l_)
- {
- create_bar ();
- bar_p_->type_str_ = bar_req_l_->type_str_;
- }
- else
- {
- Scalar always = get_property ("barAlways", 0);
- if ((time && !time->whole_in_measure_) || always.to_bool ())
- {
- if (auto_create_bar_b_)
- create_bar ();
- Scalar prop = get_property ("barAuto", 0);
- auto_create_bar_b_ = prop.to_bool ();
- }
- }
-
- if (!bar_p_)
- {
- Break_req r;
- r.penalty_i_ = Break_req::DISALLOW;
- daddy_grav_l ()->try_music (&r);
- }
+ bar_ = 0;
+ spanners_.clear ();
}
-
-void
-Bar_engraver::do_pre_move_processing()
+void
+Bar_engraver::acknowledge_end_spanner (Grob_info gi)
{
- if (bar_p_)
- {
- typeset_element (bar_p_);
- bar_p_ =0;
- }
+ Grob *g = gi.grob ();
+
+ if (to_boolean (g->get_property ("to-barline")))
+ spanners_.push_back (dynamic_cast<Spanner *> (g));
}
+
void
-Bar_engraver::do_post_move_processing()
+Bar_engraver::boot ()
{
- bar_req_l_ = 0;
+ ADD_END_ACKNOWLEDGER (Bar_engraver, spanner);
}
+ADD_TRANSLATOR (Bar_engraver,
+ /* doc */
+ "Create barlines. This engraver is controlled through the"
+ " @code{whichBar} property. If it has no bar line to create,"
+ " it will forbid a linebreak at this point. This engraver"
+ " is required to trigger the creation of clefs at the start"
+ " of systems.",
+ /* create */
+ "BarLine ",
-ADD_THIS_TRANSLATOR(Bar_engraver);
-
+ /* read */
+ "whichBar ",
+ /* write */
+ "forbidBreak "
+ );