source file of the GNU LilyPond music typesetter
- (c) 1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1997--2006 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 "musical-request.hh"
-#include "paper-column.hh"
+#include "interval.hh"
#include "note-column.hh"
-#include "item.hh"
+#include "paper-column.hh"
+#include "script-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 "warn.hh"
+#include "self-alignment-interface.hh"
+#include "pointer-group-interface.hh"
+
+#include "translator.icc"
/*
TODO:
- * direction of text-dynamic-request if not equal to direction of
+ * 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
+ 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_;
- Text_script_req* script_req_;
-
- Span_req * current_cresc_req_;
- Drul_array<Span_req*> accepted_spanreqs_drul_;
+ Music *script_ev_;
+ Music *current_cresc_ev_;
- Spanner* line_spanner_;
- Spanner* finished_line_spanner_;
+ Drul_array<Music *> accepted_spanevents_drul_;
Link_array<Note_column> pending_columns_;
Link_array<Grob> pending_elements_;
-
+
void typeset_all ();
-TRANSLATOR_DECLARATIONS(Dynamic_engraver );
-
+ TRANSLATOR_DECLARATIONS (Dynamic_engraver);
+ DECLARE_ACKNOWLEDGER (script);
+ DECLARE_ACKNOWLEDGER (stem_tremolo);
+ DECLARE_ACKNOWLEDGER (note_column);
+ DECLARE_ACKNOWLEDGER (slur);
+
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 ();
- virtual void start_translation_timestep ();
+ virtual bool try_music (Music *event);
+ void stop_translation_timestep ();
+ void process_music ();
};
-
-
-
Dynamic_engraver::Dynamic_engraver ()
{
script_ = 0;
finished_cresc_ = 0;
line_spanner_ = 0;
finished_line_spanner_ = 0;
- current_cresc_req_ = 0;
- cresc_ =0;
-
- script_req_ = 0;
- accepted_spanreqs_drul_[START] = 0;
- accepted_spanreqs_drul_[STOP] = 0;
-}
+ current_cresc_ev_ = 0;
+ cresc_ = 0;
-void
-Dynamic_engraver::start_translation_timestep ()
-{
- script_req_ = 0;
- accepted_spanreqs_drul_[START] = 0;
- accepted_spanreqs_drul_[STOP] = 0;
+ script_ev_ = 0;
+ accepted_spanevents_drul_[START] = 0;
+ accepted_spanevents_drul_[STOP] = 0;
}
bool
-Dynamic_engraver::try_music (Music * m)
+Dynamic_engraver::try_music (Music *m)
{
- if (dynamic_cast <Text_script_req*> (m)
- && m->get_mus_property ("text-type") == ly_symbol2scm ("dynamic"))
+ if (m->is_mus_type ("absolute-dynamic-event"))
{
- script_req_ = dynamic_cast<Text_script_req*> (m);
+ /*
+ TODO: probably broken.
+ */
+ script_ev_ = m;
return true;
}
- else if (Span_req* s = dynamic_cast <Span_req*> (m))
+ else if (m->is_mus_type ("decrescendo-event")
+ || m->is_mus_type ("crescendo-event"))
{
- String t = ly_scm2string (s->get_mus_property ("span-type"));
- if (t== "abort")
- {
- 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.
-
- 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 (t == "crescendo"
- || t == "decrescendo")
- {
- accepted_spanreqs_drul_[s->get_span_dir ()] = s;
- return true;
- }
+ Direction d = to_dir (m->get_property ("span-direction"));
+
+ accepted_spanevents_drul_[d] = m;
+ if (current_cresc_ev_ && d == START)
+ accepted_spanevents_drul_[STOP] = m;
+ return true;
}
return false;
}
void
Dynamic_engraver::process_music ()
{
- if (accepted_spanreqs_drul_[START] || accepted_spanreqs_drul_[STOP] || script_req_)
+ if (accepted_spanevents_drul_[START] || accepted_spanevents_drul_[STOP] || script_ev_)
{
if (!line_spanner_)
{
- line_spanner_ = new Spanner (get_property ("DynamicLineSpanner"));
-
- Music * rq = accepted_spanreqs_drul_[START];
- if (script_req_)
- rq = script_req_ ;
- announce_grob(line_spanner_, rq ? rq->self_scm(): SCM_EOL);
+ Music *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 request will not be cleared,
+ During a (de)crescendo, pending event will not be cleared,
and a line-spanner will always be created, as \< \! are already
- two requests.
+ 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_req_)
+ if (script_ev_)
{
- script_ = new Item (get_property ("DynamicText"));
- script_->set_grob_property ("text",
- script_req_->get_mus_property ("text"));
-
- if (Direction d = script_req_->get_direction ())
- Directional_element_interface::set (line_spanner_, d);
+ script_ = make_item ("DynamicText", script_ev_->self_scm ());
+ script_->set_property ("text",
+ script_ev_->get_property ("text"));
- Axis_group_interface::add_element (line_spanner_, script_);
+ 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);
- announce_grob(script_, script_req_->self_scm());
+ Axis_group_interface::add_element (line_spanner_, script_);
}
- if (accepted_spanreqs_drul_[STOP])
+ Music *stop_ev = accepted_spanevents_drul_ [STOP]
+ ? accepted_spanevents_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_)
- {
- accepted_spanreqs_drul_[STOP]->origin ()->warning
- (_ ("can't find start of (de)crescendo"));
- accepted_spanreqs_drul_[STOP] = 0;
- }
- else
+ */
+
+ 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_req_ = 0;
+ current_cresc_ev_ = 0;
+ }
+ else if (accepted_spanevents_drul_[STOP])
+ {
+ accepted_spanevents_drul_[STOP]->origin ()->warning (_ ("can't find start of (de)crescendo"));
+ stop_ev = 0;
}
}
-
- if (accepted_spanreqs_drul_[START])
+
+ if (accepted_spanevents_drul_[START])
{
- if (current_cresc_req_)
+ if (current_cresc_ev_)
{
- String msg = current_cresc_req_->get_span_dir () == 1
- ? _ ("already have a crescendo")
- : _ ("already have a decrescendo");
-
- accepted_spanreqs_drul_[START]->origin ()->warning (msg);
- current_cresc_req_->origin ()->warning (_("Cresc started here"));
+ String msg = _ ("already have a decrescendo");
+ if (current_cresc_ev_->is_mus_type ("decrescendo-event"))
+ msg = _ ("already have a crescendo");
+
+ accepted_spanevents_drul_[START]->origin ()->warning (msg);
+ current_cresc_ev_->origin ()->warning (_ ("cresc starts here"));
}
else
{
- current_cresc_req_ = 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_scm2string (accepted_spanreqs_drul_[START]->get_mus_property ("span-type"));
+ String start_type
+ = ly_symbol2string (current_cresc_ev_->get_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"))
+ if (!scm_is_symbol (s) || s == ly_symbol2scm ("hairpin"))
{
- cresc_ = new Spanner (get_property ("Hairpin"));
- cresc_->set_grob_property ("grow-direction",
- gh_int2scm ((start_type == "crescendo")
- ? BIGGER : SMALLER));
-
+ 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_);
+ }
+ cresc_->set_property ("grow-direction",
+ scm_from_int ((start_type == "crescendo")
+ ? BIGGER : SMALLER));
}
+
/*
This is a convenient (and legacy) interface to TextSpanners
for use in (de)crescendi.
*/
else
{
- cresc_ = new Spanner (get_property ("TextSpanner"));
- cresc_->set_grob_property ("type", s);
- daddy_trans_->set_property ((start_type
- + "Spanner").to_str0 (), SCM_EOL);
+ 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 ());
/*
FIXME: use get_markup () to check type.
*/
- if (gh_string_p (s) || gh_pair_p (s))
+ if (scm_is_string (s) || scm_is_pair (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_property ("edge-text",
+ scm_cons (s, scm_makfrom0str ("")));
+ context ()->set_property ((start_type + "Text").to_str0 (),
+ 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));
-
- announce_grob(cresc_, accepted_spanreqs_drul_[START]->self_scm());
}
}
}
void
Dynamic_engraver::stop_translation_timestep ()
{
- typeset_all ();
- if (!current_cresc_req_)
+ 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_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_)
{
- current_cresc_req_->origin ()->warning (_ ("unterminated (de)crescendo"));
+ current_cresc_ev_->origin ()->warning (_ ("unterminated (de)crescendo"));
cresc_->suicide ();
cresc_ = 0;
}
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")));
+ ? 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;
+ 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_);
+
+ 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);
}
-
- typeset_grob (finished_line_spanner_);
+
finished_line_spanner_ = 0;
}
}
+
void
-Dynamic_engraver::acknowledge_grob (Grob_info i)
+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_->live())
+ 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))
+ {
+ extract_grob_set (info.grob (), "note-heads", heads);
+ if (heads.size ())
{
- Side_position_interface::add_support (line_spanner_,i.grob_);
- add_bound_item (line_spanner_,dynamic_cast<Item*> (i.grob_));
+ Grob *head = heads[0];
+ script_->set_parent (head, X_AXIS);
+ Self_alignment_interface::set_center_parent (script_, X_AXIS);
}
+ }
- if (script_ && !script_->get_parent (X_AXIS))
+ if (cresc_)
+ {
+ if (!cresc_->get_bound (LEFT))
{
- script_->set_parent (i.grob_, X_AXIS);
+ cresc_->set_bound (LEFT, info.grob ());
+ add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
}
-
}
- else if (Script_interface::has_interface (i.grob_) && script_)
- {
- SCM p = i.grob_->get_grob_property ("script-priority");
- /*
- UGH.
+ if (finished_cresc_ && !finished_cresc_->get_bound (RIGHT))
+ finished_cresc_->set_bound (RIGHT, info.grob ());
+}
- 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_);
+void
+Dynamic_engraver::acknowledge_script (Grob_info info)
+{
+ if (!line_spanner_ || !script_)
+ return;
- }
- }
+ SCM p = info.grob ()->get_property ("script-priority");
+
+ /*
+ UGH.
+
+ DynamicText doesn't really have a script-priority field.
+ */
+ if (scm_is_number (p)
+ && scm_to_int (p)
+ < scm_to_int (script_->get_property ("script-priority")))
+ Side_position_interface::add_support (line_spanner_, info.grob ());
}
-ENTER_DESCRIPTION(Dynamic_engraver,
-/* descr */ "
-This engraver creates hairpins, dynamic texts, and their vertical
-alignments. The symbols are collected onto a DynamicLineSpanner grob
-which takes care of vertical positioning.
-",
-
-/* creats*/ "DynamicLineSpanner DynamicText Hairpin TextSpanner",
-/* accepts */ "general-music",
-/* acks */ "note-column-interface script-interface",
-/* reads */ "",
-/* write */ "");
+
+ADD_ACKNOWLEDGER (Dynamic_engraver, script);
+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",
+ /* accept */ "absolute-dynamic-event crescendo-event decrescendo-event",
+ /* read */ "",
+ /* write */ "");