]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/instrument-name-engraver.cc
Doc-es: various updates.
[lilypond.git] / lily / instrument-name-engraver.cc
index 9290ef93e523bf984170e95d43839281d823ec01..8ba26f31beaf97d7b7a2e5d454c19c85e599e276 100644 (file)
@@ -1,19 +1,30 @@
 /*
-  instrument-name-engraver.cc -- implement Instrument_name_engraver
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 2000--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 2000--2006 Han-Wen Nienhuys <hanwen@xs4all.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 "align-interface.hh"
+#include "axis-group-interface.hh"
 #include "engraver.hh"
-#include "spanner.hh"
+#include "page-layout-problem.hh"
 #include "pointer-group-interface.hh"
 #include "side-position-interface.hh"
-#include "axis-group-interface.hh"
-#include "align-interface.hh"
-#include "text-interface.hh"
 #include "system.hh"
+#include "text-interface.hh"
 
 #include "translator.icc"
 
@@ -28,17 +39,28 @@ protected:
   SCM long_text_;
   SCM short_text_;
 
-  vector<Grob*> axis_groups_;
-  
+  vector<Grob *> axis_groups_;
+  vector<Grob *> backup_axis_groups_;
+
   virtual void finalize ();
-  DECLARE_ACKNOWLEDGER (axis_group);
+  void acknowledge_axis_group (Grob_info);
   void process_music ();
   void start_spanner ();
   void consider_start_spanner ();
   void stop_spanner ();
+
+  virtual void derived_mark () const;
 };
 
-Instrument_name_engraver::Instrument_name_engraver ()
+void
+Instrument_name_engraver::derived_mark () const
+{
+  scm_gc_mark (long_text_);
+  scm_gc_mark (short_text_);
+}
+
+Instrument_name_engraver::Instrument_name_engraver (Context *c)
+  : Engraver (c)
 {
   text_spanner_ = 0;
 
@@ -59,22 +81,21 @@ Instrument_name_engraver::consider_start_spanner ()
   SCM short_text = get_property ("shortInstrumentName");
 
   if (!(Text_interface::is_markup (long_text)
-       || Text_interface::is_markup (short_text)))
+        || Text_interface::is_markup (short_text)))
     {
       long_text = get_property ("vocalName");
       short_text = get_property ("shortVocalName");
     }
-  
+
   if ((Text_interface::is_markup (long_text)
        || Text_interface::is_markup (short_text))
       && (!text_spanner_
-         || short_text_ != short_text
-         || long_text_ != long_text))
+          || !scm_is_eq (short_text_, short_text)
+          || !scm_is_eq (long_text_, long_text)))
     {
       if (text_spanner_)
-       stop_spanner ();
+        stop_spanner ();
 
-      
       short_text_ = short_text;
       long_text_ = long_text;
 
@@ -86,8 +107,8 @@ void
 Instrument_name_engraver::start_spanner ()
 {
   text_spanner_ = make_spanner ("InstrumentName", SCM_EOL);
-         
-  Grob *col = unsmob_grob (get_property ("currentCommandColumn"));
+
+  Grob *col = unsmob<Grob> (get_property ("currentCommandColumn"));
   text_spanner_->set_bound (LEFT, col);
   text_spanner_->set_property ("text", short_text_);
   text_spanner_->set_property ("long-text", long_text_);
@@ -95,14 +116,13 @@ Instrument_name_engraver::start_spanner ()
   /*
     UGH, should handle this in Score_engraver.
   */
-  Grob *system = unsmob_grob (get_property ("rootSystem"));
+  Grob *system = unsmob<Grob> (get_property ("rootSystem"));
   if (system)
     Axis_group_interface::add_element (system, text_spanner_);
   else
-    text_spanner_->programming_error ("can't find root system");
+    text_spanner_->programming_error ("cannot find root system");
 }
 
-
 void
 Instrument_name_engraver::acknowledge_axis_group (Grob_info info)
 {
@@ -113,9 +133,16 @@ Instrument_name_engraver::acknowledge_axis_group (Grob_info info)
 
       && !info.grob ()->internal_has_interface (ly_symbol2scm ("dynamic-interface"))
       && !info.grob ()->internal_has_interface (ly_symbol2scm ("piano-pedal-interface"))
-      && (!Align_interface::has_interface (info.grob ())))
+      && !info.grob ()->internal_has_interface (ly_symbol2scm ("volta-interface"))
+      && (!has_interface<Align_interface> (info.grob ())))
     {
-      axis_groups_.push_back (info.grob ());
+      if (Page_layout_problem::is_spaceable (info.grob ()))
+        axis_groups_.push_back (info.grob ());
+      else
+        // By default, don't include non-spaceable staves in the
+        // support of an instrument name.  However, if the only staves
+        // are non-spaceable, we'll fall back to using them.
+        backup_axis_groups_.push_back (info.grob ());
     }
 }
 
@@ -123,43 +150,51 @@ void
 Instrument_name_engraver::finalize ()
 {
   if (text_spanner_)
-    {
-      stop_spanner ();
-    }
+    stop_spanner ();
 }
 
 void
 Instrument_name_engraver::stop_spanner ()
 {
+  if (axis_groups_.empty ())
+    axis_groups_ = backup_axis_groups_;
+
   for (vsize i = 0; i < axis_groups_.size (); i++)
-    Pointer_group_interface::add_grob (text_spanner_, ly_symbol2scm ("elements"), axis_groups_[i]);
-  
+    Pointer_group_interface::add_grob (text_spanner_,
+                                       ly_symbol2scm ("elements"),
+                                       axis_groups_[i]);
+
   text_spanner_->set_bound (RIGHT,
-                           unsmob_grob (get_property ("currentCommandColumn")));
+                            unsmob<Grob> (get_property ("currentCommandColumn")));
 
-  Pointer_group_interface::set_ordered (text_spanner_, ly_symbol2scm ("elements"), false);
+  Pointer_group_interface::set_ordered (text_spanner_,
+                                        ly_symbol2scm ("elements"),
+                                        false);
 
   text_spanner_ = 0;
 }
 
-#include "translator.icc"
 
-ADD_ACKNOWLEDGER (Instrument_name_engraver, axis_group);
+void
+Instrument_name_engraver::boot ()
+{
+  ADD_ACKNOWLEDGER (Instrument_name_engraver, axis_group);
+}
 
 ADD_TRANSLATOR (Instrument_name_engraver,
-
-               /* doc */
-               "Creates a system start text for instrument or vocal names.",
-               
-               /* create */
-               "InstrumentName ",
-               
-               /* read */
-               "currentCommandColumn "
-               "shortInstrumentName "
-               "instrumentName "
-               "shortVocalName "
-               "vocalName "
-               ,
-
-               /* write */ "");
+                /* doc */
+                "Create a system start text for instrument or vocal names.",
+
+                /* create */
+                "InstrumentName ",
+
+                /* read */
+                "currentCommandColumn "
+                "instrumentName "
+                "shortInstrumentName "
+                "shortVocalName "
+                "vocalName ",
+
+                /* write */
+                ""
+               );