]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/bar-engraver.cc
Issue 5167/6: Changes: show \markup xxx = ... \etc assignments
[lilypond.git] / lily / bar-engraver.cc
index 1dc6c18fafef76859e9896a9eb1fbe75235ad6b8..fb39ae4955c5f301f141bc32b527362cfa74b759 100644 (file)
 /*
-  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 "context.hh"
 #include "score-engraver.hh"
-#include "bar-engraver.hh"
-#include "staff-bar.hh"
-#include "musical-request.hh"
-#include "multi-measure-rest.hh"
-#include "command-request.hh"
-#include "timing-engraver.hh"
-#include "engraver-group-engraver.hh"
 #include "warn.hh"
+#include "item.hh"
+#include "spanner.hh"
 
-ADD_THIS_TRANSLATOR (Bar_engraver);
+#include "translator.icc"
 
-Bar_engraver::Bar_engraver()
+/*
+  generate bars. Either user ("|:"), or default (new measure)
+*/
+class Bar_engraver : public Engraver
 {
-  bar_p_ =0;
-  do_post_move_processing();
-}
+public:
+  TRANSLATOR_DECLARATIONS (Bar_engraver);
+
+protected:
+  void stop_translation_timestep ();
+  void process_acknowledged ();
 
+  void acknowledge_end_spanner (Grob_info);
 
+private:
+  void create_bar ();
 
+  Item *bar_;
+  vector<Spanner *> spanners_;
+};
+
+Bar_engraver::Bar_engraver (Context *c)
+  : Engraver (c)
+{
+  bar_ = 0;
+}
 
 void
 Bar_engraver::create_bar ()
 {
-  if (!bar_p_)
+  if (!bar_)
     {
-      bar_p_ = new Staff_bar;
-      bar_p_->set_elt_property ("break-aligned", SCM_BOOL_T);
-
-      // urg: "" != empty...
-      SCM default_type = get_property ("defaultBarType", 0);
-      if (gh_string_p (default_type))
-       {
-         bar_p_->set_elt_property ("glyph", default_type); // gu.h
-       }
-
-#if 0
-      /*
-       urg.  Why did I implement this? And did I implement this so
-       clumsily?  */
-      SCM prop = get_property ("barAtLineStart", 0);
-      if (to_boolean (prop))
-       {
-         bar_p_->set_elt_property ("at-line-start", SCM_BOOL_T);
-       }
-#endif
-      announce_element (Score_element_info (bar_p_, 0));
+      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);
     }
 }
 
-/**
-   Make a barline.  If there are both |: and :| requested, merge them
-   to :|:.
-
+/*
+  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 requested_type)
+Bar_engraver::process_acknowledged ()
 {
-  if (!now_mom ())
-    {
-      SCM prop = get_property ("barAtLineStart", 0);
-      if (!to_boolean (prop))
-       return;
-    }
-  bool  bar_existed = bar_p_;
-  create_bar ();
-  if (bar_existed && requested_type == "")
-    {
-      return;
-    }
+  if (!bar_ && scm_is_string (get_property ("whichBar")))
+    create_bar ();
 
-  String current = ly_scm2string (bar_p_->get_elt_property ("glyph"));
-  
-  if ((requested_type == "|:" && current== ":|")
-    || (requested_type == ":|" && current == "|:"))
-    requested_type = ":|:";
-
-  
-  bar_p_->set_elt_property ("glyph",
-                           ly_str02scm (requested_type.ch_C ()));
-}
-
-void 
-Bar_engraver::do_creation_processing ()
-{
+  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);
+
+  bar_ = 0;
+  spanners_.clear ();
 }
 
 void
-Bar_engraver::do_process_requests()
-{  
-  Translator * t = daddy_grav_l  ()->get_simple_translator ("Timing_engraver");
-
-  Timing_engraver * te = dynamic_cast<Timing_engraver*>(t);
-  String which = (te) ? te->which_bar () : "";
+Bar_engraver::acknowledge_end_spanner (Grob_info gi)
+{
+  Grob *g = gi.grob ();
 
-  if (which.length_i ())
-    {
-      create_bar();
-      bar_p_->set_elt_property ("glyph",  ly_str02scm (which.ch_C ()));
-    }
-  
-  if (!bar_p_)
-    {
-      Score_engraver * e = 0;
-      Translator * t  =  daddy_grav_l ();
-      for (; !e && t;  t = t->daddy_trans_l_)
-       {
-         e = dynamic_cast<Score_engraver*> (t);
-       }
-      
-      if (!e)
-       programming_error ("No score engraver!");
-      else
-       e->forbid_breaks ();
-    }
+  if (to_boolean (g->get_property ("to-barline")))
+    spanners_.push_back (dynamic_cast<Spanner *> (g));
 }
 
 
-void 
-Bar_engraver::do_pre_move_processing()
+void
+Bar_engraver::boot ()
 {
-  if (bar_p_) 
-    {
-      typeset_element (bar_p_);
-      bar_p_ =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 ",
+
+                /* read */
+                "whichBar ",
+
+                /* write */
+                "forbidBreak "
+               );