/*
- dynamic-engraver.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--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
- (c) 1997--2003 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 "warn.hh"
+
+#include "axis-group-interface.hh"
+#include "context.hh"
+#include "engraver.hh"
#include "dimensions.hh"
+#include "directional-element-interface.hh"
+#include "engraver.hh"
#include "hairpin.hh"
-#include "event.hh"
-#include "paper-column.hh"
+#include "international.hh"
+#include "interval.hh"
#include "note-column.hh"
-#include "item.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 "engraver.hh"
-#include "group-interface.hh"
-#include "directional-element-interface.hh"
-#include "translator-group.hh"
-#include "axis-group-interface.hh"
-#include "script.hh"
+#include "staff-symbol-referencer.hh"
+#include "stream-event.hh"
+#include "warn.hh"
+#include "spanner.hh"
+#include "text-interface.hh"
+
+#include "translator.icc"
/*
TODO:
line-spanner
- TODO: this engraver is too complicated. We should split it into
- the handling of the basic grobs and the linespanner
+ 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
{
- Item * script_;
- Spanner * finished_cresc_;
- Spanner * cresc_;
+ Item *script_;
+ Spanner *line_spanner_;
+ Spanner *cresc_;
+
+ Spanner *finished_line_spanner_;
+ Spanner *finished_cresc_;
+
+ Stream_event *script_ev_;
+ Stream_event *current_cresc_ev_;
- Music* script_ev_;
-
- Music * current_cresc_ev_;
- Drul_array<Music*> accepted_spanreqs_drul_;
+ Drul_array<Stream_event *> accepted_spanevents_drul_;
- Spanner* line_spanner_;
- Spanner* finished_line_spanner_;
+ vector<Note_column *> pending_columns_;
+ vector<Grob *> pending_elements_;
- Link_array<Note_column> pending_columns_;
- Link_array<Grob> pending_elements_;
-
void typeset_all ();
-TRANSLATOR_DECLARATIONS(Dynamic_engraver );
-
+ TRANSLATOR_DECLARATIONS (Dynamic_engraver);
+ DECLARE_ACKNOWLEDGER (note_column);
+ DECLARE_TRANSLATOR_LISTENER (absolute_dynamic);
+ DECLARE_TRANSLATOR_LISTENER (span_dynamic);
+
protected:
virtual void finalize ();
- virtual void acknowledge_grob (Grob_info);
- virtual bool try_music (Music *req);
- virtual void stop_translation_timestep ();
- virtual void process_music ();
+ void stop_translation_timestep ();
+ void process_music ();
};
-
-
-
Dynamic_engraver::Dynamic_engraver ()
{
script_ = 0;
line_spanner_ = 0;
finished_line_spanner_ = 0;
current_cresc_ev_ = 0;
- cresc_ =0;
+ cresc_ = 0;
script_ev_ = 0;
- accepted_spanreqs_drul_[START] = 0;
- accepted_spanreqs_drul_[STOP] = 0;
+ accepted_spanevents_drul_[START] = 0;
+ accepted_spanevents_drul_[STOP] = 0;
}
-bool
-Dynamic_engraver::try_music (Music * m)
+IMPLEMENT_TRANSLATOR_LISTENER (Dynamic_engraver, absolute_dynamic);
+void
+Dynamic_engraver::listen_absolute_dynamic (Stream_event *ev)
{
- if (m->is_mus_type ("absolute-dynamic-event"))
- {
- /*
- TODO: probably broken.
- */
- script_ev_ = m;
- return true;
- }
- else if (m->is_mus_type ("abort-event"))
- {
- accepted_spanreqs_drul_[LEFT] = 0;
- accepted_spanreqs_drul_[RIGHT] = 0;
- /*
- Let's not kill the line spanner, since that would fuck up
- earlier, not-to-be-terminated stuff.
+ /*
+ TODO: probably broken.
+ */
+ ASSIGN_EVENT_ONCE (script_ev_, ev);
+}
- It will disappear by itself when stop_translation_timestep
- () finds that there is nothing to support anymore. */
-
- if (cresc_)
- cresc_->suicide ();
- cresc_ = 0;
- }
- else if (m->is_mus_type ("decrescendo-event")
- || m->is_mus_type ("crescendo-event"))
- {
- Direction d = to_dir (m->get_mus_property ("span-direction"));
+IMPLEMENT_TRANSLATOR_LISTENER (Dynamic_engraver, span_dynamic);
+void
+Dynamic_engraver::listen_span_dynamic (Stream_event *ev)
+{
+ Direction d = to_dir (ev->get_property ("span-direction"));
- accepted_spanreqs_drul_[d] = m;
- if (current_cresc_ev_ && d == START)
- accepted_spanreqs_drul_[STOP] = m;
- return true;
- }
- return false;
+ 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_spanreqs_drul_[START] || accepted_spanreqs_drul_[STOP] || script_ev_)
+ if (accepted_spanevents_drul_[START] || accepted_spanevents_drul_[STOP] || script_ev_)
{
if (!line_spanner_)
- {
- line_spanner_ = make_spanner ("DynamicLineSpanner");
-
- Music * rq = accepted_spanreqs_drul_[START];
- if (script_ev_)
- rq = script_ev_ ;
- announce_grob(line_spanner_, rq ? rq->self_scm(): SCM_EOL);
- }
+ {
+ Stream_event *rq = accepted_spanevents_drul_[START];
+ line_spanner_ = make_spanner ("DynamicLineSpanner", rq ? rq->self_scm () : SCM_EOL);
+ if (script_ev_)
+ rq = script_ev_;
+ }
}
-
+
/*
During a (de)crescendo, pending event will not be cleared,
and a line-spanner will always be created, as \< \! are already
as (de)crecsendo, b.o. line-breaking.
*/
-
-
/*
maybe we should leave dynamic texts to the text-engraver and
simply acknowledge them?
*/
if (script_ev_)
{
- script_ = make_item ("DynamicText");
- script_->set_grob_property ("text",
- script_ev_->get_mus_property ("text"));
+ 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_mus_property ("direction")))
- set_grob_direction (line_spanner_, d);
+ 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_);
-
- announce_grob(script_, script_ev_->self_scm());
}
- Music *stop_ev = accepted_spanreqs_drul_ [STOP] ?
- accepted_spanreqs_drul_[STOP] : script_ev_;
-
- if (accepted_spanreqs_drul_[STOP] || script_ev_)
+ if (accepted_spanevents_drul_[STOP] || script_ev_)
{
/*
- finish side position alignment if the (de)cresc ends here, and
- there are no new dynamics.
- */
-
+ finish side position alignment if the (de)cresc ends here, and
+ there are no new dynamics.
+ */
if (cresc_)
- {
- assert (!finished_cresc_ && cresc_);
-
- cresc_->set_bound (RIGHT, script_
- ? script_
- : unsmob_grob (get_property ("currentMusicalColumn")));
- add_bound_item (line_spanner_, cresc_->get_bound (RIGHT));
-
-
- finished_cresc_ = cresc_;
- cresc_ = 0;
- current_cresc_ev_ = 0;
- }
- else if (accepted_spanreqs_drul_[STOP] )
- {
- accepted_spanreqs_drul_[STOP]->origin ()->warning(_ ("can't find start of (de)crescendo"));
- stop_ev = 0;
- }
-
+ {
+ assert (!finished_cresc_ && cresc_);
+
+ if (script_)
+ {
+ cresc_->set_bound (RIGHT, script_);
+ add_bound_item (line_spanner_, script_);
+ }
+
+ 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"));
}
-
- if (accepted_spanreqs_drul_[START])
+
+ if (accepted_spanevents_drul_[START])
{
if (current_cresc_ev_)
- {
- Direction sd = to_dir (current_cresc_ev_->get_mus_property ("span-direction"));
- String msg = sd == 1
- ? _ ("already have a crescendo")
- : _ ("already have a decrescendo");
-
- accepted_spanreqs_drul_[START]->origin ()->warning (msg);
- current_cresc_ev_->origin ()->warning (_("Cresc started here"));
- }
+ {
+ 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_spanreqs_drul_[START];
-
- if (Direction d = to_dir (current_cresc_ev_->get_mus_property ("direction")))
- set_grob_direction (line_spanner_, d);
-
- /*
- TODO: Use symbols.
- */
-
- String start_type =
- ly_symbol2string (current_cresc_ev_->get_mus_property ("name"));
-
- /*
- ugh. Use push/pop?
- */
- if (start_type == "DecrescendoEvent")
- start_type = "decrescendo";
- else if (start_type == "CrescendoEvent")
- start_type = "crescendo";
-
- SCM s = get_property ((start_type + "Spanner").to_str0 ());
- if (!gh_symbol_p (s) || s == ly_symbol2scm ("hairpin"))
- {
- cresc_ = make_spanner ("Hairpin");
- cresc_->set_grob_property ("grow-direction",
- gh_int2scm ((start_type == "crescendo")
- ? BIGGER : SMALLER));
-
- }
-
-
- /*
- This is a convenient (and legacy) interface to TextSpanners
- for use in (de)crescendi.
- Hmm.
- */
- else
- {
- cresc_ = make_spanner ("TextSpanner");
- cresc_->set_grob_property ("style", s);
- daddy_trans_->set_property ((start_type
- + "Spanner").to_str0 (), SCM_EOL);
- s = get_property ((start_type + "Text").to_str0 ());
- /*
- FIXME: use get_markup () to check type.
- */
- if (gh_string_p (s) || gh_pair_p (s))
- {
- cresc_->set_grob_property ("edge-text",
- gh_cons (s, scm_makfrom0str ("")));
- daddy_trans_->set_property ((start_type + "Text").to_str0 (),
- SCM_EOL);
- }
- }
-
- cresc_->set_bound (LEFT, script_
- ? script_
- : unsmob_grob (get_property ("currentMusicalColumn")));
-
- Axis_group_interface::add_element (line_spanner_, cresc_);
-
- add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
-
- announce_grob(cresc_, accepted_spanreqs_drul_[START]->self_scm());
- }
+ {
+ 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;
+
+ if (start_sym == ly_symbol2scm ("decrescendo-event"))
+ start_type = "decrescendo";
+ else if (start_sym == ly_symbol2scm ("crescendo-event"))
+ start_type = "crescendo";
+ else
+ {
+ programming_error ("unknown dynamic spanner type");
+ return;
+ }
+
+ /*
+ 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"))
+ {
+ 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_);
+
+ Pointer_group_interface::add_grob (cresc_,
+ ly_symbol2scm ("adjacent-hairpins"),
+ finished_cresc_);
+ }
+ }
+
+ /*
+ This is a convenient (and legacy) interface to TextSpanners
+ for use in (de)crescendi.
+ Hmm.
+ */
+ else
+ {
+ 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))
+ {
+ cresc_->set_property ("text", s);
+ context ()->set_property ((start_type + "Text").c_str (),
+ SCM_EOL);
+ }
+
+ if (script_)
+ {
+ set_nested_property (cresc_,
+ scm_list_3 (ly_symbol2scm ("bound-details"),
+ ly_symbol2scm ("left"),
+ ly_symbol2scm ("attach-dir")
+ ),
+ scm_from_int (RIGHT));
+ }
+ }
+
+ if (script_)
+ {
+ cresc_->set_bound (LEFT, script_);
+ add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
+ }
+ Axis_group_interface::add_element (line_spanner_, cresc_);
+ }
}
}
void
Dynamic_engraver::stop_translation_timestep ()
{
- typeset_all ();
- if (!current_cresc_ev_)
+ if (!current_cresc_ev_ && line_spanner_)
{
+ assert (!finished_line_spanner_);
finished_line_spanner_ = line_spanner_;
- line_spanner_ =0;
- typeset_all ();
+ 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));
}
script_ev_ = 0;
- accepted_spanreqs_drul_[START] = 0;
- accepted_spanreqs_drul_[STOP] = 0;
+ accepted_spanevents_drul_[START] = 0;
+ accepted_spanevents_drul_[STOP] = 0;
}
void
Dynamic_engraver::finalize ()
{
typeset_all ();
-
+
if (line_spanner_
- && !line_spanner_->live())
+ && !line_spanner_->is_live ())
line_spanner_ = 0;
if (line_spanner_)
{
}
if (cresc_
- && !cresc_->live())
+ && !cresc_->is_live ())
cresc_ = 0;
if (cresc_)
{
void
Dynamic_engraver::typeset_all ()
-{
- /*
- remove suicided spanners,
- ugh: we'll need this for every spanner, beam, slur
- Hmm, how to do this, cleanly?
- Maybe just check at typeset_grob ()?
- */
- if (finished_cresc_
- && !finished_cresc_->live())
- finished_cresc_ = 0;
- if (finished_line_spanner_
- && !finished_line_spanner_->live())
- finished_line_spanner_ = 0;
-
+{
if (finished_cresc_)
{
if (!finished_cresc_->get_bound (RIGHT))
- {
- finished_cresc_->set_bound (RIGHT, script_
- ? script_
- : unsmob_grob (get_property ("currentMusicalColumn")));
-
- if (finished_line_spanner_)
- add_bound_item (finished_line_spanner_,
- finished_cresc_->get_bound (RIGHT));
- }
- typeset_grob (finished_cresc_);
- finished_cresc_ =0;
- }
-
- if (script_)
- {
- typeset_grob (script_);
- script_ = 0;
+ {
+
+ 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;
}
+
+ script_ = 0;
if (finished_line_spanner_)
{
- /* To make sure that this works */
- Side_position_interface::add_staff_support (finished_line_spanner_);
-
/*
- We used to have
-
- extend-spanner-over-elements (finished_line_spanner_);
+ 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.
+ 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);
+ 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);
+ finished_line_spanner_->set_bound (RIGHT, l);
else if (!l && r)
- finished_line_spanner_->set_bound (LEFT, 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);
- }
-
- typeset_grob (finished_line_spanner_);
+ {
+ /*
+ 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_grob (Grob_info i)
+Dynamic_engraver::acknowledge_note_column (Grob_info info)
{
if (!line_spanner_)
- return ;
-
- if (Note_column::has_interface (i.grob_))
+ return;
+
+ if (line_spanner_
+ /* Don't refill killed spanner */
+ && line_spanner_->is_live ())
{
- if (line_spanner_
- /* Don't refill killed spanner */
- && line_spanner_->live())
- {
- Side_position_interface::add_support (line_spanner_,i.grob_);
- add_bound_item (line_spanner_,dynamic_cast<Item*> (i.grob_));
- }
-
- if (script_ && !script_->get_parent (X_AXIS))
- {
- script_->set_parent (i.grob_, X_AXIS);
- }
-
+ Side_position_interface::add_support (line_spanner_, info.grob ());
+ add_bound_item (line_spanner_, dynamic_cast<Item *> (info.grob ()));
}
- else if (Script_interface::has_interface (i.grob_) && script_)
- {
- SCM p = i.grob_->get_grob_property ("script-priority");
-
- /*
- UGH.
- DynamicText doesn't really have a script-priority field.
- */
- if (gh_number_p (p)
- && gh_scm2int (p) < gh_scm2int (script_->get_grob_property ("script-priority")))
- {
- Side_position_interface::add_support (line_spanner_, i.grob_);
+ 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 (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 ());
}
-ENTER_DESCRIPTION(Dynamic_engraver,
-/* descr */
-"This engraver creates hairpins, dynamic texts, and their vertical\n"
-"alignments. The symbols are collected onto a DynamicLineSpanner grob\n"
-"which takes care of vertical positioning. "
-,
-
-/* creats*/ "DynamicLineSpanner DynamicText Hairpin TextSpanner",
-/* accepts */ "absolute-dynamic-event crescendo-event decrescendo-event",
-/* acks */ "note-column-interface script-interface",
-/* reads */ "",
-/* write */ "");
+
+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