lily/bar-number-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include <algorithm> // for reverse
  21
  22 #include "paper-column.hh"
  23 #include "output-def.hh"
  24 #include "side-position-interface.hh"
  25 #include "engraver.hh"
  26 #include "context.hh"
  27 #include "grob-array.hh"
  28 #include "stream-event.hh"
  29
  30 #include "translator.icc"
  31
  32 /*
  33   TODO: detect the top staff (stavesFound), and acknowledge staff-group
  34   system-start-delims. If we find these, and the top staff is in the
  35   staff-group, add padding to the bar number.
  36 */
  37 class Bar_number_engraver : public Engraver
  38 {
  39 protected:
  40   Item *text_;
  41   int alternative_starting_bar_number_;
  42   int alternative_number_;
  43   int alternative_number_increment_;
  44   Stream_event *alternative_event_;
  45
  46 protected:
  47   void stop_translation_timestep ();
  48   DECLARE_TRANSLATOR_LISTENER (alternative);
  49   DECLARE_ACKNOWLEDGER (break_alignment);
  50   void process_music ();
  51   void create_items ();
  52   TRANSLATOR_DECLARATIONS (Bar_number_engraver);
  53 };
  54
  55 IMPLEMENT_TRANSLATOR_LISTENER (Bar_number_engraver, alternative);
  56 void
  57 Bar_number_engraver::listen_alternative (Stream_event *ev)
  58 {
  59   if (alternative_event_)
  60     return;
  61
  62   alternative_event_ = ev;
  63   int current_barnumber = robust_scm2int (get_property ("currentBarNumber"), 0);
  64   Direction alternative_dir = robust_scm2dir (ev->get_property ("alternative-dir"), CENTER);
  65   bool make_alternative = scm_is_eq (get_property ("alternativeNumberingStyle"),
  66                                      ly_symbol2scm ("numbers"))
  67                           || scm_is_eq (get_property ("alternativeNumberingStyle"),
  68                                         ly_symbol2scm ("numbers-with-letters"));
  69   if (make_alternative)
  70     {
  71       /*
  72         if we're starting the first alternative, we set the starting
  73         bar number to the current bar number
  74       */
  75       if (alternative_dir == LEFT)
  76         alternative_starting_bar_number_ = current_barnumber;
  77
  78       /*
  79         if the alternative is not the last one, we send the
  80         current bar number back to the alternative bar number.
  81       */
  82       if (alternative_dir < RIGHT)
  83         current_barnumber = alternative_starting_bar_number_;
  84
  85       context ()->set_property ("currentBarNumber", scm_from_int (current_barnumber));
  86     }
  87 }
  88
  89 void
  90 Bar_number_engraver::process_music ()
  91 {
  92   SCM wb = get_property ("whichBar");
  93
  94   if (scm_is_string (wb))
  95     {
  96       Moment mp (robust_scm2moment (get_property ("measurePosition"), Moment (0)));
  97       SCM bn = get_property ("currentBarNumber");
  98       SCM proc = get_property ("barNumberVisibility");
  99       if (scm_is_number (bn) && ly_is_procedure (proc)
 100           && to_boolean (scm_call_2 (proc, bn, mp.smobbed_copy ())))
 101         {
 102           create_items ();
 103           SCM alternative_style = get_property ("alternativeNumberingStyle");
 104           string text_tag = "";
 105           if (scm_is_eq (alternative_style, ly_symbol2scm ("numbers-with-letters")))
 106             {
 107               if (alternative_event_)
 108                 {
 109                   Direction alternative_dir = robust_scm2dir (alternative_event_->get_property ("alternative-dir"), RIGHT);
 110                   switch (alternative_dir)
 111                     {
 112                     case LEFT:
 113                       alternative_number_ = 0;
 114                       break;
 115                     case CENTER:
 116                       break;
 117                     case RIGHT:
 118                       alternative_number_ = INT_MIN;
 119                       break;
 120                     default:
 121                       assert (false);
 122                     }
 123                   alternative_number_ += alternative_number_increment_;
 124
 125                   alternative_number_increment_ = robust_scm2int (alternative_event_->get_property ("alternative-increment"), 1);
 126                 }
 127             }
 128           SCM formatter = get_property ("barNumberFormatter");
 129           if (ly_is_procedure (formatter))
 130             text_->set_property ("text", scm_call_4 (formatter,
 131                                                      bn,
 132                                                      mp.smobbed_copy (),
 133                                                      scm_from_int (alternative_number_),
 134                                                      context ()->self_scm ()));
 135         }
 136     }
 137 }
 138
 139 Bar_number_engraver::Bar_number_engraver ()
 140 {
 141   text_ = 0;
 142   alternative_starting_bar_number_ = 0;
 143   alternative_number_increment_ = 0;
 144   alternative_number_ = INT_MIN;
 145   alternative_event_ = 0;
 146 }
 147
 148 void
 149 Bar_number_engraver::acknowledge_break_alignment (Grob_info inf)
 150 {
 151   Grob *s = inf.grob ();
 152   if (text_
 153       && dynamic_cast<Item *> (s))
 154     {
 155       text_->set_parent (s, X_AXIS);
 156     }
 157 }
 158
 159 void
 160 Bar_number_engraver::stop_translation_timestep ()
 161 {
 162   alternative_event_ = 0;
 163   if (text_)
 164     {
 165       text_->set_object ("side-support-elements",
 166                          grob_list_to_grob_array (get_property ("stavesFound")));
 167       text_ = 0;
 168     }
 169 }
 170
 171 void
 172 Bar_number_engraver::create_items ()
 173 {
 174   if (text_)
 175     return;
 176
 177   text_ = make_item ("BarNumber", SCM_EOL);
 178 }
 179
 180 ADD_ACKNOWLEDGER (Bar_number_engraver, break_alignment);
 181
 182 ADD_TRANSLATOR (Bar_number_engraver,
 183                 /* doc */
 184                 "A bar number is created whenever @code{measurePosition} is"
 185                 " zero and when there is a bar line (i.e., when"
 186                 " @code{whichBar} is set).  It is put on top of all staves,"
 187                 " and appears only at the left side of the staff.  The staves"
 188                 " are taken from @code{stavesFound}, which is maintained by"
 189                 " @ref{Staff_collecting_engraver}.",
 190
 191                 /* create */
 192                 "BarNumber ",
 193
 194                 /* read */
 195                 "currentBarNumber "
 196                 "whichBar "
 197                 "stavesFound "
 198                 "barNumberFormatter "
 199                 "barNumberVisibility "
 200                 "alternativeNumberingStyle ",
 201
 202                 /* write */
 203                 "currentBarNumber "
 204                );