lily/bar-engraver.cc

   1 /*
   2   bar-engraver.cc -- implement Bar_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7   Jan Nieuwenhuizen <janneke@gnu.org>
   8 */
   9
  10 #include "bar-line.hh"
  11 #include "score-engraver.hh"
  12 #include "event.hh"
  13 #include "engraver-group-engraver.hh"
  14 #include "warn.hh"
  15 #include "item.hh"
  16 #include "engraver.hh"
  17
  18 /*
  19   generate bars. Either user ("|:"), or default (new measure)
  20
  21   */
  22 class Bar_engraver : public Engraver
  23 {
  24 public:
  25   TRANSLATOR_DECLARATIONS (Bar_engraver);
  26   void request_bar (String type_string);
  27
  28 protected:
  29   virtual void finalize ();
  30   virtual void stop_translation_timestep ();
  31   virtual void process_acknowledged_grobs ();
  32
  33 private:
  34   void typeset_bar ();
  35   void create_bar ();
  36
  37   Item * bar_;
  38 };
  39
  40 Bar_engraver::Bar_engraver ()
  41 {
  42   bar_ =0;
  43 }
  44
  45 void
  46 Bar_engraver::create_bar ()
  47 {
  48   if (!bar_)
  49     {
  50       bar_ = make_item ("BarLine", SCM_EOL);
  51       SCM gl = get_property ("whichBar");
  52       if (scm_equal_p (gl, bar_->get_property ("glyph")) != SCM_BOOL_T)
  53           bar_->set_property ("glyph", gl);
  54     }
  55 }
  56
  57 void
  58 Bar_engraver::finalize ()
  59 {
  60   typeset_bar ();
  61 }
  62
  63 /*
  64   Bar_engraver should come *after* any engravers that
  65   modify whichBar
  66
  67   This is a little hairy : whichBar may be set by
  68   Repeat_acknowledge_engraver::process_music, which is at score
  69   context. This means that grobs could should be created after
  70   process_music. We do stuff process_acknowledged_grobs (), just to be
  71   on the safe side.
  72
  73 */
  74
  75 void
  76 Bar_engraver::process_acknowledged_grobs ()
  77 {
  78   if (!bar_ && ly_c_string_p (get_property ("whichBar")))
  79     {
  80       create_bar ();
  81     }
  82 }
  83
  84 void
  85 Bar_engraver::typeset_bar ()
  86 {
  87   if (bar_)
  88     {
  89       typeset_grob (bar_);
  90       bar_ =0;
  91     }
  92 }
  93
  94 /*
  95   lines may only be broken if there is a barline in all staves
  96 */
  97 void
  98 Bar_engraver::stop_translation_timestep ()
  99 {
 100   if (!bar_)
 101     {
 102       get_score_engraver ()->forbid_breaks ();  // guh. Use properties!
 103     }
 104   else
 105     typeset_bar ();
 106 }
 107
 108
 109 ENTER_DESCRIPTION (Bar_engraver,
 110 /* descr */       "Create barlines. This engraver is controlled through the "
 111 "@code{whichBar} property. If it has no bar line to create, it will forbid a linebreak at this point",
 112 /* creats*/       "BarLine",
 113 /* accepts */     "",
 114 /* acks  */      "",
 115 /* reads */       "whichBar",
 116 /* write */       "");