2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2010 Han-Wen Nienhuys <hanwen@xs4all.nl>,
5 Erik Sandberg <mandolaerik@gmail.com>
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.
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.
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/>.
21 #include "translator-group.hh"
23 #include "context-def.hh"
25 #include "dispatcher.hh"
26 #include "engraver-group.hh"
27 #include "international.hh"
30 #include "output-def.hh"
31 #include "performer-group.hh"
32 #include "scheme-engraver.hh"
33 #include "scm-hash.hh"
37 translator_each (SCM list
, Translator_method method
)
39 for (SCM p
= list
; scm_is_pair (p
); p
= scm_cdr (p
))
40 (unsmob_translator (scm_car (p
))->*method
) ();
44 Translator_group::initialize ()
46 precompute_method_bindings ();
50 Translator_group::connect_to_context (Context
*c
)
54 programming_error ("translator group is already connected to context "
55 + context_
->context_name ());
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
))
63 Translator
*tr
= unsmob_translator (scm_car (tr_list
));
64 tr
->connect_to_context (c
);
69 Translator_group::disconnect_from_context ()
71 for (SCM tr_list
= simple_trans_list_
; scm_is_pair (tr_list
); tr_list
= scm_cdr (tr_list
))
73 Translator
*tr
= unsmob_translator (scm_car (tr_list
));
74 tr
->disconnect_from_context (context_
);
76 context_
->event_source ()->remove_listener (GET_LISTENER (create_child_translator
),
77 ly_symbol2scm ("AnnounceNewContext"));
79 protected_events_
= SCM_EOL
;
83 Translator_group::finalize ()
88 filter_performers (SCM ell
)
91 for (SCM p
= ell
; scm_is_pair (p
); p
= scm_cdr (p
))
93 if (dynamic_cast<Performer
*> (unsmob_translator (scm_car (*tail
))))
94 *tail
= scm_cdr (*tail
);
96 tail
= SCM_CDRLOC (*tail
);
102 filter_engravers (SCM ell
)
105 for (SCM p
= ell
; scm_is_pair (p
); p
= scm_cdr (p
))
107 if (dynamic_cast<Engraver
*> (unsmob_translator (scm_car (*tail
))))
108 *tail
= scm_cdr (*tail
);
110 tail
= SCM_CDRLOC (*tail
);
116 Protects the parameter from being garbage collected. The object is
117 protected until the next disconnect_from_context call.
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
124 TODO: Should the list also be flushed at the beginning of each new
128 Translator_group::protect_event (SCM ev
)
130 protected_events_
= scm_cons (ev
, protected_events_
);
134 Create a new translator for a newly created child context. Triggered
135 by AnnounceNewContext events.
137 IMPLEMENT_LISTENER (Translator_group
, create_child_translator
);
139 Translator_group::create_child_translator (SCM sev
)
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 ();
148 SCM trans_names
= def
->get_translator_names (ops
);
150 Translator_group
*g
= get_translator_group (def
->get_translator_group_type ());
151 SCM trans_list
= SCM_EOL
;
153 for (SCM s
= trans_names
; scm_is_pair (s
); s
= scm_cdr (s
))
155 SCM definition
= scm_car (s
);
157 Translator
*type
= 0;
158 Translator
*instance
= type
;
159 if (ly_is_symbol (definition
))
161 type
= get_translator (definition
);
162 instance
= type
->clone ();
164 else if (ly_is_pair (definition
))
166 type
= get_translator (ly_symbol2scm ("Scheme_engraver"));
167 instance
= type
->clone ();
168 dynamic_cast<Scheme_engraver
*> (instance
)->init_from_scheme (definition
);
170 else if (ly_is_procedure (definition
))
172 // `definition' is a procedure, which takes the context as
173 // an argument and evaluates to an a-list scheme engraver
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
);
182 warning (_f ("cannot find: `%s'", ly_symbol2string (scm_car (s
)).c_str ()));
185 SCM str
= instance
->self_scm ();
187 if (instance
->must_be_last ())
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
);
196 trans_list
= scm_cons (str
, trans_list
);
198 instance
->daddy_context_
= new_context
;
199 instance
->unprotect ();
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
);
210 // TODO: scrap Context::implementation
211 new_context
->implementation_
= g
;
213 g
->connect_to_context (new_context
);
216 recurse_over_translators (new_context
,
217 &Translator::initialize
,
218 &Translator_group::initialize
,
223 Translator_group::get_simple_trans_list ()
225 return simple_trans_list_
;
229 precomputed_recurse_over_translators (Context
*c
, Translator_precompute_index idx
, Direction dir
)
232 = dynamic_cast<Translator_group
*> (c
->implementation ());
234 if (tg
&& dir
== DOWN
)
236 tg
->precomputed_translator_foreach (idx
);
237 tg
->call_precomputed_self_method (idx
);
240 for (SCM s
= c
->children_contexts (); scm_is_pair (s
);
242 precomputed_recurse_over_translators (unsmob_context (scm_car (s
)), idx
, dir
);
246 tg
->precomputed_translator_foreach (idx
);
247 tg
->call_precomputed_self_method (idx
);
252 recurse_over_translators (Context
*c
, Translator_method ptr
,
253 Translator_group_method tg_ptr
, Direction dir
)
256 = dynamic_cast<Translator_group
*> (c
->implementation ());
258 if (tg
&& dir
== DOWN
)
261 translator_each (tg
->get_simple_trans_list (), ptr
);
264 for (SCM s
= c
->children_contexts (); scm_is_pair (s
);
266 recurse_over_translators (unsmob_context (scm_car (s
)), ptr
, tg_ptr
, dir
);
270 translator_each (tg
->get_simple_trans_list (),
277 Translator_group::Translator_group ()
279 simple_trans_list_
= SCM_EOL
;
280 protected_events_
= SCM_EOL
;
286 Translator_group::derived_mark () const
291 Translator_group::precompute_method_bindings ()
293 for (SCM s
= simple_trans_list_
; scm_is_pair (s
); s
= scm_cdr (s
))
295 Translator
*tr
= unsmob_translator (scm_car (s
));
296 Translator_void_method_ptr ptrs
[TRANSLATOR_METHOD_PRECOMPUTE_COUNT
];
297 tr
->fetch_precomputable_methods (ptrs
);
300 for (int i
= 0; i
< TRANSLATOR_METHOD_PRECOMPUTE_COUNT
; i
++)
303 precomputed_method_bindings_
[i
].push_back (Translator_method_binding (tr
, ptrs
[i
]));
307 fetch_precomputable_methods (precomputed_self_method_bindings_
);
311 Translator_group::precomputed_translator_foreach (Translator_precompute_index idx
)
313 vector
<Translator_method_binding
> &bindings (precomputed_method_bindings_
[idx
]);
314 for (vsize i
= 0; i
< bindings
.size (); i
++)
315 bindings
[i
].invoke ();
319 Translator_group::fetch_precomputable_methods (Translator_group_void_method ptrs
[])
321 for (int i
= 0; i
< TRANSLATOR_METHOD_PRECOMPUTE_COUNT
; i
++)
326 Translator_group::call_precomputed_self_method (Translator_precompute_index idx
)
328 if (precomputed_self_method_bindings_
[idx
])
329 (*precomputed_self_method_bindings_
[idx
]) (this);
332 Translator_group::~Translator_group ()
336 #include "ly-smobs.icc"
338 IMPLEMENT_SMOBS (Translator_group
);
339 IMPLEMENT_DEFAULT_EQUAL_P (Translator_group
);
340 IMPLEMENT_TYPE_P (Translator_group
, "ly:translator-group?");
343 Translator_group::print_smob (SCM s
, SCM port
, scm_print_state
*)
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
);
354 Translator_group::mark_smob (SCM smob
)
356 Translator_group
*me
= (Translator_group
*)SCM_CELL_WORD_1 (smob
);
359 scm_gc_mark (me
->protected_events_
);
360 return me
->simple_trans_list_
;