2 script-engraver.cc -- engrave Scripts: Articulations.
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
10 #include "directional-element-interface.hh"
11 #include "engraver.hh"
13 #include "new-slur.hh"
14 #include "note-column.hh"
15 #include "rhythmic-head.hh"
16 #include "script-interface.hh"
17 #include "side-position-interface.hh"
18 #include "staff-symbol-referencer.hh"
31 description_ = SCM_EOL;
35 class Script_engraver : public Engraver
37 Array<Script_tuple> scripts_;
41 virtual bool try_music (Music*);
42 virtual void stop_translation_timestep ();
43 virtual void process_music ();
44 virtual void acknowledge_grob (Grob_info);
47 TRANSLATOR_DECLARATIONS (Script_engraver);
50 Script_engraver::Script_engraver ()
56 Script_engraver::try_music (Music *r)
58 if (r->is_mus_type ("articulation-event"))
60 /* Discard double articulations for part-combining. */
61 int script_count = scripts_.size ();
62 for (int i = 0; i < script_count; i++)
63 if (ly_c_equal_p (scripts_[i].event_
64 ->get_property ("articulation-type"),
65 r->get_property ("articulation-type")))
77 copy_property (Grob *g, SCM sym, SCM alist)
79 if (g->internal_get_property (sym) == SCM_EOL)
81 SCM entry = scm_assoc (sym, alist);
82 if (ly_c_pair_p (entry))
83 g->internal_set_property (sym, ly_cdr (entry));
87 /* Add the properties, one by one for each Script. A little space
88 (memory? --jcn) could be saved by tacking the props onto the Script
89 grob (i.e. make ScriptStaccato , ScriptMarcato, etc. ). */
90 void make_script_from_event (Grob *p, SCM *descr, Context *tg,
91 SCM art_type, int index)
93 SCM alist = tg->get_property ("scriptDefinitions");
94 SCM art = scm_assoc (art_type, alist);
96 if (art == SCM_BOOL_F)
99 warning (_ ("Do not know how to interpret articulation: "));
100 warning (_ ("Scheme encoding: "));
101 scm_write (art_type, scm_current_error_port ());
108 copy_property (p, ly_symbol2scm ("script-stencil"), art);
109 copy_property (p, ly_symbol2scm ("direction"), art);
110 copy_property (p, ly_symbol2scm ("side-relative-direction"), art);
113 SCM sprio = scm_assoc (ly_symbol2scm ("script-priority"), art);
114 if (ly_c_pair_p (sprio))
115 prio = ly_scm2int (ly_cdr (sprio));
117 /* Make sure they're in order of user input by adding index i.
118 Don't use the direction in this priority. Smaller means closer
122 Side_position_interface::set_axis (p, Y_AXIS);
123 p->set_property ("script-priority", scm_int2num (prio));
127 Script_engraver::process_music ()
129 int script_count = scripts_.size ();
130 for (int i = 0; i < script_count; i++)
132 Music *m = scripts_[i].event_;
134 Grob *p = make_item ("Script", m->self_scm ());
136 make_script_from_event (p, &scripts_[i].description_, context (),
137 m->get_property ("articulation-type"),
140 scripts_[i].script_ = p;
142 SCM force_dir = m->get_property ("direction");
143 if (is_direction (force_dir) && to_dir (force_dir))
144 p->set_property ("direction", force_dir);
149 Script_engraver::acknowledge_grob (Grob_info inf)
151 int script_count = scripts_.size ();
152 if (Stem::has_interface (inf.grob_))
154 for (int i = 0; i < script_count; i++)
156 Grob *e = scripts_[i].script_;
158 if (to_dir (e->get_property ("side-relative-direction")))
159 e->set_property ("direction-source", inf.grob_->self_scm ());
161 /* FIXME: add dependency */
162 e->add_dependency (inf.grob_);
163 Side_position_interface::add_support (e, inf.grob_);
166 else if (Rhythmic_head::has_interface (inf.grob_))
168 for (int i = 0; i < script_count; i++)
170 Grob *e = scripts_[i].script_;
172 if (Side_position_interface::get_axis (e) == X_AXIS
173 && !e->get_parent (Y_AXIS))
175 e->set_parent (inf.grob_, Y_AXIS);
176 e->add_dependency (inf.grob_); // ??
178 Side_position_interface::add_support (e,inf.grob_);
181 else if (Note_column::has_interface (inf.grob_))
183 /* Make note column the parent of the script. That is not
184 correct, but due to seconds in a chord, noteheads may be
185 swapped around horizontally.
187 As the note head to put it on is not known now, postpone this
188 decision to Script_interface::before_line_breaking (). */
189 for (int i = 0; i < script_count; i++)
191 Grob *e = scripts_[i].script_;
193 if (!e->get_parent (X_AXIS)
194 && Side_position_interface::get_axis (e) == Y_AXIS)
195 e->set_parent (inf.grob_, X_AXIS);
198 else if (New_slur::has_interface (inf.grob_) && script_count)
203 Script_engraver::stop_translation_timestep ()
205 int script_count = scripts_.size ();
206 for (int i = 0; i < script_count; i++)
207 if (Grob *sc = scripts_[i].script_)
209 SCM follow = scm_assoc (ly_symbol2scm ("follow-into-staff"),
210 scripts_[i].description_);
211 if (ly_c_pair_p (follow) && to_boolean (ly_cdr (follow)))
213 sc->add_offset_callback (Side_position_interface
214 ::quantised_position_proc, Y_AXIS);
215 sc->set_property ("staff-padding", SCM_EOL);
217 SCM priority = sc->get_property ("script-priority");
218 if (robust_scm2int (priority, 0) >= 0
220 && get_grob_direction (sc) == get_slur_dir (slur_))
222 Real ss = Staff_symbol_referencer::staff_space (sc);
223 Real pad = robust_scm2double (sc->get_property ("padding"), 0);
225 /* FIXME: 1ss padding hardcoded */
226 sc->set_property ("padding", scm_make_real (pad + ss));
233 ENTER_DESCRIPTION (Script_engraver,
234 /* descr */ "Handles note scripted articulations.",
235 /* creats*/ "Script",
236 /* accepts */ "script-event articulation-event",
237 /* acks */ "stem-interface rhythmic-head-interface\
238 new-slur-interface note-column-interface",
239 /* reads */ "scriptDefinitions",