X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Finstrument-name-engraver.cc;h=d339fbce612e94c19638c33ed0da5c532b07f89b;hb=cd33b4fe18eb39c9ebeb6a02ccea7b4d17d1395f;hp=11758a82c8e43c1ff93ee2bef972722ddf081359;hpb=d9b43b93f2c885409bafdb157138158f65cc49aa;p=lilypond.git diff --git a/lily/instrument-name-engraver.cc b/lily/instrument-name-engraver.cc index 11758a82c8..d339fbce61 100644 --- a/lily/instrument-name-engraver.cc +++ b/lily/instrument-name-engraver.cc @@ -1,128 +1,194 @@ -/* - new-staff-margin-engraver.cc -- implement Instrument_name_engraver - - source file of the GNU LilyPond music typesetter - - (c) 2000--2002 Han-Wen Nienhuys - - */ +/* + This file is part of LilyPond, the GNU music typesetter. + + Copyright (C) 2000--2015 Han-Wen Nienhuys + + 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 . +*/ -#include "engraver.hh" -#include "item.hh" -#include "bar.hh" -#include "system-start-delimiter.hh" -#include "side-position-interface.hh" #include "align-interface.hh" #include "axis-group-interface.hh" -#include "translator-group.hh" +#include "engraver.hh" +#include "page-layout-problem.hh" +#include "pointer-group-interface.hh" +#include "side-position-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: - TRANSLATOR_DECLARATIONS(Instrument_name_engraver); + TRANSLATOR_DECLARATIONS (Instrument_name_engraver); - virtual void initialize (); - virtual void acknowledge_grob (Grob_info); - virtual void stop_translation_timestep (); -}; +protected: + Spanner *text_spanner_; + SCM long_text_; + SCM short_text_; + vector axis_groups_; + vector backup_axis_groups_; -Instrument_name_engraver::Instrument_name_engraver () + virtual void finalize (); + DECLARE_ACKNOWLEDGER (axis_group); + 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 () +{ + text_spanner_ = 0; + + long_text_ = SCM_EOL; + short_text_ = SCM_EOL; +} void -Instrument_name_engraver::initialize () +Instrument_name_engraver::process_music () { - daddy_trans_l_->set_property ("instrumentSupport", SCM_EOL); + consider_start_spanner (); } void -Instrument_name_engraver::stop_translation_timestep () +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))) { - text_->set_grob_property ("side-support-elements", - get_property ("instrumentSupport")); - typeset_grob (text_); - text_ = 0; + long_text = get_property ("vocalName"); + short_text = get_property ("shortVocalName"); } -} -void -Instrument_name_engraver::create_text (SCM txt) -{ - if (!text_) + 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")); - - if (text_->get_grob_property ("text") != txt) - text_->set_grob_property ("text", txt); - - if (delim_) - text_->set_parent (delim_, Y_AXIS); - - announce_grob (text_,0); + if (text_spanner_) + stop_spanner (); + + short_text_ = short_text; + long_text_ = long_text; + + start_spanner (); } } void -Instrument_name_engraver::acknowledge_grob (Grob_info i) +Instrument_name_engraver::start_spanner () { - if (Bar::has_interface (i.grob_l_)) - { - SCM s = get_property ("instrument"); - - if (now_mom () > Moment (0)) - s = get_property ("instr"); - - /* - FIXME: use markup_p () to check type. - */ - if (gh_string_p (s) || gh_pair_p (s)) - create_text (s); - } + text_spanner_ = make_spanner ("InstrumentName", SCM_EOL); - if (dynamic_cast (i.grob_l_) - && i.grob_l_->has_interface (ly_symbol2scm ("dynamic-interface"))) - return; + Grob *col = unsmob (get_property ("currentCommandColumn")); + text_spanner_->set_bound (LEFT, col); + text_spanner_->set_property ("text", short_text_); + text_spanner_->set_property ("long-text", long_text_); /* - Hang the instrument names on the staves, but not on the alignment - groups enclosing that staff. The alignment has no real location, - but is only a vehicle for the placement routine it contains, and - therefore the location of its refpoint won't be very useful. - + UGH, should handle this in Score_engraver. */ - if (dynamic_cast (i.grob_l_) - && ((Axis_group_interface::has_interface (i.grob_l_) - && Axis_group_interface::axis_b (i.grob_l_, Y_AXIS))) - && !Align_interface::has_interface (i.grob_l_)) - { - SCM nl = gh_cons (i.grob_l_->self_scm (), - get_property ("instrumentSupport")); + Grob *system = unsmob (get_property ("rootSystem")); + if (system) + Axis_group_interface::add_element (system, text_spanner_); + else + text_spanner_->programming_error ("cannot find root system"); +} + +void +Instrument_name_engraver::acknowledge_axis_group (Grob_info info) +{ + if (dynamic_cast (info.grob ()) + && Axis_group_interface::has_axis (info.grob (), Y_AXIS) + + /* ugh. */ - daddy_trans_l_->set_property ("instrumentSupport", nl); + && !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 (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 ()); } } +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 (get_property ("currentCommandColumn"))); + + Pointer_group_interface::set_ordered (text_spanner_, + ly_symbol2scm ("elements"), + false); + + text_spanner_ = 0; +} + +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 ", -ENTER_DESCRIPTION(Instrument_name_engraver, -/* descr */ " Prints the name of the instrument (specified by -@code{Staff.instrument} and @code{Staff.instr}) -at the left of the -staff.", -/* creats*/ "InstrumentName", -/* acks */ "bar-line-interface axis-group-interface", -/* reads */ "instrument instr", -/* write */ ""); + /* write */ + "" + );