lily/instrument-name-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2000--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 "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
  44   virtual void finalize ();
  45   DECLARE_ACKNOWLEDGER (axis_group);
  46   void process_music ();
  47   void start_spanner ();
  48   void consider_start_spanner ();
  49   void stop_spanner ();
  50
  51   virtual void derived_mark () const;
  52 };
  53
  54 void
  55 Instrument_name_engraver::derived_mark () const
  56 {
  57   scm_gc_mark (long_text_);
  58   scm_gc_mark (short_text_);
  59 }
  60
  61 Instrument_name_engraver::Instrument_name_engraver ()
  62 {
  63   text_spanner_ = 0;
  64
  65   long_text_ = SCM_EOL;
  66   short_text_ = SCM_EOL;
  67 }
  68
  69 void
  70 Instrument_name_engraver::process_music ()
  71 {
  72   consider_start_spanner ();
  73 }
  74
  75 void
  76 Instrument_name_engraver::consider_start_spanner ()
  77 {
  78   SCM long_text = get_property ("instrumentName");
  79   SCM short_text = get_property ("shortInstrumentName");
  80
  81   if (!(Text_interface::is_markup (long_text)
  82         || Text_interface::is_markup (short_text)))
  83     {
  84       long_text = get_property ("vocalName");
  85       short_text = get_property ("shortVocalName");
  86     }
  87
  88   if ((Text_interface::is_markup (long_text)
  89        || Text_interface::is_markup (short_text))
  90       && (!text_spanner_
  91           || short_text_ != short_text
  92           || long_text_ != long_text))
  93     {
  94       if (text_spanner_)
  95         stop_spanner ();
  96
  97       short_text_ = short_text;
  98       long_text_ = long_text;
  99
 100       start_spanner ();
 101     }
 102 }
 103
 104 void
 105 Instrument_name_engraver::start_spanner ()
 106 {
 107   text_spanner_ = make_spanner ("InstrumentName", SCM_EOL);
 108
 109   Grob *col = unsmob_grob (get_property ("currentCommandColumn"));
 110   text_spanner_->set_bound (LEFT, col);
 111   text_spanner_->set_property ("text", short_text_);
 112   text_spanner_->set_property ("long-text", long_text_);
 113
 114   /*
 115     UGH, should handle this in Score_engraver.
 116   */
 117   Grob *system = unsmob_grob (get_property ("rootSystem"));
 118   if (system)
 119     Axis_group_interface::add_element (system, text_spanner_);
 120   else
 121     text_spanner_->programming_error ("cannot find root system");
 122 }
 123
 124 void
 125 Instrument_name_engraver::acknowledge_axis_group (Grob_info info)
 126 {
 127   if (dynamic_cast<Spanner *> (info.grob ())
 128       && Axis_group_interface::has_axis (info.grob (), Y_AXIS)
 129       && Page_layout_problem::is_spaceable (info.grob ())
 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       axis_groups_.push_back (info.grob ());
 139     }
 140 }
 141
 142 void
 143 Instrument_name_engraver::finalize ()
 144 {
 145   if (text_spanner_)
 146     stop_spanner ();
 147 }
 148
 149 void
 150 Instrument_name_engraver::stop_spanner ()
 151 {
 152   for (vsize i = 0; i < axis_groups_.size (); i++)
 153     Pointer_group_interface::add_grob (text_spanner_,
 154                                        ly_symbol2scm ("elements"),
 155                                        axis_groups_[i]);
 156
 157   text_spanner_->set_bound (RIGHT,
 158                             unsmob_grob (get_property ("currentCommandColumn")));
 159
 160   Pointer_group_interface::set_ordered (text_spanner_,
 161                                         ly_symbol2scm ("elements"),
 162                                         false);
 163
 164   text_spanner_ = 0;
 165 }
 166
 167 ADD_ACKNOWLEDGER (Instrument_name_engraver, axis_group);
 168
 169 ADD_TRANSLATOR (Instrument_name_engraver,
 170                 /* doc */
 171                 "Create a system start text for instrument or vocal names.",
 172
 173                 /* create */
 174                 "InstrumentName ",
 175
 176                 /* read */
 177                 "currentCommandColumn "
 178                 "instrumentName "
 179                 "shortInstrumentName "
 180                 "shortVocalName "
 181                 "vocalName ",
 182
 183                 /* write */
 184                 ""
 185                );