/*
- script-engraver.cc -- implement Script_engraver
+ script-engraver.cc -- engrave Scripts: Articulations.
- (c) 1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-*/
+ source file of the GNU LilyPond music typesetter
+ (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+*/
-#include "script.hh"
+#include "context.hh"
+#include "directional-element-interface.hh"
+#include "engraver.hh"
+#include "event.hh"
+#include "slur.hh"
+#include "note-column.hh"
+#include "paper-column.hh"
+#include "rhythmic-head.hh"
+#include "script-interface.hh"
#include "side-position-interface.hh"
-#include "musical-request.hh"
+#include "staff-symbol-referencer.hh"
#include "stem.hh"
-#include "rhythmic-head.hh"
-#include "engraver.hh"
+#include "warn.hh"
+
+struct Script_tuple
+{
+ Music *event_;
+ Grob *script_;
+ bool follow_into_staff_;
+ Script_tuple ()
+ {
+ follow_into_staff_ = false;
+ event_ = 0;
+ script_ = 0;
+ }
+};
-class Script_engraver : public Engraver {
- Link_array<Score_element> script_p_arr_;
- Link_array<Articulation_req> script_req_l_arr_;
+class Script_engraver : public Engraver
+{
+ Array<Script_tuple> scripts_;
+ Spanner *slur_;
-public:
- VIRTUAL_COPY_CONS(Translator);
-
- Script_engraver();
protected:
- virtual bool do_try_music (Music*);
- virtual void do_process_music ();
- virtual void do_pre_move_processing ();
- virtual void do_post_move_processing ();
- virtual void acknowledge_element (Score_element_info);
-};
+ virtual bool try_music (Music*);
+ virtual void stop_translation_timestep ();
+ virtual void process_music ();
+ virtual void acknowledge_grob (Grob_info);
+public:
+ TRANSLATOR_DECLARATIONS (Script_engraver);
+};
-Script_engraver::Script_engraver()
+Script_engraver::Script_engraver ()
{
- do_post_move_processing();
+ slur_ = 0;
}
bool
-Script_engraver::do_try_music (Music *r_l)
+Script_engraver::try_music (Music *m)
{
- if (Articulation_req *mr = dynamic_cast <Articulation_req *> (r_l))
+ if (m->is_mus_type ("articulation-event"))
{
- for (int i=0; i < script_req_l_arr_.size(); i++)
- {
- if (script_req_l_arr_[i]->equal_b (mr))
- return true;
- }
- script_req_l_arr_.push (mr);
+ /* Discard double articulations for part-combining. */
+ int script_count = scripts_.size ();
+ for (int i = 0; i < script_count; i++)
+ if (ly_c_equal_p (scripts_[i].event_
+ ->get_property ("articulation-type"),
+ m->get_property ("articulation-type")))
+ return true;
+
+ Script_tuple t;
+ t.event_ = m;
+ scripts_.push (t);
return true;
}
return false;
}
void
-Script_engraver::do_process_music()
+copy_property (Grob *g, SCM sym, SCM alist)
+{
+ if (g->internal_get_property (sym) == SCM_EOL)
+ {
+ SCM entry = scm_assoc (sym, alist);
+ if (ly_c_pair_p (entry))
+ g->internal_set_property (sym, ly_cdr (entry));
+ }
+}
+
+/* Add the properties, one by one for each Script. A little memory
+ could be saved by tacking the props onto the Script grob (i.e. make
+ ScriptStaccato , ScriptMarcato, etc. ).
+
+*/
+void make_script_from_event (Grob *p, bool * follow, Context *tg,
+ SCM art_type, int index)
{
- for (int i=0; i < script_req_l_arr_.size(); i++)
+ SCM alist = tg->get_property ("scriptDefinitions");
+ SCM art = scm_assoc (art_type, alist);
+
+ if (art == SCM_BOOL_F)
{
- Articulation_req* l=script_req_l_arr_[i];
+ /* FIXME: */
+ warning (_ ("Do not know how to interpret articulation: "));
+ warning (_ ("Scheme encoding: "));
+ scm_write (art_type, scm_current_error_port ());
+ return;
+ }
+
+ art = ly_cdr (art);
+
+ SCM follow_scm = scm_assoc (ly_symbol2scm ("follow-into-staff"),
+ art);
- SCM list = scm_assoc (ly_str02scm (l->articulation_str_.ch_C ()),
- scm_eval (ly_symbol2scm ("script-alist")));
+ *follow = ly_c_pair_p (follow_scm) && to_boolean (ly_cdr (follow_scm));
+ bool priority_found = false ;
+
+ for (SCM s = art ; ly_c_pair_p (s); s = ly_cdr (s))
+ {
+ SCM sym = ly_caar (s);
+ SCM type = scm_object_property (sym, ly_symbol2scm ("backend-type?"));
+ if (!ly_c_procedure_p (type))
+ continue;
- if (list == SCM_BOOL_F)
+ SCM val = ly_cdar (s);
+
+ if (sym == ly_symbol2scm ("script-priority"))
{
- l->origin ()->warning (_f ("Don't know how to interpret articulation `%s'",
- l->articulation_str_.ch_C ()));
- continue;
+ priority_found = true;
+ /* Make sure they're in order of user input by adding index i.
+ Don't use the direction in this priority. Smaller means closer
+ to the head. */
+ int prio = scm_to_int (val) + index;
+
+
+ val = scm_int2num (prio);
}
- // todo -> use result of articulation-to-scriptdef directly as basic prop list.
- Score_element *p =new Item (get_property ("basicScriptProperties"));
- Script::set_interface (p);
+ if (p->internal_get_property (sym) == SCM_EOL)
+ p->internal_set_property (sym, val);
+ }
- p->add_offset_callback (Side_position::centered_on_parent, X_AXIS);
-
- list = gh_cdr (list);
- p->set_elt_property ("molecule",
- gh_car (list));
-
- list = gh_cdr(list);
- bool follow_staff = gh_scm2bool (gh_car (list));
- list = gh_cdr(list);
- int relative_stem_dir = gh_scm2int (gh_car (list));
- list = gh_cdr(list);
- int force_dir =gh_scm2int (gh_car (list));
- list = gh_cdr(list);
- SCM priority = gh_car (list);
+ if (!priority_found)
+ {
+ p->set_property ("script-priority",
+ scm_int2num (index));
+ }
+
+ Side_position_interface::set_axis (p, Y_AXIS);
-
- if (relative_stem_dir)
- p->set_elt_property ("side-relative-direction", gh_int2scm (relative_stem_dir));
- else
- Side_position::set_direction (p,(Direction)force_dir);
+}
+
+void
+Script_engraver::process_music ()
+{
+ int script_count = scripts_.size ();
+ for (int i = 0; i < script_count; i++)
+ {
+ Music *m = scripts_[i].event_;
- if (l->get_direction ())
- Side_position::set_direction (p, l->get_direction ());
+ Grob *p = make_item ("Script", m->self_scm ());
- SCM axisprop = get_property ("scriptHorizontal");
- bool xaxis = to_boolean (axisprop);
- Side_position::set_axis (p, xaxis ? X_AXIS : Y_AXIS);
-
- if (!follow_staff && ! xaxis)
- p->set_elt_property ("staff-support", SCM_BOOL_T);
+ make_script_from_event (p, &scripts_[i].follow_into_staff_, context (),
+ m->get_property ("articulation-type"),
+ i);
- if (!xaxis && follow_staff)
- p->add_offset_callback (Side_position::quantised_position, Y_AXIS);
-
-
- p->set_elt_property ("script-priority", priority);
-
- script_p_arr_.push (p);
-
- announce_element (p, l);
+ scripts_[i].script_ = p;
+
+ SCM force_dir = m->get_property ("direction");
+ if (is_direction (force_dir) && to_dir (force_dir))
+ p->set_property ("direction", force_dir);
}
}
void
-Script_engraver::acknowledge_element (Score_element_info inf)
+Script_engraver::acknowledge_grob (Grob_info info)
{
- bool them_grace = to_boolean (inf.elem_l_->get_elt_property ("grace"));
- bool us_grace = to_boolean (get_property ("weAreGraceContext"));
-
- if (us_grace != them_grace)
- return;
-
- if (Stem::has_interface (inf.elem_l_))
+ int script_count = scripts_.size ();
+ if (Stem::has_interface (info.grob_))
{
- for (int i=0; i < script_p_arr_.size(); i++)
+ for (int i = 0; i < script_count; i++)
{
- Score_element*e = script_p_arr_[i];
+ Grob *e = scripts_[i].script_;
- e->set_elt_property ("direction-source", inf.elem_l_->self_scm ());
- Side_position::add_support (e, inf.elem_l_);
+ if (to_dir (e->get_property ("side-relative-direction")))
+ e->set_property ("direction-source", info.grob_->self_scm ());
+
+ /* FIXME: add dependency */
+ e->add_dependency (info.grob_);
+ Side_position_interface::add_support (e, info.grob_);
}
}
- else if (Rhythmic_head::has_interface (inf.elem_l_))
+ else if (Rhythmic_head::has_interface (info.grob_)
+ && info.music_cause ())
{
- for (int i=0; i < script_p_arr_.size(); i++)
+ for (int i = 0; i < script_count; i++)
{
- Score_element *e = script_p_arr_[i];
-
- if (!e->parent_l (X_AXIS))
+ Grob *e = scripts_[i].script_;
+
+ if (Side_position_interface::get_axis (e) == X_AXIS
+ && !e->get_parent (Y_AXIS))
{
- e->set_parent (inf.elem_l_, X_AXIS);
+ e->set_parent (info.grob_, Y_AXIS);
+ e->add_dependency (info.grob_);
}
- if (Side_position::get_axis (e) == X_AXIS
- && !e->parent_l (Y_AXIS))
- e->set_parent (inf.elem_l_, Y_AXIS);
-
- Side_position::add_support (e,inf.elem_l_);
+ Side_position_interface::add_support (e,info.grob_);
}
- }
-}
-
-void
-Script_engraver::do_pre_move_processing()
-{
- for (int i=0; i < script_p_arr_.size(); i++)
+ }
+ else if (Note_column::has_interface (info.grob_))
{
- Score_element * sc = script_p_arr_[i];
- if (to_boolean (sc->get_elt_property ("staff-support")))
+ /* Make note column the parent of the script. That is not
+ correct, but due to seconds in a chord, noteheads may be
+ swapped around horizontally.
+
+ As the note head to put it on is not known now, postpone this
+ decision to Script_interface::before_line_breaking (). */
+ for (int i = 0; i < script_count; i++)
{
- Side_position::add_staff_support (sc);
+ Grob *e = scripts_[i].script_;
+
+ if (!e->get_parent (X_AXIS)
+ && Side_position_interface::get_axis (e) == Y_AXIS)
+ e->set_parent (info.grob_, X_AXIS);
}
- typeset_element (sc);
}
- script_p_arr_.clear();
+ else if (Slur::has_interface (info.grob_))
+ slur_ = dynamic_cast<Spanner*> (info.grob_);
}
void
-Script_engraver::do_post_move_processing()
+Script_engraver::stop_translation_timestep ()
{
- script_req_l_arr_.clear();
+ int script_count = scripts_.size ();
+ for (int i = 0; i < script_count; i++)
+ if (scripts_[i].follow_into_staff_)
+ {
+ Grob *sc = scripts_[i].script_;
+ sc->add_offset_callback (Side_position_interface
+ ::quantised_position_proc, Y_AXIS);
+ sc->set_property ("staff-padding", SCM_EOL);
+ }
+
+ scripts_.clear ();
}
-ADD_THIS_TRANSLATOR(Script_engraver);
-
-
+ENTER_DESCRIPTION (Script_engraver,
+/* descr */ "Handles note scripted articulations.",
+/* creats*/ "Script",
+/* accepts */ "script-event articulation-event",
+/* acks */ "stem-interface rhythmic-head-interface "
+ "slur-interface note-column-interface",
+/* reads */ "scriptDefinitions",
+/* write */ "");