]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/bar-number-engraver.cc
Web-ja: update introduction
[lilypond.git] / lily / bar-number-engraver.cc
index 455690e5165a34d02091e871b7fc330bfcf55eb7..44f155df6e24298ca81a6f20c45b8b63904abd74 100644 (file)
 /*
-  bar-number-grav.cc -- implement Bar_number_engraver
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c)  1997--1998 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  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 <algorithm> // for reverse
+
+#include "paper-column.hh"
+#include "output-def.hh"
+#include "side-position-interface.hh"
+#include "engraver.hh"
+#include "context.hh"
+#include "grob-array.hh"
+#include "stream-event.hh"
 
-#include "bar-number-engraver.hh"
-#include "script.hh"
-#include "text-def.hh"
-#include "paper-def.hh"
-#include "command-request.hh"
-#include "bar.hh"
-#include "span-bar.hh"
-#include "stem.hh"
-#include "time-description.hh"
+#include "translator.icc"
 
-Bar_number_engraver::Bar_number_engraver()
+/*
+  TODO: detect the top staff (stavesFound), and acknowledge staff-group
+  system-start-delims. If we find these, and the top staff is in the
+  staff-group, add padding to the bar number.
+*/
+class Bar_number_engraver : public Engraver
 {
-  script_p_ =0;
-}
+protected:
+  Item *text_;
+  int alternative_starting_bar_number_;
+  int alternative_number_;
+  int alternative_number_increment_;
+  Stream_event *alternative_event_;
+
+protected:
+  void stop_translation_timestep ();
+  void listen_alternative (Stream_event *);
+  void acknowledge_break_alignment (Grob_info);
+  void process_music ();
+  void create_items ();
+  TRANSLATOR_DECLARATIONS (Bar_number_engraver);
+};
 
 void
-Bar_number_engraver::acknowledge_element (Score_element_info i)
+Bar_number_engraver::listen_alternative (Stream_event *ev)
 {
-  Bar *b =dynamic_cast <Bar *> (i.elem_l_);
-  if (script_p_ || !b)
-      return;
-
-  /* Only put numbers on bars that are at our own level (don't put
-    numbers over the staffs of a GrandStaff, only over the GrandStaff
-    itself */
-  if (i.origin_grav_l_arr_.size() != 1)
+  if (alternative_event_)
     return;
 
-  Time_description const * time = get_staff_info().time_C_;
-  if (!time || time->cadenza_b_)
-    return;
-  
-  script_p_ = new Script;
-  Text_def *td_p = new Text_def;
-  td_p->text_str_ = to_str (time->bars_i_);
+  alternative_event_ = ev;
+  int current_barnumber = robust_scm2int (get_property ("currentBarNumber"), 0);
+  Direction alternative_dir = robust_scm2dir (ev->get_property ("alternative-dir"), CENTER);
+  bool make_alternative = scm_is_eq (get_property ("alternativeNumberingStyle"),
+                                     ly_symbol2scm ("numbers"))
+                          || scm_is_eq (get_property ("alternativeNumberingStyle"),
+                                        ly_symbol2scm ("numbers-with-letters"));
+  if (make_alternative)
+    {
+      /*
+        if we're starting the first alternative, we set the starting
+        bar number to the current bar number
+      */
+      if (alternative_dir == LEFT)
+        alternative_starting_bar_number_ = current_barnumber;
 
-  td_p->align_dir_ = LEFT;
+      /*
+        if the alternative is not the last one, we send the
+        current bar number back to the alternative bar number.
+      */
+      if (alternative_dir < RIGHT)
+        current_barnumber = alternative_starting_bar_number_;
 
-  script_p_->dir_ = UP;
-  script_p_->axis_ = Y_AXIS;
-  script_p_->specs_p_ = td_p->clone ();
-  script_p_->breakable_b_ = true;
+      context ()->set_property ("currentBarNumber", scm_from_int (current_barnumber));
+    }
+}
+
+void
+Bar_number_engraver::process_music ()
+{
+  SCM wb = get_property ("whichBar");
 
-  Scalar pri = get_property ("barNumberBreakPriority");
-  if (pri.length_i () && pri.isnum_b ())
+  if (scm_is_string (wb))
     {
-      script_p_->break_priority_i_ = int (pri);
+      Moment mp (robust_scm2moment (get_property ("measurePosition"), Moment (0)));
+      SCM bn = get_property ("currentBarNumber");
+      SCM proc = get_property ("barNumberVisibility");
+      if (scm_is_number (bn) && ly_is_procedure (proc)
+          && to_boolean (scm_call_2 (proc, bn, mp.smobbed_copy ())))
+        {
+          create_items ();
+          SCM alternative_style = get_property ("alternativeNumberingStyle");
+          string text_tag = "";
+          if (scm_is_eq (alternative_style, ly_symbol2scm ("numbers-with-letters")))
+            {
+              if (alternative_event_)
+                {
+                  Direction alternative_dir = robust_scm2dir (alternative_event_->get_property ("alternative-dir"), RIGHT);
+                  switch (alternative_dir)
+                    {
+                    case LEFT:
+                      alternative_number_ = 0;
+                      break;
+                    case CENTER:
+                      break;
+                    case RIGHT:
+                      alternative_number_ = INT_MIN;
+                      break;
+                    default:
+                      assert (false);
+                    }
+                  alternative_number_ += alternative_number_increment_;
+
+                  alternative_number_increment_ = robust_scm2int (alternative_event_->get_property ("alternative-increment"), 1);
+                }
+            }
+          SCM formatter = get_property ("barNumberFormatter");
+          if (ly_is_procedure (formatter))
+            text_->set_property ("text", scm_call_4 (formatter,
+                                                     bn,
+                                                     mp.smobbed_copy (),
+                                                     scm_from_int (alternative_number_),
+                                                     context ()->self_scm ()));
+        }
     }
-  else
-    script_p_->break_priority_i_ = b->break_priority_i_;
+}
+
+Bar_number_engraver::Bar_number_engraver (Context *c)
+  : Engraver (c)
+{
+  text_ = 0;
+  alternative_starting_bar_number_ = 0;
+  alternative_number_increment_ = 0;
+  alternative_number_ = INT_MIN;
+  alternative_event_ = 0;
+}
 
