2 fingering-engraver.cc -- implement New_fingering_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 1998--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
11 #include "international.hh"
12 #include "rhythmic-head.hh"
13 #include "script-interface.hh"
14 #include "self-alignment-interface.hh"
15 #include "side-position-interface.hh"
17 #include "stream-event.hh"
20 #include "translator.icc"
26 Stream_event *note_event_;
27 Stream_event *finger_event_;
28 bool follow_into_staff_;
35 note_event_ = finger_event_ = 0;
36 follow_into_staff_ = false;
41 operator< (Finger_tuple const &a, Finger_tuple const &b)
43 return a.position_ < b.position_;
46 class New_fingering_engraver : public Engraver
48 vector<Finger_tuple> fingerings_;
49 vector<Finger_tuple> articulations_;
50 vector<Finger_tuple> string_numbers_;
57 TRANSLATOR_DECLARATIONS (New_fingering_engraver);
59 void stop_translation_timestep ();
60 DECLARE_ACKNOWLEDGER (rhythmic_head);
61 DECLARE_ACKNOWLEDGER (stem);
62 void add_fingering (Grob *, Stream_event *, Stream_event *);
63 void add_script (Grob *, Stream_event *, Stream_event *);
64 void add_string (Grob *, Stream_event *, Stream_event *);
65 void position_scripts (SCM orientations, vector<Finger_tuple> *);
69 New_fingering_engraver::acknowledge_rhythmic_head (Grob_info inf)
71 Stream_event *note_ev = inf.event_cause ();
75 SCM arts = note_ev->get_property ("articulations");
77 for (SCM s = arts; scm_is_pair (s); s = scm_cdr (s))
79 Stream_event *ev = unsmob_stream_event (scm_car (s));
84 if (ev->in_event_class ("fingering-event"))
85 add_fingering (inf.grob (), ev, note_ev);
86 else if (ev->in_event_class ("text-script-event"))
87 ev->origin ()->warning (_ ("can't add text scripts to individual note heads"));
88 else if (ev->in_event_class ("script-event"))
89 add_script (inf.grob (), ev, note_ev);
90 else if (ev->in_event_class ("string-number-event"))
91 add_string (inf.grob (), ev, note_ev);
92 else if (ev->in_event_class ("harmonic-event"))
94 inf.grob ()->set_property ("style", ly_symbol2scm ("harmonic"));
95 Grob *d = unsmob_grob (inf.grob ()->get_object ("dot"));
101 heads_.push_back (inf.grob ());
105 New_fingering_engraver::acknowledge_stem (Grob_info inf)
111 New_fingering_engraver::add_script (Grob *head,
119 Grob *g = make_item ("Script", event->self_scm ());
120 make_script_from_event (g, context (), event->get_property ("articulation-type"), 0);
124 ft.script_->set_parent (head, X_AXIS);
126 articulations_.push_back (ft);
131 New_fingering_engraver::add_fingering (Grob *head,
133 Stream_event *hevent)
137 ft.script_ = make_item ("Fingering", event->self_scm ());
139 Side_position_interface::add_support (ft.script_, head);
144 Should add support for thumb. It's a little involved, since
145 the thumb lives in a different font. Maybe it should be moved?
148 ft.finger_event_ = event;
149 ft.note_event_ = hevent;
152 fingerings_.push_back (ft);
156 New_fingering_engraver::add_string (Grob *head,
158 Stream_event *hevent)
162 ft.script_ = make_item ("StringNumber", event->self_scm ());
164 Side_position_interface::add_support (ft.script_, head);
166 ft.finger_event_ = event;
167 ft.note_event_ = hevent;
170 string_numbers_.push_back (ft);
174 New_fingering_engraver::position_scripts (SCM orientations,
175 vector<Finger_tuple> *scripts)
177 for (vsize i = 0; i < scripts->size (); i++)
178 if (stem_ && to_boolean (scripts->at (i).script_->get_property ("add-stem-support")))
179 Side_position_interface::add_support (scripts->at (i).script_, stem_);
182 This is not extremely elegant, but we have to do a little
183 formatting here, because the parent/child relations should be
184 known before we move on to the next time step.
186 A more sophisticated approach would be to set both X and Y parents
187 to the note head, and write a more flexible function for
188 positioning the fingerings, setting both X and Y coordinates.
190 for (vsize i = 0; i < scripts->size (); i++)
191 (*scripts)[i].position_ = scm_to_int ((*scripts)[i].head_->get_property ("staff-position"));
193 for (vsize i = scripts->size (); i--;)
194 for (vsize j = heads_.size (); j--;)
195 Side_position_interface::add_support ((*scripts)[i].script_, heads_[j]);
197 vector<Finger_tuple> up, down, horiz;
198 for (vsize i = scripts->size (); i--;)
200 SCM d = (*scripts)[i].finger_event_->get_property ("direction");
203 ((to_dir (d) == UP) ? up : down).push_back ((*scripts)[i]);
204 scripts->erase (scripts->begin () + i);
208 vector_sort (*scripts, less<Finger_tuple> ());
210 bool up_p = scm_c_memq (ly_symbol2scm ("up"), orientations) != SCM_BOOL_F;
211 bool down_p = scm_c_memq (ly_symbol2scm ("down"), orientations) != SCM_BOOL_F;
212 bool left_p = scm_c_memq (ly_symbol2scm ("left"), orientations) != SCM_BOOL_F;
213 bool right_p = scm_c_memq (ly_symbol2scm ("right"), orientations) != SCM_BOOL_F;
214 Direction hordir = (right_p) ? RIGHT : LEFT;
215 if (left_p || right_p)
217 if (up_p && !up.size () && scripts->size ())
219 up.push_back (scripts->back ());
220 scripts->pop_back ();
223 if (down_p && !down.size () && scripts->size ())
225 down.push_back ((*scripts)[0]);
226 scripts->erase (scripts->begin ());
229 horiz.insert (horiz.end (), scripts->begin (), scripts->end ());
231 else if (up_p && down_p)
233 int center = scripts->size () / 2;
234 down.insert (down.end (), scripts->begin (), scripts->begin () + center);
235 up.insert (up.end (), scripts->begin () + center, scripts->end ());
239 up.insert (up.end (), scripts->begin (), scripts->end ());
246 warning (_ ("no placement found for fingerings"));
247 warning (_ ("placing below"));
249 down.insert (down.end (), scripts->begin (), scripts->end ());
253 for (vsize i = 0; i < horiz.size (); i++)
255 Finger_tuple ft = horiz[i];
256 Grob *f = ft.script_;
257 f->set_parent (ft.head_, X_AXIS);
258 f->set_parent (ft.head_, Y_AXIS);
260 Self_alignment_interface::set_align_self (f, Y_AXIS);
261 Self_alignment_interface::set_center_parent (f, Y_AXIS);
262 Side_position_interface::set_axis (f, X_AXIS);
264 f->set_property ("direction", scm_from_int (hordir));
267 int finger_prio = 200;
270 Drul_array< vector<Finger_tuple> > vertical (down, up);
273 for (vsize i = 0; i < vertical[d].size (); i++)
275 Finger_tuple ft = vertical[d][i];
276 Grob *f = ft.script_;
277 f->set_parent (ft.head_, X_AXIS);
278 f->set_property ("script-priority",
279 scm_from_int (finger_prio + d * ft.position_));
281 Self_alignment_interface::set_align_self (f, X_AXIS);
282 Self_alignment_interface::set_center_parent (f, X_AXIS);
283 Side_position_interface::set_axis (f, Y_AXIS);
285 f->set_property ("direction", scm_from_int (d));
288 while (flip (&d) != DOWN);
292 New_fingering_engraver::stop_translation_timestep ()
301 New_fingering_engraver::position_all ()
303 if (fingerings_.size ())
305 position_scripts (get_property ("fingeringOrientations"),
307 fingerings_.clear ();
310 if (string_numbers_.size ())
312 position_scripts (get_property ("stringNumberOrientations"),
314 string_numbers_.clear ();
317 for (vsize i = articulations_.size (); i--;)
319 Grob *script = articulations_[i].script_;
321 for (vsize j = heads_.size (); j--;)
322 Side_position_interface::add_support (script, heads_[j]);
324 if (stem_ && to_dir (script->get_property ("side-relative-direction")))
325 script->set_object ("direction-source", stem_->self_scm ());
327 if (stem_ && to_boolean (script->get_property ("add-stem-support")))
328 Side_position_interface::add_support (script, stem_);
330 articulations_.clear ();
333 New_fingering_engraver::New_fingering_engraver ()
339 ADD_ACKNOWLEDGER (New_fingering_engraver, rhythmic_head);
340 ADD_ACKNOWLEDGER (New_fingering_engraver, stem);
342 ADD_TRANSLATOR (New_fingering_engraver,
343 /* doc */ "Create fingering-scripts for notes in a new chord. "
344 "This engraver is ill-named, since it "
345 "also takes care of articulations and harmonic note heads",
351 "fingeringOrientations "
352 "stringNumberOrientations "