/*
- 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 "new-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"
-class Script_engraver : public Engraver {
- Link_array<Grob> script_p_arr_;
- Link_array<Articulation_req> script_req_l_arr_;
+struct Script_tuple
+{
+ Music *event_;
+ Grob *script_;
+ SCM description_;
+ Script_tuple ()
+ {
+ event_ = 0;
+ script_ = 0;
+ description_ = SCM_EOL;
+ }
+};
-public:
- VIRTUAL_COPY_CONS (Translator);
+class Script_engraver : public Engraver
+{
+ Array<Script_tuple> scripts_;
+ Spanner *slur_;
protected:
virtual bool try_music (Music*);
- virtual void initialize ();
virtual void stop_translation_timestep ();
- virtual void start_translation_timestep ();
- virtual void create_grobs ();
+ virtual void process_music ();
virtual void acknowledge_grob (Grob_info);
-};
+public:
+ TRANSLATOR_DECLARATIONS (Script_engraver);
+};
-void
-Script_engraver::initialize ()
+Script_engraver::Script_engraver ()
{
- script_req_l_arr_.clear();
+ slur_ = 0;
}
bool
-Script_engraver::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::create_grobs ()
+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 entry = scm_assoc (sym, alist);
+ if (ly_c_pair_p (entry))
+ g->internal_set_property (sym, ly_cdr (entry));
+ }
+}
- SCM alist = get_property ("scriptDefinitions");
- SCM list = scm_assoc (l->get_mus_property ("articulation-type"), alist);
+/* Add the properties, one by one for each Script. A little space
+ (memory? --jcn) could be saved 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);
- if (list == SCM_BOOL_F)
- {
- String a = ly_scm2string (l->get_mus_property ("articulation-type"));
- l->origin ()->warning (_f ("Don't know how to interpret articulation `%s'", a.ch_C()));
-
- continue;
- }
- // todo -> use result of articulation-to-scriptdef directly as basic prop list.
- Grob *p =new Item (get_property ("Script"));
- list = gh_cdr (list);
- p->set_grob_property ("molecule",
- gh_car (list));
-
- list = gh_cdr(list);
- bool follow_staff = gh_scm2bool (gh_car (list));
- list = gh_cdr(list);
- SCM relative_stem_dir = gh_car (list);
- list = gh_cdr(list);
-
- SCM force_dir = l->get_mus_property ("direction");
- if (!isdir_b (force_dir))
- force_dir = gh_car (list);
- list = gh_cdr(list);
- SCM priority = gh_car (list);
-
-
- if (!isdir_b (force_dir)
- && to_dir (relative_stem_dir))
- p->set_grob_property ("side-relative-direction", relative_stem_dir);
- else
- p->set_grob_property ("direction", force_dir);
-
- /*
- FIXME: should figure this out in relation with basic props!
- */
- 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_grob_property ("staff-support", SCM_BOOL_T);
-
- if (!xaxis && follow_staff)
- p->add_offset_callback (Side_position::quantised_position_proc, Y_AXIS);
-
-
- p->set_grob_property ("script-priority", priority);
-
- script_p_arr_.push (p);
-
- announce_grob (p, l);
+ if (art == SCM_BOOL_F)
+ {
+ /* FIXME: */
+ warning (_ ("Do not know how to interpret articulation: "));
+ warning (_ ("Scheme encoding: "));
+ scm_write (art_type, scm_current_error_port ());
+ return;
}
- script_req_l_arr_.clear ();
+
+ art = ly_cdr (art);
+ *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::acknowledge_grob (Grob_info inf)
+Script_engraver::process_music ()
{
- bool them_grace = to_boolean (inf.elem_l_->get_grob_property ("grace"));
- bool us_grace = to_boolean (get_property ("weAreGraceContext"));
+ int script_count = scripts_.size ();
+ for (int i = 0; i < script_count; i++)
+ {
+ Music *m = scripts_[i].event_;
+
+ Grob *p = make_item ("Script", m->self_scm ());
+
+ make_script_from_event (p, &scripts_[i].description_, context (),
+ m->get_property ("articulation-type"),
+ i);
- if (us_grace != them_grace)
- return;
-
- if (Stem::has_interface (inf.elem_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_grob (Grob_info info)
+{
+ 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++)
{
- Grob*e = script_p_arr_[i];
+ Grob *e = scripts_[i].script_;
- e->set_grob_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_))
{
- for (int i=0; i < script_p_arr_.size(); i++)
+ for (int i = 0; i < script_count; i++)
{
- Grob *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::stop_translation_timestep()
-{
- for (int i=0; i < script_p_arr_.size(); i++)
+ }
+ else if (Note_column::has_interface (info.grob_))
{
- Grob * sc = script_p_arr_[i];
- if (to_boolean (sc->get_grob_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_grob (sc);
}
- script_p_arr_.clear();
+ else if (New_slur::has_interface (info.grob_))
+ slur_ = dynamic_cast<Spanner*> (info.grob_);
}
void
-Script_engraver::start_translation_timestep()
+Script_engraver::stop_translation_timestep ()
{
- script_req_l_arr_.clear();
-}
+ int script_count = scripts_.size ();
+ for (int i = 0; i < script_count; i++)
+ if (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);
+ }
+
+ /* Simplistic slur collision handling. This fixes simple collisions
+ like
+
+ a_\upbow( b)
+
+ but it most probably breaks for more interesting cases.
+ Maybe make a new colission engraver.
-ADD_THIS_TRANSLATOR (Script_engraver);
+
+ Assume that a SCRIPT that should collide with SLUR does not
+ have a negative priority. */
+ SCM priority = sc->get_property ("script-priority");
+#if 0
+ // this segfaults...
+ int rank = Paper_column::get_rank (sc);
+#endif
+
+ int rank = -1;
+#if 1
+ // this always yields -1
+ if (Item *i = dynamic_cast<Item*> (sc))
+ if (i->get_column ())
+ rank = i->get_column ()->rank_;
+#else
+ // this always yields -1
+ for (Grob *p = sc; p && rank < 0; p = p->get_parent (Y_AXIS))
+ {
+ if (Item *i = dynamic_cast<Item*> (p))
+ if (i->get_column ())
+ rank = i->get_column ()->rank_;
+ }
+#endif
+
+ if (robust_scm2int (priority, 0) >= 0
+ && slur_
+ && get_grob_direction (sc) == get_slur_dir (slur_)
+ && (slur_->spanned_rank_iv ().contains (rank)
+ /* I'm a bit out of ideas about and time to search for
+ how to get our rank. Sue me. */
+ || rank == -1))
+ {
+ Real ss = Staff_symbol_referencer::staff_space (sc);
+ Real pad = robust_scm2double (sc->get_property ("padding"), 0);
+
+ /* FIXME: 1ss padding hardcoded */
+ sc->set_property ("padding", scm_make_real (pad + ss));
+ }
+ }
+ scripts_.clear ();
+}
+ENTER_DESCRIPTION (Script_engraver,
+/* descr */ "Handles note scripted articulations.",
+/* creats*/ "Script",
+/* accepts */ "script-event articulation-event",
+/* acks */ "stem-interface rhythmic-head-interface\
+ new-slur-interface note-column-interface",
+/* reads */ "scriptDefinitions",
+/* write */ "");
projects / lilypond.git / blobdiff