X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Finstrument-name-engraver.cc;h=ec37d6bcbffc2b18d638e76cf1ead798526e8e47;hb=bd06e2fbf3c63b2fb6a537c87d09a0f6fd5e2c2e;hp=8e1e84dc8e9f072227a12e7d90887b97c98052d8;hpb=e24df7c27635dc996c466295eacf2981bddccaf7;p=lilypond.git diff --git a/lily/instrument-name-engraver.cc b/lily/instrument-name-engraver.cc index 8e1e84dc8e..ec37d6bcbf 100644 --- a/lily/instrument-name-engraver.cc +++ b/lily/instrument-name-engraver.cc @@ -1,190 +1,199 @@ -/* - instrument-name-engraver.cc -- implement Instrument_name_engraver - - source file of the GNU LilyPond music typesetter - - (c) 2000--2005 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 "bar-line.hh" -#include "system-start-delimiter.hh" -#include "side-position-interface.hh" #include "align-interface.hh" #include "axis-group-interface.hh" -#include "context.hh" -#include "text-item.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 { - public: TRANSLATOR_DECLARATIONS (Instrument_name_engraver); protected: - Grob *text_; + Spanner *text_spanner_; + + SCM long_text_; + SCM short_text_; - virtual void create_text (); - virtual void initialize (); - virtual void acknowledge_grob (Grob_info); - virtual void stop_translation_timestep (); - virtual void process_music (); + vector axis_groups_; + vector 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 +{ + scm_gc_mark (long_text_); + scm_gc_mark (short_text_); +} + Instrument_name_engraver::Instrument_name_engraver () { - text_ = 0; + text_spanner_ = 0; + + long_text_ = SCM_EOL; + short_text_ = SCM_EOL; } void -Instrument_name_engraver::initialize () +Instrument_name_engraver::process_music () { - context ()->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_property ("side-support-elements", - get_property ("instrumentSupport")); - text_ = 0; + 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))) + { + if (text_spanner_) + stop_spanner (); + + short_text_ = short_text; + long_text_ = long_text; + + start_spanner (); } } void -Instrument_name_engraver::create_text () +Instrument_name_engraver::start_spanner () { - if (text_) - return ; - - SCM txt = get_property ("instrument"); - - if (now_mom () > Moment (0)) - txt = get_property ("instr"); + text_spanner_ = make_spanner ("InstrumentName", SCM_EOL); + + 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_); + /* - UGH. + UGH, should handle this in Score_engraver. */ - if (txt == SCM_EOL) - return ; - - - text_ = make_item ("InstrumentName", SCM_EOL); - - if (text_->get_property ("text") != txt) - text_->set_property ("text", txt); - + 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_grob (Grob_info i) +Instrument_name_engraver::acknowledge_axis_group (Grob_info info) { - if (Bar_line::has_interface (i.grob_)) - { - create_text (); - } + if (dynamic_cast (info.grob ()) + && Axis_group_interface::has_axis (info.grob (), Y_AXIS) - /* - Ugh - typechecking for pedal and dynamic sucks. - */ - if (dynamic_cast (i.grob_) - && (i.grob_->internal_has_interface (ly_symbol2scm ("dynamic-interface")) - || i.grob_->internal_has_interface (ly_symbol2scm ("piano-pedal-interface"))) - ) - return; - - /* - 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. */ - We could also just use stavesFound, but lets keep this working - without staffs as well. - */ - if (dynamic_cast (i.grob_) - && ((Axis_group_interface::has_interface (i.grob_) - && Axis_group_interface::has_axis (i.grob_, Y_AXIS))) - && !Align_interface::has_interface (i.grob_)) + && !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 ()))) { - SCM nl = scm_cons (i.grob_->self_scm (), - get_property ("instrumentSupport")); - - context ()->set_property ("instrumentSupport", nl); + 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::process_music () +Instrument_name_engraver::finalize () { - /* - Also create text if barlines in other groups. This allows - a name to be attached to lyrics or chords. - */ - if (scm_is_string (get_property ("whichBar"))) - create_text (); + if (text_spanner_) + stop_spanner (); } -ADD_TRANSLATOR (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", -/* accepts */ "", -/* acks */ "bar-line-interface axis-group-interface", -/* reads */ "instrument instr", -/* write */ ""); - -/****************************************************************/ +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]); -class Vocal_name_engraver : public Instrument_name_engraver -{ -public: - TRANSLATOR_DECLARATIONS (Vocal_name_engraver); - virtual void create_text (); -}; + text_spanner_->set_bound (RIGHT, + unsmob (get_property ("currentCommandColumn"))); + Pointer_group_interface::set_ordered (text_spanner_, + ly_symbol2scm ("elements"), + false); -Vocal_name_engraver::Vocal_name_engraver () -{ + text_spanner_ = 0; } void -Vocal_name_engraver::create_text () +Instrument_name_engraver::boot () { - if (text_) - return ; - - SCM txt = get_property ("vocalName"); - - if (now_mom () > Moment (0)) - txt = get_property ("vocNam"); - - /* - UGH. - */ - if (txt == SCM_EOL) - return ; - - text_ = make_item ("VocalName", SCM_EOL); - - if (text_->get_property ("text") != txt) - text_->set_property ("text", txt); - + ADD_ACKNOWLEDGER (Instrument_name_engraver, axis_group); } - - -ADD_TRANSLATOR (Vocal_name_engraver, -/* descr */ " Prints the name of the a lyric voice (specified by " -" @code{Staff.vocalName} and @code{Staff.vocNam}) " -"at the left of the staff. ", -/* creats*/ "VocalName", -/* accepts */ "", -/* acks */ "bar-line-interface axis-group-interface", -/* reads */ "vocNam vocalName", -/* write */ ""); +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 */ + "" + );