2 script-engraver.cc -- implement Script_engraver
4 (c) 1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
8 #include "side-position-interface.hh"
11 #include "rhythmic-head.hh"
12 #include "engraver.hh"
13 #include "note-column.hh"
15 class Script_engraver : public Engraver
17 Link_array<Grob> scripts_;
18 Link_array<Music> script_reqs_;
21 TRANSLATOR_DECLARATIONS(Script_engraver);
23 virtual bool try_music (Music*);
24 virtual void initialize ();
25 virtual void stop_translation_timestep ();
26 virtual void start_translation_timestep ();
27 virtual void process_music ();
28 virtual void acknowledge_grob (Grob_info);
32 Script_engraver::initialize ()
34 script_reqs_.clear ();
38 Script_engraver::try_music (Music *r)
40 if (r->is_mus_type ("articulation-event"))
42 script_reqs_.push (r);
49 Script_engraver::process_music ()
51 for (int i=0; i < script_reqs_.size (); i++)
53 Music* l=script_reqs_[i];
55 SCM alist = get_property ("scriptDefinitions");
56 SCM art = scm_assoc (l->get_mus_property ("articulation-type"), alist);
58 if (art == SCM_BOOL_F)
60 String a = ly_scm2string (l->get_mus_property ("articulation-type"));
61 l->origin ()->warning (_f ("Don't know how to interpret articulation `%s'", a.to_str0 ()));
65 // todo -> use result of articulation-to-scriptdef directly as basic prop list.
66 Grob *p =new Item (get_property ("Script"));
68 p->set_grob_property ("script-molecule", ly_car (art));
71 bool follow_staff = gh_scm2bool (ly_car (art));
73 SCM relative_stem_dir = ly_car (art);
76 SCM force_dir = l->get_mus_property ("direction");
77 if (ly_dir_p (force_dir) && !to_dir (force_dir))
78 force_dir = ly_car (art);
81 int priority = gh_scm2int (ly_car (art));
83 SCM s = p->get_grob_property ("script-priority");
85 priority = gh_scm2int (s);
87 /* Make sure they're in order of user input by adding index i.
88 Don't use the direction in this priority. Smaller means closer
93 if (ly_dir_p (force_dir) && to_dir (force_dir))
94 p->set_grob_property ("direction", force_dir);
95 else if (to_dir (relative_stem_dir))
96 p->set_grob_property ("side-relative-direction", relative_stem_dir);
100 FIXME: should figure this out in relation with basic props!
102 SCM axisprop = get_property ("scriptHorizontal");
103 bool xaxis = to_boolean (axisprop);
104 Side_position_interface::set_axis (p, xaxis ? X_AXIS : Y_AXIS);
106 if (!follow_staff && ! xaxis)
107 p->set_grob_property ("staff-support", SCM_BOOL_T);
109 if (!xaxis && follow_staff)
110 p->add_offset_callback (Side_position_interface::quantised_position_proc, Y_AXIS);
113 p->set_grob_property ("script-priority", gh_int2scm (priority));
117 announce_grob (p, l->self_scm());
122 Script_engraver::acknowledge_grob (Grob_info inf)
124 if (Stem::has_interface (inf.grob_))
126 for (int i=0; i < scripts_.size (); i++)
128 Grob*e = scripts_[i];
130 e->set_grob_property ("direction-source", inf.grob_->self_scm ());
131 e->add_dependency (inf.grob_);
132 Side_position_interface::add_support (e, inf.grob_);
135 else if (Rhythmic_head::has_interface (inf.grob_))
137 for (int i=0; i < scripts_.size (); i++)
139 Grob *e = scripts_[i];
141 if (Side_position_interface::get_axis (e) == X_AXIS
142 && !e->get_parent (Y_AXIS))
144 e->set_parent (inf.grob_, Y_AXIS);
145 e->add_dependency (inf.grob_); // ??
147 Side_position_interface::add_support (e,inf.grob_);
150 else if (Note_column::has_interface (inf.grob_))
154 We make note column the parent of the script. That's not
155 correct, but due to seconds in a chord, noteheads may be
156 swapped around horizontally. We don't know which note head to
157 put it on, so we postpone this decision to
158 Script_interface::before_line_breaking ().
161 for (int i=0; i < scripts_.size (); i++)
163 Grob *e = scripts_[i];
165 if (!e->get_parent (X_AXIS) &&
166 Side_position_interface::get_axis (e) == Y_AXIS)
168 e->set_parent (inf.grob_, X_AXIS);
175 Script_engraver::stop_translation_timestep ()
177 for (int i=0; i < scripts_.size (); i++)
181 TODO: junk staff-support.
183 Grob * sc = scripts_[i];
184 if (to_boolean (sc->get_grob_property ("staff-support")))
186 Side_position_interface::add_staff_support (sc);
194 Script_engraver::start_translation_timestep ()
196 script_reqs_.clear ();
201 Script_engraver::Script_engraver(){}
203 ENTER_DESCRIPTION(Script_engraver,
204 /* descr */ " Handles note ornaments generated by @code{\\script}.
206 /* creats*/ "Script",
207 /* accepts */ "script-event articulation-event",
208 /* acks */ "stem-interface rhythmic-head-interface note-column-interface",
209 /* reads */ "scriptDefinitions scriptHorizontal",