source file of the GNU LilyPond music typesetter
- (c) 1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
*/
-#include "debug.hh"
+
+#include "axis-group-interface.hh"
+#include "context.hh"
#include "dimensions.hh"
-#include "dimension-cache.hh"
-#include "crescendo.hh"
-#include "musical-request.hh"
-#include "lookup.hh"
-#include "paper-def.hh"
-#include "paper-column.hh"
-#include "staff-symbol.hh"
+#include "directional-element-interface.hh"
+#include "engraver.hh"
+#include "hairpin.hh"
+#include "international.hh"
+#include "interval.hh"
#include "note-column.hh"
-#include "text-item.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 "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 "stream-event.hh"
+#include "warn.hh"
+#include "translator.icc"
/*
TODO:
- * fix vertical placement of orphaned items
- * fix padding
- */
+ * direction of text-dynamic-event if not equal to direction of
+ line-spanner
-class Dynamic_line_spanner : public Spanner
-{
-public:
- Dynamic_line_spanner ();
- VIRTUAL_COPY_CONS(Score_element);
- void add_column (Item*);
- Direction get_default_dir () const;
-};
+ - 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 (this).set_axis (Y_AXIS);
-}
-
-void
-Dynamic_line_spanner::add_column (Item* n)
-{
- if (!get_bound (LEFT))
- set_bound (LEFT, n);
- else
- set_bound (RIGHT, n);
-
- add_dependency (n);
-}
-
-Direction
-Dynamic_line_spanner::get_default_dir () const
-{
- return DOWN;
-}
+ - TODO: the line-spanner is not killed after the (de)crescs are
+ finished.
+*/
/**
print text & hairpin dynamics.
- */
+*/
class Dynamic_engraver : public Engraver
{
- Text_item * text_p_;
- Crescendo * finished_cresc_p_;
- Crescendo * cresc_p_;
-
- Text_script_req* text_req_l_;
- Span_req * span_start_req_l_;
- Drul_array<Span_req*> span_req_l_drul_;
-
- Dynamic_line_spanner* line_spanner_;
- Moment last_request_mom_;
-
- Note_column* pending_column_;
- Link_array<Score_element> pending_element_arr_;
-
- void typeset_all ();
-
-public:
- VIRTUAL_COPY_CONS(Translator);
- 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 typeset_element (Score_element*);
-};
+ Item *script_;
+ Spanner *line_spanner_;
+ Spanner *cresc_;
-ADD_THIS_TRANSLATOR (Dynamic_engraver);
+ Spanner *finished_line_spanner_;
+ Spanner *finished_cresc_;
-void
-Dynamic_engraver::announce_element (Score_element_info i)
-{
- group (i.elem_l_, "interfaces").add_thing (ly_symbol2scm ("dynamic"));
-
- Engraver::announce_element (i);
-}
+ 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_;
+ void typeset_all ();
+
+ TRANSLATOR_DECLARATIONS (Dynamic_engraver);
+ DECLARE_ACKNOWLEDGER (accidental);
+ DECLARE_ACKNOWLEDGER (script);
+ 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 ();
+ void stop_translation_timestep ();
+ void process_music ();
+};
Dynamic_engraver::Dynamic_engraver ()
{
- text_p_ = 0;
- finished_cresc_p_ = 0;
+ script_ = 0;
+ finished_cresc_ = 0;
line_spanner_ = 0;
- span_start_req_l_ = 0;
- cresc_p_ =0;
- pending_column_ = 0;
+ finished_line_spanner_ = 0;
+ current_cresc_ev_ = 0;
+ cresc_ = 0;
- text_req_l_ = 0;
- span_req_l_drul_[START] = 0;
- span_req_l_drul_[STOP] = 0;
+ script_ev_ = 0;
+ accepted_spanevents_drul_[START] = 0;
+ accepted_spanevents_drul_[STOP] = 0;
}
+IMPLEMENT_TRANSLATOR_LISTENER (Dynamic_engraver, absolute_dynamic);
void
-Dynamic_engraver::do_post_move_processing ()
+Dynamic_engraver::listen_absolute_dynamic (Stream_event *ev)
{
- text_req_l_ = 0;
- span_req_l_drul_[START] = 0;
- span_req_l_drul_[STOP] = 0;
-
- /* ugr; we must attach the Dynamic_line_spanner to something
- to be sure that the linebreaker will not be confused
+ /*
+ TODO: probably broken.
*/
- // if (line_spanner_)
- // line_spanner_->add_column (LEFT, get_staff_info ().command_pcol_l ());
+ script_ev_ = ev;
}
-bool
-Dynamic_engraver::do_try_music (Music * m)
+IMPLEMENT_TRANSLATOR_LISTENER (Dynamic_engraver, span_dynamic);
+void
+Dynamic_engraver::listen_span_dynamic (Stream_event *ev)
{
- if (Text_script_req* d = dynamic_cast <Text_script_req*> (m))
- {
- if (d->style_str_ == "dynamic")
- {
- text_req_l_ = d;
- return true;
- }
- }
- else if (Span_req* s = dynamic_cast <Span_req*> (m))
- {
- if ((s->span_type_str_ == "crescendo"
- || s->span_type_str_ == "decrescendo"))
- {
- span_req_l_drul_[s->span_dir_] = s;
- return true;
- }
- }
- return false;
+ Direction d = to_dir (ev->get_property ("span-direction"));
+
+ accepted_spanevents_drul_[d] = ev;
+ if (current_cresc_ev_ && d == START)
+ accepted_spanevents_drul_[STOP] = ev;
}
void
-Dynamic_engraver::do_process_music ()
+Dynamic_engraver::process_music ()
{
- if ((span_req_l_drul_[START] || text_req_l_)
- && !line_spanner_
- && pending_element_arr_.size ())
+ if (accepted_spanevents_drul_[START] || accepted_spanevents_drul_[STOP] || script_ev_)
{
- line_spanner_ = new Dynamic_line_spanner;
- assert (pending_column_);
- line_spanner_->add_column (pending_column_);
- side_position (line_spanner_).set_axis (Y_AXIS);
- announce_element (Score_element_info
- (line_spanner_,
- text_req_l_ ? text_req_l_ : span_req_l_drul_[START]));
-
+ if (!line_spanner_)
+ {
+ Stream_event *rq = accepted_spanevents_drul_[START];
+ line_spanner_ = make_spanner ("DynamicLineSpanner", rq ? rq->self_scm () : SCM_EOL);
+ if (script_ev_)
+ rq = script_ev_;
+ }
}
- if (line_spanner_ && pending_element_arr_.size ())
- {
- for (int i = 0; i < pending_element_arr_.size (); i++)
- pending_element_arr_[i]->set_parent (line_spanner_, Y_AXIS);
- pending_element_arr_.clear ();
- }
+ /*
+ During a (de)crescendo, pending event will not be cleared,
+ and a line-spanner will always be created, as \< \! are already
+ two events.
- if (span_req_l_drul_[START] || text_req_l_)
- last_request_mom_ = now_mom ();
- else
- pending_element_arr_.clear ();
+ Note: line-spanner must always have at least same duration
+ as (de)crecsendo, b.o. line-breaking.
+ */
-
- if (text_req_l_)
+ /*
+ maybe we should leave dynamic texts to the text-engraver and
+ simply acknowledge them?
+ */
+ if (script_ev_)
{
- 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));
- pending_element_arr_.push (text_p_);
- text_p_->set_elt_property ("self-alignment-Y", gh_int2scm (0));
- text_p_->dim_cache_[Y_AXIS]->off_callbacks_.push
- (Side_position_interface::aligned_on_self);
- //text_p_->dim_cache_[Y_AXIS]->off_callbacks_.push
- // (Side_position_interface::aligned_side);
- announce_element (Score_element_info (text_p_, text_req_l_));
+ script_ = make_item ("DynamicText", script_ev_->self_scm ());
+ 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_);
}
- if (span_req_l_drul_[STOP])
+ Stream_event *stop_ev = accepted_spanevents_drul_ [STOP]
+ ? accepted_spanevents_drul_[STOP] : script_ev_;
+
+ if (accepted_spanevents_drul_[STOP] || script_ev_)
{
- if (!cresc_p_)
+ /*
+ finish side position alignment if the (de)cresc ends here, and
+ there are no new dynamics.
+ */
+
+ if (cresc_)
{
- span_req_l_drul_[STOP]->warning
- (_ ("can't find start of (de)crescendo"));
+ assert (!finished_cresc_ && cresc_);
+
+ if (script_)
+ {
+ cresc_->set_bound (RIGHT, script_);
+ add_bound_item (line_spanner_, script_);
+ }
+
+ finished_cresc_ = cresc_;
+ cresc_ = 0;
+ current_cresc_ev_ = 0;
}
- else
+ else if (accepted_spanevents_drul_[STOP])
{
- assert (!finished_cresc_p_);
- cresc_p_->set_bound(RIGHT, get_staff_info ().musical_pcol_l ());
- finished_cresc_p_ = cresc_p_;
- cresc_p_ = 0;
- span_start_req_l_ = 0;
+ accepted_spanevents_drul_[STOP]->origin ()->warning (_ ("can't find start of (de)crescendo"));
+ stop_ev = 0;
}
}
- if (span_req_l_drul_[START])
+ if (accepted_spanevents_drul_[START])
{
- if (span_start_req_l_)
+ if (current_cresc_ev_)
{
- span_req_l_drul_[START]->warning
- (span_start_req_l_->span_dir_ == 1
- ?
- _ ("already have a crescendo")
- : _ ("already have a decrescendo"));
+ string msg = _ ("already have a decrescendo");
+ if (current_cresc_ev_->in_event_class ("crescendo-event"))
+ msg = _ ("already have a crescendo");
+
+ accepted_spanevents_drul_[START]->origin ()->warning (msg);
+ current_cresc_ev_->origin ()->warning (_ ("cresc starts here"));
}
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))
+ 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.
+ */
+
+ 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_sym == ly_symbol2scm ("crescendo-event"))
+ start_type = "crescendo";
+ else
{
- cresc_p_->set_elt_property ("start-text", s);
- daddy_trans_l_->set_property (span_req_l_drul_[START]->span_type_str_
- + "Text", SCM_UNDEFINED);
+ programming_error ("unknown dynamic spanner type");
+ return;
}
- s = get_property (span_req_l_drul_[START]->span_type_str_ + "Spanner");
- if (gh_string_p (s)) //&& ly_scm2string (s) != "hairpin")
+ /*
+ 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_p_->set_elt_property ("spanner", s);
- daddy_trans_l_->set_property (span_req_l_drul_[START]->span_type_str_
- + "Spanner", SCM_UNDEFINED);
+ 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));
}
- 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.
*/
+ else
+ {
+ cresc_ = make_spanner ("DynamicTextSpanner", accepted_spanevents_drul_[START]->self_scm ());
+ cresc_->set_property ("style", s);
+ context ()->set_property ((start_type
+ + "Spanner").c_str (), SCM_EOL);
+ s = get_property ((start_type + "Text").c_str ());
+ /*
+ FIXME: use get_markup () to check type.
+ */
+ 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").c_str (),
+ SCM_EOL);
+ }
+ }
-
- if (text_p_)
+ if (script_)
{
- 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_->set_bound (LEFT, script_);
+ add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
}
- pending_element_arr_.push (cresc_p_);
- cresc_p_->set_elt_property ("self-alignment-Y", gh_int2scm (0));
- cresc_p_->dim_cache_[Y_AXIS]->off_callbacks_.push
- (Side_position_interface::aligned_on_self);
- //cresc_p_->dim_cache_[Y_AXIS]->off_callbacks_.push
- // (Side_position_interface::aligned_side);
- announce_element (Score_element_info (cresc_p_, span_req_l_drul_[START]));
+
+ Axis_group_interface::add_element (line_spanner_, cresc_);
}
}
}
void
-Dynamic_engraver::do_pre_move_processing ()
+Dynamic_engraver::stop_translation_timestep ()
{
+ if (!current_cresc_ev_ && line_spanner_)
+ {
+ assert (!finished_line_spanner_);
+ finished_line_spanner_ = line_spanner_;
+ 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::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_->is_live ())
+ line_spanner_ = 0;
if (line_spanner_)
{
- typeset_element (line_spanner_);
- line_spanner_ = 0;
+ finished_line_spanner_ = line_spanner_;
+ typeset_all ();
}
-}
-void
-Dynamic_engraver::typeset_element (Score_element* e)
-{
- side_position (e).add_staff_support ();
- Engraver::typeset_element (e);
+ if (cresc_
+ && !cresc_->is_live ())
+ cresc_ = 0;
+ if (cresc_)
+ {
+ current_cresc_ev_->origin ()->warning (_ ("unterminated (de)crescendo"));
+ cresc_->suicide ();
+ cresc_ = 0;
+ }
}
void
Dynamic_engraver::typeset_all ()
-{
- if (finished_cresc_p_)
- {
- typeset_element (finished_cresc_p_);
- finished_cresc_p_ =0;
- }
-
- if (text_p_)
+{
+ if (finished_cresc_)
{
- typeset_element (text_p_);
- text_p_ = 0;
+ 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 = unsmob_grob (use_bar
+ ? get_property ("currentCommandColumn")
+ : get_property ("currentMusicalColumn"));
+
+ finished_cresc_->set_bound (RIGHT, script_
+ ? script_
+ : column_bound);
+
+ if (finished_line_spanner_)
+ add_bound_item (finished_line_spanner_,
+ finished_cresc_->get_bound (RIGHT));
+ }
+ finished_cresc_ = 0;
}
- /*
- TODO: This should be optionised:
- * break when group of dynamic requests ends
- * break now
- * continue through piece */
- if (line_spanner_ && last_request_mom_ < now_mom ())
+ script_ = 0;
+ if (finished_line_spanner_)
{
- typeset_element (line_spanner_);
- line_spanner_ = 0;
+ /*
+ 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);
+ }
+
+ finished_line_spanner_ = 0;
}
}
+
+void
+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_element (Score_element_info i)
+Dynamic_engraver::acknowledge_slur (Grob_info info)
{
- if (Note_column* n = dynamic_cast<Note_column*> (i.elem_l_))
+ 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 (line_spanner_
+ /* Don't refill killed spanner */
+ && line_spanner_->is_live ())
{
- if (line_spanner_)
+ 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 (line_spanner_).add_support (n);
- line_spanner_->add_column (n);
+ Grob *head = heads[0];
+ script_->set_parent (head, X_AXIS);
+ Self_alignment_interface::set_center_parent (script_, X_AXIS);
}
- else
+ }
+
+ if (cresc_)
+ {
+ if (!cresc_->get_bound (LEFT))
{
- pending_column_ = n;
+ 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 ());
+}
+
+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 ());
}
+
+ADD_ACKNOWLEDGER (Dynamic_engraver, accidental);
+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 */ "");
projects / lilypond.git / blobdiff