lily/bar-number-engraver.cc

   1 /*
   2   bar-number-grav.cc -- implement Bar_number_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c)  1997--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9
  10 #include "lily-guile.hh"
  11 #include "paper-column.hh"
  12 #include "paper-def.hh"
  13 #include "side-position-interface.hh"
  14 #include "staff-symbol.hh"
  15 #include "item.hh"
  16 #include "moment.hh"
  17 #include "engraver.hh"
  18 #include "translator-group.hh"
  19
  20
  21 class Bar_number_engraver : public Engraver
  22 {
  23 protected:
  24   Item* text_p_;
  25
  26 protected:
  27   virtual void stop_translation_timestep ();
  28   virtual void acknowledge_grob (Grob_info);
  29   virtual void initialize ();
  30   virtual void create_grobs ();
  31   void create_items ();
  32   TRANSLATOR_DECLARATIONS(  Bar_number_engraver );
  33 };
  34
  35
  36 /*
  37   TODO: more advanced formatting via SCM function, perhaps barnumbers
  38   every 5 measures?  */
  39
  40 void
  41 Bar_number_engraver::create_grobs ()
  42 {
  43   // todo include (&&!time->cadenza_b_)
  44   SCM bn = get_property ("currentBarNumber");
  45   SCM smp = get_property ("measurePosition");
  46   Moment mp = (unsmob_moment (smp)) ? *unsmob_moment (smp) : Moment (0);
  47
  48   if (gh_number_p (bn) &&
  49       !mp.to_bool () && now_mom () > Moment (0))
  50     {
  51       create_items ();
  52
  53       // guh.
  54       text_p_->set_grob_property ("text",
  55                                  ly_str02scm (to_str (gh_scm2int (bn)).ch_C ()));
  56     }
  57 }
  58
  59
  60
  61 Bar_number_engraver::Bar_number_engraver ()
  62 {
  63   text_p_ =0;
  64 }
  65
  66 void
  67 Bar_number_engraver::initialize ()
  68 {
  69   /*
  70     ugh: need to share code with mark_engraver
  71    */
  72   daddy_trans_l_->set_property ("stavesFound", SCM_EOL);
  73 }
  74
  75
  76
  77 void
  78 Bar_number_engraver::acknowledge_grob (Grob_info inf)
  79 {
  80   Grob * s = inf.grob_l_;
  81   if (Staff_symbol::has_interface (s))
  82     {
  83       SCM sts = get_property ("stavesFound");
  84       SCM thisstaff = inf.grob_l_->self_scm ();
  85       if (scm_memq (thisstaff, sts) == SCM_BOOL_F)
  86         daddy_trans_l_->set_property ("stavesFound", gh_cons (thisstaff, sts));
  87     }
  88   else if (text_p_
  89            && dynamic_cast<Item*> (s)
  90            && s->get_grob_property ("break-align-symbol") == ly_symbol2scm ("Left_edge_item"))
  91     {
  92       /*
  93         By default this would land on the Paper_column -- so why
  94         doesn't it work when you leave this out?  */
  95       text_p_->set_parent (s, X_AXIS);
  96     }
  97 }
  98
  99 void
 100 Bar_number_engraver::stop_translation_timestep ()
 101 {
 102   if (text_p_)
 103     {
 104       text_p_->set_grob_property ("side-support-elements", get_property ("stavesFound"));
 105       typeset_grob (text_p_);
 106       text_p_ =0;
 107     }
 108 }
 109
 110
 111 void
 112 Bar_number_engraver::create_items ()
 113 {
 114   if (text_p_)
 115     return;
 116
 117   SCM b = get_property ("BarNumber");
 118   text_p_ = new Item (b);
 119   Side_position_interface::set_axis (text_p_,Y_AXIS);
 120
 121   announce_grob (text_p_, 0);
 122 }
 123
 124 ENTER_DESCRIPTION(Bar_number_engraver,
 125 /* descr */       "A bar number is created whenever measurePosition is zero. It is
 126 put on top of all staves, and appears only at  left side of the staff.",
 127 /* creats*/       "BarNumber",
 128 /* acks  */       "staff-symbol-interface break-aligned-interface",
 129 /* reads */       "currentBarNumber",
 130 /* write */       "");