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>
11 #include "engraver.hh"
12 #include "side-position-interface.hh"
14 #include "rhythmic-head.hh"
15 #include "self-alignment-interface.hh"
16 #include "script-interface.hh"
25 bool follow_into_staff_;
32 note_event_ = finger_event_ = 0;
33 follow_into_staff_ = false;
35 static int compare (Finger_tuple const & c1, Finger_tuple const & c2)
37 return c1.position_- c2.position_;
42 class New_fingering_engraver : public Engraver
44 Array<Finger_tuple> fingerings_;
45 Array<Finger_tuple> articulations_;
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 position_scripts ();
60 New_fingering_engraver::acknowledge_grob (Grob_info inf)
62 if (Rhythmic_head::has_interface (inf.grob_))
64 Music * note_ev = inf.music_cause ();
68 SCM arts = note_ev->get_property ("articulations");
70 for (SCM s = arts; scm_is_pair (s); s = scm_cdr (s))
72 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 ("harmonic-event"))
92 inf.grob_->set_property ("style", ly_symbol2scm ("harmonic"));
93 Grob * d = unsmob_grob (inf.grob_->get_property ("dot"));
99 heads_.push (inf.grob_);
101 else if (Stem::has_interface (inf.grob_))
108 New_fingering_engraver::add_script (Grob * head,
114 Grob * g = make_item ("Script", event->self_scm () );
115 make_script_from_event (g, &ft.follow_into_staff_, context (),
116 event->get_property ("articulation-type"), 0);
121 articulations_.push (ft);
123 ft.script_->set_parent (head, X_AXIS);
129 New_fingering_engraver::add_fingering (Grob * head,
135 ft.script_ = make_item ("Fingering", event->self_scm () );
137 Side_position_interface::add_support (ft.script_, head);
139 int d = scm_to_int (event->get_property ("digit"));
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?
151 music for the softenon children?
153 event->origin ()->warning (_("music for the martians."));
155 SCM sstr = scm_number_to_string (scm_int2num (d), scm_int2num (10)) ;
156 ft.script_->set_property ("text", sstr);
158 ft.finger_event_ = event;
159 ft.note_event_ = hevent;
162 fingerings_.push (ft);
166 New_fingering_engraver::position_scripts ()
170 This is not extremely elegant, but we have to do a little
171 formatting here, because the parent/child relations should be
172 known before we move on to the next time step.
174 A more sophisticated approach would be to set both X and Y parents
175 to the note head, and write a more flexible function for
176 positioning the fingerings, setting both X and Y coordinates.
178 for (int i = 0; i < fingerings_.size (); i++)
180 fingerings_[i].position_ = scm_to_int (fingerings_[i].head_ -> get_property ( "staff-position"));
183 for (int i = fingerings_.size (); i--;)
184 for (int j = heads_.size () ; j--;)
185 Side_position_interface::add_support (fingerings_[i].script_, heads_[j]);
187 Array<Finger_tuple> up, down, horiz;
188 for (int i = fingerings_.size (); i--;)
190 SCM d = fingerings_[i].finger_event_->get_property ("direction");
193 ((to_dir (d) == UP) ? up : down ).push (fingerings_[i]);
198 fingerings_.sort (&Finger_tuple::compare);
199 SCM orientations = get_property ("fingeringOrientations");
201 bool up_p = scm_c_memq (ly_symbol2scm ("up"), orientations) != SCM_BOOL_F;
202 bool down_p = scm_c_memq (ly_symbol2scm ("down"), orientations) != SCM_BOOL_F;
203 bool left_p = scm_c_memq (ly_symbol2scm ("left"), orientations) != SCM_BOOL_F;
204 bool right_p = scm_c_memq (ly_symbol2scm ("right"), orientations) != SCM_BOOL_F;
205 Direction hordir = (right_p) ? RIGHT : LEFT;
206 if (left_p || right_p)
208 if (up_p && !up.size () && fingerings_.size ())
209 up.push (fingerings_.pop ());
211 if (down_p && !down.size () && fingerings_.size ())
213 down.push (fingerings_[0]);
217 horiz.concat (fingerings_);
219 else if (up_p && down_p)
221 int center = fingerings_.size () / 2;
222 down.concat (fingerings_.slice (0, center));
223 up.concat (fingerings_.slice (center, fingerings_.size ()));
227 up.concat (fingerings_);
228 fingerings_ .clear ();
233 warning (_ ("Fingerings are also not down?! Putting them down anyway."));
234 down.concat (fingerings_);
235 fingerings_.clear ();
238 for (int i = 0; i < horiz.size (); i++)
240 Finger_tuple ft = horiz[i];
241 Grob* f = ft.script_;
242 f->set_parent (ft.head_, X_AXIS);
243 f->set_parent (ft.head_, Y_AXIS);
244 f->add_offset_callback (Self_alignment_interface::centered_on_parent_proc, Y_AXIS);
245 f->add_offset_callback (Self_alignment_interface::aligned_on_self_proc, Y_AXIS);
246 f->add_offset_callback (Side_position_interface::aligned_side_proc, X_AXIS);
248 f->set_property ("direction", scm_int2num (hordir));
251 int finger_prio = 200;
252 for (int i = 0; i < up.size (); i++)
254 Finger_tuple ft = up[i];
255 Grob* f = ft.script_;
256 f->set_parent (ft.head_, X_AXIS);
257 f->set_property ("script-priority",
258 scm_int2num (finger_prio + i));
259 f->add_offset_callback (Side_position_interface::aligned_side_proc, Y_AXIS);
260 f->add_offset_callback (Self_alignment_interface::centered_on_parent_proc, X_AXIS);
261 f->add_offset_callback (Self_alignment_interface::aligned_on_self_proc, X_AXIS);
263 f->set_property ("direction", scm_int2num (UP));
267 for (int i = 0; i < down.size (); i++)
269 Finger_tuple ft = down[i];
270 Grob* f = ft.script_;
271 f->set_parent (ft.head_, X_AXIS);
272 f->set_property ("script-priority",
273 scm_int2num (finger_prio + down.size () - i));
275 f->add_offset_callback (Self_alignment_interface::centered_on_parent_proc, X_AXIS);
276 f->add_offset_callback (Self_alignment_interface::aligned_on_self_proc, X_AXIS);
277 f->add_offset_callback (Side_position_interface::aligned_side_proc, Y_AXIS);
278 f->set_property ("direction", scm_int2num (DOWN));
283 New_fingering_engraver::stop_translation_timestep ()
285 if (fingerings_.size ())
287 for (int i = 0; i < fingerings_.size(); i++)
288 if (stem_ && to_boolean (fingerings_[i].script_->get_property ("add-stem-support")))
289 Side_position_interface::add_support (fingerings_[i].script_, stem_);
291 fingerings_.clear ();
294 for (int i = articulations_.size (); i--;)
296 Grob *script = articulations_[i].script_;
298 for (int j = heads_.size () ; j--;)
299 Side_position_interface::add_support (script, heads_[j]);
301 if (stem_ && to_dir (script->get_property ("side-relative-direction")))
302 script->set_property ("direction-source", stem_->self_scm ());
305 if (stem_ && to_boolean (script->get_property ("add-stem-support")))
306 Side_position_interface::add_support (script, stem_);
308 if (articulations_[i].follow_into_staff_)
310 script->add_offset_callback (Side_position_interface::quantised_position_proc, Y_AXIS);
311 script->set_property ("staff-padding" , SCM_EOL);
317 articulations_.clear ();
321 New_fingering_engraver::New_fingering_engraver ()
326 ADD_TRANSLATOR (New_fingering_engraver,
327 /* descr */ "Create fingering-scripts for notes in a new chord. "
328 "This engraver is ill-named, since it "
329 "also takes care of articulations and harmonic note heads",
330 /* creats*/ "Fingering",
332 /* acks */ "rhythmic-head-interface stem-interface",
333 /* reads */ "fingeringOrientations",