lily/instrument-name-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2000--2012 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 "align-interface.hh"
  21 #include "axis-group-interface.hh"
  22 #include "engraver.hh"
  23 #include "page-layout-problem.hh"
  24 #include "pointer-group-interface.hh"
  25 #include "side-position-interface.hh"
  26 #include "system.hh"
  27 #include "text-interface.hh"
  28
  29 #include "translator.icc"
  30
  31 class Instrument_name_engraver : public Engraver
  32 {
  33 public:
  34   TRANSLATOR_DECLARATIONS (Instrument_name_engraver);
  35
  36 protected:
  37   Spanner *text_spanner_;
  38
  39   SCM long_text_;
  40   SCM short_text_;
  41
  42   vector<Grob *> axis_groups_;
  43   vector<Grob *> backup_axis_groups_;
  44
  45   virtual void finalize ();
  46   DECLARE_ACKNOWLEDGER (axis_group);
  47   void process_music ();
  48   void start_spanner ();
  49   void consider_start_spanner ();
  50   void stop_spanner ();
  51
  52   virtual void derived_mark () const;
  53 };
  54
  55 void
  56 Instrument_name_engraver::derived_mark () const
  57 {
  58   scm_gc_mark (long_text_);
  59   scm_gc_mark (short_text_);
  60 }
  61
  62 Instrument_name_engraver::Instrument_name_engraver ()
  63 {
  64   text_spanner_ = 0;
  65
  66   long_text_ = SCM_EOL;
  67   short_text_ = SCM_EOL;
  68 }
  69
  70 void
  71 Instrument_name_engraver::process_music ()
  72 {
  73   consider_start_spanner ();
  74 }
  75
  76 void
  77 Instrument_name_engraver::consider_start_spanner ()
  78 {
  79   SCM long_text = get_property ("instrumentName");
  80   SCM short_text = get_property ("shortInstrumentName");
  81
  82   if (!(Text_interface::is_markup (long_text)
  83         || Text_interface::is_markup (short_text)))
  84     {
  85       long_text = get_property ("vocalName");
  86       short_text = get_property ("shortVocalName");
  87     }
  88
  89   if ((Text_interface::is_markup (long_text)
  90        || Text_interface::is_markup (short_text))
  91       && (!text_spanner_
  92           || short_text_ != short_text
  93           || long_text_ != long_text))
  94     {
  95       if (text_spanner_)
  96         stop_spanner ();
  97
  98       short_text_ = short_text;
  99       long_text_ = long_text;
 100
 101       start_spanner ();
 102     }
 103 }
 104
 105 void
 106 Instrument_name_engraver::start_spanner ()
 107 {
 108   text_spanner_ = make_spanner ("InstrumentName", SCM_EOL);
 109
 110   Grob *col = unsmob_grob (get_property ("currentCommandColumn"));
 111   text_spanner_->set_bound (LEFT, col);
 112   text_spanner_->set_property ("text", short_text_);
 113   text_spanner_->set_property ("long-text", long_text_);
 114
 115   /*
 116     UGH, should handle this in Score_engraver.
 117   */
 118   Grob *system = unsmob_grob (get_property ("rootSystem"));
 119   if (system)
 120     Axis_group_interface::add_element (system, text_spanner_);
 121   else
 122     text_spanner_->programming_error ("cannot find root system");
 123 }
 124
 125 void
 126 Instrument_name_engraver::acknowledge_axis_group (Grob_info info)
 127 {
 128   if (dynamic_cast<Spanner *> (info.grob ())
 129       && Axis_group_interface::has_axis (info.grob (), Y_AXIS)
 130
 131       /* ugh. */
 132
 133       && !info.grob ()->internal_has_interface (ly_symbol2scm ("dynamic-interface"))
 134       && !info.grob ()->internal_has_interface (ly_symbol2scm ("piano-pedal-interface"))
 135       && !info.grob ()->internal_has_interface (ly_symbol2scm ("volta-interface"))
 136       && (!Align_interface::has_interface (info.grob ())))
 137     {
 138       if (Page_layout_problem::is_spaceable (info.grob ()))
 139         axis_groups_.push_back (info.grob ());
 140       else
 141         // By default, don't include non-spaceable staves in the
 142         // support of an instrument name.  However, if the only staves
 143         // are non-spaceable, we'll fall back to using them.
 144         backup_axis_groups_.push_back (info.grob ());
 145     }
 146 }
 147
 148 void
 149 Instrument_name_engraver::finalize ()
 150 {
 151   if (text_spanner_)
 152     stop_spanner ();
 153 }
 154
 155 void
 156 Instrument_name_engraver::stop_spanner ()
 157 {
 158   if (axis_groups_.empty ())
 159     axis_groups_ = backup_axis_groups_;
 160
 161   for (vsize i = 0; i < axis_groups_.size (); i++)
 162     Pointer_group_interface::add_grob (text_spanner_,
 163                                        ly_symbol2scm ("elements"),
 164                                        axis_groups_[i]);
 165
 166   text_spanner_->set_bound (RIGHT,
 167                             unsmob_grob (get_property ("currentCommandColumn")));
 168
 169   Pointer_group_interface::set_ordered (text_spanner_,
 170                                         ly_symbol2scm ("elements"),
 171                                         false);
 172
 173   text_spanner_ = 0;
 174 }
 175
 176 ADD_ACKNOWLEDGER (Instrument_name_engraver, axis_group);
 177
 178 ADD_TRANSLATOR (Instrument_name_engraver,
 179                 /* doc */
 180                 "Create a system start text for instrument or vocal names.",
 181
 182                 /* create */
 183                 "InstrumentName ",
 184
 185                 /* read */
 186                 "currentCommandColumn "
 187                 "instrumentName "
 188                 "shortInstrumentName "
 189                 "shortVocalName "
 190                 "vocalName ",
 191
 192                 /* write */
 193                 ""
 194                );