2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2000--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
6 LilyPond is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 LilyPond is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
20 /* TODO: should junk this class an replace by
21 a single list of context modifications? */
23 #include "context-def.hh"
26 #include "context-mod.hh"
27 #include "international.hh"
28 #include "output-def.hh"
29 #include "translator.hh"
32 ADD_SMOB_INIT (Context_def);
34 Context_def::Context_def ()
36 context_aliases_ = SCM_EOL;
37 translator_group_type_ = SCM_EOL;
38 accept_mods_ = SCM_EOL;
39 translator_mods_ = SCM_EOL;
40 property_ops_ = SCM_EOL;
41 context_name_ = SCM_EOL;
42 default_child_ = SCM_EOL;
43 description_ = SCM_EOL;
44 input_location_ = SCM_EOL;
48 input_location_ = Input ().smobbed_copy ();
49 context_name_ = ly_symbol2scm ("");
53 Context_def::origin () const
55 return Input::unsmob (input_location_);
58 Context_def::Context_def (Context_def const &s)
59 : Smob<Context_def> ()
61 context_aliases_ = SCM_EOL;
62 translator_group_type_ = SCM_EOL;
63 accept_mods_ = SCM_EOL;
64 translator_mods_ = SCM_EOL;
65 property_ops_ = SCM_EOL;
66 context_name_ = SCM_EOL;
67 description_ = SCM_EOL;
68 default_child_ = SCM_EOL;
69 input_location_ = SCM_EOL;
72 description_ = s.description_;
73 input_location_ = s.origin ()->smobbed_copy ();
74 default_child_ = s.default_child_;
75 accept_mods_ = s.accept_mods_;
76 property_ops_ = s.property_ops_;
77 translator_mods_ = s.translator_mods_;
78 context_aliases_ = s.context_aliases_;
79 translator_group_type_ = s.translator_group_type_;
80 context_name_ = s.context_name_;
83 Context_def::~Context_def ()
87 const char Context_def::type_p_name_[] = "ly:context-def?";
90 Context_def::print_smob (SCM port, scm_print_state *)
92 scm_puts ("#<Context_def ", port);
93 scm_display (context_name_, port);
95 string loc = origin ()->location_string ();
96 scm_puts (loc.c_str (), port);
102 Context_def::mark_smob ()
104 ASSERT_LIVE_IS_ALLOWED (self_scm ());
106 scm_gc_mark (description_);
107 scm_gc_mark (context_aliases_);
108 scm_gc_mark (accept_mods_);
109 scm_gc_mark (translator_mods_);
110 scm_gc_mark (property_ops_);
111 scm_gc_mark (translator_group_type_);
112 scm_gc_mark (default_child_);
113 scm_gc_mark (input_location_);
115 return context_name_;
119 Context_def::add_context_mod (SCM mod)
121 SCM tag = scm_car (mod);
122 if (scm_is_eq (tag, ly_symbol2scm ("description")))
124 description_ = scm_cadr (mod);
129 other modifiers take symbols as argument.
131 SCM sym = scm_cadr (mod);
132 if (scm_is_string (sym))
133 sym = scm_string_to_symbol (sym);
135 if (scm_is_eq (tag, ly_symbol2scm ("default-child")))
136 default_child_ = sym;
137 else if (scm_is_eq (tag, ly_symbol2scm ("consists"))
138 || scm_is_eq (tag, ly_symbol2scm ("remove")))
140 translator_mods_ = scm_cons (scm_list_2 (tag, sym), translator_mods_);
142 else if (scm_is_eq (tag, ly_symbol2scm ("accepts"))
143 || scm_is_eq (tag, ly_symbol2scm ("denies")))
144 accept_mods_ = scm_cons (scm_list_2 (tag, sym), accept_mods_);
145 else if (scm_is_eq (tag, ly_symbol2scm ("pop"))
146 || scm_is_eq (tag, ly_symbol2scm ("push"))
147 || scm_is_eq (tag, ly_symbol2scm ("assign"))
148 || scm_is_eq (tag, ly_symbol2scm ("unset"))
149 || scm_is_eq (tag, ly_symbol2scm ("apply")))
150 property_ops_ = scm_cons (mod, property_ops_);
151 else if (scm_is_eq (tag, ly_symbol2scm ("alias")))
152 context_aliases_ = scm_cons (sym, context_aliases_);
153 else if (scm_is_eq (tag, ly_symbol2scm ("translator-type")))
154 translator_group_type_ = sym;
155 else if (scm_is_eq (tag, ly_symbol2scm ("context-name")))
158 programming_error ("unknown context mod tag");
162 Context_def::get_accepted (SCM user_mod) const
164 SCM mods = scm_reverse_x (scm_list_copy (accept_mods_), user_mod);
166 for (SCM s = mods; scm_is_pair (s); s = scm_cdr (s))
168 SCM tag = scm_caar (s);
169 SCM sym = scm_cadar (s);
170 if (scm_is_eq (tag, ly_symbol2scm ("accepts")))
171 acc = scm_cons (sym, acc);
172 else if (scm_is_eq (tag, ly_symbol2scm ("denies")))
173 acc = scm_delete_x (sym, acc);
176 SCM def = get_default_child (user_mod);
177 if (scm_is_symbol (def))
179 acc = scm_delete_x (def, acc);
180 acc = scm_cons (def, acc);
187 Context_def::get_default_child (SCM user_mod) const
189 SCM name = default_child_;
190 for (SCM s = user_mod; scm_is_pair (s); s = scm_cdr (s))
192 SCM entry = scm_car (s);
193 if (scm_is_eq (scm_car (entry), ly_symbol2scm ("default-child")))
195 name = scm_cadr (entry);
204 Given a name of a context that we want to create, finds a list of context
205 definitions such that:
206 - the first element in the list defines a context that is a valid child of
207 the context defined by this Context_def
208 - each subsequent element in the list defines a context that is a valid child
209 of the context defined by the preceding element in the list
210 - the last element in the list defines a context with the given name
212 The ADDITIONAL_ACCEPTS parameter is a list of additional contexts that this
213 specific context def (but not any of the child context defs) should accept.
215 vector<Context_def *>
216 Context_def::path_to_acceptable_context (SCM type_sym,
218 SCM additional_accepts) const
220 set<const Context_def *> seen;
221 return internal_path_to_acceptable_context (type_sym, odef, additional_accepts, &seen);
225 The SEEN parameter is a set which keeps track of visited contexts, allowing
226 contexts of the same type to be nested.
228 vector<Context_def *>
229 Context_def::internal_path_to_acceptable_context (SCM type_sym,
231 SCM additional_accepts,
232 set<const Context_def *> *seen) const
234 assert (scm_is_symbol (type_sym));
236 SCM accepted = get_accepted (additional_accepts);
238 vector<Context_def *> accepteds;
239 for (SCM s = accepted; scm_is_pair (s); s = scm_cdr (s))
240 if (Context_def *t = Context_def::unsmob (find_context_def (odef,
242 accepteds.push_back (t);
244 vector<Context_def *> best_result;
245 for (vsize i = 0; i < accepteds.size (); i++)
247 /* do not check aliases, because \context Staff should not
248 create RhythmicStaff. */
249 if (ly_is_equal (accepteds[i]->get_context_name (), type_sym))
251 best_result.push_back (accepteds[i]);
257 vsize best_depth = INT_MAX;
258 for (vsize i = 0; i < accepteds.size (); i++)
260 Context_def *g = accepteds[i];
262 if (!seen->count (g))
264 vector<Context_def *> result
265 = g->internal_path_to_acceptable_context (type_sym, odef, SCM_EOL, seen);
266 if (result.size () && result.size () < best_depth)
268 best_depth = result.size ();
269 result.insert (result.begin (), g);
270 best_result = result;
280 Context_def::get_translator_names (SCM user_mod) const
284 SCM mods = scm_reverse_x (scm_list_copy (translator_mods_), user_mod);
286 for (SCM s = mods; scm_is_pair (s); s = scm_cdr (s))
288 SCM tag = scm_caar (s);
289 SCM arg = scm_cadar (s);
291 if (scm_is_string (arg))
292 arg = scm_string_to_symbol (arg);
294 if (scm_is_eq (tag, ly_symbol2scm ("consists")))
295 l1 = scm_cons (arg, l1);
296 else if (scm_is_eq (tag, ly_symbol2scm ("remove"))
297 && (scm_is_pair (arg)
298 || ly_is_procedure (arg)
299 || get_translator (arg)))
300 l1 = scm_delete_x (arg, l1);
307 Context_def::instantiate (SCM ops)
309 Context *context = new Context ();
311 context->definition_ = self_scm ();
312 context->definition_mods_ = ops;
313 context->aliases_ = context_aliases_;
314 context->accepts_list_ = get_accepted (ops);
315 context->default_child_ = get_default_child (ops);
321 Context_def::make_scm ()
323 Context_def *t = new Context_def;
324 return t->unprotect ();
328 Context_def::apply_default_property_operations (Context *tg)
330 apply_property_operations (tg, scm_reverse (property_ops_));
334 Context_def::to_alist () const
338 ell = scm_cons (scm_cons (ly_symbol2scm ("consists"),
339 get_translator_names (SCM_EOL)), ell);
340 ell = scm_cons (scm_cons (ly_symbol2scm ("description"), description_), ell);
341 ell = scm_cons (scm_cons (ly_symbol2scm ("aliases"), context_aliases_), ell);
342 ell = scm_cons (scm_cons (ly_symbol2scm ("accepts"), get_accepted (SCM_EOL)),
344 if (scm_is_symbol (default_child_))
345 ell = scm_acons (ly_symbol2scm ("default-child"), default_child_, ell);
346 ell = scm_cons (scm_cons (ly_symbol2scm ("accepts"), get_accepted (SCM_EOL)),
348 ell = scm_cons (scm_cons (ly_symbol2scm ("property-ops"), property_ops_),
350 ell = scm_cons (scm_cons (ly_symbol2scm ("context-name"), context_name_),
353 if (scm_is_symbol (translator_group_type_))
354 ell = scm_cons (scm_cons (ly_symbol2scm ("group-type"),
355 translator_group_type_), ell);
360 Context_def::lookup (SCM sym) const
362 if (scm_is_eq (ly_symbol2scm ("default-child"), sym))
363 return default_child_;
364 else if (scm_is_eq (ly_symbol2scm ("consists"), sym))
365 return get_translator_names (SCM_EOL);
366 else if (scm_is_eq (ly_symbol2scm ("description"), sym))
368 else if (scm_is_eq (ly_symbol2scm ("aliases"), sym))
369 return context_aliases_;
370 else if (scm_is_eq (ly_symbol2scm ("accepts"), sym))
371 return get_accepted (SCM_EOL);
372 else if (scm_is_eq (ly_symbol2scm ("property-ops"), sym))
373 return property_ops_;
374 else if (scm_is_eq (ly_symbol2scm ("context-name"), sym))
375 return context_name_;
376 else if (scm_is_eq (ly_symbol2scm ("group-type"), sym))
377 return translator_group_type_;
378 return SCM_UNDEFINED;
382 Context_def::is_alias (SCM sym) const
384 if (scm_is_eq (sym, ly_symbol2scm ("Bottom")))
385 return !scm_is_symbol (get_default_child (SCM_EOL));
387 if (scm_is_eq (sym, get_context_name ()))
390 return scm_is_true (scm_c_memq (sym, context_aliases_));
393 LY_DEFINE (ly_context_def_lookup, "ly:context-def-lookup",
394 2, 1, 0, (SCM def, SCM sym, SCM val),
395 "Return the value of @var{sym} in context definition @var{def}"
396 " (e.g., @code{\\Voice}). If no value is found, return"
397 " @var{val} or @code{'()} if @var{val} is undefined."
398 " @var{sym} can be any of @samp{default-child}, @samp{consists},"
399 " @samp{description}, @samp{aliases}, @samp{accepts},"
400 " @samp{property-ops}, @samp{context-name}, @samp{group-type}.")
402 LY_ASSERT_SMOB (Context_def, def, 1);
403 Context_def *cd = Context_def::unsmob (def);
404 LY_ASSERT_TYPE (ly_is_symbol, sym, 2);
406 SCM res = cd->lookup (sym);
408 scm_remember_upto_here_1 (def);
410 if (SCM_UNBNDP (res))
413 if (scm_is_null (res) && !SCM_UNBNDP (val))
419 LY_DEFINE (ly_context_def_modify, "ly:context-def-modify",
420 2, 0, 0, (SCM def, SCM mod),
421 "Return the result of applying the context-mod @var{mod} to"
422 " the context definition @var{def}. Does not change @var{def}.")
424 LY_ASSERT_SMOB (Context_def, def, 1);
425 LY_ASSERT_SMOB (Context_mod, mod, 2);
427 Context_def *cd = Context_def::unsmob (def)->clone ();
429 for (SCM s = Context_mod::unsmob (mod)->get_mods ();
432 cd->add_context_mod (scm_car (s));
434 return cd->unprotect ();