/*
- dynamic-reg.cc -- implement Dynamic_engraver
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
+ Copyright (C) 1997--2010 Han-Wen Nienhuys <hanwen@xs4all.nl>
- (c) 1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.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 "debug.hh"
-#include "crescendo.hh"
-#include "musical-request.hh"
-#include "lookup.hh"
-#include "paper-def.hh"
-#include "score-column.hh"
-#include "staff-symbol.hh"
-#include "note-column.hh"
-#include "text-item.hh"
-#include "staff-side.hh"
+
+#include "axis-group-interface.hh"
+#include "context.hh"
#include "engraver.hh"
-#include "stem.hh"
-#include "note-head.hh"
+#include "dimensions.hh"
+#include "directional-element-interface.hh"
+#include "engraver.hh"
+#include "hairpin.hh"
+#include "international.hh"
+#include "interval.hh"
+#include "note-column.hh"
+#include "paper-column.hh"
+#include "pointer-group-interface.hh"
+#include "script-interface.hh"
+#include "self-alignment-interface.hh"
+#include "side-position-interface.hh"
+#include "staff-symbol-referencer.hh"
+#include "stream-event.hh"
+#include "warn.hh"
+#include "spanner.hh"
+#include "text-interface.hh"
+
+#include "translator.icc"
+
+/*
+ TODO:
+
+ * direction of text-dynamic-event if not equal to direction of
+ line-spanner
+
+ - TODO: this engraver is too complicated. We should split it into
+ the handling of the basic grobs and the linespanner
+
+ - TODO: the line-spanner is not killed after the (de)crescs are
+ finished.
+*/
/**
print text & hairpin dynamics.
- */
+*/
class Dynamic_engraver : public Engraver
{
- Text_item * text_p_;
- Staff_side_item * staff_side_p_;
- Staff_side_spanner * ss_span_p_;
- Staff_side_spanner * to_end_ss_span_p_;
-
-
- Crescendo * to_end_cresc_p_;
- Crescendo * cresc_p_;
- Span_req * cresc_req_l_;
- Array<Request*> dynamic_req_l_arr_;
- void typeset_all ();
-public:
- VIRTUAL_COPY_CONS(Translator);
- Dynamic_engraver();
-
-protected:
- virtual void do_removal_processing ();
- virtual void acknowledge_element (Score_element_info);
- virtual bool do_try_music (Music *req_l);
- virtual void do_process_requests();
- virtual void do_pre_move_processing();
- virtual void do_post_move_processing();
-};
+ Item *script_;
+ Spanner *line_spanner_;
+ Spanner *cresc_;
+
+ Spanner *finished_line_spanner_;
+ Spanner *finished_cresc_;
+ Stream_event *script_ev_;
+ Stream_event *current_cresc_ev_;
+ Drul_array<Stream_event *> accepted_spanevents_drul_;
-Dynamic_engraver::Dynamic_engraver()
+ vector<Note_column*> pending_columns_;
+ vector<Grob*> pending_elements_;
+
+ void typeset_all ();
+
+ TRANSLATOR_DECLARATIONS (Dynamic_engraver);
+ DECLARE_ACKNOWLEDGER (note_column);
+ DECLARE_TRANSLATOR_LISTENER (absolute_dynamic);
+ DECLARE_TRANSLATOR_LISTENER (span_dynamic);
+
+protected:
+ virtual void finalize ();
+ void stop_translation_timestep ();
+ void process_music ();
+};
+
+Dynamic_engraver::Dynamic_engraver ()
{
- do_post_move_processing();
- text_p_ =0;
- staff_side_p_ =0;
- to_end_cresc_p_ = cresc_p_ = 0;
- ss_span_p_ = to_end_ss_span_p_=0;
- cresc_req_l_ = 0;
+ script_ = 0;
+ finished_cresc_ = 0;
+ line_spanner_ = 0;
+ finished_line_spanner_ = 0;
+ current_cresc_ev_ = 0;
+ cresc_ = 0;
+
+ script_ev_ = 0;
+ accepted_spanevents_drul_[START] = 0;
+ accepted_spanevents_drul_[STOP] = 0;
}
+IMPLEMENT_TRANSLATOR_LISTENER (Dynamic_engraver, absolute_dynamic);
void
-Dynamic_engraver::do_post_move_processing()
+Dynamic_engraver::listen_absolute_dynamic (Stream_event *ev)
{
- dynamic_req_l_arr_.clear();
+ /*
+ TODO: probably broken.
+ */
+ ASSIGN_EVENT_ONCE (script_ev_, ev);
}
-bool
-Dynamic_engraver::do_try_music (Music * m)
+IMPLEMENT_TRANSLATOR_LISTENER (Dynamic_engraver, span_dynamic);
+void
+Dynamic_engraver::listen_span_dynamic (Stream_event *ev)
{
- Request * r = dynamic_cast<Request*> (m);
+ Direction d = to_dir (ev->get_property ("span-direction"));
- if(Text_script_req * d = dynamic_cast <Text_script_req *> (r))
+ if (d == START)
+ ASSIGN_EVENT_ONCE (accepted_spanevents_drul_[START], ev);
+
+ /* Cancel any ongoing crescendo, either explicitly by \! or
+ implicitly by a new crescendo. Also avoid warning if cresc is
+ cancelled both implicitly and explicitly. */
+ if ((d == STOP || current_cresc_ev_) && !accepted_spanevents_drul_[STOP])
+ ASSIGN_EVENT_ONCE (accepted_spanevents_drul_[STOP], ev);
+}
+
+void
+Dynamic_engraver::process_music ()
+{
+ if (accepted_spanevents_drul_[START] || accepted_spanevents_drul_[STOP] || script_ev_)
{
- if (d->style_str_ != "dynamic")
- return false;
+ if (!line_spanner_)
+ {
+ Stream_event *rq = accepted_spanevents_drul_[START];
+ line_spanner_ = make_spanner ("DynamicLineSpanner", rq ? rq->self_scm () : SCM_EOL);
+ if (script_ev_)
+ rq = script_ev_;
+ }
}
- else if (Span_req * s = dynamic_cast <Span_req*> (r))
+
+ /*
+ During a (de)crescendo, pending event will not be cleared,
+ and a line-spanner will always be created, as \< \! are already
+ two events.
+
+ Note: line-spanner must always have at least same duration
+ as (de)crecsendo, b.o. line-breaking.
+ */
+
+ /*
+ maybe we should leave dynamic texts to the text-engraver and
+ simply acknowledge them?
+ */
+ if (script_ev_)
{
- if (s-> span_type_str_ != "crescendo"
- && s->span_type_str_ != "decrescendo")
- return false;
+ script_ = make_item ("DynamicText", script_ev_->self_scm ());
+ script_->set_property ("text",
+ script_ev_->get_property ("text"));
+
+ if (Direction d = to_dir (script_ev_->get_property ("direction")))
+ set_grob_direction (line_spanner_, d);
+ else if (Direction d = to_dir (line_spanner_->get_property ("direction")))
+ set_grob_direction (script_, d);
+
+ Axis_group_interface::add_element (line_spanner_, script_);
}
- else
- return false;
-
- for (int i=0; i < dynamic_req_l_arr_.size (); i++)
- if (r->equal_b (dynamic_req_l_arr_[i]))
- return true;
-
- dynamic_req_l_arr_.push (r);
- return true;
-}
+ Stream_event *stop_ev = accepted_spanevents_drul_ [STOP]
+ ? accepted_spanevents_drul_[STOP] : script_ev_;
-void
-Dynamic_engraver::do_process_requests()
-{
- Crescendo* new_cresc_p=0;
- Staff_side_spanner * new_sss_p =0;
- for (int i=0; i < dynamic_req_l_arr_.size(); i++)
+ if (accepted_spanevents_drul_[STOP] || script_ev_)
{
- if (Text_script_req *absd =
- dynamic_cast<Text_script_req *> ( dynamic_req_l_arr_[i]))
+ /*
+ finish side position alignment if the (de)cresc ends here, and
+ there are no new dynamics.
+ */
+
+ if (cresc_)
{
- if (text_p_)
+ assert (!finished_cresc_ && cresc_);
+
+ if (script_)
{
- dynamic_req_l_arr_[i]->warning (_("Got a dynamic already. Continuing dazed and confused."));
- continue;
+ cresc_->set_bound (RIGHT, script_);
+ add_bound_item (line_spanner_, script_);
}
-
- String loud = absd->text_str_;
- text_p_ = new Text_item;
- text_p_->text_str_ = loud; // ugh
+ finished_cresc_ = cresc_;
+ announce_end_grob (finished_cresc_, SCM_EOL);
+ cresc_ = 0;
+ current_cresc_ev_ = 0;
+ }
+ else if (accepted_spanevents_drul_[STOP])
+ {
+ accepted_spanevents_drul_[STOP]->origin ()->warning (_ ("cannot find start of (de)crescendo"));
+ stop_ev = 0;
+ }
+ }
- staff_side_p_ = new Staff_side_item;
- staff_side_p_->set_elt_property (script_priority_scm_sym,
- gh_int2scm (100));
-
- staff_side_p_->set_victim (text_p_);
- staff_side_p_->axis_ = Y_AXIS;
- staff_side_p_->dir_ = DOWN;
+ if (accepted_spanevents_drul_[START])
+ {
+ if (current_cresc_ev_)
+ {
+ string msg = _ ("already have a decrescendo");
+ if (current_cresc_ev_->in_event_class ("crescendo-event"))
+ msg = _ ("already have a crescendo");
+ accepted_spanevents_drul_[START]->origin ()->warning (msg);
+ current_cresc_ev_->origin ()->warning (_ ("cresc starts here"));
+ }
+ else
+ {
+ current_cresc_ev_ = accepted_spanevents_drul_[START];
+
+ if (Direction d = to_dir (current_cresc_ev_->get_property ("direction")))
+ set_grob_direction (line_spanner_, d);
+
+ /*
+ TODO: Use symbols.
+ */
+
+ SCM start_sym = current_cresc_ev_->get_property ("class");
+ string start_type;
- SCM prop = get_property ("verticalDirection", 0);
- if (isdir_b (prop))
+ if (start_sym == ly_symbol2scm ("decrescendo-event"))
+ start_type = "decrescendo";
+ else if (start_sym == ly_symbol2scm ("crescendo-event"))
+ start_type = "crescendo";
+ else
{
- staff_side_p_->dir_ = to_dir (prop);
+ programming_error ("unknown dynamic spanner type");
+ return;
}
- prop = get_property ("dynamicDirection", 0);
- if (gh_number_p(prop))
+ /*
+ UGH. TODO: should read from original event, so appearance
+ may be altered with \tweak.
+ */
+ SCM s = get_property ((start_type + "Spanner").c_str ());
+ if (!scm_is_symbol (s) || s == ly_symbol2scm ("hairpin"))
{
- staff_side_p_->dir_ = to_dir (prop);
- }
- if (absd->dir_)
- {
- staff_side_p_->dir_ = absd->dir_;
- }
+ cresc_ = make_spanner ("Hairpin", accepted_spanevents_drul_[START]->self_scm ());
+ if (finished_cresc_)
+ {
+ Pointer_group_interface::add_grob (finished_cresc_,
+ ly_symbol2scm ("adjacent-hairpins"),
+ cresc_);
- prop = get_property ("dynamicPadding", 0);
- if (gh_number_p(prop))
- {
- staff_side_p_->set_elt_property (padding_scm_sym, prop);
+ Pointer_group_interface::add_grob (cresc_,
+ ly_symbol2scm ("adjacent-hairpins"),
+ finished_cresc_);
+ }
}
- announce_element (Score_element_info (text_p_, absd));
- announce_element (Score_element_info (staff_side_p_, absd));
- }
- else if (Span_req *span_l
- = dynamic_cast <Span_req *> (dynamic_req_l_arr_[i]))
- {
- if (span_l->span_dir_ == STOP)
+
+ /*
+ This is a convenient (and legacy) interface to TextSpanners
+ for use in (de)crescendi.
+ Hmm.
+ */
+ else
{
- if (!cresc_p_)
+ cresc_ = make_spanner ("DynamicTextSpanner", accepted_spanevents_drul_[START]->self_scm ());
+ cresc_->set_property ("style", s);
+ context ()->set_property ((start_type
+ + "Spanner").c_str (), SCM_EOL);
+ s = get_property ((start_type + "Text").c_str ());
+ if (Text_interface::is_markup (s))
{
- span_l->warning (_ ("Can't find (de)crescendo to end"));
+ cresc_->set_property ("text", s);
+ context ()->set_property ((start_type + "Text").c_str (),
+ SCM_EOL);
}
- else
+
+ if (script_)
{
- assert (!to_end_cresc_p_);
- to_end_cresc_p_ =cresc_p_;
- to_end_ss_span_p_ = ss_span_p_ ;
-
- cresc_p_ = 0;
- ss_span_p_ =0;
-
-
-
-
- SCM prop = get_property ("verticalDirection", 0);
- if (isdir_b (prop))
- {
- to_end_ss_span_p_->dir_ = to_dir (prop);
- }
- prop = get_property ("dynamicDirection", 0);
- if (isdir_b (prop))
- {
- to_end_ss_span_p_->dir_ = to_dir (prop);
- }
- prop = get_property ("dynamicPadding", 0);
- if (gh_number_p(prop))
- {
- to_end_ss_span_p_->set_elt_property (padding_scm_sym,prop);
- }
+ set_nested_property (cresc_,
+ scm_list_3 (ly_symbol2scm ("bound-details"),
+ ly_symbol2scm ("left"),
+ ly_symbol2scm ("attach-dir")
+ ),
+ scm_from_int (RIGHT));
}
}
- else if (span_l->span_dir_ == START)
+
+ if (script_)
{
- cresc_req_l_ = span_l;
- assert (!new_cresc_p);
- new_cresc_p = new Crescendo;
- new_cresc_p->grow_dir_ = (span_l->span_type_str_ == "crescendo") ? BIGGER : SMALLER;
- announce_element (Score_element_info (new_cresc_p, span_l));
-
- new_sss_p = new Staff_side_spanner;
- new_sss_p->set_victim (new_cresc_p);
- new_sss_p->axis_ = Y_AXIS;
- // UGH.!
- // new_sss_p->set_elt_property (dangling_scm_sym, SCM_BOOL_T);
- announce_element (Score_element_info (new_sss_p, span_l));
+ cresc_->set_bound (LEFT, script_);
+ add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
}
- }
- }
-
- if (new_cresc_p)
- {
- if (cresc_p_)
- {
- ::warning (_ ("Too many crescendi here"));
- typeset_element (cresc_p_);
- typeset_element (ss_span_p_);
- cresc_p_ = 0;
- ss_span_p_ =0;
- }
-
- cresc_p_ = new_cresc_p;
- ss_span_p_ = new_sss_p;
- cresc_p_->set_bounds(LEFT,get_staff_info().musical_pcol_l ());
- ss_span_p_->set_bounds (LEFT,get_staff_info().musical_pcol_l ());
- if (text_p_)
- {
- cresc_p_->dyn_b_drul_[LEFT] = true;
- if (to_end_cresc_p_)
- to_end_cresc_p_->dyn_b_drul_[RIGHT] = true;
+ Axis_group_interface::add_element (line_spanner_, cresc_);
}
}
}
void
-Dynamic_engraver::do_pre_move_processing()
+Dynamic_engraver::stop_translation_timestep ()
{
- typeset_all ();
-}
+ if (!current_cresc_ev_ && line_spanner_)
+ {
+ assert (!finished_line_spanner_);
+ finished_line_spanner_ = line_spanner_;
+ line_spanner_ = 0;
+ }
+ typeset_all ();
+ if (cresc_ && !cresc_->get_bound (LEFT))
+ {
+ cresc_->set_bound (LEFT, unsmob_grob (get_property ("currentMusicalColumn")));
+ add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
+ }
-ADD_THIS_TRANSLATOR(Dynamic_engraver);
+ script_ev_ = 0;
+ accepted_spanevents_drul_[START] = 0;
+ accepted_spanevents_drul_[STOP] = 0;
+}
void
-Dynamic_engraver::do_removal_processing ()
+Dynamic_engraver::finalize ()
{
- if (cresc_p_)
+ typeset_all ();
+
+ if (line_spanner_
+ && !line_spanner_->is_live ())
+ line_spanner_ = 0;
+ if (line_spanner_)
{
- typeset_element (cresc_p_ );
- typeset_element (ss_span_p_);
- ss_span_p_ =0;
- cresc_req_l_->warning (_ ("unended crescendo"));
- cresc_p_ =0;
+ finished_line_spanner_ = line_spanner_;
+ typeset_all ();
}
- typeset_all ();
-}
+ if (cresc_
+ && !cresc_->is_live ())
+ cresc_ = 0;
+ if (cresc_)
+ {
+ current_cresc_ev_->origin ()->warning (_ ("unterminated (de)crescendo"));
+ cresc_->suicide ();
+ cresc_ = 0;
+ }
+}
void
Dynamic_engraver::typeset_all ()
-{
- if (to_end_cresc_p_)
+{
+ if (finished_cresc_)
{
- to_end_cresc_p_->set_bounds(RIGHT,get_staff_info().musical_pcol_l ());
- to_end_ss_span_p_->set_bounds(RIGHT,get_staff_info().musical_pcol_l ());
- typeset_element (to_end_cresc_p_);
- typeset_element (to_end_ss_span_p_);
- to_end_cresc_p_ =0;
- to_end_ss_span_p_ =0;
+ if (!finished_cresc_->get_bound (RIGHT))
+ {
+
+ Grob *column_bound = unsmob_grob (get_property ("currentMusicalColumn"));
+
+ finished_cresc_->set_bound (RIGHT, script_
+ ? script_
+ : column_bound);
+
+ if (finished_line_spanner_)
+ add_bound_item (finished_line_spanner_,
+ finished_cresc_->get_bound (RIGHT));
+ }
+ finished_cresc_ = 0;
}
-
- if (text_p_)
+
+ script_ = 0;
+ if (finished_line_spanner_)
{
- typeset_element (text_p_);
- typeset_element (staff_side_p_);
- text_p_ =0;
- staff_side_p_ =0;
+ /*
+ We used to have
+
+ extend-spanner-over-elements (finished_line_spanner_);
+
+ but this is rather kludgy, since finished_line_spanner_
+ typically has a staff-symbol field set , extending it over the
+ entire staff.
+
+ */
+
+ Grob *l = finished_line_spanner_->get_bound (LEFT);
+ Grob *r = finished_line_spanner_->get_bound (RIGHT);
+ if (!r && l)
+ finished_line_spanner_->set_bound (RIGHT, l);
+ else if (!l && r)
+ finished_line_spanner_->set_bound (LEFT, r);
+ else if (!r && !l)
+ {
+ /*
+ This is a isolated dynamic apparently, and does not even have
+ any interesting support item.
+ */
+ Grob *cc = unsmob_grob (get_property ("currentMusicalColumn"));
+ Item *ci = dynamic_cast<Item *> (cc);
+ finished_line_spanner_->set_bound (RIGHT, ci);
+ finished_line_spanner_->set_bound (LEFT, ci);
+ }
+ finished_line_spanner_ = 0;
}
}
-
void
-Dynamic_engraver::acknowledge_element (Score_element_info i)
+Dynamic_engraver::acknowledge_note_column (Grob_info info)
{
- if (dynamic_cast<Stem *> (i.elem_l_)
- || dynamic_cast<Note_head *> (i.elem_l_)
- )
+ if (!line_spanner_)
+ return;
+
+ if (line_spanner_
+ /* Don't refill killed spanner */
+ && line_spanner_->is_live ())
{
- if (staff_side_p_)
- staff_side_p_->add_support (i.elem_l_);
+ Side_position_interface::add_support (line_spanner_, info.grob ());
+ add_bound_item (line_spanner_, dynamic_cast<Item *> (info.grob ()));
+ }
- if (to_end_ss_span_p_)
- to_end_ss_span_p_->add_support (i.elem_l_);
+ if (script_ && !script_->get_parent (X_AXIS))
+ {
+ extract_grob_set (info.grob (), "note-heads", heads);
+ if (heads.size ())
+ {
+ Grob *head = heads[0];
+ script_->set_parent (head, X_AXIS);
+ Self_alignment_interface::set_center_parent (script_, X_AXIS);
+ }
+ }
- if (ss_span_p_)
- ss_span_p_->add_support (i.elem_l_);
+ if (cresc_)
+ {
+ if (!cresc_->get_bound (LEFT))
+ {
+ cresc_->set_bound (LEFT, info.grob ());
+ add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
+ }
}
+
+ if (finished_cresc_ && !finished_cresc_->get_bound (RIGHT))
+ finished_cresc_->set_bound (RIGHT, info.grob ());
}
+
+ADD_ACKNOWLEDGER (Dynamic_engraver, note_column);
+
+ADD_TRANSLATOR (Dynamic_engraver,
+ /* doc */
+ "Create hairpins, dynamic texts, and their vertical"
+ " alignments. The symbols are collected onto a"
+ " @code{DynamicLineSpanner} grob which takes care of vertical"
+ " positioning.",
+
+ /* create */
+ "DynamicLineSpanner "
+ "DynamicTextSpanner "
+ "DynamicText "
+ "Hairpin ",
+
+ /* read */
+ "",
+
+ /* write */
+ ""
+ );
projects / lilypond.git / blobdiff