source file of the GNU LilyPond music typesetter
- (c) 1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
*/
#include "debug.hh"
#include "dimensions.hh"
-#include "dimension-cache.hh"
-#include "crescendo.hh"
+#include "hairpin.hh"
#include "musical-request.hh"
-#include "lookup.hh"
-#include "paper-def.hh"
#include "paper-column.hh"
-#include "staff-symbol.hh"
#include "note-column.hh"
-#include "text-item.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 "staff-symbol-referencer.hh"
#include "translator-group.hh"
#include "axis-group-interface.hh"
/*
TODO:
- * direction of text-dynamic-request if not equalt to direction
- of line-spanner
+ * direction of text-dynamic-request if not equal to direction of
+ line-spanner
- * FIXME: this has gotten a bit too hairy.
- */
-
-class Dynamic_line_spanner : public Spanner
-{
-public:
- Dynamic_line_spanner ();
- VIRTUAL_COPY_CONS(Score_element);
- void add_column (Note_column*);
- void add_element (Score_element*);
-};
+ - TODO: this engraver is too complicated. We should split it into
+ the handling of the basic grobs and the linespanner
-Dynamic_line_spanner::Dynamic_line_spanner ()
-{
- set_elt_property ("transparent", SCM_BOOL_T);
- Side_position_interface (this).set_axis (Y_AXIS);
- Axis_group_interface (this).set_interface ();
- Axis_group_interface (this).set_axes (X_AXIS, Y_AXIS);
-}
+ - TODO: the line-spanner is not killed after the (de)crescs are
+ finished.
-void
-Dynamic_line_spanner::add_column (Note_column* n)
-{
- if (!get_bound (LEFT))
- set_bound (LEFT, n);
- else
- set_bound (RIGHT, n);
-
- add_dependency (n);
-}
-
-
-void
-Dynamic_line_spanner::add_element (Score_element* e)
-{
- e->set_parent (this, Y_AXIS);
- Axis_group_interface (this).add_element (e);
-}
+*/
/**
print text & hairpin dynamics.
*/
class Dynamic_engraver : public Engraver
{
- Text_item * text_p_;
- Crescendo * finished_cresc_p_;
- Crescendo * cresc_p_;
+ Item * script_p_;
+ Spanner * finished_cresc_p_;
+ Spanner * cresc_p_;
- Text_script_req* text_req_l_;
- Span_req * span_start_req_l_;
- Drul_array<Span_req*> span_req_l_drul_;
+ Text_script_req* script_req_l_;
+
+ Span_req * current_cresc_req_;
+ Drul_array<Span_req*> accepted_spanreqs_drul_;
- Dynamic_line_spanner* line_spanner_;
- Dynamic_line_spanner* finished_line_spanner_;
- Moment last_request_mom_;
+ Spanner* line_spanner_;
+ Spanner* finished_line_spanner_;
- Array<Note_column*> pending_column_arr_;
- Link_array<Score_element> pending_element_arr_;
+ Link_array<Note_column> pending_column_arr_;
+ Link_array<Grob> pending_element_arr_;
- void typeset_all ();
+ void typeset_all ();
-public:
- VIRTUAL_COPY_CONS(Translator);
- Dynamic_engraver ();
+TRANSLATOR_DECLARATIONS(Dynamic_engraver );
protected:
- void announce_element (Score_element_info);
-
- 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_l);
+ virtual void stop_translation_timestep ();
+ virtual void process_music ();
+ virtual void start_translation_timestep ();
};
-ADD_THIS_TRANSLATOR (Dynamic_engraver);
-void
-Dynamic_engraver::announce_element (Score_element_info i)
-{
- group (i.elem_l_, "interfaces").add_thing (ly_symbol2scm ("dynamic"));
-
- Engraver::announce_element (i);
-}
Dynamic_engraver::Dynamic_engraver ()
{
- text_p_ = 0;
+ script_p_ = 0;
finished_cresc_p_ = 0;
line_spanner_ = 0;
finished_line_spanner_ = 0;
- span_start_req_l_ = 0;
+ current_cresc_req_ = 0;
cresc_p_ =0;
- text_req_l_ = 0;
- span_req_l_drul_[START] = 0;
- span_req_l_drul_[STOP] = 0;
+ script_req_l_ = 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;
- span_req_l_drul_[START] = 0;
- span_req_l_drul_[STOP] = 0;
+ script_req_l_ = 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 (dynamic_cast <Text_script_req*> (m)
+ && m->get_mus_property ("text-type") == ly_symbol2scm ("dynamic"))
{
- if (d->style_str_ == "dynamic")
- {
- text_req_l_ = d;
- return true;
- }
+ script_req_l_ = dynamic_cast<Text_script_req*> (m);
+ return true;
}
else if (Span_req* s = dynamic_cast <Span_req*> (m))
{
- if ((s->span_type_str_ == "crescendo"
- || s->span_type_str_ == "decrescendo"))
+ 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_p_)
+ cresc_p_->suicide ();
+ cresc_p_ = 0;
+ }
+ else if (t == "crescendo"
+ || t == "decrescendo")
{
- span_req_l_drul_[s->span_dir_] = s;
+ accepted_spanreqs_drul_[s->get_span_dir ()] = s;
return true;
}
}
}
void
-Dynamic_engraver::do_process_music ()
+Dynamic_engraver::process_music ()
{
- if ((span_req_l_drul_[START] || span_req_l_drul_[STOP] || text_req_l_)
- && !line_spanner_
- && pending_element_arr_.size ())
+ if (accepted_spanreqs_drul_[START] || accepted_spanreqs_drul_[STOP] || script_req_l_)
{
- line_spanner_ = new Dynamic_line_spanner;
- for (int i = 0; i < pending_column_arr_.size (); i++)
- line_spanner_->add_column (pending_column_arr_[i]);
- pending_column_arr_.clear ();
- announce_element (Score_element_info
- (line_spanner_,
- text_req_l_ ? text_req_l_ : span_req_l_drul_[START]));
+ if (!line_spanner_)
+ {
+ line_spanner_ = new Spanner (get_property ("DynamicLineSpanner"));
- }
+ Side_position_interface::set_axis (line_spanner_, Y_AXIS);
+ Axis_group_interface::set_interface (line_spanner_);
+ Axis_group_interface::set_axes (line_spanner_, Y_AXIS, Y_AXIS);
- if (line_spanner_ && pending_element_arr_.size ())
- {
- for (int i = 0; i < pending_element_arr_.size (); i++)
- line_spanner_->add_element (pending_element_arr_[i]);
- pending_element_arr_.clear ();
- }
+ Music * rq = accepted_spanreqs_drul_[START];
+ if (script_req_l_)
+ rq = script_req_l_ ;
+ announce_grob (line_spanner_, rq);
+
- /*
- TODO: This should be optionised:
- * break when group of dynamic requests ends
- * break now (only if no cresc. in progress)
- * continue through piece */
- if (span_req_l_drul_[START] || span_req_l_drul_[STOP] || text_req_l_)
- {
- last_request_mom_ = now_mom ();
+ }
}
- else
- {
- /*
+
+ /*
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:
+ Note: line-spanner must always have at least same duration
+ as (de)crecsendo, b.o. line-breaking.
+ */
- 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?
+ /*
+ maybe we should leave dynamic texts to the text-engraver and
+ simply acknowledge them?
+ */
+ if (script_req_l_)
+ {
+ script_p_ = new Item (get_property ("DynamicText"));
+ script_p_->set_grob_property ("text",
+ script_req_l_->get_mus_property ("text"));
+
+ Side_position_interface::set_direction (script_p_, DOWN);
- Urg, but line-spanner must always have at least same duration
- as (de)crecsendo, b.o. line-breaking.
- */
- if (now_mom () > last_request_mom_ && !span_start_req_l_)
- {
- for (int i = 0; i < pending_element_arr_.size (); i++)
- {
- Score_element* e = pending_element_arr_[i];
- Side_position_interface (e).set_axis (Y_AXIS);
- Side_position_interface (e).add_staff_support ();
+ if (Direction d = script_req_l_->get_direction ())
+ Directional_element_interface::set (line_spanner_, d);
- /*
- UGH UGH
- */
- Direction d = directional_element (e).get ();
- if (!d)
- {
- SCM s = get_property ("dynamicDirection");
- if (!isdir_b (s))
- s = get_property ("verticalDirection");
- if (isdir_b (s))
- d = to_dir (s);
- directional_element (e).set (d);
- }
-
- SCM s = get_property ("dynamicPadding");
- if (gh_number_p (s))
- e->set_elt_property ("padding", s);
- s = get_property ("dynamicMinimumSpace");
- if (gh_number_p (s))
- e->set_elt_property ("minimum-space", s);
- }
- pending_element_arr_.clear ();
- if (line_spanner_)
- {
- for (int i = 0; i < pending_column_arr_.size (); i++)
- line_spanner_->add_column (pending_column_arr_[i]);
- pending_column_arr_.clear ();
- finished_line_spanner_ = line_spanner_;
- line_spanner_ = 0;
- }
- }
- }
+ Axis_group_interface::add_element (line_spanner_, script_p_);
- if (text_req_l_)
- {
- String loud = text_req_l_->text_str_;
-
- text_p_ = new Text_item;
- text_p_->set_elt_property ("text",
- ly_str02scm (loud.ch_C ()));
- text_p_->set_elt_property ("style", gh_str02scm ("dynamic"));
- text_p_->set_elt_property ("script-priority",
- gh_int2scm (100));
- if (Direction d=text_req_l_->get_direction ())
- directional_element (text_p_).set (d);
- pending_element_arr_.push (text_p_);
- text_p_->set_elt_property ("self-alignment-Y", gh_int2scm (0));
- text_p_->add_offset_callback (Side_position_interface::aligned_on_self,
- Y_AXIS);
- announce_element (Score_element_info (text_p_, text_req_l_));
+ announce_grob (script_p_, script_req_l_);
}
- if (span_req_l_drul_[STOP])
+ if (accepted_spanreqs_drul_[STOP])
{
+ /*
+ finish side position alignment if the (de)cresc ends here, and
+ there are no new dynamics.
+ */
+
if (!cresc_p_)
{
- span_req_l_drul_[STOP]->warning
- (_ ("can't find start of (de)crescendo"));
+ accepted_spanreqs_drul_[STOP]->origin ()->warning
+ (_ ("can't find start of (de)crescendo"));
+ accepted_spanreqs_drul_[STOP] = 0;
}
else
{
- assert (!finished_cresc_p_);
- cresc_p_->set_bound (RIGHT, get_staff_info ().musical_pcol_l ());
+ assert (!finished_cresc_p_ && cresc_p_);
+
+ cresc_p_->set_bound (RIGHT, script_p_
+ ? script_p_
+ : unsmob_grob (get_property ("currentMusicalColumn")));
+ add_bound_item (line_spanner_, cresc_p_->get_bound (RIGHT));
+
+
finished_cresc_p_ = cresc_p_;
cresc_p_ = 0;
- span_start_req_l_ = 0;
+ current_cresc_req_ = 0;
}
}
-
- if (span_req_l_drul_[START])
+
+ if (accepted_spanreqs_drul_[START])
{
- if (span_start_req_l_)
+ if (current_cresc_req_)
{
- span_req_l_drul_[START]->warning
- (span_start_req_l_->span_dir_ == 1
- ?
- _ ("already have a crescendo")
+ accepted_spanreqs_drul_[START]->origin ()->warning
+ (current_cresc_req_->get_span_dir () == 1
+ ? _ ("already have a crescendo")
: _ ("already have a decrescendo"));
}
else
{
- span_start_req_l_ = span_req_l_drul_[START];
- cresc_p_ = new Crescendo;
- cresc_p_->set_elt_property
- ("grow-direction",
- gh_int2scm ((span_req_l_drul_[START]->span_type_str_ == "crescendo")
- ? BIGGER : SMALLER));
-
- SCM s = get_property (span_req_l_drul_[START]->span_type_str_ + "Text");
- if (gh_string_p (s))
- {
- cresc_p_->set_elt_property ("start-text", s);
- daddy_trans_l_->set_property (span_req_l_drul_[START]->span_type_str_
- + "Text", SCM_UNDEFINED);
- }
+ current_cresc_req_ = accepted_spanreqs_drul_[START];
- s = get_property (span_req_l_drul_[START]->span_type_str_ + "Spanner");
+ /*
+ TODO: Use symbols.
+ */
+ String start_type = ly_scm2string (accepted_spanreqs_drul_[START]->get_mus_property ("span-type"));
/*
- TODO: Use symbols.
- */
- if (gh_string_p (s)) //&& ly_scm2string (s) != "hairpin")
+ ugh. Use push/pop?
+ */
+ SCM s = get_property ((start_type + "Spanner").ch_C ());
+ if (!gh_symbol_p (s) || s == ly_symbol2scm ("hairpin"))
{
- cresc_p_->set_elt_property ("spanner", s);
- daddy_trans_l_->set_property (span_req_l_drul_[START]->span_type_str_
- + "Spanner", SCM_UNDEFINED);
+ cresc_p_ = new Spanner (get_property ("Hairpin"));
+ cresc_p_->set_grob_property ("grow-direction",
+ gh_int2scm ((start_type == "crescendo")
+ ? BIGGER : SMALLER));
+
}
-
- cresc_p_->set_bound (LEFT, get_staff_info ().musical_pcol_l ());
-
-
- /*
- 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.
-
-
- 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.
+ /*
+ This is a convenient (and legacy) interface to TextSpanners
+ for use in (de)crescendi.
+ Hmm.
*/
-
-
- if (text_p_)
+ else
{
- index_set_cell (cresc_p_->get_elt_property ("dynamic-drul"),
- LEFT, SCM_BOOL_T);
- if (finished_cresc_p_)
- index_set_cell (finished_cresc_p_->get_elt_property ("dynamic-drul"),
- RIGHT, SCM_BOOL_T);
+ cresc_p_ = new Spanner (get_property ("TextSpanner"));
+ cresc_p_->set_interface (ly_symbol2scm ("dynamic-interface"));
+ cresc_p_->set_grob_property ("type", s);
+
+ daddy_trans_l_->set_property ((start_type
+ + "Spanner").ch_C(), SCM_UNDEFINED);
+ s = get_property ((start_type + "Text").ch_C ());
+ /*
+ FIXME: use markup_p () to check type.
+ */
+ if (gh_string_p (s) || gh_pair_p (s))
+ {
+ cresc_p_->set_grob_property ("edge-text",
+ gh_cons (s, ly_str02scm ("")));
+ daddy_trans_l_->set_property ((start_type + "Text").ch_C(),
+ SCM_UNDEFINED);
+ }
}
- pending_element_arr_.push (cresc_p_);
- cresc_p_->set_elt_property ("self-alignment-Y", gh_int2scm (0));
- cresc_p_->add_offset_callback
- (Side_position_interface::aligned_on_self, Y_AXIS);
- announce_element (Score_element_info (cresc_p_, span_req_l_drul_[START]));
+
+ cresc_p_->set_bound (LEFT, script_p_
+ ? script_p_
+ : unsmob_grob (get_property ("currentMusicalColumn")));
+
+ Axis_group_interface::add_element (line_spanner_, cresc_p_);
+
+ add_bound_item (line_spanner_, cresc_p_->get_bound (LEFT));
+
+ announce_grob (cresc_p_, accepted_spanreqs_drul_[START]);
}
}
}
void
-Dynamic_engraver::do_pre_move_processing ()
+Dynamic_engraver::stop_translation_timestep ()
{
typeset_all ();
+ if (script_req_l_ && !current_cresc_req_)
+ {
+ finished_line_spanner_ = line_spanner_;
+ line_spanner_ =0;
+ typeset_all ();
+ }
}
void
-Dynamic_engraver::do_removal_processing ()
+Dynamic_engraver::finalize ()
{
- if (cresc_p_)
- {
- typeset_element (cresc_p_ );
- span_start_req_l_->warning (_ ("unterminated (de)crescendo"));
- cresc_p_ =0;
- }
typeset_all ();
+
+ if (line_spanner_
+ && line_spanner_->immutable_property_alist_ == SCM_EOL)
+ line_spanner_ = 0;
if (line_spanner_)
{
- Side_position_interface (line_spanner_).add_staff_support ();
- typeset_element (line_spanner_);
- line_spanner_ = 0;
+ finished_line_spanner_ = line_spanner_;
+ typeset_all ();
+ }
+
+ if (cresc_p_
+ && cresc_p_->immutable_property_alist_ == SCM_EOL)
+ cresc_p_ = 0;
+ if (cresc_p_)
+ {
+ current_cresc_req_->origin ()->warning (_ ("unterminated (de)crescendo"));
+ cresc_p_->suicide ();
+ cresc_p_ = 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_p_
+ && finished_cresc_p_->immutable_property_alist_ == SCM_EOL)
+ finished_cresc_p_ = 0;
+ if (finished_line_spanner_
+ && finished_line_spanner_->immutable_property_alist_ == SCM_EOL)
+ finished_line_spanner_ = 0;
+
if (finished_cresc_p_)
{
- typeset_element (finished_cresc_p_);
+ if (!finished_cresc_p_->get_bound (RIGHT))
+ {
+ finished_cresc_p_->set_bound (RIGHT, script_p_
+ ? script_p_
+ : unsmob_grob (get_property ("currentMusicalColumn")));
+
+ if (finished_line_spanner_)
+ add_bound_item (finished_line_spanner_,
+ finished_cresc_p_->get_bound (RIGHT));
+ }
+ typeset_grob (finished_cresc_p_);
finished_cresc_p_ =0;
}
- if (text_p_)
+ if (script_p_)
{
- typeset_element (text_p_);
- text_p_ = 0;
+ typeset_grob (script_p_);
+ script_p_ = 0;
}
if (finished_line_spanner_)
{
- Side_position_interface (finished_line_spanner_).add_staff_support ();
- 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* n = dynamic_cast<Note_column*> (i.elem_l_))
+ if (Note_column::has_interface (i.grob_l_))
{
- if (line_spanner_)
- {
- Side_position_interface (line_spanner_).add_support (n);
- line_spanner_->add_column (n);
- }
- else
+ if (line_spanner_
+ /* Don't refill killed spanner */
+ && line_spanner_->immutable_property_alist_ != SCM_EOL)
{
- pending_column_arr_.push (n);
+ Side_position_interface::add_support (line_spanner_,i.grob_l_);
+ add_bound_item (line_spanner_,dynamic_cast<Item*> (i.grob_l_));
}
}
}
+ENTER_DESCRIPTION(Dynamic_engraver,
+/* descr */ "",
+/* creats*/ "DynamicLineSpanner DynamicText Hairpin TextSpanner",
+/* acks */ "note-column-interface",
+/* reads */ "",
+/* write */ "");