/*
script-engraver.cc -- implement Script_engraver
- (c) 1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
*/
-#include "script-engraver.hh"
#include "script.hh"
-#include "stem-staff-side.hh"
-#include "musical-request.hh"
+#include "side-position-interface.hh"
+#include "event.hh"
#include "stem.hh"
-#include "staff-symbol.hh"
#include "rhythmic-head.hh"
-#include "dimension-cache.hh"
+#include "engraver.hh"
+#include "note-column.hh"
+#include "context.hh"
-Script_engraver::Script_engraver()
+#include "warn.hh"
+
+struct Script_tuple
{
- do_post_move_processing();
-}
+ Music *event_;
+ Grob * script_;
+ SCM description_;
+ Script_tuple ()
+ {
+ event_ = 0;
+ script_ = 0;
+ description_ = SCM_EOL;
+ }
+};
+
+class Script_engraver : public Engraver
+{
+ Array<Script_tuple> scripts_;
+public:
+ TRANSLATOR_DECLARATIONS (Script_engraver);
+protected:
+ virtual bool try_music (Music*);
+ virtual void stop_translation_timestep ();
+ virtual void process_music ();
+ virtual void acknowledge_grob (Grob_info);
+};
bool
-Script_engraver::do_try_music (Music *r_l)
+Script_engraver::try_music (Music *r)
{
- if (Articulation_req *mr = dynamic_cast <Articulation_req *> (r_l))
+ if (r->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.
+ This is necessary for part-combining.
+ */
+ for (int j = 0; j < scripts_.size (); j++)
+ if (ly_c_equal_p (scripts_[j]. event_->get_property ("articulation-type"),
+ r->get_property ("articulation-type")
+ ))
+ return true;
+
+ Script_tuple t;
+ t.event_ =r;
+ scripts_.push (t);
+
return true;
}
return false;
}
void
-Script_engraver::do_process_requests()
+copy_property (Grob * g , SCM sym, SCM alist)
{
- for (int i=0; i < script_req_l_arr_.size(); i++)
+ if (g->internal_get_property (sym) == SCM_EOL)
{
- Articulation_req* l=script_req_l_arr_[i];
-
- SCM list = ly_ch_C_eval_scm (("(articulation-to-scriptdef \"" + l->articulation_str_ + "\")").ch_C());
-
- if (list == SCM_BOOL_F)
- {
- l->warning (_f ("Don't know how to interpret articulation `%s'",
- l->articulation_str_.ch_C ()));
- continue;
- }
- Script *p =new Script;
- Stem_staff_side_item * ss =new Stem_staff_side_item;
-
- list = gh_cdr (list);
- p->set_elt_property ("molecule",
- SCM_CAR(list));
-
- list = SCM_CDR(list);
- bool follow_staff = gh_scm2bool (SCM_CAR(list));
- list = SCM_CDR(list);
- int relative_stem_dir = gh_scm2int (SCM_CAR(list));
- list = SCM_CDR(list);
- int force_dir =gh_scm2int (SCM_CAR(list));
- list = SCM_CDR(list);
- SCM priority = SCM_CAR(list);
-
- if (relative_stem_dir)
- ss->relative_dir_ = (Direction)relative_stem_dir;
- else
- ss->set_direction ((Direction)force_dir);
-
- SCM dir_prop (get_property ("articulationScriptVerticalDirection", 0));
- if (gh_number_p(dir_prop))
- ss->set_direction (to_dir (dir_prop));
-
- if (l->get_direction ())
- ss->set_direction (l->get_direction ());
-
- SCM paddingprop = get_property ("articulationScriptPadding", 0);
- if (gh_number_p(paddingprop))
+ SCM entry = scm_assoc (sym,alist);
+ if (ly_c_pair_p (entry))
{
- ss->set_elt_property ("padding", paddingprop);
+ g->internal_set_property (sym, ly_cdr (entry));
}
+ }
+}
- SCM axisprop = get_property ("scriptHorizontal",0);
- if (gh_boolean_p (axisprop) && gh_scm2bool (axisprop))
- ss->axis_ = X_AXIS;
- if (follow_staff && !gh_boolean_p (axisprop) && gh_scm2bool (axisprop))
- ss->set_elt_property ("no-staff-support", SCM_BOOL_T);
+/*
+ We add the properties, one by one for each Script. We could save a
+ little space by tacking the props onto the Script grob (i.e. make
+ ScriptStaccato , ScriptMarcato, etc. )
+ */
+void make_script_from_event (Grob *p,
+ SCM * descr, Context *tg,
+ SCM art_type,
+ int index)
+{
+ SCM alist = tg->get_property ("scriptDefinitions");
+ SCM art = scm_assoc (art_type, alist);
- p->set_staff_side (ss);
- ss->set_elt_property ("script-priority", priority);
- if (gh_number_p (paddingprop))
- ss->set_elt_property ("padding", paddingprop);
-
+ if (art == SCM_BOOL_F)
+ {
+ warning (_("Don't know how to interpret articulation:"));
+ warning (_("Scheme encoding: "));
+ scm_write (art_type, scm_current_error_port ());
+ return ;
+ }
+
+ art = ly_cdr (art);
- script_p_arr_.push (p);
- staff_side_p_arr_.push (ss);
+ *descr = art;
+
+
+ copy_property (p, ly_symbol2scm ("script-stencil"), art);
+ copy_property (p, ly_symbol2scm ("direction"), art);
+ copy_property (p, ly_symbol2scm ("side-relative-direction"), art);
+
+ int prio =0;
+ SCM sprio = scm_assoc (ly_symbol2scm ("script-priority"), art);
+ if (ly_c_pair_p (sprio))
+ prio = ly_scm2int (ly_cdr (sprio));
+
+
+ /*
+ 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.
+ */
+ prio += index;
+
+ Side_position_interface::set_axis (p, Y_AXIS);
+ p->set_property ("script-priority", scm_int2num (prio));
+}
+
+void
+Script_engraver::process_music ()
+{
+ for (int i=0; i < scripts_.size (); i++)
+ {
+ Music* l=scripts_[i].event_;
+
+ Grob * p = make_item ("Script", l->self_scm ());
+
+ make_script_from_event (p, &scripts_[i].description_, context (),
+ l->get_property ("articulation-type"),
+ i);
+
+ scripts_[i].script_ = p;
+
- announce_element (Score_element_info (p, l));
- announce_element (Score_element_info (ss, l));
+ SCM force_dir = l->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 inf)
{
- if (Stem *s = dynamic_cast<Stem*>(inf.elem_l_))
+ if (Stem::has_interface (inf.grob_))
{
- for (int i=0; i < staff_side_p_arr_.size(); i++)
- if (Stem_staff_side_item * ss = dynamic_cast<Stem_staff_side_item*>(staff_side_p_arr_[i]))
- {
- ss->set_stem (s);
- ss->add_support (s);
- }
+ for (int i=0; i < scripts_.size (); i++)
+ {
+ Grob*e = scripts_[i].script_;
+
+ if (to_dir (e->get_property ("side-relative-direction")))
+ e->set_property ("direction-source", inf.grob_->self_scm ());
+
+ /*
+ add dep ?
+ */
+ e->add_dependency (inf.grob_);
+ Side_position_interface::add_support (e, inf.grob_);
+ }
}
- else if (Rhythmic_head * rh = dynamic_cast<Rhythmic_head*>(inf.elem_l_))
+ else if (Rhythmic_head::has_interface (inf.grob_))
{
- for (int i=0; i < staff_side_p_arr_.size(); i++)
+ for (int i=0; i < scripts_.size (); i++)
{
- Staff_side_item * ss = dynamic_cast<Staff_side_item*>(staff_side_p_arr_[i]);
+ Grob *e = scripts_[i].script_;
- if (!ss->parent_l (X_AXIS))
+ if (Side_position_interface::get_axis (e) == X_AXIS
+ && !e->get_parent (Y_AXIS))
{
- ss->set_parent (inf.elem_l_, X_AXIS);
+ e->set_parent (inf.grob_, Y_AXIS);
+ e->add_dependency (inf.grob_); // ??
}
- if (ss->axis_ == X_AXIS
- && !ss->parent_l (Y_AXIS))
- ss->set_parent (rh, Y_AXIS);
+ Side_position_interface::add_support (e,inf.grob_);
+ }
+ }
+ else if (Note_column::has_interface (inf.grob_))
+ {
+
+ /*
+ We make note column the parent of the script. That's not
+ correct, but due to seconds in a chord, noteheads may be
+ swapped around horizontally. We don't know which note head to
+ put it on, so we postpone this decision to
+ Script_interface::before_line_breaking ().
+
+ */
+ for (int i=0; i < scripts_.size (); i++)
+ {
+ Grob *e = scripts_[i].script_;
- ss->add_support (rh);
+ if (!e->get_parent (X_AXIS) &&
+ Side_position_interface::get_axis (e) == Y_AXIS)
+ {
+ e->set_parent (inf.grob_, X_AXIS);
+ }
}
- }
+ }
}
void
-Script_engraver::do_pre_move_processing()
+Script_engraver::stop_translation_timestep ()
{
- for (int i=0; i < script_p_arr_.size(); i++)
+ for (int i=0; i < scripts_.size (); i++)
{
- typeset_element (script_p_arr_[i]);
- typeset_element (staff_side_p_arr_[i]);
+ if (!scripts_[i].script_)
+ continue;
+
+ Grob * sc = scripts_[i].script_;
+
+ SCM follow = scm_assoc (ly_symbol2scm ("follow-into-staff"), scripts_[i].description_);
+ if (ly_c_pair_p (follow) && to_boolean (ly_cdr (follow)))
+ {
+ sc->add_offset_callback (Side_position_interface::quantised_position_proc, Y_AXIS);
+ sc->set_property ("staff-padding", SCM_EOL);
+ }
}
- script_p_arr_.clear();
- staff_side_p_arr_.clear ();
+ scripts_.clear ();
}
-void
-Script_engraver::do_post_move_processing()
-{
- script_req_l_arr_.clear();
-}
-ADD_THIS_TRANSLATOR(Script_engraver);
+Script_engraver::Script_engraver (){}
+ENTER_DESCRIPTION (Script_engraver,
+/* descr */ "Handles note scripted articulations.",
+/* creats*/ "Script",
+/* accepts */ "script-event articulation-event",
+/* acks */ "stem-interface rhythmic-head-interface note-column-interface",
+/* reads */ "scriptDefinitions",
+/* write */ "");