]> git.donarmstrong.com Git - lilypond.git/blob - lily/translator-group.cc
Instanciable scheme engravers
[lilypond.git] / lily / translator-group.cc
1 /*
2   This file is part of LilyPond, the GNU music typesetter.
3
4   Copyright (C) 1997--2010 Han-Wen Nienhuys <hanwen@xs4all.nl>,
5                  Erik Sandberg <mandolaerik@gmail.com>
6
7   LilyPond is free software: you can redistribute it and/or modify
8   it under the terms of the GNU General Public License as published by
9   the Free Software Foundation, either version 3 of the License, or
10   (at your option) any later version.
11
12   LilyPond is distributed in the hope that it will be useful,
13   but WITHOUT ANY WARRANTY; without even the implied warranty of
14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15   GNU General Public License for more details.
16
17   You should have received a copy of the GNU General Public License
18   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
19 */
20
21 #include "translator-group.hh"
22
23 #include "context-def.hh"
24 #include "context.hh"
25 #include "dispatcher.hh"
26 #include "engraver-group.hh"
27 #include "international.hh"
28 #include "main.hh"
29 #include "music.hh"
30 #include "output-def.hh"
31 #include "performer-group.hh"
32 #include "scheme-engraver.hh"
33 #include "scm-hash.hh"
34 #include "warn.hh"
35
36 void
37 translator_each (SCM list, Translator_method method)
38 {
39   for (SCM p = list; scm_is_pair (p); p = scm_cdr (p))
40     (unsmob_translator (scm_car (p))->*method) ();
41 }
42
43 void
44 Translator_group::initialize ()
45 {
46   precompute_method_bindings ();
47 }
48
49 void
50 Translator_group::connect_to_context (Context *c)
51 {
52   if (context_)
53     {
54       programming_error ("translator group is already connected to context "
55                          +  context_->context_name ());
56     }
57   
58   context_ = c;
59   c->event_source ()->add_listener (GET_LISTENER (create_child_translator),
60                                     ly_symbol2scm ("AnnounceNewContext"));
61   for (SCM tr_list = simple_trans_list_; scm_is_pair (tr_list); tr_list = scm_cdr (tr_list))
62     {
63       Translator *tr = unsmob_translator (scm_car (tr_list));
64       tr->connect_to_context (c);
65     }
66 }
67
68 void
69 Translator_group::disconnect_from_context ()
70 {
71   for (SCM tr_list = simple_trans_list_; scm_is_pair (tr_list); tr_list = scm_cdr (tr_list))
72     {
73       Translator *tr = unsmob_translator (scm_car (tr_list));
74       tr->disconnect_from_context (context_);
75     }
76   context_->event_source ()->remove_listener (GET_LISTENER (create_child_translator),
77                                               ly_symbol2scm ("AnnounceNewContext"));
78   context_ = 0;
79   protected_events_ = SCM_EOL;
80 }
81
82 void
83 Translator_group::finalize ()
84 {
85 }
86
87 SCM
88 filter_performers (SCM ell)
89 {
90   SCM *tail = &ell;
91   for (SCM p = ell; scm_is_pair (p); p = scm_cdr (p))
92     {
93       if (dynamic_cast<Performer *> (unsmob_translator (scm_car (*tail))))
94         *tail = scm_cdr (*tail);
95       else
96         tail = SCM_CDRLOC (*tail);
97     }
98   return ell;
99 }
100
101 SCM
102 filter_engravers (SCM ell)
103 {
104   SCM *tail = &ell;
105   for (SCM p = ell; scm_is_pair (p); p = scm_cdr (p))
106     {
107       if (dynamic_cast<Engraver *> (unsmob_translator (scm_car (*tail))))
108         *tail = scm_cdr (*tail);
109       else
110         tail = SCM_CDRLOC (*tail);
111     }
112   return ell;
113 }
114
115 /* 
116   Protects the parameter from being garbage collected. The object is
117   protected until the next disconnect_from_context call.
118
119   Whenever a child translator hears an event, the event is added to
120   this list. This eliminates the need for derived_mark methods in most
121   translators; all incoming events are instead protected by the
122   translator group.
123  
124   TODO: Should the list also be flushed at the beginning of each new
125   moment?
126  */
127 void
128 Translator_group::protect_event (SCM ev)
129 {
130   protected_events_ = scm_cons (ev, protected_events_);
131 }
132
133 /*
134   Create a new translator for a newly created child context. Triggered
135   by AnnounceNewContext events.
136  */
137 IMPLEMENT_LISTENER (Translator_group, create_child_translator);
138 void
139 Translator_group::create_child_translator (SCM sev)
140 {
141   Stream_event *ev = unsmob_stream_event (sev);
142   // get from AnnounceNewContext
143   SCM cs = ev->get_property ("context");
144   Context *new_context = unsmob_context (cs);
145   Context_def *def = unsmob_context_def (new_context->get_definition ());
146   SCM ops = new_context->get_definition_mods ();
147   
148   SCM trans_names = def->get_translator_names (ops);
149
150   Translator_group *g = get_translator_group (def->get_translator_group_type ());
151   SCM trans_list = SCM_EOL;
152
153   for (SCM s = trans_names; scm_is_pair (s); s = scm_cdr (s))
154     {
155       SCM definition = scm_car (s);
156
157       Translator *type = 0;
158       Translator *instance = type;
159       if (ly_is_symbol (definition))
160         {
161           type = get_translator (definition);
162           instance = type->clone ();
163         }
164       else if (ly_is_pair (definition))
165         {
166           type = get_translator (ly_symbol2scm ("Scheme_engraver"));
167           instance = type->clone ();
168           dynamic_cast<Scheme_engraver*> (instance)->init_from_scheme (definition);
169         }
170       else if (ly_is_procedure (definition))
171         {
172           // `definition' is a procedure, which takes the context as
173           // an argument and evaluates to an a-list scheme engraver
174           // definition.
175           SCM def = scm_call_1 (definition, cs);
176           type = get_translator (ly_symbol2scm ("Scheme_engraver"));
177           instance = type->clone ();
178           dynamic_cast<Scheme_engraver*> (instance)->init_from_scheme (def);
179         }
180          
181       if (!type)
182         warning (_f ("cannot find: `%s'", ly_symbol2string (scm_car (s)).c_str ()));
183       else
184         {
185           SCM str = instance->self_scm ();
186
187           if (instance->must_be_last ())
188             {
189               SCM cons = scm_cons (str, SCM_EOL);
190               if (scm_is_pair (trans_list))
191                 scm_set_cdr_x (scm_last_pair (trans_list), cons);
192               else
193                 trans_list = cons;
194             }
195           else
196             trans_list = scm_cons (str, trans_list);
197
198           instance->daddy_context_ = new_context;
199           instance->unprotect ();
200         }
201     }
202
203   /* Filter unwanted translator types. Required to make
204      \with { \consists "..." } work. */
205   if (dynamic_cast<Engraver_group *> (g))
206     g->simple_trans_list_ = filter_performers (trans_list);
207   else if (dynamic_cast<Performer_group *> (g))
208     g->simple_trans_list_ = filter_engravers (trans_list);
209
210   // TODO: scrap Context::implementation
211   new_context->implementation_ = g;
212
213   g->connect_to_context (new_context);
214   g->unprotect ();
215
216   recurse_over_translators (new_context,
217                             &Translator::initialize,
218                             &Translator_group::initialize,
219                             DOWN);
220 }
221
222 SCM
223 Translator_group::get_simple_trans_list ()
224 {
225   return simple_trans_list_;
226 }
227
228 void
229 precomputed_recurse_over_translators (Context *c, Translator_precompute_index idx, Direction dir)
230 {
231   Translator_group *tg
232     = dynamic_cast<Translator_group *> (c->implementation ());
233
234   if (tg && dir == DOWN)
235     {
236       tg->precomputed_translator_foreach (idx);
237       tg->call_precomputed_self_method (idx);
238     }
239
240   for (SCM s = c->children_contexts (); scm_is_pair (s);
241        s = scm_cdr (s))
242     precomputed_recurse_over_translators (unsmob_context (scm_car (s)), idx, dir);
243
244   if (tg && dir == UP)
245     {
246       tg->precomputed_translator_foreach (idx);
247       tg->call_precomputed_self_method (idx);
248     }
249 }
250
251 void
252 recurse_over_translators (Context *c, Translator_method ptr,
253                           Translator_group_method tg_ptr, Direction dir)
254 {
255   Translator_group *tg
256     = dynamic_cast<Translator_group *> (c->implementation ());
257
258   if (tg && dir == DOWN)
259     {
260       (tg->*tg_ptr) ();
261       translator_each (tg->get_simple_trans_list (), ptr);
262     }
263
264   for (SCM s = c->children_contexts (); scm_is_pair (s);
265        s = scm_cdr (s))
266     recurse_over_translators (unsmob_context (scm_car (s)), ptr, tg_ptr, dir);
267
268   if (tg && dir == UP)
269     {
270       translator_each (tg->get_simple_trans_list (),
271                        ptr);
272
273       (tg->*tg_ptr) ();
274     }
275 }
276
277 Translator_group::Translator_group ()
278 {
279   simple_trans_list_ = SCM_EOL;
280   protected_events_ = SCM_EOL;
281   context_ = 0;
282   smobify_self ();
283 }
284
285 void
286 Translator_group::derived_mark () const
287 {
288 }
289
290 void
291 Translator_group::precompute_method_bindings ()
292 {
293   for (SCM s = simple_trans_list_; scm_is_pair (s); s = scm_cdr (s))
294     {
295       Translator *tr = unsmob_translator (scm_car (s));
296       Translator_void_method_ptr ptrs[TRANSLATOR_METHOD_PRECOMPUTE_COUNT];
297       tr->fetch_precomputable_methods (ptrs);
298
299       assert (tr);
300       for (int i = 0; i < TRANSLATOR_METHOD_PRECOMPUTE_COUNT; i++)
301         {
302           if (ptrs[i])
303             precomputed_method_bindings_[i].push_back (Translator_method_binding (tr, ptrs[i]));
304         }
305     }
306
307   fetch_precomputable_methods (precomputed_self_method_bindings_);
308 }
309
310 void
311 Translator_group::precomputed_translator_foreach (Translator_precompute_index idx)
312 {
313   vector<Translator_method_binding> &bindings (precomputed_method_bindings_[idx]);
314   for (vsize i = 0; i < bindings.size (); i++)
315     bindings[i].invoke ();
316 }
317
318 void
319 Translator_group::fetch_precomputable_methods (Translator_group_void_method ptrs[])
320 {
321   for (int i = 0; i < TRANSLATOR_METHOD_PRECOMPUTE_COUNT; i++)
322     ptrs[i] = 0;
323 }
324
325 void
326 Translator_group::call_precomputed_self_method (Translator_precompute_index idx)
327 {
328   if (precomputed_self_method_bindings_[idx])
329     (*precomputed_self_method_bindings_[idx]) (this);
330 }
331
332 Translator_group::~Translator_group ()
333 {
334 }
335
336 #include "ly-smobs.icc"
337
338 IMPLEMENT_SMOBS (Translator_group);
339 IMPLEMENT_DEFAULT_EQUAL_P (Translator_group);
340 IMPLEMENT_TYPE_P (Translator_group, "ly:translator-group?");
341
342 int
343 Translator_group::print_smob (SCM s, SCM port, scm_print_state *)
344 {
345   Translator_group *me = (Translator_group *) SCM_CELL_WORD_1 (s);
346   scm_puts ("#<Translator_group ", port);
347   scm_puts (me->class_name (), port);
348   scm_display (me->simple_trans_list_, port);
349   scm_puts (" >", port);
350   return 1;
351 }
352
353 SCM
354 Translator_group::mark_smob (SCM smob)
355 {
356   Translator_group *me = (Translator_group *)SCM_CELL_WORD_1 (smob);
357
358   me->derived_mark ();
359   scm_gc_mark (me->protected_events_);
360   return me->simple_trans_list_;
361 }