2 translator-def.cc -- implement Context_def
4 source file of the GNU LilyPond music typesetter
6 (c) 2000--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
9 /* TODO: should junk this class an replace by
10 a single list of context modifications? */
12 #include "context-def.hh"
15 #include "international.hh"
16 #include "output-def.hh"
17 #include "translator.hh"
20 Context_def::Context_def ()
22 context_aliases_ = SCM_EOL;
23 translator_group_type_ = SCM_EOL;
24 accept_mods_ = SCM_EOL;
25 translator_mods_ = SCM_EOL;
26 property_ops_ = SCM_EOL;
27 context_name_ = SCM_EOL;
28 default_child_ = SCM_EOL;
29 description_ = SCM_EOL;
30 input_location_ = SCM_EOL;
34 input_location_ = make_input (Input ());
35 context_name_ = ly_symbol2scm ("");
39 Context_def::origin () const
41 return unsmob_input (input_location_);
44 Context_def::Context_def (Context_def const &s)
46 context_aliases_ = SCM_EOL;
47 translator_group_type_ = SCM_EOL;
48 accept_mods_ = SCM_EOL;
49 translator_mods_ = SCM_EOL;
50 property_ops_ = SCM_EOL;
51 context_name_ = SCM_EOL;
52 description_ = SCM_EOL;
53 default_child_ = SCM_EOL;
54 input_location_ = SCM_EOL;
57 description_ = s.description_;
58 input_location_ = make_input (*s.origin ());
59 default_child_ = s.default_child_;
60 accept_mods_ = s.accept_mods_;
61 property_ops_ = s.property_ops_;
62 translator_mods_ = s.translator_mods_;
63 context_aliases_ = s.context_aliases_;
64 translator_group_type_ = s.translator_group_type_;
65 context_name_ = s.context_name_;
68 Context_def::~Context_def ()
72 #include "ly-smobs.icc"
73 IMPLEMENT_SMOBS (Context_def);
74 IMPLEMENT_DEFAULT_EQUAL_P (Context_def);
77 Context_def::print_smob (SCM smob, SCM port, scm_print_state*)
79 Context_def *me = (Context_def *) SCM_CELL_WORD_1 (smob);
81 scm_puts ("#<Context_def ", port);
82 scm_display (me->context_name_, port);
88 Context_def::mark_smob (SCM smob)
90 ASSERT_LIVE_IS_ALLOWED();
92 Context_def *me = (Context_def *) SCM_CELL_WORD_1 (smob);
94 scm_gc_mark (me->description_);
95 scm_gc_mark (me->context_aliases_);
96 scm_gc_mark (me->accept_mods_);
97 scm_gc_mark (me->translator_mods_);
98 scm_gc_mark (me->property_ops_);
99 scm_gc_mark (me->translator_group_type_);
100 scm_gc_mark (me->default_child_);
101 scm_gc_mark (me->input_location_);
103 return me->context_name_;
107 Context_def::add_context_mod (SCM mod)
109 SCM tag = scm_car (mod);
110 if (ly_symbol2scm ("description") == tag)
112 description_ = scm_cadr (mod);
117 other modifiers take symbols as argument.
119 SCM sym = scm_cadr (mod);
120 if (scm_is_string (sym))
121 sym = scm_string_to_symbol (sym);
123 if (ly_symbol2scm ("default-child") == tag)
124 default_child_ = sym;
125 else if (ly_symbol2scm ("consists") == tag
126 || ly_symbol2scm ("consists-end") == tag
127 || ly_symbol2scm ("remove") == tag)
129 if (!get_translator (sym))
130 error (_f ("program has no such type: `%s'",
131 ly_symbol2string (sym).c_str ()));
133 translator_mods_ = scm_cons (scm_list_2 (tag, sym), translator_mods_);
135 else if (ly_symbol2scm ("accepts") == tag
136 || ly_symbol2scm ("denies") == tag)
137 accept_mods_ = scm_cons (scm_list_2 (tag, sym), accept_mods_);
138 else if (ly_symbol2scm ("pop") == tag
139 || ly_symbol2scm ("push") == tag
140 || ly_symbol2scm ("assign") == tag
141 || ly_symbol2scm ("unset") == tag)
142 property_ops_ = scm_cons (mod, property_ops_);
143 else if (ly_symbol2scm ("alias") == tag)
144 context_aliases_ = scm_cons (sym, context_aliases_);
145 else if (ly_symbol2scm ("translator-type") == tag)
146 translator_group_type_ = sym;
147 else if (ly_symbol2scm ("context-name") == tag)
150 programming_error ("unknown context mod tag");
154 Context_def::get_accepted (SCM user_mod) const
156 SCM mods = scm_reverse_x (scm_list_copy (accept_mods_), user_mod);
158 for (SCM s = mods; scm_is_pair (s); s = scm_cdr (s))
160 SCM tag = scm_caar (s);
161 SCM sym = scm_cadar (s);
162 if (tag == ly_symbol2scm ("accepts"))
163 acc = scm_cons (sym, acc);
164 else if (tag == ly_symbol2scm ("denies"))
165 acc = scm_delete_x (sym, acc);
168 SCM def = get_default_child (user_mod);
169 if (scm_is_symbol (def))
171 if (scm_memq (def, acc))
172 acc = scm_delete_x (def, acc);
173 acc = scm_cons (def, acc);
180 Context_def::get_default_child (SCM user_mod) const
182 SCM name = default_child_;
183 for (SCM s = user_mod; scm_is_pair (s); s = scm_cdr (s))
185 SCM entry = scm_car (s);
186 if (scm_car (entry) == ly_symbol2scm ("default-child"))
188 name = scm_cadr (entry);
197 Context_def::path_to_acceptable_context (SCM type_sym, Output_def *odef) const
199 assert (scm_is_symbol (type_sym));
201 SCM accepted = get_accepted (SCM_EOL);
203 vector<Context_def*> accepteds;
204 for (SCM s = accepted; scm_is_pair (s); s = scm_cdr (s))
205 if (Context_def *t = unsmob_context_def (find_context_def (odef,
207 accepteds.push_back (t);
209 vector<Context_def*> best_result;
210 for (vsize i = 0; i < accepteds.size (); i++)
212 /* do not check aliases, because \context Staff should not
213 create RhythmicStaff. */
214 if (ly_is_equal (accepteds[i]->get_context_name (), type_sym))
216 best_result.push_back (accepteds[i]);
221 vsize best_depth = INT_MAX;
222 for (vsize i = 0; i < accepteds.size (); i++)
224 Context_def *g = accepteds[i];
226 vector<Context_def*> result
227 = g->path_to_acceptable_context (type_sym, odef);
228 if (result.size () && result.size () < best_depth)
230 best_depth = result.size ();
231 result.insert (result.begin (), g);
232 best_result = result;
240 Context_def::get_translator_names (SCM user_mod) const
244 SCM mods = scm_reverse_x (scm_list_copy (translator_mods_), user_mod);
246 for (SCM s = mods; scm_is_pair (s); s = scm_cdr (s))
248 SCM tag = scm_caar (s);
249 SCM arg = scm_cadar (s);
251 if (scm_is_string (arg))
252 arg = scm_string_to_symbol (arg);
254 if (ly_symbol2scm ("consists") == tag)
255 l1 = scm_cons (arg, l1);
256 else if (ly_symbol2scm ("remove") == tag)
257 l1 = scm_delete_x (arg, l1);
264 Context_def::instantiate (SCM ops, Object_key const *key)
266 Context *context = new Context (key);
268 context->definition_ = self_scm ();
269 context->definition_mods_ = ops;
270 context->aliases_ = context_aliases_;
271 context->accepts_list_ = get_accepted (ops);
277 Context_def::make_scm ()
279 Context_def *t = new Context_def;
280 return t->unprotect ();
284 Context_def::apply_default_property_operations (Context *tg)
286 apply_property_operations (tg, property_ops_);
290 Context_def::to_alist () const
294 ell = scm_cons (scm_cons (ly_symbol2scm ("consists"),
295 get_translator_names (SCM_EOL)), ell);
296 ell = scm_cons (scm_cons (ly_symbol2scm ("description"), description_), ell);
297 ell = scm_cons (scm_cons (ly_symbol2scm ("aliases"), context_aliases_), ell);
298 ell = scm_cons (scm_cons (ly_symbol2scm ("accepts"), get_accepted (SCM_EOL)),
300 ell = scm_cons (scm_cons (ly_symbol2scm ("property-ops"), property_ops_),
302 ell = scm_cons (scm_cons (ly_symbol2scm ("context-name"), context_name_),
305 if (scm_is_symbol (translator_group_type_))
306 ell = scm_cons (scm_cons (ly_symbol2scm ("group-type"),
307 translator_group_type_), ell);