source file of the GNU LilyPond music typesetter
- (c) 1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1997--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
*/
-#include "debug.hh"
+#include "warn.hh"
#include "dimensions.hh"
-#include "crescendo.hh"
-#include "musical-request.hh"
+#include "hairpin.hh"
+#include "event.hh"
#include "paper-column.hh"
#include "note-column.hh"
#include "item.hh"
#include "directional-element-interface.hh"
#include "translator-group.hh"
#include "axis-group-interface.hh"
-
+#include "script.hh"
/*
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
+
+ - TODO: the line-spanner is not killed after the (de)crescs are
+ finished.
+
*/
/**
*/
class Dynamic_engraver : public Engraver
{
- Item * text_p_;
- Spanner * finished_cresc_p_;
- Spanner * cresc_p_;
+ Item * script_;
+ Spanner * finished_cresc_;
+ Spanner * cresc_;
- Text_script_req* text_req_l_;
+ Music* script_ev_;
- Span_req * current_cresc_req_;
- Drul_array<Span_req*> accepted_spanreqs_drul_;
+ Music * current_cresc_ev_;
+ Drul_array<Music*> accepted_spanreqs_drul_;
Spanner* line_spanner_;
Spanner* finished_line_spanner_;
- Link_array<Note_column> pending_column_arr_;
- Link_array<Score_element> pending_element_arr_;
+ Link_array<Note_column> pending_columns_;
+ Link_array<Grob> pending_elements_;
void typeset_all ();
-public:
- VIRTUAL_COPY_CONS(Translator);
- Dynamic_engraver ();
+TRANSLATOR_DECLARATIONS(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_music ();
- virtual void do_pre_move_processing ();
- virtual void do_post_move_processing ();
+ 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 ();
};
-ADD_THIS_TRANSLATOR (Dynamic_engraver);
+
Dynamic_engraver::Dynamic_engraver ()
{
- text_p_ = 0;
- finished_cresc_p_ = 0;
+ script_ = 0;
+ finished_cresc_ = 0;
line_spanner_ = 0;
finished_line_spanner_ = 0;
- current_cresc_req_ = 0;
- cresc_p_ =0;
+ current_cresc_ev_ = 0;
+ cresc_ =0;
- text_req_l_ = 0;
+ script_ev_ = 0;
accepted_spanreqs_drul_[START] = 0;
accepted_spanreqs_drul_[STOP] = 0;
}
void
-Dynamic_engraver::do_post_move_processing ()
+Dynamic_engraver::start_translation_timestep ()
{
- text_req_l_ = 0;
+ script_ev_ = 0;
accepted_spanreqs_drul_[START] = 0;
accepted_spanreqs_drul_[STOP] = 0;
}
bool
-Dynamic_engraver::do_try_music (Music * m)
+Dynamic_engraver::try_music (Music * m)
{
- if (Text_script_req* d = dynamic_cast <Text_script_req*> (m))
+ if (m->is_mus_type ("absolute-dynamic-event"))
{
- if (d->style_str_ == "dynamic")
- {
- text_req_l_ = d;
- return true;
- }
+ /*
+ TODO: probably broken.
+ */
+ script_ev_ = m;
+ return true;
}
- else if (Span_req* s = dynamic_cast <Span_req*> (m))
+ else if (m->is_mus_type ("abort-event"))
{
- if ((s->span_type_str_ == "crescendo"
- || s->span_type_str_ == "decrescendo"))
- {
- accepted_spanreqs_drul_[s->span_dir_] = s;
- return true;
- }
+ 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 (m->is_mus_type ("decrescendo-event")
+ || m->is_mus_type ("crescendo-event"))
+ {
+ Direction d = to_dir (m->get_mus_property ("span-direction"));
+ accepted_spanreqs_drul_[d] = m;
+ return true;
}
return false;
}
void
-Dynamic_engraver::do_process_music ()
+Dynamic_engraver::process_music ()
{
- if (accepted_spanreqs_drul_[START] || accepted_spanreqs_drul_[STOP] || text_req_l_)
-
+ if (accepted_spanreqs_drul_[START] || accepted_spanreqs_drul_[STOP] || script_ev_)
{
if (!line_spanner_)
{
- line_spanner_ = new Spanner (get_property ("basicDynamicLineSpannerProperties"));
-
- Side_position::set_axis (line_spanner_, Y_AXIS);
- Axis_group_interface::set_interface (line_spanner_);
- Axis_group_interface::set_axes (line_spanner_, Y_AXIS, Y_AXIS);
- announce_element (line_spanner_,
- text_req_l_ ? text_req_l_ : accepted_spanreqs_drul_[START]);
+ line_spanner_ = new Spanner (get_property ("DynamicLineSpanner"));
+ Music * rq = accepted_spanreqs_drul_[START];
+ if (script_ev_)
+ rq = script_ev_ ;
+ announce_grob(line_spanner_, rq ? rq->self_scm(): SCM_EOL);
}
}
-
+
/*
- finish side position alignment if the (de)cresc ends here, and
- there are no new dynamics.
-
- */
- else if (accepted_spanreqs_drul_[STOP]
- && !accepted_spanreqs_drul_[START] && !text_req_l_)
- {
- finished_line_spanner_ = line_spanner_;
- line_spanner_ = 0;
- }
-
- /*
- todo: resurrect dynamic{direction, padding,minimumspace}
- */
- /*
- During a (de)crescendo, pending request will not be cleared,
- and a line-spanner will always be created, as \< \! are already
- two requests.
-
- Maybe always creating a line-spanner for a (de)crescendo (see
- below) is not a good idea:
+ During a (de)crescendo, pending event will not be cleared,
+ and a line-spanner will always be created, as \< \! are already
+ two events.
- a\< b\p \!c
-
- the \p will be centred on the line-spanner, and thus clash
- with the hairpin. When axis-group code is in place, the \p
- should move below the hairpin, which is probably better?
-
- Urg, but line-spanner must always have at least same duration
- as (de)crecsendo, b.o. line-breaking.
- */
+ 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 (text_req_l_)
+ if (script_ev_)
{
- String loud = text_req_l_->text_str_;
+ script_ = new Item (get_property ("DynamicText"));
+ script_->set_grob_property ("text",
+ script_ev_->get_mus_property ("text"));
- text_p_ = new Item (get_property ("basicDynamicTextProperties"));
- text_p_->set_elt_property ("text", ly_str02scm (loud.ch_C ()));
- if (Direction d=text_req_l_->get_direction ())
+
+ if (Direction d = to_dir (script_ev_->get_mus_property ("direction")))
Directional_element_interface::set (line_spanner_, d);
- Axis_group_interface::add_element (line_spanner_, text_p_);
+ Axis_group_interface::add_element (line_spanner_, script_);
- text_p_->add_offset_callback (Side_position::aligned_on_self,
- Y_AXIS);
- announce_element (text_p_, text_req_l_);
+ announce_grob(script_, script_ev_->self_scm());
}
- if (accepted_spanreqs_drul_[STOP])
+ Music *stop_ev = accepted_spanreqs_drul_ [STOP] ?
+ accepted_spanreqs_drul_[STOP] : script_ev_;
+
+ if (accepted_spanreqs_drul_[STOP] || script_ev_)
{
- if (!cresc_p_)
- {
- accepted_spanreqs_drul_[STOP]->origin ()->warning
- (_ ("can't find start of (de)crescendo"));
- }
- else
+ /*
+ finish side position alignment if the (de)cresc ends here, and
+ there are no new dynamics.
+ */
+
+
+ if (cresc_)
{
- assert (!finished_cresc_p_);
- Score_element* cc = unsmob_element (get_property ("currentMusicalColumn"));
+ assert (!finished_cresc_ && cresc_);
+
+ cresc_->set_bound (RIGHT, script_
+ ? script_
+ : unsmob_grob (get_property ("currentMusicalColumn")));
+ add_bound_item (line_spanner_, cresc_->get_bound (RIGHT));
- cresc_p_->set_bound (RIGHT, cc);
- finished_cresc_p_ = cresc_p_;
- cresc_p_ = 0;
- current_cresc_req_ = 0;
+ 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;
+ }
+
}
-
+
if (accepted_spanreqs_drul_[START])
{
- if (current_cresc_req_)
+ if (current_cresc_ev_)
{
- accepted_spanreqs_drul_[START]->origin ()->warning
- (current_cresc_req_->span_dir_ == 1
- ? _ ("already have a crescendo")
- : _ ("already have a decrescendo"));
+ 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"));
}
else
{
- current_cresc_req_ = accepted_spanreqs_drul_[START];
- cresc_p_ = new Spanner (get_property ("basicCrescendoProperties"));
- Crescendo::set_interface (cresc_p_);
- cresc_p_->set_elt_property
- ("grow-direction",
- gh_int2scm ((accepted_spanreqs_drul_[START]->span_type_str_ == "crescendo")
- ? BIGGER : SMALLER));
-
- SCM s = get_property ((accepted_spanreqs_drul_[START]->span_type_str_ + "Text").ch_C());
- if (gh_string_p (s))
- {
- cresc_p_->set_elt_property ("start-text", s);
- daddy_trans_l_->set_property (accepted_spanreqs_drul_[START]->span_type_str_
- + "Text", SCM_UNDEFINED);
- }
-
- s = get_property ((accepted_spanreqs_drul_[START]->span_type_str_ + "Spanner").ch_C());
+ current_cresc_ev_ = accepted_spanreqs_drul_[START];
+ if (Direction d = to_dir (current_cresc_ev_->get_mus_property ("direction")))
+ Directional_element_interface::set (line_spanner_, d);
/*
TODO: Use symbols.
- */
- if (gh_string_p (s)) //&& ly_scm2string (s) != "hairpin")
- {
- cresc_p_->set_elt_property ("spanner", s);
- daddy_trans_l_->set_property (accepted_spanreqs_drul_[START]->span_type_str_
- + "Spanner", SCM_UNDEFINED);
- }
-
- Score_element *cc = unsmob_element (get_property ("currentMusicalColumn"));
- cresc_p_->set_bound (LEFT, cc);
-
-
- /*
- We know how wide the text is, if we can be sure that the
- text already has relevant pointers into the paperdef,
- and it has its font-size property set.
-
- Since font-size may be set by a context higher up, we
- can not be sure of the size.
+ */
+ String start_type =
+ ly_symbol2string (current_cresc_ev_->get_mus_property ("name"));
- We shouldn't try to do this stuff here, the Item should
- do it when the score is finished. We could maybe
- set a callback to have the Item do the alignment if
- it is not a special symbol, like Crescendo.
+ /*
+ 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_ = new Spanner (get_property ("Hairpin"));
+ cresc_->set_grob_property ("grow-direction",
+ gh_int2scm ((start_type == "crescendo")
+ ? BIGGER : SMALLER));
+
+ }
- if (text_p_)
+ /*
+ This is a convenient (and legacy) interface to TextSpanners
+ for use in (de)crescendi.
+ Hmm.
+ */
+ else
{
- index_set_cell (cresc_p_->get_elt_property ("dynamic-drul"),
- LEFT, text_p_->self_scm ());
- if (finished_cresc_p_)
- index_set_cell (finished_cresc_p_->get_elt_property ("dynamic-drul"),
- RIGHT, text_p_->self_scm ());
+ cresc_ = new Spanner (get_property ("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);
+ }
}
- Axis_group_interface::add_element (line_spanner_, cresc_p_);
- cresc_p_->set_elt_property ("self-alignment-Y", gh_int2scm (0));
- cresc_p_->add_offset_callback
- (Side_position::aligned_on_self, Y_AXIS);
- announce_element (cresc_p_, accepted_spanreqs_drul_[START]);
+ 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());
}
}
}
void
-Dynamic_engraver::do_pre_move_processing ()
+Dynamic_engraver::stop_translation_timestep ()
{
typeset_all ();
+ if (!current_cresc_ev_)
+ {
+ finished_line_spanner_ = line_spanner_;
+ line_spanner_ =0;
+ typeset_all ();
+ }
}
void
-Dynamic_engraver::do_removal_processing ()
+Dynamic_engraver::finalize ()
{
typeset_all ();
+
+ if (line_spanner_
+ && !line_spanner_->live())
+ line_spanner_ = 0;
if (line_spanner_)
{
finished_line_spanner_ = line_spanner_;
typeset_all ();
}
- if (cresc_p_)
+ if (cresc_
+ && !cresc_->live())
+ cresc_ = 0;
+ if (cresc_)
{
- current_cresc_req_->origin ()->warning (_ ("unterminated (de)crescendo"));
- cresc_p_->suicide ();
+ current_cresc_ev_->origin ()->warning (_ ("unterminated (de)crescendo"));
+ cresc_->suicide ();
+ cresc_ = 0;
}
}
void
Dynamic_engraver::typeset_all ()
{
- if (finished_cresc_p_)
+ /*
+ 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_)
{
- typeset_element (finished_cresc_p_);
- finished_cresc_p_ =0;
+ 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 (text_p_)
+ if (script_)
{
- typeset_element (text_p_);
- text_p_ = 0;
+ typeset_grob (script_);
+ script_ = 0;
}
if (finished_line_spanner_)
{
- Side_position::add_staff_support (finished_line_spanner_);
- extend_spanner_over_elements (finished_line_spanner_);
- typeset_element (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_);
+
+ 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);
+ }
+
+ typeset_grob (finished_line_spanner_);
finished_line_spanner_ = 0;
}
}
void
-Dynamic_engraver::acknowledge_element (Score_element_info i)
+Dynamic_engraver::acknowledge_grob (Grob_info i)
{
- if (Note_column::has_interface (i.elem_l_))
+ if (!line_spanner_)
+ return ;
+
+ if (Note_column::has_interface (i.grob_))
{
- if (line_spanner_)
+ if (line_spanner_
+ /* Don't refill killed spanner */
+ && line_spanner_->live())
{
- Side_position::add_support (line_spanner_,i.elem_l_);
- add_bound_item (line_spanner_,dynamic_cast<Item*>(i.elem_l_));
+ 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);
+ }
+
+ }
+ 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_);
+
+ }
}
}
+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 */ "");