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 Context_def *me = (Context_def *) SCM_CELL_WORD_1 (smob);
92 scm_gc_mark (me->description_);
93 scm_gc_mark (me->context_aliases_);
94 scm_gc_mark (me->accept_mods_);
95 scm_gc_mark (me->translator_mods_);
96 scm_gc_mark (me->property_ops_);
97 scm_gc_mark (me->translator_group_type_);
98 scm_gc_mark (me->default_child_);
99 scm_gc_mark (me->input_location_);
101 return me->context_name_;
105 Context_def::add_context_mod (SCM mod)
107 SCM tag = scm_car (mod);
108 if (ly_symbol2scm ("description") == tag)
110 description_ = scm_cadr (mod);
115 other modifiers take symbols as argument.
117 SCM sym = scm_cadr (mod);
118 if (scm_is_string (sym))
119 sym = scm_string_to_symbol (sym);
121 if (ly_symbol2scm ("default-child") == tag)
122 default_child_ = sym;
123 else if (ly_symbol2scm ("consists") == tag
124 || ly_symbol2scm ("consists-end") == tag
125 || ly_symbol2scm ("remove") == tag)
127 if (!get_translator (sym))
128 error (_f ("program has no such type: `%s'",
129 ly_symbol2string (sym).c_str ()));
131 translator_mods_ = scm_cons (scm_list_2 (tag, sym), translator_mods_);
133 else if (ly_symbol2scm ("accepts") == tag
134 || ly_symbol2scm ("denies") == tag)
135 accept_mods_ = scm_cons (scm_list_2 (tag, sym), accept_mods_);
136 else if (ly_symbol2scm ("pop") == tag
137 || ly_symbol2scm ("push") == tag
138 || ly_symbol2scm ("assign") == tag
139 || ly_symbol2scm ("unset") == tag)
140 property_ops_ = scm_cons (mod, property_ops_);
141 else if (ly_symbol2scm ("alias") == tag)
142 context_aliases_ = scm_cons (sym, context_aliases_);
143 else if (ly_symbol2scm ("translator-type") == tag)
144 translator_group_type_ = sym;
145 else if (ly_symbol2scm ("context-name") == tag)
148 programming_error ("unknown context mod tag");
152 Context_def::get_accepted (SCM user_mod) const
154 SCM mods = scm_reverse_x (scm_list_copy (accept_mods_), user_mod);
156 for (SCM s = mods; scm_is_pair (s); s = scm_cdr (s))
158 SCM tag = scm_caar (s);
159 SCM sym = scm_cadar (s);
160 if (tag == ly_symbol2scm ("accepts"))
161 acc = scm_cons (sym, acc);
162 else if (tag == ly_symbol2scm ("denies"))
163 acc = scm_delete_x (sym, acc);
166 SCM def = get_default_child (user_mod);
167 if (scm_is_symbol (def))
169 if (scm_memq (def, acc))
170 acc = scm_delete_x (def, acc);
171 acc = scm_cons (def, acc);
178 Context_def::get_default_child (SCM user_mod) const
180 SCM name = default_child_;
181 for (SCM s = user_mod; scm_is_pair (s); s = scm_cdr (s))
183 SCM entry = scm_car (s);
184 if (scm_car (entry) == ly_symbol2scm ("default-child"))
186 name = scm_cadr (entry);
195 Context_def::path_to_acceptable_context (SCM type_sym, Output_def *odef) const
197 assert (scm_is_symbol (type_sym));
199 SCM accepted = get_accepted (SCM_EOL);
201 vector<Context_def*> accepteds;
202 for (SCM s = accepted; scm_is_pair (s); s = scm_cdr (s))
203 if (Context_def *t = unsmob_context_def (find_context_def (odef,
205 accepteds.push_back (t);
207 vector<Context_def*> best_result;
208 for (vsize i = 0; i < accepteds.size (); i++)
210 /* do not check aliases, because \context Staff should not
211 create RhythmicStaff. */
212 if (ly_is_equal (accepteds[i]->get_context_name (), type_sym))
214 best_result.push_back (accepteds[i]);
219 vsize best_depth = INT_MAX;
220 for (vsize i = 0; i < accepteds.size (); i++)
222 Context_def *g = accepteds[i];
224 vector<Context_def*> result
225 = g->path_to_acceptable_context (type_sym, odef);
226 if (result.size () && result.size () < best_depth)
228 best_depth = result.size ();
229 result.insert (result.begin (), g);
230 best_result = result;
238 Context_def::get_translator_names (SCM user_mod) const
242 SCM mods = scm_reverse_x (scm_list_copy (translator_mods_), user_mod);
244 for (SCM s = mods; scm_is_pair (s); s = scm_cdr (s))
246 SCM tag = scm_caar (s);
247 SCM arg = scm_cadar (s);
249 if (scm_is_string (arg))
250 arg = scm_string_to_symbol (arg);
252 if (ly_symbol2scm ("consists") == tag)
253 l1 = scm_cons (arg, l1);
254 else if (ly_symbol2scm ("remove") == tag)
255 l1 = scm_delete_x (arg, l1);
262 Context_def::instantiate (SCM ops, Object_key const *key)
264 Context *context = new Context (key);
266 context->definition_ = self_scm ();
267 context->definition_mods_ = ops;
268 context->aliases_ = context_aliases_;
269 context->accepts_list_ = get_accepted (ops);
275 Context_def::make_scm ()
277 Context_def *t = new Context_def;
278 return t->unprotect ();
282 Context_def::apply_default_property_operations (Context *tg)
284 apply_property_operations (tg, property_ops_);
288 Context_def::to_alist () const
292 ell = scm_cons (scm_cons (ly_symbol2scm ("consists"),
293 get_translator_names (SCM_EOL)), ell);
294 ell = scm_cons (scm_cons (ly_symbol2scm ("description"), description_), ell);
295 ell = scm_cons (scm_cons (ly_symbol2scm ("aliases"), context_aliases_), ell);
296 ell = scm_cons (scm_cons (ly_symbol2scm ("accepts"), get_accepted (SCM_EOL)),
298 ell = scm_cons (scm_cons (ly_symbol2scm ("property-ops"), property_ops_),
300 ell = scm_cons (scm_cons (ly_symbol2scm ("context-name"), context_name_),
303 if (scm_is_symbol (translator_group_type_))
304 ell = scm_cons (scm_cons (ly_symbol2scm ("group-type"),
305 translator_group_type_), ell);