2 fingering-engraver.cc -- implement New_fingering_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 1998--2004 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"
18 #include "script-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 ();
70 SCM arts = note_ev->get_property ("articulations");
72 for (SCM s = arts; ly_c_pair_p (s); s = ly_cdr (s))
74 Music * m = unsmob_music (ly_car (s));
80 if (m->is_mus_type ("fingering-event"))
82 add_fingering (inf.grob_ , m, note_ev);
84 else if (m->is_mus_type ("text-script-event"))
86 m->origin ()->warning ("Can not add text scripts to individual note heads");
88 else if (m->is_mus_type ("script-event"))
90 add_script (inf.grob_, m, note_ev);
92 else if (m->is_mus_type ("harmonic-event"))
94 inf.grob_->set_property ("style", ly_symbol2scm ("harmonic"));
95 Grob * d = unsmob_grob (inf.grob_->get_property ("dot"));
101 heads_.push (inf.grob_);
103 else if (Stem::has_interface (inf.grob_))
110 New_fingering_engraver::add_script (Grob * head,
116 Grob * g= make_item ("Script", event->self_scm () );
117 make_script_from_event (g, &ft.description_, context (),
118 event->get_property ("articulation-type"), 0);
123 articulations_.push (ft);
125 ft.script_->set_parent (head, X_AXIS);
131 New_fingering_engraver::add_fingering (Grob * head,
137 ft.script_ = make_item ("Fingering", event->self_scm () );
139 Side_position_interface::add_support (ft.script_, head);
141 int d = ly_scm2int (event->get_property ("digit"));
146 Should add support for thumb. It's a little involved, since
147 the thumb lives in a different font. Maybe it should be moved?
153 music for the softenon children?
155 event->origin ()->warning (_("music for the martians."));
157 SCM sstr = scm_number_to_string (scm_int2num (d), scm_int2num (10)) ;
158 ft.script_->set_property ("text", sstr);
160 ft.finger_event_ = event;
161 ft.note_event_ = hevent;
164 fingerings_.push (ft);
168 New_fingering_engraver::position_scripts ()
172 This is not extremely elegant, but we have to do a little
173 formatting here, because the parent/child relations should be
174 known before we move on to the next time step.
176 A more sophisticated approach would be to set both X and Y parents
177 to the note head, and write a more flexible function for
178 positioning the fingerings, setting both X and Y coordinates.
180 for (int i = 0; i < fingerings_.size (); i++)
182 fingerings_[i].position_ = ly_scm2int (fingerings_[i].head_ -> get_property ( "staff-position"));
185 for (int i = fingerings_.size (); i--;)
186 for (int j = heads_.size () ; j--;)
187 Side_position_interface::add_support (fingerings_[i].script_, heads_[j]);
189 Array<Finger_tuple> up, down, horiz;
190 for (int i = fingerings_.size (); i--;)
192 SCM d = fingerings_[i].finger_event_->get_property ("direction");
195 ((to_dir (d) == UP) ? up : down ).push (fingerings_[i]);
200 fingerings_.sort (&Finger_tuple::compare);
201 SCM orientations = get_property ("fingeringOrientations");
203 bool up_p = scm_c_memq (ly_symbol2scm ("up"), orientations) != SCM_BOOL_F;
204 bool down_p = scm_c_memq (ly_symbol2scm ("down"), orientations) != SCM_BOOL_F;
205 bool left_p = scm_c_memq (ly_symbol2scm ("left"), orientations) != SCM_BOOL_F;
206 bool right_p = scm_c_memq (ly_symbol2scm ("right"), orientations) != SCM_BOOL_F;
207 Direction hordir = (right_p) ? RIGHT : LEFT;
208 if (left_p || right_p)
210 if (up_p && !up.size () && fingerings_.size ())
211 up.push (fingerings_.pop ());
213 if (down_p && !down.size () && fingerings_.size ())
215 down.push (fingerings_[0]);
219 horiz.concat (fingerings_);
221 else if (up_p && down_p)
223 int center = fingerings_.size () / 2;
224 down.concat (fingerings_.slice (0,center));
225 up.concat (fingerings_.slice (center, fingerings_.size ()));
229 up.concat (fingerings_);
230 fingerings_ .clear ();
235 warning (_ ("Fingerings are also not down?! Putting them down anyway."));
236 down.concat (fingerings_);
237 fingerings_.clear ();
240 for (int i = 0; i < horiz.size (); i++)
242 Finger_tuple ft = horiz[i];
243 Grob* f = ft.script_;
244 f->set_parent (ft.head_, X_AXIS);
245 f->set_parent (ft.head_, Y_AXIS);
246 f->add_offset_callback (Self_alignment_interface::centered_on_parent_proc, Y_AXIS);
247 f->add_offset_callback (Self_alignment_interface::aligned_on_self_proc, Y_AXIS);
248 f->add_offset_callback (Side_position_interface::aligned_side_proc, X_AXIS);
250 f->set_property ("direction", scm_int2num (hordir));
253 int finger_prio = 200;
254 for (int i = 0; i < up.size (); i++)
256 Finger_tuple ft = up[i];
257 Grob* f = ft.script_;
258 f->set_parent (ft.head_, X_AXIS);
259 f->set_property ("script-priority",
260 scm_int2num (finger_prio + i));
261 f->add_offset_callback (Side_position_interface::aligned_side_proc, Y_AXIS);
262 f->add_offset_callback (Self_alignment_interface::centered_on_parent_proc, X_AXIS);
263 f->add_offset_callback (Self_alignment_interface::aligned_on_self_proc, X_AXIS);
265 f->set_property ("direction", scm_int2num (UP));
269 for (int i = 0; i < down.size (); i++)
271 Finger_tuple ft = down[i];
272 Grob* f = ft.script_;
273 f->set_parent (ft.head_, X_AXIS);
274 f->set_property ("script-priority",
275 scm_int2num (finger_prio + down.size () - i));
277 f->add_offset_callback (Self_alignment_interface::centered_on_parent_proc, X_AXIS);
278 f->add_offset_callback (Self_alignment_interface::aligned_on_self_proc, X_AXIS);
279 f->add_offset_callback (Side_position_interface::aligned_side_proc, Y_AXIS);
280 f->set_property ("direction", scm_int2num (DOWN));
285 New_fingering_engraver::stop_translation_timestep ()
287 if (fingerings_.size ())
290 fingerings_.clear ();
293 for (int i = articulations_.size (); i--;)
295 Grob *sc = articulations_[i].script_;
297 for (int j = heads_.size () ; j--;)
298 Side_position_interface::add_support (sc, heads_[j]);
300 if (stem_ && to_dir (sc->get_property ("side-relative-direction")))
301 sc->set_property ("direction-source", stem_->self_scm ());
303 SCM follow = scm_assoc (ly_symbol2scm ("follow-into-staff"), articulations_[i].description_);
304 if (ly_c_pair_p (follow) && to_boolean (ly_cdr (follow)))
306 sc->add_offset_callback (Side_position_interface::quantised_position_proc, Y_AXIS);
307 sc->set_property ("staff-padding" , SCM_EOL);
313 articulations_.clear ();
317 New_fingering_engraver::New_fingering_engraver ()
322 ENTER_DESCRIPTION (New_fingering_engraver,
323 /* descr */ "Create fingering-scripts for notes in a new chord. "
324 "This engraver is ill-named, since it "
325 "also takes care of articulations and harmonic note heads",
326 /* creats*/ "Fingering",
328 /* acks */ "rhythmic-head-interface stem-interface",
329 /* reads */ "fingeringOrientations",