2 fingering-engraver.cc -- implement New_fingering_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 1998--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
10 #include "engraver.hh"
11 #include "side-position-interface.hh"
13 #include "rhythmic-head.hh"
14 #include "self-alignment-interface.hh"
15 #include "script-interface.hh"
24 bool follow_into_staff_;
31 note_event_ = finger_event_ = 0;
32 follow_into_staff_ = false;
34 static int compare (Finger_tuple const &c1, Finger_tuple const &c2)
36 return c1.position_- c2.position_;
40 class New_fingering_engraver : public Engraver
42 Array<Finger_tuple> fingerings_;
43 Array<Finger_tuple> articulations_;
44 Array<Finger_tuple> string_numbers_;
46 Link_array<Grob> heads_;
50 TRANSLATOR_DECLARATIONS (New_fingering_engraver);
52 virtual void stop_translation_timestep ();
53 virtual void acknowledge_grob (Grob_info);
54 void add_fingering (Grob *, Music *, Music *);
55 void add_script (Grob *, Music *, Music *);
56 void add_string (Grob *, Music *, Music *);
57 void position_scripts (SCM orientations, Array<Finger_tuple> *);
61 New_fingering_engraver::acknowledge_grob (Grob_info inf)
63 if (Rhythmic_head::has_interface (inf.grob_))
65 Music *note_ev = inf.music_cause ();
69 SCM arts = note_ev->get_property ("articulations");
71 for (SCM s = arts; scm_is_pair (s); s = scm_cdr (s))
73 Music *m = unsmob_music (scm_car (s));
78 if (m->is_mus_type ("fingering-event"))
80 add_fingering (inf.grob_, m, note_ev);
82 else if (m->is_mus_type ("text-script-event"))
84 m->origin ()->warning ("Can not add text scripts to individual note heads");
86 else if (m->is_mus_type ("script-event"))
88 add_script (inf.grob_, m, note_ev);
90 else if (m->is_mus_type ("string-number-event"))
92 add_string (inf.grob_, m, note_ev);
94 else if (m->is_mus_type ("harmonic-event"))
96 inf.grob_->set_property ("style", ly_symbol2scm ("harmonic"));
97 Grob *d = unsmob_grob (inf.grob_->get_property ("dot"));
103 heads_.push (inf.grob_);
105 else if (Stem::has_interface (inf.grob_))
112 New_fingering_engraver::add_script (Grob *head,
120 Grob *g = make_item ("Script", event->self_scm ());
121 make_script_from_event (g, &ft.follow_into_staff_, context (),
122 event->get_property ("articulation-type"), 0);
127 articulations_.push (ft);
129 ft.script_->set_parent (head, X_AXIS);
134 New_fingering_engraver::add_fingering (Grob *head,
140 ft.script_ = make_item ("Fingering", event->self_scm ());
142 Side_position_interface::add_support (ft.script_, head);
144 int d = scm_to_int (event->get_property ("digit"));
149 Should add support for thumb. It's a little involved, since
150 the thumb lives in a different font. Maybe it should be moved?
156 music for the softenon children?
158 event->origin ()->warning (_ ("music for the martians."));
160 SCM sstr = scm_number_to_string (scm_int2num (d), scm_int2num (10));
161 ft.script_->set_property ("text", sstr);
163 ft.finger_event_ = event;
164 ft.note_event_ = hevent;
167 fingerings_.push (ft);
172 New_fingering_engraver::add_string (Grob *head,
178 ft.script_ = make_item ("StringNumber", event->self_scm ());
180 Side_position_interface::add_support (ft.script_, head);
182 int d = scm_to_int (event->get_property ("string-number"));
184 SCM sstr = scm_number_to_string (scm_int2num (d), scm_int2num (10));
185 ft.script_->set_property ("text", sstr);
187 ft.finger_event_ = event;
188 ft.note_event_ = hevent;
191 string_numbers_.push (ft);
195 New_fingering_engraver::position_scripts (SCM orientations,
196 Array<Finger_tuple> *scripts)
198 for (int i = 0; i < scripts->size (); i++)
199 if (stem_ && to_boolean (scripts->elem (i).script_->get_property ("add-stem-support")))
200 Side_position_interface::add_support (scripts->elem (i).script_, stem_);
203 This is not extremely elegant, but we have to do a little
204 formatting here, because the parent/child relations should be
205 known before we move on to the next time step.
207 A more sophisticated approach would be to set both X and Y parents
208 to the note head, and write a more flexible function for
209 positioning the fingerings, setting both X and Y coordinates.
211 for (int i = 0; i < scripts->size (); i++)
213 (*scripts)[i].position_ = scm_to_int ((*scripts)[i].head_->get_property ("staff-position"));
216 for (int i = scripts->size (); i--;)
217 for (int j = heads_.size (); j--;)
218 Side_position_interface::add_support ((*scripts)[i].script_, heads_[j]);
220 Array<Finger_tuple> up, down, horiz;
221 for (int i = scripts->size (); i--;)
223 SCM d = (*scripts)[i].finger_event_->get_property ("direction");
226 ((to_dir (d) == UP) ? up : down).push ((*scripts)[i]);
231 scripts->sort (&Finger_tuple::compare);
233 bool up_p = scm_c_memq (ly_symbol2scm ("up"), orientations) != SCM_BOOL_F;
234 bool down_p = scm_c_memq (ly_symbol2scm ("down"), orientations) != SCM_BOOL_F;
235 bool left_p = scm_c_memq (ly_symbol2scm ("left"), orientations) != SCM_BOOL_F;
236 bool right_p = scm_c_memq (ly_symbol2scm ("right"), orientations) != SCM_BOOL_F;
237 Direction hordir = (right_p) ? RIGHT : LEFT;
238 if (left_p || right_p)
240 if (up_p && !up.size () && scripts->size ())
241 up.push (scripts->pop ());
243 if (down_p && !down.size () && scripts->size ())
245 down.push ((*scripts)[0]);
249 horiz.concat (*scripts);
251 else if (up_p && down_p)
253 int center = scripts->size () / 2;
254 down.concat (scripts->slice (0, center));
255 up.concat (scripts->slice (center, scripts->size ()));
259 up.concat (*scripts);
265 warning (_ ("Fingerings are also not down?! Putting them down anyway."));
266 down.concat (*scripts);
270 for (int i = 0; i < horiz.size (); i++)
272 Finger_tuple ft = horiz[i];
273 Grob *f = ft.script_;
274 f->set_parent (ft.head_, X_AXIS);
275 f->set_parent (ft.head_, Y_AXIS);
276 f->add_offset_callback (Self_alignment_interface::centered_on_parent_proc, Y_AXIS);
277 f->add_offset_callback (Self_alignment_interface::aligned_on_self_proc, Y_AXIS);
278 f->add_offset_callback (Side_position_interface::aligned_side_proc, X_AXIS);
280 f->set_property ("direction", scm_int2num (hordir));
283 int finger_prio = 200;
284 for (int i = 0; i < up.size (); i++)
286 Finger_tuple ft = up[i];
287 Grob *f = ft.script_;
288 f->set_parent (ft.head_, X_AXIS);
289 f->set_property ("script-priority",
290 scm_int2num (finger_prio + ft.position_));
291 f->add_offset_callback (Side_position_interface::aligned_side_proc, Y_AXIS);
292 f->add_offset_callback (Self_alignment_interface::centered_on_parent_proc, X_AXIS);
293 f->add_offset_callback (Self_alignment_interface::aligned_on_self_proc, X_AXIS);
295 f->set_property ("direction", scm_int2num (UP));
298 for (int i = 0; i < down.size (); i++)
300 Finger_tuple ft = down[i];
301 Grob *f = ft.script_;
302 f->set_parent (ft.head_, X_AXIS);
303 f->set_property ("script-priority",
304 scm_int2num (finger_prio + down.size () - ft.position_));
306 f->add_offset_callback (Self_alignment_interface::centered_on_parent_proc, X_AXIS);
307 f->add_offset_callback (Self_alignment_interface::aligned_on_self_proc, X_AXIS);
308 f->add_offset_callback (Side_position_interface::aligned_side_proc, Y_AXIS);
309 f->set_property ("direction", scm_int2num (DOWN));
314 New_fingering_engraver::stop_translation_timestep ()
316 if (fingerings_.size ())
318 position_scripts (get_property ("fingeringOrientations"),
320 fingerings_.clear ();
323 if (string_numbers_.size ())
325 position_scripts (get_property ("stringNumberOrientations"),
327 string_numbers_.clear ();
330 for (int i = articulations_.size (); i--;)
332 Grob *script = articulations_[i].script_;
334 for (int j = heads_.size (); j--;)
335 Side_position_interface::add_support (script, heads_[j]);
337 if (stem_ && to_dir (script->get_property ("side-relative-direction")))
338 script->set_property ("direction-source", stem_->self_scm ());
340 if (stem_ && to_boolean (script->get_property ("add-stem-support")))
341 Side_position_interface::add_support (script, stem_);
343 if (articulations_[i].follow_into_staff_)
345 script->add_offset_callback (Side_position_interface::quantised_position_proc, Y_AXIS);
346 script->set_property ("staff-padding", SCM_EOL);
352 articulations_.clear ();
355 New_fingering_engraver::New_fingering_engraver ()
360 ADD_TRANSLATOR (New_fingering_engraver,
361 /* descr */ "Create fingering-scripts for notes in a new chord. "
362 "This engraver is ill-named, since it "
363 "also takes care of articulations and harmonic note heads",
364 /* creats*/ "Fingering",
366 /* acks */ "rhythmic-head-interface stem-interface",
367 /* reads */ "fingeringOrientations",