2 fingering-engraver.cc -- implement New_fingering_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 1998--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
11 #include "engraver.hh"
12 #include "side-position-interface.hh"
16 #include "rhythmic-head.hh"
17 #include "self-alignment-interface.hh"
34 note_event_ = finger_event_ = 0;
35 description_ = SCM_EOL;
37 static int compare (Finger_tuple const & c1, Finger_tuple const & c2)
39 return c1.position_- c2.position_;
44 class New_fingering_engraver : public Engraver
46 Array<Finger_tuple> fingerings_;
47 Array<Finger_tuple> articulations_;
48 Link_array<Grob> heads_;
52 TRANSLATOR_DECLARATIONS(New_fingering_engraver);
54 virtual void stop_translation_timestep ();
55 virtual void acknowledge_grob (Grob_info);
56 void add_fingering (Grob*, Music*,Music*);
57 void add_script (Grob*, Music*,Music*);
58 void position_scripts();
62 New_fingering_engraver::acknowledge_grob (Grob_info inf)
64 if (Rhythmic_head::has_interface (inf.grob_))
66 Music * note_ev =inf.music_cause ();
68 SCM arts = note_ev->get_mus_property ("articulations");
70 for (SCM s = arts; gh_pair_p (s); s = gh_cdr (s))
72 Music * m = unsmob_music (gh_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);
92 heads_.push (inf.grob_);
94 else if (Stem::has_interface (inf.grob_))
100 extern Grob *make_script_from_event (SCM * descr, Translator_group*tg, Music * event,
103 New_fingering_engraver::add_script (Grob * head,
109 Grob * g= make_script_from_event (&ft.description_, daddy_trans_, event, 0);
114 articulations_.push (ft);
115 announce_grob (g, event->self_scm ());
117 ft.script_->set_parent (head, X_AXIS);
123 New_fingering_engraver::add_fingering (Grob * head,
129 ft.script_ = new Item (get_property ("Fingering"));
130 announce_grob (ft.script_, event->self_scm());
132 Side_position_interface::add_support (ft.script_, head);
134 int d = gh_scm2int ( event->get_mus_property ("digit"));
139 Should add support for thumb. It's a little involved, since
140 the thumb lives in a different font. Maybe it should be moved?
146 music for the softenon children?
148 event->origin()->warning (_("music for the martians."));
150 SCM sstr = scm_number_to_string (gh_int2scm (d), gh_int2scm (10)) ;
151 ft.script_->set_grob_property ("text", sstr);
153 ft.finger_event_ = event;
154 ft.note_event_ = hevent;
157 fingerings_.push (ft);
161 New_fingering_engraver::position_scripts ()
165 This is not extremely elegant, but we have to do a little
166 formatting here, because the parent/child relations should be
167 known before we move on to the next time step.
169 A more sophisticated approach would be to set both X and Y parents
170 to the note head, and write a more flexible function for
171 positioning the fingerings, setting both X and Y coordinates.
173 for (int i = 0; i < fingerings_.size(); i++)
175 fingerings_[i].position_ = gh_scm2int (fingerings_[i].head_ -> get_grob_property( "staff-position"));
178 for (int i = fingerings_.size(); i--;)
179 for (int j = heads_.size() ; j--;)
180 Side_position_interface::add_support (fingerings_[i].script_, heads_[j]);
182 Array<Finger_tuple> up, down, horiz;
183 for (int i = fingerings_.size(); i--;)
185 SCM d = fingerings_[i].finger_event_->get_mus_property ("direction");
188 ((to_dir (d) == UP) ? up : down ).push (fingerings_[i]);
193 fingerings_.sort (&Finger_tuple::compare);
194 SCM orientations = get_property ("fingeringOrientations");
196 bool up_p = scm_memq (ly_symbol2scm ("up"), orientations) != SCM_BOOL_F;
197 bool down_p = scm_memq (ly_symbol2scm ("down"), orientations) != SCM_BOOL_F;
198 bool left_p = scm_memq (ly_symbol2scm ("left"), orientations) != SCM_BOOL_F;
199 bool right_p = scm_memq (ly_symbol2scm ("right"), orientations) != SCM_BOOL_F;
200 Direction hordir = (right_p) ? RIGHT : LEFT;
201 if (left_p || right_p)
203 if (up_p && !up.size () && fingerings_.size ())
204 up.push (fingerings_.pop());
206 if (down_p && !down.size () && fingerings_.size())
208 down.push (fingerings_[0]);
212 horiz.concat (fingerings_);
214 else if (up_p && down_p)
216 int center = fingerings_.size() / 2;
217 down.concat (fingerings_.slice (0,center));
218 up.concat (fingerings_.slice (center, fingerings_.size()));
222 up.concat (fingerings_);
223 fingerings_ .clear ();
228 warning(_ ("Fingerings are also not down?! Putting them down anyway."));
229 down.concat (fingerings_);
233 for (int i = 0; i < horiz.size(); i++)
235 Finger_tuple ft = horiz[i];
236 Grob* f = ft.script_;
237 f->set_parent (ft.head_, X_AXIS);
238 f->set_parent (ft.head_, Y_AXIS);
239 f->add_offset_callback (Self_alignment_interface::centered_on_parent_proc, Y_AXIS);
240 f->add_offset_callback (Self_alignment_interface::aligned_on_self_proc, Y_AXIS);
241 f->add_offset_callback (Side_position_interface::aligned_side_proc, X_AXIS);
243 f->set_grob_property ("direction", gh_int2scm (hordir));
247 int finger_prio = 200;
248 for (int i = 0; i < up.size(); i++)
250 Finger_tuple ft = up[i];
251 Grob* f = ft.script_;
252 f->set_parent (ft.head_, X_AXIS);
253 f->set_grob_property ("script-priority",
254 gh_int2scm (finger_prio + i));
255 f->add_offset_callback (Side_position_interface::aligned_side_proc, Y_AXIS);
256 f->add_offset_callback (Self_alignment_interface::centered_on_parent_proc, X_AXIS);
257 f->add_offset_callback (Self_alignment_interface::aligned_on_self_proc, X_AXIS);
259 f->set_grob_property ("direction", gh_int2scm (UP));
261 Side_position_interface::add_staff_support (f);
265 for (int i = 0; i < down.size(); i++)
267 Finger_tuple ft = down[i];
268 Grob* f = ft.script_;
269 f->set_parent (ft.head_, X_AXIS);
270 f->set_grob_property ("script-priority",
271 gh_int2scm (finger_prio + down.size() - i));
273 f->add_offset_callback (Self_alignment_interface::centered_on_parent_proc, X_AXIS);
274 f->add_offset_callback (Self_alignment_interface::aligned_on_self_proc, X_AXIS);
275 f->add_offset_callback (Side_position_interface::aligned_side_proc, Y_AXIS);
276 f->set_grob_property ("direction", gh_int2scm (DOWN));
277 Side_position_interface::add_staff_support (f);
283 New_fingering_engraver::stop_translation_timestep ()
285 if (fingerings_.size ())
288 fingerings_.clear ();
291 for (int i = articulations_.size(); i--;)
293 Grob *sc = articulations_[i].script_;
295 for (int j = heads_.size() ; j--;)
296 Side_position_interface::add_support (sc, heads_[j]);
298 if (stem_ && to_dir (sc->get_grob_property ("side-relative-direction")))
299 sc->set_grob_property ("direction-source", stem_->self_scm ());
301 SCM follow = scm_assoc (ly_symbol2scm ("follow-into-staff"), articulations_[i].description_);
302 if (gh_pair_p (follow) && to_boolean (gh_cdr (follow)))
303 sc->add_offset_callback (Side_position_interface::quantised_position_proc, Y_AXIS);
305 Side_position_interface::add_staff_support (sc);
311 articulations_.clear();
315 New_fingering_engraver::New_fingering_engraver()
320 ENTER_DESCRIPTION(New_fingering_engraver,
321 /* descr */ "Create fingering-scripts for notes in a new chord.",
322 /* creats*/ "Fingering",
324 /* acks */ "rhythmic-head-interface stem-interface",
325 /* reads */ "fingeringOrientations",