]> git.donarmstrong.com Git - lilypond.git/blob - lily/local-key-item.cc
release: 1.5.47
[lilypond.git] / lily / local-key-item.cc
1 /*
2   local-key-item.cc -- implement Local_key_item, Pitch
3
4   source file of the GNU LilyPond music typesetter
5
6   (c)  1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
7 */
8 #include "local-key-item.hh"
9 #include "molecule.hh"
10 #include "staff-symbol-referencer.hh"
11 #include "font-interface.hh"
12 #include "paper-def.hh"
13 #include "musical-request.hh"
14 #include "rhythmic-head.hh"
15 #include "misc.hh"
16 #include "spanner.hh"
17 #include "tie.hh"
18 #include "lookup.hh"
19
20 static SCM
21 pitch_less (SCM p1, SCM p2)
22 {
23   return Pitch::less_p (ly_car (p1),  ly_car (p2));
24 }
25
26 static SCM pitch_less_proc;
27
28 void
29 init_pitch_funcs ()
30 {
31   pitch_less_proc = gh_new_procedure2_0 ("pitch-less", &pitch_less);
32 }
33
34 ADD_SCM_INIT_FUNC (lkpitch,init_pitch_funcs);
35
36
37 void
38 Local_key_item::add_pitch (Grob*me, Pitch p, bool cautionary, bool natural,
39                            Grob* tie_break_reminder)
40 {
41   SCM acs = me->get_grob_property ("accidentals");
42   SCM pitch = p.smobbed_copy ();
43   SCM opts = scm_assoc (pitch, acs);
44   bool new_pitch = !gh_pair_p (opts);
45   opts= new_pitch ? SCM_EOL : gh_cdr (opts);
46   
47   if (cautionary)
48     opts = gh_cons (ly_symbol2scm ("cautionary"), opts);
49   if (natural)
50     opts = gh_cons (ly_symbol2scm ("natural"), opts);
51   if (tie_break_reminder)
52     {
53       /* Ugh, these 'options' can't have a value, faking... */
54       opts = gh_cons (tie_break_reminder->self_scm (), opts);
55       opts = gh_cons (ly_symbol2scm ("tie-break-reminder"), opts);
56     }
57
58   if (new_pitch)
59     {
60       pitch = gh_cons (pitch, opts);
61       acs = scm_merge_x (acs, gh_cons (pitch, SCM_EOL), pitch_less_proc);
62     }
63   else
64     scm_assoc_set_x (acs, pitch, opts);
65
66   me->set_grob_property ("accidentals", acs);
67 }
68
69 Molecule
70 Local_key_item::parenthesize (Grob*me, Molecule m)
71 {
72   Molecule open = Font_interface::get_default_font (me)->find_by_name (String ("accidentals-leftparen"));
73   Molecule close = Font_interface::get_default_font (me)->find_by_name (String ("accidentals-rightparen"));
74   m.add_at_edge (X_AXIS, LEFT, Molecule (open), 0);
75   m.add_at_edge (X_AXIS, RIGHT, Molecule (close), 0);
76
77   return m;
78 }
79
80 /*
81   HW says: maybe move to tie.cc
82
83   Note, tie should not kill all accidentals when broken, only the ones
84   that are indicated by a property tie-break-reminder, I guess
85
86   Find if any of the accidentals were created because they're at the rhs of a
87   tie.  If that's the reason they exist, and the tie was NOT broken,
88   put the accidental up for deletion.  Clear molecule cache. */
89 MAKE_SCHEME_CALLBACK (Local_key_item, after_line_breaking, 1);
90 SCM
91 Local_key_item::after_line_breaking (SCM smob)
92 {
93   Grob *me = unsmob_grob (smob);
94
95   SCM accs = me->get_grob_property ("accidentals");
96   for (SCM s = accs;
97         gh_pair_p (s); s = ly_cdr (s))
98     {
99       SCM opts = ly_cdar (s);
100
101       SCM t = scm_memq (ly_symbol2scm ("tie-break-reminder"), opts);
102       if (t != SCM_BOOL_F)
103         {
104           Grob *tie = unsmob_grob (ly_cadr (t));
105           Spanner *sp = dynamic_cast<Spanner*> (tie);
106           if (!sp->original_l_)
107             {
108               /* there should be a better way to delete part of me */
109               scm_set_car_x (s, scm_list_n (ly_caar (s),
110                                          ly_symbol2scm ("deleted"),
111                                          SCM_UNDEFINED));
112               me->set_grob_property ("molecule", SCM_EOL);
113             }
114         }
115     }
116   
117   return SCM_UNSPECIFIED;
118 }
119
120 /*
121   UGH. clean me, revise placement routine (See Ross & Wanske;
122   accidental placement is more complicated than this.
123  */
124
125 MAKE_SCHEME_CALLBACK (Local_key_item,brew_molecule,1);
126 SCM
127 Local_key_item::brew_molecule (SCM smob)
128 {
129   Grob* me = unsmob_grob (smob);
130   
131   Molecule mol;
132
133   Real note_distance = Staff_symbol_referencer::staff_space (me)/2;
134   Molecule octave_mol;
135   bool oct_b = false;
136   int lastoct = -100;
137
138   SCM scm_style = me->get_grob_property ("style");
139   String style;
140   if (gh_symbol_p (scm_style))
141     {
142       style = ly_scm2string (scm_symbol_to_string (scm_style));
143     }
144   else
145     {
146       /*
147         preferably no name for the default style.
148        */
149       style = "";
150     }
151
152   SCM accs = me->get_grob_property ("accidentals");
153   for (SCM s = accs;
154         gh_pair_p (s); s = ly_cdr (s))
155     {
156       Pitch p (*unsmob_pitch (ly_caar (s)));
157       SCM opts = ly_cdar (s);
158       
159       if (scm_memq (ly_symbol2scm ("deleted"), opts) != SCM_BOOL_F)
160         continue;
161       
162       // do one octave
163       if (p.octave_i ()  != lastoct) 
164         {
165           if (oct_b)
166             {
167               Real dy =lastoct*7* note_distance;
168               octave_mol.translate_axis (dy, Y_AXIS);
169               mol.add_molecule (octave_mol);
170               octave_mol = Molecule ();
171             }
172           oct_b = true; 
173         }
174       
175
176       lastoct = p.octave_i () ;
177
178       bool cautionary = (scm_memq (ly_symbol2scm ("cautionary"), opts) != SCM_BOOL_F);
179       SCM font_rel_siz = me->get_grob_property("font-relative-size");
180       SCM caut_siz = me->get_grob_property("cautionary-size");
181       int frs = (gh_exact_p(font_rel_siz) ? gh_scm2int(font_rel_siz) : 0);
182       int cs = (gh_exact_p(caut_siz) ? gh_scm2int(caut_siz) : 0);
183
184
185       // Ugh. This will only work if only called once on each grob. --rz
186       if (cautionary && caut_siz!=0)
187         me->set_grob_property ("font-relative-size",gh_int2scm(frs+cs));
188
189       SCM c0 =  me->get_grob_property ("c0-position");
190       Real dy = (gh_number_p (c0) ? gh_scm2int (c0) : 0 + p.notename_i_)
191         * note_distance;
192
193       Molecule acc (Font_interface::get_default_font (me)->
194                     find_by_name (String ("accidentals-") +
195                                   style +
196                                   to_str (p.alteration_i_)));
197       
198       if (scm_memq (ly_symbol2scm ("natural"), opts) != SCM_BOOL_F)
199         {
200           Molecule prefix = Font_interface::get_default_font (me)->
201               find_by_name (String ("accidentals-") + style + String ("0"));
202           acc.add_at_edge (X_AXIS, LEFT, Molecule (prefix), 0);
203         }
204
205       if (cautionary && to_boolean(me->get_grob_property("paren-cautionaries")))
206         acc = parenthesize (me, acc);
207
208       acc.translate_axis (dy, Y_AXIS);
209       octave_mol.add_at_edge (X_AXIS, RIGHT, acc, 0);
210     }
211
212   if (oct_b)
213     {
214       Real dy =lastoct*7*note_distance;
215       octave_mol.translate_axis (dy, Y_AXIS);
216       mol.add_molecule (octave_mol);
217       octave_mol = Molecule ();
218     }
219   
220  if (gh_pair_p (accs))
221     {
222       Drul_array<SCM> pads;
223
224       /*
225         Use a cons?
226        */
227       pads[RIGHT] = me->get_grob_property ("right-padding");
228       pads[LEFT] = me->get_grob_property ("left-padding");
229
230
231       // unused ?
232       Direction d = LEFT;
233       do {
234         if (!gh_number_p (pads[d]))
235           continue;
236
237         Box b (Interval (0, gh_scm2double (pads[d]) * note_distance),
238               Interval (0,0));
239         Molecule m (Lookup::blank (b));
240         mol.add_at_edge (X_AXIS, d, m, 0);
241       } while (flip (&d)!= LEFT);
242     }
243
244   return mol.smobbed_copy ();
245 }
246
247 bool
248 Local_key_item::has_interface (Grob*m)
249 {
250   return m && m->has_interface (ly_symbol2scm ("accidentals-interface"));
251 }
252
253
254
255 ADD_INTERFACE (Local_key_item, "accidentals-interface",
256   "Accidentals",
257   "accidentals left-padding right-padding paren-cautionaries cautionary-size");