/*
- dynamic-reg.cc -- implement Dynamic_engraver
+ dynamic-engraver.cc -- implement Dynamic_engraver
source file of the GNU LilyPond music typesetter
- (c) 1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1997--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
*/
-#include "debug.hh"
-#include "crescendo.hh"
-#include "dynamic-engraver.hh"
-#include "musical-request.hh"
-#include "lookup.hh"
-#include "paper-def.hh"
-#include "score-column.hh"
-#include "staff-sym.hh"
+#include "warn.hh"
+#include "dimensions.hh"
+#include "hairpin.hh"
+#include "event.hh"
+#include "paper-column.hh"
#include "note-column.hh"
-#include "g-text-item.hh"
-#include "g-staff-side.hh"
+#include "item.hh"
+#include "side-position-interface.hh"
#include "engraver.hh"
-#include "stem.hh"
-#include "note-head.hh"
+#include "group-interface.hh"
+#include "directional-element-interface.hh"
+#include "translator-group.hh"
+#include "axis-group-interface.hh"
+#include "script.hh"
+
+/*
+ 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
{
- G_text_item * text_p_;
- G_staff_side_item * staff_side_p_;
+ Item * script_;
+ Spanner * finished_cresc_;
+ Spanner * cresc_;
+
+ Music* script_ev_;
- Crescendo * to_end_cresc_p_;
- Crescendo * cresc_p_;
- Span_dynamic_req * cresc_req_l_;
- Array<Dynamic_req*> dynamic_req_l_arr_;
- void typeset_all ();
-public:
- VIRTUAL_COPY_CONS(Translator);
- Dynamic_engraver();
+ Music * current_cresc_ev_;
+ Drul_array<Music*> accepted_spanreqs_drul_;
+
+ Spanner* line_spanner_;
+ Spanner* finished_line_spanner_;
+
+ Link_array<Note_column> pending_columns_;
+ Link_array<Grob> pending_elements_;
+
+ void typeset_all ();
+
+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_requests();
- 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 ();
};
-Dynamic_engraver::Dynamic_engraver()
-{
- do_post_move_processing();
- text_p_ =0;
- staff_side_p_ =0;
- to_end_cresc_p_ = cresc_p_ = 0;
- cresc_req_l_ = 0;
-}
-void
-Dynamic_engraver::do_post_move_processing()
+Dynamic_engraver::Dynamic_engraver ()
{
- dynamic_req_l_arr_.clear();
+ script_ = 0;
+ finished_cresc_ = 0;
+ line_spanner_ = 0;
+ finished_line_spanner_ = 0;
+ current_cresc_ev_ = 0;
+ cresc_ =0;
+
+ script_ev_ = 0;
+ accepted_spanreqs_drul_[START] = 0;
+ accepted_spanreqs_drul_[STOP] = 0;
}
bool
-Dynamic_engraver::do_try_music (Music * r)
+Dynamic_engraver::try_music (Music * m)
{
- if(Dynamic_req * d = dynamic_cast <Dynamic_req *> (r))
+ if (m->is_mus_type ("absolute-dynamic-event"))
{
- for (int i=0; i < dynamic_req_l_arr_.size (); i++)
- if (d->equal_b (dynamic_req_l_arr_[i]))
- return true;
-
- dynamic_req_l_arr_.push (d);
+ /*
+ 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.
+
+ 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;
+ if (current_cresc_ev_ && d == START)
+ accepted_spanreqs_drul_[STOP] = m;
return true;
}
return false;
}
+
void
-Dynamic_engraver::do_process_requests()
+Dynamic_engraver::process_music ()
{
- Crescendo* new_cresc_p=0;
- for (int i=0; i < dynamic_req_l_arr_.size(); i++)
+ if (accepted_spanreqs_drul_[START] || accepted_spanreqs_drul_[STOP] || script_ev_)
{
- Dynamic_req *dreq_l = dynamic_req_l_arr_[i];
- if (Absolute_dynamic_req *absd = dynamic_cast<Absolute_dynamic_req *> (dreq_l))
+ if (!line_spanner_)
{
- if (text_p_)
- {
- dynamic_req_l_arr_[i]->warning (_("Got a dynamic already. Continuing dazed and confused"));
- continue;
- }
-
- String loud = absd->loudness_str_;
+ line_spanner_ = make_spanner ("DynamicLineSpanner");
- text_p_ = new G_text_item;
- text_p_->text_str_ = loud; // ugh
- Scalar prop = get_property ("dynamicStyle", 0);
+ Music * rq = accepted_spanreqs_drul_[START];
+ if (script_ev_)
+ rq = script_ev_ ;
+ announce_grob(line_spanner_, rq ? rq->self_scm(): SCM_EOL);
+ }
+ }
+
+ /*
+ During a (de)crescendo, pending event will not be cleared,
+ and a line-spanner will always be created, as \< \! are already
+ two events.
- text_p_->style_str_ = prop.length_i () ? prop : "dynamic";
+ Note: line-spanner must always have at least same duration
+ as (de)crecsendo, b.o. line-breaking.
+ */
- staff_side_p_ = new G_staff_side_item;
- staff_side_p_->set_victim (text_p_);
- staff_side_p_->axis_ = Y_AXIS;
-
+
- prop = get_property ("dynamicDir", 0);
- if (prop.isnum_b ())
- {
- staff_side_p_->dir_ = (Direction) (int) prop;
- }
+ /*
+ 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"));
+
+
+ if (Direction d = to_dir (script_ev_->get_mus_property ("direction")))
+ set_grob_direction (line_spanner_, 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_)
+ {
+ /*
+ finish side position alignment if the (de)cresc ends here, and
+ there are no new dynamics.
+ */
- announce_element (Score_element_info (text_p_, dreq_l));
- announce_element (Score_element_info (staff_side_p_, dreq_l));
+ 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 (Span_dynamic_req *span_l = dynamic_cast <Span_dynamic_req *> (dreq_l))
+ else if (accepted_spanreqs_drul_[STOP] )
{
- if (span_l->spantype_ == STOP)
- {
- if (!cresc_p_)
- {
- span_l->warning (_ ("can't find (de)crescendo to end"));
- }
- else
- {
- assert (!to_end_cresc_p_);
- to_end_cresc_p_ =cresc_p_;
- cresc_p_ = 0;
- Scalar prop = get_property ("dynamicDir", 0);
- if (prop.isnum_b ())
- {
- to_end_cresc_p_->dir_ = (Direction) (int) prop;
- }
-
- }
- }
- else if (span_l->spantype_ == START)
- {
- cresc_req_l_ = span_l;
- assert (!new_cresc_p);
- new_cresc_p = new Crescendo;
- new_cresc_p->grow_dir_ = span_l->dynamic_dir_;
- announce_element (Score_element_info (new_cresc_p, span_l));
- }
+ accepted_spanreqs_drul_[STOP]->origin ()->warning(_ ("can't find start of (de)crescendo"));
+ stop_ev = 0;
}
+
}
-
- if (new_cresc_p)
+
+ if (accepted_spanreqs_drul_[START])
{
- if (cresc_p_)
+ if (current_cresc_ev_)
{
- ::warning (_ ("Too many crescendi here"));
- typeset_element (cresc_p_);
- cresc_p_ = 0;
- }
+ Direction sd = to_dir (current_cresc_ev_->get_mus_property ("span-direction"));
+ String msg = sd == 1
+ ? _ ("already have a crescendo")
+ : _ ("already have a decrescendo");
- cresc_p_ = new_cresc_p;
- cresc_p_->set_bounds(LEFT,get_staff_info().musical_l ());
- if (text_p_)
+ accepted_spanreqs_drul_[START]->origin ()->warning (msg);
+ current_cresc_ev_->origin ()->warning (_("Cresc started here"));
+ }
+ else
{
- cresc_p_->dyn_b_drul_[LEFT] = true;
- if (to_end_cresc_p_)
- to_end_cresc_p_->dyn_b_drul_[RIGHT] = true;
+ 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());
}
}
}
void
-Dynamic_engraver::do_pre_move_processing()
+Dynamic_engraver::stop_translation_timestep ()
{
- Staff_symbol* s_l = get_staff_info().staff_sym_l_;
- if (to_end_cresc_p_)
- to_end_cresc_p_->add_support (s_l);
- if (staff_side_p_)
+ typeset_all ();
+ if (!current_cresc_ev_)
{
- staff_side_p_->add_support (s_l);
- // staff_side_p_->dim_cache_[Y_AXIS].parent_l_ = &s_l->dim_cache_[Y_AXIS];
+ finished_line_spanner_ = line_spanner_;
+ line_spanner_ =0;
+ typeset_all ();
}
- typeset_all ();
+ script_ev_ = 0;
+ accepted_spanreqs_drul_[START] = 0;
+ accepted_spanreqs_drul_[STOP] = 0;
}
-
-
-ADD_THIS_TRANSLATOR(Dynamic_engraver);
-
void
-Dynamic_engraver::do_removal_processing ()
+Dynamic_engraver::finalize ()
{
- if (cresc_p_)
+ typeset_all ();
+
+ if (line_spanner_
+ && !line_spanner_->live())
+ line_spanner_ = 0;
+ if (line_spanner_)
{
- typeset_element (cresc_p_ );
- cresc_req_l_->warning (_ ("unended crescendo"));
- cresc_p_ =0;
+ finished_line_spanner_ = line_spanner_;
+ typeset_all ();
}
- typeset_all ();
-}
+ if (cresc_
+ && !cresc_->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_)
+ /*
+ 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_)
{
- to_end_cresc_p_->set_bounds(RIGHT,get_staff_info().musical_l ());
- typeset_element (to_end_cresc_p_);
- to_end_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_);
- typeset_element (staff_side_p_);
- text_p_ =0;
- staff_side_p_ =0;
+ typeset_grob (script_);
+ script_ = 0;
}
-}
+ if (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 (dynamic_cast<Stem *> (i.elem_l_)
- || dynamic_cast<Note_head *> (i.elem_l_)
- )
+ if (!line_spanner_)
+ return ;
+
+ if (Note_column::has_interface (i.grob_))
+ {
+ 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);
+ }
+
+ }
+ else if (Script_interface::has_interface (i.grob_) && script_)
{
- if (staff_side_p_)
- staff_side_p_->add_support (i.elem_l_);
+ SCM p = i.grob_->get_grob_property ("script-priority");
- if (to_end_cresc_p_)
- to_end_cresc_p_->add_support (i.elem_l_);
+ /*
+ UGH.
- if (cresc_p_)
- cresc_p_->add_support (i.elem_l_);
+ 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 */ "");
projects / lilypond.git / blobdiff