-  Scalar padding = get_property ("barScriptPadding");
-  if (padding.length_i() && padding.isnum_b ())
+void
+Bar_number_engraver::acknowledge_break_alignment (Grob_info inf)
+{
+  Grob *s = inf.grob ();
+  if (text_
+      && dynamic_cast<Item *> (s))
     {
-      script_p_->padding_f_ = Real(padding);
+      text_->set_parent (s, X_AXIS);
     }
-
-  announce_element (Score_element_info (script_p_,0));
 }
 
 void
-Bar_number_engraver::do_pre_move_processing()
+Bar_number_engraver::stop_translation_timestep ()
 {
-  if (script_p_) 
+  alternative_event_ = 0;
+  if (text_)
     {
-      typeset_element (script_p_);
-      script_p_ =0;
+      text_->set_object ("side-support-elements",
+                         grob_list_to_grob_array (get_property ("stavesFound")));
+      text_ = 0;
     }
 }
 
-IMPLEMENT_IS_TYPE_B1(Bar_number_engraver,Engraver);
-ADD_THIS_TRANSLATOR(Bar_number_engraver);
+void
+Bar_number_engraver::create_items ()
+{
+  if (text_)
+    return;
+
+  text_ = make_item ("BarNumber", SCM_EOL);
+}
+
+
+void
+Bar_number_engraver::boot ()
+{
+  ADD_LISTENER (Bar_number_engraver, alternative);
+  ADD_ACKNOWLEDGER (Bar_number_engraver, break_alignment);
+}
+
+ADD_TRANSLATOR (Bar_number_engraver,
+                /* doc */
+                "A bar number is created whenever @code{measurePosition} is"
+                " zero and when there is a bar line (i.e., when"
+                " @code{whichBar} is set).  It is put on top of all staves,"
+                " and appears only at the left side of the staff.  The staves"
+                " are taken from @code{stavesFound}, which is maintained by"
+                " @ref{Staff_collecting_engraver}.",
+
+                /* create */
+                "BarNumber ",
+
+                /* read */
+                "currentBarNumber "
+                "whichBar "
+                "stavesFound "
+                "barNumberFormatter "
+                "barNumberVisibility "
+                "alternativeNumberingStyle ",
+
+                /* write */
+                "currentBarNumber "
+               );