X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Finstrument-name-engraver.cc;h=879914a81de2032db6dd6e6f3a57cd26938a1001;hb=9e781b7dc83b60a543ce218aa1a5f139f74c760f;hp=3f01e8c12f84ad0c4f39f61153c0676e3c3b0bdf;hpb=7f6816438d66f6d70db5b68454d80656a0f3f131;p=lilypond.git diff --git a/lily/instrument-name-engraver.cc b/lily/instrument-name-engraver.cc index 3f01e8c12f..879914a81d 100644 --- a/lily/instrument-name-engraver.cc +++ b/lily/instrument-name-engraver.cc @@ -1,199 +1,194 @@ /* - instrument-name-engraver.cc -- implement Instrument_name_engraver + This file is part of LilyPond, the GNU music typesetter. - source file of the GNU LilyPond music typesetter + Copyright (C) 2000--2014 Han-Wen Nienhuys - (c) 2000--2005 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 "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 "grob-array.hh" #include "translator.icc" class Instrument_name_engraver : public Engraver { - bool first_; 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 (); + vector axis_groups_; + vector backup_axis_groups_; - DECLARE_ACKNOWLEDGER(bar_line); - DECLARE_ACKNOWLEDGER(axis_group); - - void stop_translation_timestep (); + 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; }; -Instrument_name_engraver::Instrument_name_engraver () +void +Instrument_name_engraver::derived_mark () const { - text_ = 0; - first_ = true; + scm_gc_mark (long_text_); + scm_gc_mark (short_text_); } -void -Instrument_name_engraver::initialize () +Instrument_name_engraver::Instrument_name_engraver () { - context ()->set_property ("instrumentSupport", SCM_EOL); + 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_) - { - text_->set_object ("side-support-elements", - grob_list_to_grob_array (get_property ("instrumentSupport"))); - text_ = 0; - } - - first_ = false; + consider_start_spanner (); } void -Instrument_name_engraver::create_text () +Instrument_name_engraver::consider_start_spanner () { - if (text_) - return; + SCM long_text = get_property ("instrumentName"); + SCM short_text = get_property ("shortInstrumentName"); - SCM txt = get_property ("instrument"); + if (!(Text_interface::is_markup (long_text) + || Text_interface::is_markup (short_text))) + { + long_text = get_property ("vocalName"); + short_text = get_property ("shortVocalName"); + } - if (now_mom () > Moment (0)) - txt = get_property ("instr"); - /* - UGH. - */ - if (txt == SCM_EOL) - return; + if ((Text_interface::is_markup (long_text) + || Text_interface::is_markup (short_text)) + && (!text_spanner_ + || short_text_ != short_text + || long_text_ != long_text)) + { + if (text_spanner_) + stop_spanner (); - text_ = make_item ("InstrumentName", SCM_EOL); + short_text_ = short_text; + long_text_ = long_text; - if (text_->get_property ("text") != txt) - text_->set_property ("text", txt); + start_spanner (); + } } void -Instrument_name_engraver::acknowledge_bar_line (Grob_info i) +Instrument_name_engraver::start_spanner () { - (void)i; - create_text (); -} + 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_); -void -Instrument_name_engraver::acknowledge_axis_group (Grob_info i) -{ /* - Ugh - typechecking for pedal and dynamic sucks. + UGH, should handle this in Score_engraver. */ - 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. - - 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 ())) - { - SCM nl = scm_cons (i.grob ()->self_scm (), - get_property ("instrumentSupport")); - - context ()->set_property ("instrumentSupport", nl); - } + 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"); } void -Instrument_name_engraver::process_music () +Instrument_name_engraver::acknowledge_axis_group (Grob_info info) { - /* - 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")) - || first_) - create_text (); -} - -#include "translator.icc" - - -ADD_ACKNOWLEDGER(Instrument_name_engraver, bar_line); -ADD_ACKNOWLEDGER(Instrument_name_engraver, axis_group); -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 */ "", - /* reads */ "instrument instr", - /* write */ ""); + if (dynamic_cast (info.grob ()) + && Axis_group_interface::has_axis (info.grob (), Y_AXIS) -/****************************************************************/ + /* ugh. */ -class Vocal_name_engraver : public Instrument_name_engraver -{ -public: - TRANSLATOR_DECLARATIONS (Vocal_name_engraver); - virtual void create_text (); -}; + && !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")) + && (!Align_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 ()); + } +} -Vocal_name_engraver::Vocal_name_engraver () +void +Instrument_name_engraver::finalize () { + if (text_spanner_) + stop_spanner (); } void -Vocal_name_engraver::create_text () +Instrument_name_engraver::stop_spanner () { - if (text_) - return; - - SCM txt = get_property ("vocalName"); + if (axis_groups_.empty ()) + axis_groups_ = backup_axis_groups_; - if (now_mom () > Moment (0)) - txt = get_property ("vocNam"); + for (vsize i = 0; i < axis_groups_.size (); i++) + Pointer_group_interface::add_grob (text_spanner_, + ly_symbol2scm ("elements"), + axis_groups_[i]); - /* - UGH. - */ - if (txt == SCM_EOL) - return; + text_spanner_->set_bound (RIGHT, + unsmob_grob (get_property ("currentCommandColumn"))); - text_ = make_item ("VocalName", SCM_EOL); + Pointer_group_interface::set_ordered (text_spanner_, + ly_symbol2scm ("elements"), + false); - if (text_->get_property ("text") != txt) - text_->set_property ("text", txt); + text_spanner_ = 0; } -ADD_ACKNOWLEDGER(Vocal_name_engraver, bar_line); -ADD_ACKNOWLEDGER(Vocal_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 */ "", - /* reads */ "vocNam vocalName", - /* write */ ""); +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 */ + "" + );