]> git.donarmstrong.com Git - lilypond.git/blob - lily/bar-number-engraver.cc
Doc-es: update Vocal.
[lilypond.git] / lily / bar-number-engraver.cc
1 /*
2   This file is part of LilyPond, the GNU music typesetter.
3
4   Copyright (C) 1997--2011 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 = get_property ("alternativeNumberingStyle") == ly_symbol2scm ("numbers")
66                           || get_property ("alternativeNumberingStyle") == ly_symbol2scm ("numbers-with-letters");
67   if (make_alternative)
68     {
69       /*
70         if we're starting the first alternative, we set the starting
71         bar number to the current bar number
72       */
73       if (alternative_dir == LEFT)
74         alternative_starting_bar_number_ = current_barnumber;
75
76       /*
77         if the alternative is not the last one, we send the
78         current bar number back to the alternative bar number.
79       */
80       if (alternative_dir < RIGHT)
81         current_barnumber = alternative_starting_bar_number_;
82
83       context ()->set_property ("currentBarNumber", scm_from_int (current_barnumber));
84     }
85 }
86
87 void
88 Bar_number_engraver::process_music ()
89 {
90   SCM wb = get_property ("whichBar");
91
92   if (scm_is_string (wb))
93     {
94       Moment mp (robust_scm2moment (get_property ("measurePosition"), Moment (0)));
95       SCM bn = get_property ("currentBarNumber");
96       SCM proc = get_property ("barNumberVisibility");
97       if (scm_is_number (bn) && ly_is_procedure (proc)
98           && to_boolean (scm_call_2 (proc, bn, mp.smobbed_copy ())))
99         {
100           create_items ();
101           SCM alternative_style = get_property ("alternativeNumberingStyle");
102           string text_tag = "";
103           if (alternative_style == ly_symbol2scm ("numbers-with-letters"))
104             {
105               if (alternative_event_)
106                 {
107                   Direction alternative_dir = robust_scm2dir (alternative_event_->get_property ("alternative-dir"), RIGHT);
108                   switch (alternative_dir)
109                     {
110                     case LEFT:
111                       alternative_number_ = 0;
112                       break;
113                     case CENTER:
114                       break;
115                     case RIGHT:
116                       alternative_number_ = INT_MIN;
117                       break;
118                     default:
119                       assert (false);
120                     }
121                   alternative_number_ += alternative_number_increment_;
122
123                   alternative_number_increment_ = robust_scm2int (alternative_event_->get_property ("alternative-increment"), 1);
124                 }
125             }
126           SCM formatter = get_property ("barNumberFormatter");
127           if (ly_is_procedure (formatter))
128             text_->set_property ("text", scm_call_4 (formatter,
129                                                      bn,
130                                                      mp.smobbed_copy (),
131                                                      scm_from_int (alternative_number_),
132                                                      context ()->self_scm ()));
133         }
134     }
135 }
136
137 Bar_number_engraver::Bar_number_engraver ()
138 {
139   text_ = 0;
140   alternative_starting_bar_number_ = 0;
141   alternative_number_increment_ = 0;
142   alternative_number_ = INT_MIN;
143   alternative_event_ = 0;
144 }
145
146 void
147 Bar_number_engraver::acknowledge_break_alignment (Grob_info inf)
148 {
149   Grob *s = inf.grob ();
150   if (text_
151       && dynamic_cast<Item *> (s))
152     {
153       text_->set_parent (s, X_AXIS);
154     }
155 }
156
157 void
158 Bar_number_engraver::stop_translation_timestep ()
159 {
160   alternative_event_ = 0;
161   if (text_)
162     {
163       text_->set_object ("side-support-elements",
164                          grob_list_to_grob_array (get_property ("stavesFound")));
165       text_ = 0;
166     }
167 }
168
169 void
170 Bar_number_engraver::create_items ()
171 {
172   if (text_)
173     return;
174
175   text_ = make_item ("BarNumber", SCM_EOL);
176 }
177
178 ADD_ACKNOWLEDGER (Bar_number_engraver, break_alignment);
179
180 ADD_TRANSLATOR (Bar_number_engraver,
181                 /* doc */
182                 "A bar number is created whenever @code{measurePosition} is"
183                 " zero and when there is a bar line (i.e., when"
184                 " @code{whichBar} is set).  It is put on top of all staves,"
185                 " and appears only at the left side of the staff.  The staves"
186                 " are taken from @code{stavesFound}, which is maintained by"
187                 " @ref{Staff_collecting_engraver}.",
188
189                 /* create */
190                 "BarNumber ",
191
192                 /* read */
193                 "currentBarNumber "
194                 "whichBar "
195                 "stavesFound "
196                 "barNumberFormatter "
197                 "barNumberVisibility "
198                 "alternativeNumberingStyle ",
199
200                 /* write */
201                 "currentBarNumber "
202                );