source file of the GNU LilyPond music typesetter
- (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1997--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
*/
-#include "warn.hh"
+
+#include "axis-group-interface.hh"
+#include "context.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 "side-position-interface.hh"
-#include "engraver.hh"
-#include "group-interface.hh"
-#include "directional-element-interface.hh"
-#include "context.hh"
-#include "axis-group-interface.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 "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_;
+ Item *script_;
Spanner *line_spanner_;
Spanner *cresc_;
Spanner *finished_line_spanner_;
Spanner *finished_cresc_;
- Music *script_ev_;
- Music *current_cresc_ev_;
-
- Drul_array<Music*> accepted_spanreqs_drul_;
+ Stream_event *script_ev_;
+ Stream_event *current_cresc_ev_;
+
+ Drul_array<Stream_event *> accepted_spanevents_drul_;
+
+ 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);
-
+ DECLARE_ACKNOWLEDGER (accidental);
+ DECLARE_ACKNOWLEDGER (stem_tremolo);
+ DECLARE_ACKNOWLEDGER (note_column);
+ DECLARE_ACKNOWLEDGER (slur);
+ 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 ("decrescendo-event")
- || m->is_mus_type ("crescendo-event"))
- {
- Direction d = to_dir (m->get_property ("span-direction"));
+ /*
+ TODO: probably broken.
+ */
+ ASSIGN_EVENT_ONCE (script_ev_, ev);
+}
- accepted_spanreqs_drul_[d] = m;
- if (current_cresc_ev_ && d == START)
- accepted_spanreqs_drul_[STOP] = m;
- return true;
- }
- return false;
+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"));
+
+ 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_)
{
- Music * rq = accepted_spanreqs_drul_[START];
- line_spanner_ = make_spanner ("DynamicLineSpanner", 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_;
+ 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?
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_);
}
- Music *stop_ev = accepted_spanreqs_drul_ [STOP] ?
- accepted_spanreqs_drul_[STOP] : script_ev_;
+ Stream_event *stop_ev = accepted_spanevents_drul_ [STOP]
+ ? accepted_spanevents_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.
- */
-
+ */
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));
-
+ if (script_)
+ {
+ cresc_->set_bound (RIGHT, script_);
+ add_bound_item (line_spanner_, script_);
+ }
finished_cresc_ = cresc_;
cresc_ = 0;
current_cresc_ev_ = 0;
}
- else if (accepted_spanreqs_drul_[STOP])
+ else if (accepted_spanevents_drul_[STOP])
{
- accepted_spanreqs_drul_[STOP]->origin ()->warning (_ ("can't find start of (de)crescendo"));
+ accepted_spanevents_drul_[STOP]->origin ()->warning (_ ("cannot find start of (de)crescendo"));
stop_ev = 0;
}
-
}
-
- if (accepted_spanreqs_drul_[START])
+
+ if (accepted_spanevents_drul_[START])
{
if (current_cresc_ev_)
{
- String msg = _ ("already have a decrescendo");
- if (current_cresc_ev_->is_mus_type ("decrescendo-event"))
+ string msg = _ ("already have a decrescendo");
+ if (current_cresc_ev_->in_event_class ("crescendo-event"))
msg = _ ("already have a crescendo");
- accepted_spanreqs_drul_[START]->origin ()->warning (msg);
- current_cresc_ev_->origin ()->warning (_("Cresc started here"));
+ accepted_spanevents_drul_[START]->origin ()->warning (msg);
+ current_cresc_ev_->origin ()->warning (_ ("cresc starts here"));
}
else
{
- current_cresc_ev_ = accepted_spanreqs_drul_[START];
+ 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.
*/
-
- String start_type =
- ly_symbol2string (current_cresc_ev_->get_property ("name"));
-
- /*
- ugh. Use push/pop?
- */
- if (start_type == "DecrescendoEvent")
+
+ 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_type == "CrescendoEvent")
+ else if (start_sym == ly_symbol2scm ("crescendo-event"))
start_type = "crescendo";
-
- SCM s = get_property ((start_type + "Spanner").to_str0 ());
- if (!ly_c_symbol_p (s) || s == ly_symbol2scm ("hairpin"))
+ else
{
- cresc_ = make_spanner ("Hairpin", accepted_spanreqs_drul_[START]->self_scm ());
- cresc_->set_property ("grow-direction",
- scm_int2num ((start_type == "crescendo")
- ? BIGGER : SMALLER));
-
+ 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.
*/
else
{
- cresc_ = make_spanner ("DynamicTextSpanner", accepted_spanreqs_drul_[START]->self_scm ());
+ cresc_ = make_spanner ("DynamicTextSpanner", accepted_spanevents_drul_[START]->self_scm ());
cresc_->set_property ("style", s);
context ()->set_property ((start_type
- + "Spanner").to_str0 (), SCM_EOL);
- s = get_property ((start_type + "Text").to_str0 ());
+ + "Spanner").c_str (), SCM_EOL);
+ s = get_property ((start_type + "Text").c_str ());
/*
FIXME: use get_markup () to check type.
*/
- if (ly_c_string_p (s) || ly_c_pair_p (s))
+ if (scm_is_string (s) || scm_is_pair (s))
{
cresc_->set_property ("edge-text",
- scm_cons (s, scm_makfrom0str ("")));
- context ()->set_property ((start_type + "Text").to_str0 (),
+ scm_cons (s, scm_from_locale_string ("")));
+ context ()->set_property ((start_type + "Text").c_str (),
SCM_EOL);
}
}
- cresc_->set_bound (LEFT, script_
- ? script_
- : unsmob_grob (get_property ("currentMusicalColumn")));
+ if (script_)
+ {
+ cresc_->set_bound (LEFT, script_);
+ add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
+ }
Axis_group_interface::add_element (line_spanner_, cresc_);
-
- add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
}
}
}
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_->is_live ())
line_spanner_ = 0;
void
Dynamic_engraver::typeset_all ()
-{
+{
if (finished_cresc_)
{
- if (!finished_cresc_->get_bound (RIGHT))
+ bool use_bar = to_boolean (get_property ("hairpinToBarline"))
+ && scm_is_string (get_property ("whichBar"))
+ && !script_ev_;
+
+
+ if (!finished_cresc_->get_bound (RIGHT)
+ || use_bar)
{
+
+ Grob *column_bound = 0;
+ if (use_bar)
+ {
+ column_bound = unsmob_grob (get_property ("breakableSeparationItem"));
+ }
+
+ if (!column_bound)
+ column_bound = unsmob_grob (use_bar
+ ? get_property ("currentCommandColumn")
+ : get_property ("currentMusicalColumn"));
+
finished_cresc_->set_bound (RIGHT, script_
? script_
- : unsmob_grob (get_property ("currentMusicalColumn")));
+ : column_bound);
if (finished_line_spanner_)
add_bound_item (finished_line_spanner_,
finished_cresc_->get_bound (RIGHT));
}
- finished_cresc_ =0;
+ finished_cresc_ = 0;
}
-
+
script_ = 0;
if (finished_line_spanner_)
{
/*
We used to have
-
- extend-spanner-over-elements (finished_line_spanner_);
+
+ 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
*/
- 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);
else if (!l && r)
/*
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);
+ */
+ 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_->set_bound (LEFT, ci);
}
-
+
finished_line_spanner_ = 0;
}
}
void
-Dynamic_engraver::acknowledge_grob (Grob_info i)
+Dynamic_engraver::acknowledge_accidental (Grob_info info)
+{
+ if (line_spanner_)
+ Side_position_interface::add_support (line_spanner_, info.grob ());
+}
+
+void
+Dynamic_engraver::acknowledge_stem_tremolo (Grob_info info)
+{
+ if (line_spanner_)
+ Side_position_interface::add_support (line_spanner_, info.grob ());
+}
+
+void
+Dynamic_engraver::acknowledge_slur (Grob_info info)
+{
+ if (line_spanner_)
+ Side_position_interface::add_support (line_spanner_, info.grob ());
+}
+
+void
+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_->is_live ())
- {
- Side_position_interface::add_support (line_spanner_,i.grob_);
- add_bound_item (line_spanner_,dynamic_cast<Item*> (i.grob_));
- }
+ Side_position_interface::add_support (line_spanner_, info.grob ());
+ add_bound_item (line_spanner_, dynamic_cast<Item *> (info.grob ()));
+ }
- if (script_ && !script_->get_parent (X_AXIS))
+ if (script_ && !script_->get_parent (X_AXIS))
+ {
+ extract_grob_set (info.grob (), "note-heads", heads);
+ if (heads.size ())
{
- SCM head = scm_last_pair (i.grob_->get_property ("note-heads"));
- if (ly_c_pair_p (head))
- script_->set_parent (unsmob_grob (ly_car (head)), X_AXIS);
+ Grob *head = heads[0];
+ script_->set_parent (head, X_AXIS);
+ Self_alignment_interface::set_center_parent (script_, X_AXIS);
}
-
}
- else if (Script_interface::has_interface (i.grob_) && script_)
- {
- SCM p = i.grob_->get_property ("script-priority");
-
- /*
- UGH.
- DynamicText doesn't really have a script-priority field.
- */
- if (ly_c_number_p (p)
- && ly_scm2int (p) < ly_scm2int (script_->get_property ("script-priority")))
+ if (cresc_)
+ {
+ if (!cresc_->get_bound (LEFT))
{
- Side_position_interface::add_support (line_spanner_, i.grob_);
-
+ 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, accidental);
+ADD_ACKNOWLEDGER (Dynamic_engraver, note_column);
+ADD_ACKNOWLEDGER (Dynamic_engraver, slur);
+ADD_ACKNOWLEDGER (Dynamic_engraver, stem_tremolo);
+
+ADD_TRANSLATOR (Dynamic_engraver,
+ /* doc */
+ "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. ",
+
+ /* create */
+ "DynamicLineSpanner "
+ "DynamicText "
+ "Hairpin "
+ "TextSpanner ",
+
+ /* read */ "",
+ /* write */ "");