]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/bar-number-engraver.cc
Fixes overlapping boxes in docs: issue 1813
[lilypond.git] / lily / bar-number-engraver.cc
index 7ba942a3b37640e86c9250e7052a7b3015ee9806..269ed126207960893f042c5b0038175eaf1173b0 100644 (file)
 /*
-  bar-number-engraver.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--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 1997--2004 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 "lily-guile.hh"
 #include "paper-column.hh"
 #include "output-def.hh"
 #include "side-position-interface.hh"
-#include "item.hh"
-#include "moment.hh"
 #include "engraver.hh"
 #include "context.hh"
+#include "grob-array.hh"
 
-/*
-  
-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.
+#include "translator.icc"
 
+/*
+  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
 {
 protected:
-  Itemtext_;
+  Item *text_;
 protected:
-  virtual void stop_translation_timestep ();
-  virtual void acknowledge_grob (Grob_info);
-  virtual void process_music ();
+  void stop_translation_timestep ();
+  DECLARE_ACKNOWLEDGER (break_alignment);
+  void process_music ();
   void create_items ();
-  TRANSLATOR_DECLARATIONS (Bar_number_engraver );
+  TRANSLATOR_DECLARATIONS (Bar_number_engraver);
 };
 
-
 void
 Bar_number_engraver::process_music ()
 {
-  // todo include (&&!time->cadenza_b_)
-
   SCM wb = get_property ("whichBar");
-  
-  if (ly_c_string_p (wb))
+
+  if (scm_is_string (wb))
     {
-      SCM smp = get_property ("measurePosition");
-      
-      Moment mp = (unsmob_moment (smp)) ? *unsmob_moment (smp) : Moment (0);
+      Moment mp (robust_scm2moment (get_property ("measurePosition"), Moment (0)));
       if (mp.main_part_ == Rational (0))
-       {
-         SCM bn = get_property ("currentBarNumber");
-         SCM proc = get_property ("barNumberVisibility");
-         if (ly_c_number_p (bn) && ly_c_procedure_p (proc)
-             && to_boolean (scm_call_1(proc, bn)))
-           {
-             create_items ();
-             // guh.
-             text_->set_property
-               ("text", scm_makfrom0str (to_string (ly_scm2int (bn)).to_str0 ()));
-           }
-       }
+        {
+          SCM bn = get_property ("currentBarNumber");
+          SCM proc = get_property ("barNumberVisibility");
+          if (scm_is_number (bn) && ly_is_procedure (proc)
+              && to_boolean (scm_call_1 (proc, bn)))
+            {
+              create_items ();
+              // guh.
+              text_->set_property
+              ("text", scm_number_to_string (bn, scm_from_int (10)));
+            }
+        }
     }
-
 }
 
-
-
 Bar_number_engraver::Bar_number_engraver ()
 {
-  text_ =0;
+  text_ = 0;
 }
 
-                                              
 void
-Bar_number_engraver::acknowledge_grob (Grob_info inf)
+Bar_number_engraver::acknowledge_break_alignment (Grob_info inf)
 {
-  Grob * s = inf.grob_;
+  Grob *s = inf.grob ();
   if (text_
-      && dynamic_cast<Item*> (s)
-      && s->get_property ("break-align-symbol") == ly_symbol2scm ("left-edge"))
+      && dynamic_cast<Item *> (s))
     {
-      /*
-       By default this would land on the Paper_column -- so why
-       doesn't it work when you leave this out?  */
       text_->set_parent (s, X_AXIS);
     }
 }
 
-void 
+void
 Bar_number_engraver::stop_translation_timestep ()
 {
   if (text_)
     {
-      text_->set_property ("side-support-elements", get_property ("stavesFound"));
-      
-      text_ =0;
+      text_->set_object ("side-support-elements",
+                         grob_list_to_grob_array (get_property ("stavesFound")));
+      text_ = 0;
     }
 }
 
-
 void
 Bar_number_engraver::create_items ()
 {
@@ -109,18 +101,28 @@ Bar_number_engraver::create_items ()
     return;
 
   text_ = make_item ("BarNumber", SCM_EOL);
-  Side_position_interface::set_axis (text_,Y_AXIS);
 }
 
-ENTER_DESCRIPTION (Bar_number_engraver,
-/* descr */       "A bar number is created whenever measurePosition is zero. It is\n"
-                  "put on top of all staves, and appears only at  left side of the staff. "
-                  "The staves are taken from @code{stavesFound}, which is maintained by "
-                  "@code{@ref{Staff_collecting_engraver}}. "
-                  ,
-                  
-/* creats*/       "BarNumber",
-/* accepts */     "",
-/* acks  */      "break-aligned-interface",
-/* reads */       "currentBarNumber stavesFound barNumberVisibility" ,
-/* write */       "");
+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 "
+                "barNumberVisibility ",
+
+                /* write */
+                ""
+               );