]> git.donarmstrong.com Git - lilypond.git/blob - lily/new-fingering-engraver.cc
Basic-notation reorg and misc small fixes.
[lilypond.git] / lily / new-fingering-engraver.cc
1 /*
2   fingering-engraver.cc -- implement New_fingering_engraver
3
4   source file of the GNU LilyPond music typesetter
5
6   (c) 1998--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
7 */
8
9 #include "engraver.hh"
10
11 #include "international.hh"
12 #include "rhythmic-head.hh"
13 #include "script-interface.hh"
14 #include "self-alignment-interface.hh"
15 #include "side-position-interface.hh"
16 #include "stem.hh"
17 #include "stem.hh"
18 #include "warn.hh"
19
20 #include "translator.icc"
21
22 struct Finger_tuple
23 {
24   Grob *head_;
25   Grob *script_;
26   Music *note_event_;
27   Music *finger_event_;
28   bool follow_into_staff_;
29   int position_;
30
31   Finger_tuple ()
32   {
33     position_ = 0;
34     head_ = script_ = 0;
35     note_event_ = finger_event_ = 0;
36     follow_into_staff_ = false;
37   }
38   static int compare (Finger_tuple const &c1, Finger_tuple const &c2)
39   {
40     return c1.position_- c2.position_;
41   }
42 };
43
44 class New_fingering_engraver : public Engraver
45 {
46   vector<Finger_tuple> fingerings_;
47   vector<Finger_tuple> articulations_;
48   vector<Finger_tuple> string_numbers_;
49
50   vector<Grob*> heads_;
51   Grob *stem_;
52
53 public:
54   TRANSLATOR_DECLARATIONS (New_fingering_engraver);
55 protected:
56   void stop_translation_timestep ();
57   DECLARE_ACKNOWLEDGER (rhythmic_head);
58   DECLARE_ACKNOWLEDGER (stem);
59   void add_fingering (Grob *, Music *, Music *);
60   void add_script (Grob *, Music *, Music *);
61   void add_string (Grob *, Music *, Music *);
62   void position_scripts (SCM orientations, vector<Finger_tuple> *);
63 };
64
65 void
66 New_fingering_engraver::acknowledge_rhythmic_head (Grob_info inf)
67 {
68   Music *note_ev = inf.music_cause ();
69   if (!note_ev)
70     return;
71
72   SCM arts = note_ev->get_property ("articulations");
73
74   for (SCM s = arts; scm_is_pair (s); s = scm_cdr (s))
75     {
76       Music *m = unsmob_music (scm_car (s));
77
78       if (!m)
79         continue;
80
81       if (m->is_mus_type ("fingering-event"))
82         add_fingering (inf.grob (), m, note_ev);
83       else if (m->is_mus_type ("text-script-event"))
84         m->origin ()->warning (_ ("can't add text scripts to individual note heads"));
85       else if (m->is_mus_type ("script-event"))
86         add_script (inf.grob (), m, note_ev);
87       else if (m->is_mus_type ("string-number-event"))
88         add_string (inf.grob (), m, note_ev);
89       else if (m->is_mus_type ("harmonic-event"))
90         {
91           inf.grob ()->set_property ("style", ly_symbol2scm ("harmonic"));
92           Grob *d = unsmob_grob (inf.grob ()->get_object ("dot"));
93           if (d)
94             d->suicide ();
95         }
96     }
97
98   heads_.push_back (inf.grob ());
99 }
100
101 void
102 New_fingering_engraver::acknowledge_stem (Grob_info inf)
103 {
104   stem_ = inf.grob ();
105 }
106
107 void
108 New_fingering_engraver::add_script (Grob *head,
109                                     Music *event,
110                                     Music *note)
111 {
112   (void) note;
113
114   Finger_tuple ft;
115
116   Grob *g = make_item ("Script", event->self_scm ());
117   make_script_from_event (g, context (), event->get_property ("articulation-type"), 0);
118   if (g)
119     {
120       ft.script_ = g;
121
122       articulations_.push_back (ft);
123
124       ft.script_->set_parent (head, X_AXIS);
125     }
126 }
127
128 void
129 New_fingering_engraver::add_fingering (Grob *head,
130                                        Music *event,
131                                        Music *hevent)
132 {
133   Finger_tuple ft;
134
135   ft.script_ = make_item ("Fingering", event->self_scm ());
136
137   Side_position_interface::add_support (ft.script_, head);
138
139   int d = scm_to_int (event->get_property ("digit"));
140
141   /*
142     TODO:
143
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?
146
147   */
148   if (d > 5)
149     {
150       /*
151         music for the softenon children?
152       */
153       event->origin ()->warning (_ ("music for the martians."));
154     }
155   SCM sstr = scm_number_to_string (scm_from_int (d), scm_from_int (10));
156   ft.script_->set_property ("text", sstr);
157
158   ft.finger_event_ = event;
159   ft.note_event_ = hevent;
160   ft.head_ = head;
161
162   fingerings_.push_back (ft);
163 }
164
165 void
166 New_fingering_engraver::add_string (Grob *head,
167                                     Music *event,
168                                     Music *hevent)
169 {
170   Finger_tuple ft;
171
172   ft.script_ = make_item ("StringNumber", event->self_scm ());
173
174   Side_position_interface::add_support (ft.script_, head);
175
176   int d = scm_to_int (event->get_property ("string-number"));
177
178   SCM sstr = scm_number_to_string (scm_from_int (d), scm_from_int (10));
179   ft.script_->set_property ("text", sstr);
180
181   ft.finger_event_ = event;
182   ft.note_event_ = hevent;
183   ft.head_ = head;
184
185   string_numbers_.push_back (ft);
186 }
187
188 void
189 New_fingering_engraver::position_scripts (SCM orientations,
190                                           vector<Finger_tuple> *scripts)
191 {
192   for (vsize i = 0; i < scripts->size (); i++)
193     if (stem_ && to_boolean (scripts->at (i).script_->get_property ("add-stem-support")))
194       Side_position_interface::add_support (scripts->at (i).script_, stem_);
195
196   /*
197     This is not extremely elegant, but we have to do a little
198     formatting here, because the parent/child relations should be
199     known before we move on to the next time step.
200
201     A more sophisticated approach would be to set both X and Y parents
202     to the note head, and write a more flexible function for
203     positioning the fingerings, setting both X and Y coordinates.
204   */
205   for (vsize i = 0; i < scripts->size (); i++)
206     (*scripts)[i].position_ = scm_to_int ((*scripts)[i].head_->get_property ("staff-position"));
207
208   for (vsize i = scripts->size (); i--;)
209     for (vsize j = heads_.size (); j--;)
210       Side_position_interface::add_support ((*scripts)[i].script_, heads_[j]);
211
212   vector<Finger_tuple> up, down, horiz;
213   for (vsize i = scripts->size (); i--;)
214     {
215       SCM d = (*scripts)[i].finger_event_->get_property ("direction");
216       if (to_dir (d))
217         {
218           ((to_dir (d) == UP) ? up : down).push_back ((*scripts)[i]);
219           scripts->erase (scripts->begin () + i);
220         }
221     }
222
223   vector_sort (*scripts, Finger_tuple::compare);
224
225   bool up_p = scm_c_memq (ly_symbol2scm ("up"), orientations) != SCM_BOOL_F;
226   bool down_p = scm_c_memq (ly_symbol2scm ("down"), orientations) != SCM_BOOL_F;
227   bool left_p = scm_c_memq (ly_symbol2scm ("left"), orientations) != SCM_BOOL_F;
228   bool right_p = scm_c_memq (ly_symbol2scm ("right"), orientations) != SCM_BOOL_F;
229   Direction hordir = (right_p) ? RIGHT : LEFT;
230   if (left_p || right_p)
231     {
232       if (up_p && !up.size () && scripts->size ())
233         {
234           up.push_back (scripts->back ());
235           scripts->pop_back ();
236         }
237
238       if (down_p && !down.size () && scripts->size ())
239         {
240           down.push_back ((*scripts)[0]);
241           scripts->erase (scripts->begin ());
242         }
243
244       horiz.insert (horiz.end (), scripts->begin (), scripts->end ());
245     }
246   else if (up_p && down_p)
247     {
248       int center = scripts->size () / 2;
249       down.insert (down.end (), scripts->begin (), scripts->begin () + center);
250       up.insert (up.end (), scripts->begin () + center, scripts->end ());
251     }
252   else if (up_p)
253     {
254       up.insert (up.end (), scripts->begin (), scripts->end ());
255       scripts->clear ();
256     }
257   else
258     {
259       if (!down_p)
260         {
261           warning (_ ("no placement found for fingerings"));
262           warning (_ ("placing below"));
263         }
264       down.insert (down.end (), scripts->begin (), scripts->end ());
265       scripts->clear ();
266     }
267
268   for (vsize i = 0; i < horiz.size (); i++)
269     {
270       Finger_tuple ft = horiz[i];
271       Grob *f = ft.script_;
272       f->set_parent (ft.head_, X_AXIS);
273       f->set_parent (ft.head_, Y_AXIS);
274
275       Self_alignment_interface::set_align_self (f, Y_AXIS);
276       Self_alignment_interface::set_center_parent (f, Y_AXIS);
277       Side_position_interface::set_axis (f, X_AXIS);
278
279       f->set_property ("direction", scm_from_int (hordir));
280     }
281
282   int finger_prio = 200;
283
284   Direction d = DOWN;
285   Drul_array< vector<Finger_tuple> > vertical (down, up);
286   do
287     {
288       for (vsize i = 0; i < vertical[d].size (); i++)
289         {
290           Finger_tuple ft = vertical[d][i];
291           Grob *f = ft.script_;
292           f->set_parent (ft.head_, X_AXIS);
293           f->set_property ("script-priority",
294                            scm_from_int (finger_prio + d * ft.position_));
295
296           Self_alignment_interface::set_align_self (f, X_AXIS);
297           Self_alignment_interface::set_center_parent (f, X_AXIS);
298           Side_position_interface::set_axis (f, Y_AXIS);
299       
300           f->set_property ("direction", scm_from_int (d));
301         }
302     }
303   while (flip (&d) != DOWN);
304 }
305
306 void
307 New_fingering_engraver::stop_translation_timestep ()
308 {
309   if (fingerings_.size ())
310     {
311       position_scripts (get_property ("fingeringOrientations"),
312                         &fingerings_);
313       fingerings_.clear ();
314     }
315
316   if (string_numbers_.size ())
317     {
318       position_scripts (get_property ("stringNumberOrientations"),
319                         &string_numbers_);
320       string_numbers_.clear ();
321     }
322
323   for (vsize i = articulations_.size (); i--;)
324     {
325       Grob *script = articulations_[i].script_;
326
327       for (vsize j = heads_.size (); j--;)
328         Side_position_interface::add_support (script, heads_[j]);
329
330       if (stem_ && to_dir (script->get_property ("side-relative-direction")))
331         script->set_object ("direction-source", stem_->self_scm ());
332
333       if (stem_ && to_boolean (script->get_property ("add-stem-support")))
334         Side_position_interface::add_support (script, stem_);
335
336
337     }
338
339   stem_ = 0;
340   heads_.clear ();
341   articulations_.clear ();
342 }
343
344 New_fingering_engraver::New_fingering_engraver ()
345 {
346   stem_ = 0;
347 }
348 ADD_ACKNOWLEDGER (New_fingering_engraver, rhythmic_head);
349 ADD_ACKNOWLEDGER (New_fingering_engraver, stem);
350
351 ADD_TRANSLATOR (New_fingering_engraver,
352                 /* doc */ "Create fingering-scripts for notes in a new chord.  "
353                 "This engraver is ill-named, since it "
354                 "also takes care of articulations and harmonic note heads",
355                 /* create */ "Fingering",
356                 /* accept */ "",
357                 /* read */ "fingeringOrientations",
358                 /* write */ "");