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_;
41 class New_fingering_engraver : public Engraver
43 Array<Finger_tuple> fingerings_;
44 Array<Finger_tuple> articulations_;
45 Link_array<Grob> heads_;
49 TRANSLATOR_DECLARATIONS (New_fingering_engraver);
51 virtual void stop_translation_timestep ();
52 virtual void acknowledge_grob (Grob_info);
53 void add_fingering (Grob *, Music *, Music *);
54 void add_script (Grob *, Music *, Music *);
55 void position_scripts ();
59 New_fingering_engraver::acknowledge_grob (Grob_info inf)
61 if (Rhythmic_head::has_interface (inf.grob_))
63 Music *note_ev = inf.music_cause ();
67 SCM arts = note_ev->get_property ("articulations");
69 for (SCM s = arts; scm_is_pair (s); s = scm_cdr (s))
71 Music *m = unsmob_music (scm_car (s));
76 if (m->is_mus_type ("fingering-event"))
78 add_fingering (inf.grob_, m, note_ev);
80 else if (m->is_mus_type ("text-script-event"))
82 m->origin ()->warning ("Can not add text scripts to individual note heads");
84 else if (m->is_mus_type ("script-event"))
86 add_script (inf.grob_, m, note_ev);
88 else if (m->is_mus_type ("harmonic-event"))
90 inf.grob_->set_property ("style", ly_symbol2scm ("harmonic"));
91 Grob *d = unsmob_grob (inf.grob_->get_property ("dot"));
97 heads_.push (inf.grob_);
99 else if (Stem::has_interface (inf.grob_))
106 New_fingering_engraver::add_script (Grob *head,
112 Grob *g = make_item ("Script", event->self_scm ());
113 make_script_from_event (g, &ft.follow_into_staff_, context (),
114 event->get_property ("articulation-type"), 0);
119 articulations_.push (ft);
121 ft.script_->set_parent (head, X_AXIS);
126 New_fingering_engraver::add_fingering (Grob *head,
132 ft.script_ = make_item ("Fingering", event->self_scm ());
134 Side_position_interface::add_support (ft.script_, head);
136 int d = scm_to_int (event->get_property ("digit"));
141 Should add support for thumb. It's a little involved, since
142 the thumb lives in a different font. Maybe it should be moved?
148 music for the softenon children?
150 event->origin ()->warning (_ ("music for the martians."));
152 SCM sstr = scm_number_to_string (scm_int2num (d), scm_int2num (10));
153 ft.script_->set_property ("text", sstr);
155 ft.finger_event_ = event;
156 ft.note_event_ = hevent;
159 fingerings_.push (ft);
163 New_fingering_engraver::position_scripts ()
167 This is not extremely elegant, but we have to do a little
168 formatting here, because the parent/child relations should be
169 known before we move on to the next time step.
171 A more sophisticated approach would be to set both X and Y parents
172 to the note head, and write a more flexible function for
173 positioning the fingerings, setting both X and Y coordinates.
175 for (int i = 0; i < fingerings_.size (); i++)
177 fingerings_[i].position_ = scm_to_int (fingerings_[i].head_ -> get_property ("staff-position"));
180 for (int i = fingerings_.size (); i--;)
181 for (int j = heads_.size (); j--;)
182 Side_position_interface::add_support (fingerings_[i].script_, heads_[j]);
184 Array<Finger_tuple> up, down, horiz;
185 for (int i = fingerings_.size (); i--;)
187 SCM d = fingerings_[i].finger_event_->get_property ("direction");
190 ((to_dir (d) == UP) ? up : down).push (fingerings_[i]);
195 fingerings_.sort (&Finger_tuple::compare);
196 SCM orientations = get_property ("fingeringOrientations");
198 bool up_p = scm_c_memq (ly_symbol2scm ("up"), orientations) != SCM_BOOL_F;
199 bool down_p = scm_c_memq (ly_symbol2scm ("down"), orientations) != SCM_BOOL_F;
200 bool left_p = scm_c_memq (ly_symbol2scm ("left"), orientations) != SCM_BOOL_F;
201 bool right_p = scm_c_memq (ly_symbol2scm ("right"), orientations) != SCM_BOOL_F;
202 Direction hordir = (right_p) ? RIGHT : LEFT;
203 if (left_p || right_p)
205 if (up_p && !up.size () && fingerings_.size ())
206 up.push (fingerings_.pop ());
208 if (down_p && !down.size () && fingerings_.size ())
210 down.push (fingerings_[0]);
214 horiz.concat (fingerings_);
216 else if (up_p && down_p)
218 int center = fingerings_.size () / 2;
219 down.concat (fingerings_.slice (0, center));
220 up.concat (fingerings_.slice (center, fingerings_.size ()));
224 up.concat (fingerings_);
225 fingerings_ .clear ();
230 warning (_ ("Fingerings are also not down?! Putting them down anyway."));
231 down.concat (fingerings_);
232 fingerings_.clear ();
235 for (int i = 0; i < horiz.size (); i++)
237 Finger_tuple ft = horiz[i];
238 Grob *f = ft.script_;
239 f->set_parent (ft.head_, X_AXIS);
240 f->set_parent (ft.head_, Y_AXIS);
241 f->add_offset_callback (Self_alignment_interface::centered_on_parent_proc, Y_AXIS);
242 f->add_offset_callback (Self_alignment_interface::aligned_on_self_proc, Y_AXIS);
243 f->add_offset_callback (Side_position_interface::aligned_side_proc, X_AXIS);
245 f->set_property ("direction", scm_int2num (hordir));
248 int finger_prio = 200;
249 for (int i = 0; i < up.size (); i++)
251 Finger_tuple ft = up[i];
252 Grob *f = ft.script_;
253 f->set_parent (ft.head_, X_AXIS);
254 f->set_property ("script-priority",
255 scm_int2num (finger_prio + i));
256 f->add_offset_callback (Side_position_interface::aligned_side_proc, Y_AXIS);
257 f->add_offset_callback (Self_alignment_interface::centered_on_parent_proc, X_AXIS);
258 f->add_offset_callback (Self_alignment_interface::aligned_on_self_proc, X_AXIS);
260 f->set_property ("direction", scm_int2num (UP));
264 for (int i = 0; i < down.size (); i++)
266 Finger_tuple ft = down[i];
267 Grob *f = ft.script_;
268 f->set_parent (ft.head_, X_AXIS);
269 f->set_property ("script-priority",
270 scm_int2num (finger_prio + down.size () - i));
272 f->add_offset_callback (Self_alignment_interface::centered_on_parent_proc, X_AXIS);
273 f->add_offset_callback (Self_alignment_interface::aligned_on_self_proc, X_AXIS);
274 f->add_offset_callback (Side_position_interface::aligned_side_proc, Y_AXIS);
275 f->set_property ("direction", scm_int2num (DOWN));
280 New_fingering_engraver::stop_translation_timestep ()
282 if (fingerings_.size ())
284 for (int i = 0; i < fingerings_.size (); i++)
285 if (stem_ && to_boolean (fingerings_[i].script_->get_property ("add-stem-support")))
286 Side_position_interface::add_support (fingerings_[i].script_, stem_);
288 fingerings_.clear ();
291 for (int i = articulations_.size (); i--;)
293 Grob *script = articulations_[i].script_;
295 for (int j = heads_.size (); j--;)
296 Side_position_interface::add_support (script, heads_[j]);
298 if (stem_ && to_dir (script->get_property ("side-relative-direction")))
299 script->set_property ("direction-source", stem_->self_scm ());
301 if (stem_ && to_boolean (script->get_property ("add-stem-support")))
302 Side_position_interface::add_support (script, stem_);
304 if (articulations_[i].follow_into_staff_)
306 script->add_offset_callback (Side_position_interface::quantised_position_proc, Y_AXIS);
307 script->set_property ("staff-padding", SCM_EOL);
313 articulations_.clear ();
316 New_fingering_engraver::New_fingering_engraver ()
321 ADD_TRANSLATOR (New_fingering_engraver,
322 /* descr */ "Create fingering-scripts for notes in a new chord. "
323 "This engraver is ill-named, since it "
324 "also takes care of articulations and harmonic note heads",
325 /* creats*/ "Fingering",
327 /* acks */ "rhythmic-head-interface stem-interface",
328 /* reads */ "fingeringOrientations",