-/*
- new-staff-margin-engraver.cc -- implement Instrument_name_engraver
-
- source file of the GNU LilyPond music typesetter
-
- (c) 2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-
- */
+/*
+ This file is part of LilyPond, the GNU music typesetter.
+ Copyright (C) 2000--2015 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 "item.hh"
-#include "bar.hh"
-#include "system-start-delimiter.hh"
+#include "page-layout-problem.hh"
+#include "pointer-group-interface.hh"
#include "side-position-interface.hh"
-#include "align-interface.hh"
+#include "system.hh"
+#include "text-interface.hh"
+
+#include "translator.icc"
class Instrument_name_engraver : public Engraver
{
- Item *text_;
- Grob * delim_ ;
-
- void create_text (SCM s);
public:
- VIRTUAL_COPY_CONS(Translator);
- Instrument_name_engraver ();
+ TRANSLATOR_DECLARATIONS (Instrument_name_engraver);
- virtual void acknowledge_grob (Grob_info);
- virtual void stop_translation_timestep ();
-};
+protected:
+ Spanner *text_spanner_;
-ADD_THIS_TRANSLATOR(Instrument_name_engraver);
+ SCM long_text_;
+ SCM short_text_;
-Instrument_name_engraver::Instrument_name_engraver ()
+ vector<Grob *> axis_groups_;
+ vector<Grob *> backup_axis_groups_;
+
+ virtual void finalize ();
+ void acknowledge_axis_group (Grob_info);
+ void process_music ();
+ void start_spanner ();
+ void consider_start_spanner ();
+ void stop_spanner ();
+
+ virtual void derived_mark () const;
+};
+
+void
+Instrument_name_engraver::derived_mark () const
{
- text_ = 0;
- delim_ =0;
+ scm_gc_mark (long_text_);
+ scm_gc_mark (short_text_);
}
+Instrument_name_engraver::Instrument_name_engraver (Context *c)
+ : Engraver (c)
+{
+ text_spanner_ = 0;
+
+ long_text_ = SCM_EOL;
+ short_text_ = SCM_EOL;
+}
void
-Instrument_name_engraver::stop_translation_timestep ()
+Instrument_name_engraver::process_music ()
{
- if (text_)
- {
- typeset_grob (text_);
- text_ = 0;
- }
+ consider_start_spanner ();
}
void
-Instrument_name_engraver::create_text (SCM txt)
+Instrument_name_engraver::consider_start_spanner ()
{
- if(!text_)
+ SCM long_text = get_property ("instrumentName");
+ SCM short_text = get_property ("shortInstrumentName");
+
+ if (!(Text_interface::is_markup (long_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_
+ || !scm_is_eq (short_text_, short_text)
+ || !scm_is_eq (long_text_, long_text)))
{
- text_ = new Item (get_property ("InstrumentName"));
- text_->set_grob_property ("text", txt);
+ if (text_spanner_)
+ stop_spanner ();
- if (delim_)
- text_->set_parent (delim_, Y_AXIS);
+ short_text_ = short_text;
+ long_text_ = long_text;
- announce_grob (text_,0);
+ start_spanner ();
}
}
void
-Instrument_name_engraver::acknowledge_grob (Grob_info i)
+Instrument_name_engraver::start_spanner ()
{
- SCM s = get_property ("instrument");
-
- if (now_mom () > Moment (0))
- s = get_property ("instr");
+ text_spanner_ = make_spanner ("InstrumentName", SCM_EOL);
+
+ 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_);
+
+ /*
+ UGH, should handle this in Score_engraver.
+ */
+ Grob *system = unsmob<Grob> (get_property ("rootSystem"));
+ if (system)
+ Axis_group_interface::add_element (system, text_spanner_);
+ else
+ text_spanner_->programming_error ("cannot find root system");
+}
- if (gh_string_p (s))
- {
- if (Bar::has_interface (i.elem_l_))
- {
- create_text (s);
- }
- }
+void
+Instrument_name_engraver::acknowledge_axis_group (Grob_info info)
+{
+ if (dynamic_cast<Spanner *> (info.grob ())
+ && Axis_group_interface::has_axis (info.grob (), Y_AXIS)
+
+ /* ugh. */
- if (Align_interface::has_interface (i.elem_l_)
- && Align_interface::axis (i.elem_l_) == Y_AXIS
- //System_start_delimiter::has_interface (i.elem_l_)
- && i.origin_trans_l_->daddy_trans_l_ == daddy_trans_l_)
+ && !info.grob ()->internal_has_interface (ly_symbol2scm ("dynamic-interface"))
+ && !info.grob ()->internal_has_interface (ly_symbol2scm ("piano-pedal-interface"))
+ && !info.grob ()->internal_has_interface (ly_symbol2scm ("volta-interface"))
+ && (!has_interface<Align_interface> (info.grob ())))
{
- delim_ = i.elem_l_;
+ 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 ());
}
}
+void
+Instrument_name_engraver::finalize ()
+{
+ if (text_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]);
+
+ text_spanner_->set_bound (RIGHT,
+ unsmob<Grob> (get_property ("currentCommandColumn")));
+
+ Pointer_group_interface::set_ordered (text_spanner_,
+ ly_symbol2scm ("elements"),
+ false);
+
+ text_spanner_ = 0;
+}
+
+
+void
+Instrument_name_engraver::boot ()
+{
+ ADD_ACKNOWLEDGER (Instrument_name_engraver, axis_group);
+}
+
+ADD_TRANSLATOR (Instrument_name_engraver,
+ /* doc */
+ "Create a system start text for instrument or vocal names.",
+ /* create */
+ "InstrumentName ",
+ /* read */
+ "currentCommandColumn "
+ "instrumentName "
+ "shortInstrumentName "
+ "shortVocalName "
+ "vocalName ",
+ /* write */
+ ""
+ );
projects / lilypond.git / blobdiff