2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
6 LilyPond is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 LilyPond is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
20 #include "engraver.hh"
23 #include "directional-element-interface.hh"
24 #include "international.hh"
25 #include "note-column.hh"
26 #include "paper-column.hh"
27 #include "rhythmic-head.hh"
28 #include "script-interface.hh"
29 #include "side-position-interface.hh"
31 #include "staff-symbol-referencer.hh"
33 #include "stream-event.hh"
36 #include "translator.icc"
49 class Script_engraver : public Engraver
51 vector<Script_tuple> scripts_;
54 void stop_translation_timestep ();
55 void process_music ();
57 void listen_articulation (Stream_event *);
58 void acknowledge_rhythmic_head (Grob_info);
59 void acknowledge_stem (Grob_info);
60 void acknowledge_stem_tremolo (Grob_info);
61 void acknowledge_tie (Grob_info);
62 void acknowledge_end_tie (Grob_info);
63 void acknowledge_note_column (Grob_info);
64 void acknowledge_inline_accidental (Grob_info);
67 TRANSLATOR_DECLARATIONS (Script_engraver);
70 Script_engraver::Script_engraver ()
75 Script_engraver::listen_articulation (Stream_event *ev)
77 /* Discard double articulations for part-combining. */
78 for (vsize i = 0; i < scripts_.size (); i++)
79 if (ly_is_equal (scripts_[i].event_
80 ->get_property ("articulation-type"),
81 ev->get_property ("articulation-type")))
86 scripts_.push_back (t);
90 copy_property (Grob *g, SCM sym, SCM alist)
92 if (scm_is_null (g->get_property (sym)))
94 SCM entry = scm_assoc (sym, alist);
95 if (scm_is_pair (entry))
96 g->set_property (sym, scm_cdr (entry));
100 /* Add the properties, one by one for each Script. A little memory
101 could be saved by tacking the props onto the Script grob (i.e. make
102 ScriptStaccato , ScriptMarcato, etc. ).
105 make_script_from_event (Grob *p, Context *tg,
106 SCM art_type, int index)
108 SCM alist = tg->get_property ("scriptDefinitions");
109 SCM art = scm_assoc (art_type, alist);
111 if (scm_is_false (art))
114 warning (_ ("do not know how to interpret articulation:"));
115 warning (_ (" scheme encoding: "));
116 scm_write (art_type, scm_current_error_port ());
123 bool priority_found = false;
125 for (SCM s = art; scm_is_pair (s); s = scm_cdr (s))
127 SCM sym = scm_caar (s);
128 SCM type = scm_object_property (sym, ly_symbol2scm ("backend-type?"));
129 if (!ly_is_procedure (type))
132 SCM val = scm_cdar (s);
134 if (scm_is_eq (sym, ly_symbol2scm ("script-priority")))
136 priority_found = true;
137 /* Make sure they're in order of user input by adding index i.
138 Don't use the direction in this priority. Smaller means closer
140 int prio = scm_to_int (val) + index;
142 val = scm_from_int (prio);
145 SCM preset = p->get_property_data (sym);
146 if (scm_is_null (val)
147 || scm_is_false (scm_call_1 (type, preset)))
148 p->set_property (sym, val);
153 p->set_property ("script-priority",
154 scm_from_int (index));
159 Script_engraver::process_music ()
161 for (vsize i = 0; i < scripts_.size (); i++)
163 Stream_event *ev = scripts_[i].event_;
165 Grob *p = make_item ("Script", ev->self_scm ());
167 make_script_from_event (p, context (),
168 ev->get_property ("articulation-type"),
171 scripts_[i].script_ = p;
173 SCM force_dir = ev->get_property ("direction");
174 if (is_direction (force_dir) && to_dir (force_dir))
175 p->set_property ("direction", force_dir);
180 Script_engraver::acknowledge_stem (Grob_info info)
182 for (vsize i = 0; i < scripts_.size (); i++)
184 Grob *e = scripts_[i].script_;
186 if (to_dir (e->get_property ("side-relative-direction")))
187 e->set_object ("direction-source", info.grob ()->self_scm ());
189 Side_position_interface::add_support (e, info.grob ());
194 Script_engraver::acknowledge_stem_tremolo (Grob_info info)
196 for (vsize i = 0; i < scripts_.size (); i++)
198 Grob *e = scripts_[i].script_;
199 Side_position_interface::add_support (e, info.grob ());
204 Script_engraver::acknowledge_tie (Grob_info info)
206 for (vsize i = 0; i < scripts_.size (); i++)
208 Grob *e = scripts_[i].script_;
209 Side_position_interface::add_support (e, info.grob ());
214 Script_engraver::acknowledge_end_tie (Grob_info info)
216 for (vsize i = 0; i < scripts_.size (); i++)
218 Grob *e = scripts_[i].script_;
219 Side_position_interface::add_support (e, info.grob ());
224 Script_engraver::acknowledge_inline_accidental (Grob_info info)
226 for (vsize i = 0; i < scripts_.size (); i++)
228 Grob *e = scripts_[i].script_;
229 Side_position_interface::add_support (e, info.grob ());
234 Script_engraver::acknowledge_rhythmic_head (Grob_info info)
236 if (info.event_cause ())
238 for (vsize i = 0; i < scripts_.size (); i++)
240 Grob *e = scripts_[i].script_;
242 if (Side_position_interface::get_axis (e) == X_AXIS
243 && !e->get_parent (Y_AXIS))
245 e->set_parent (info.grob (), Y_AXIS);
247 Side_position_interface::add_support (e, info.grob ());
253 Script_engraver::acknowledge_note_column (Grob_info info)
255 /* Make note column the parent of the script. That is not
256 correct, but due to seconds in a chord, noteheads may be
257 swapped around horizontally.
259 As the note head to put it on is not known now, postpone this
260 decision to Script_interface::calc_direction (). */
261 for (vsize i = 0; i < scripts_.size (); i++)
263 Grob *e = scripts_[i].script_;
265 if (!e->get_parent (X_AXIS)
266 && Side_position_interface::get_axis (e) == Y_AXIS)
267 e->set_parent (info.grob (), X_AXIS);
272 Script_engraver::stop_translation_timestep ()
279 Script_engraver::boot ()
281 ADD_LISTENER (Script_engraver, articulation);
282 ADD_ACKNOWLEDGER (Script_engraver, rhythmic_head);
283 ADD_ACKNOWLEDGER (Script_engraver, stem);
284 ADD_ACKNOWLEDGER (Script_engraver, tie);
285 ADD_END_ACKNOWLEDGER (Script_engraver, tie);
286 ADD_ACKNOWLEDGER (Script_engraver, note_column);
287 ADD_ACKNOWLEDGER (Script_engraver, stem_tremolo);
288 ADD_ACKNOWLEDGER (Script_engraver, inline_accidental);
291 ADD_TRANSLATOR (Script_engraver,
293 "Handle note scripted articulations.",
299 "scriptDefinitions ",