X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fcontext-def.cc;h=72ddf6d37b32e816b0bf585a2fede4f41b429915;hb=5d84bfad4626892bcffd05adcced53c8a2329047;hp=b8d22ffb392b5a3cf4732d2f74b9bf0da94e1037;hpb=94a1966c72301b8bd1d8bb3b8628c3f089d007cf;p=lilypond.git diff --git a/lily/context-def.cc b/lily/context-def.cc index b8d22ffb39..72ddf6d37b 100644 --- a/lily/context-def.cc +++ b/lily/context-def.cc @@ -1,55 +1,33 @@ -/* - translator-def.cc -- implement Context_def - - source file of the GNU LilyPond music typesetter - - (c) 2000--2004 Han-Wen Nienhuys - - */ - /* - TODO: should junk this class an replace by - a single list of context modifications? - */ + This file is part of LilyPond, the GNU music typesetter. -#include "lily-proto.hh" -#include "context-def.hh" -#include "translator-group.hh" -#include "warn.hh" -#include "music-output-def.hh" -#include "ly-smobs.icc" -#include "score-context.hh" + Copyright (C) 2000--2015 Han-Wen Nienhuys -#include "performer.hh" -#include "engraver.hh" + LilyPond is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. -int -Context_def::print_smob (SCM smob, SCM port, scm_print_state*) -{ - Context_def* me = (Context_def*) SCM_CELL_WORD_1 (smob); - - scm_puts ("#context_name_, port); - scm_puts (">", port); - return 1; -} + LilyPond is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + You should have received a copy of the GNU General Public License + along with LilyPond. If not, see . +*/ -SCM -Context_def::mark_smob (SCM smob) -{ - Context_def* me = (Context_def*) SCM_CELL_WORD_1 (smob); +/* TODO: should junk this class an replace by + a single list of context modifications? */ - scm_gc_mark (me->description_); - scm_gc_mark (me->context_aliases_); - scm_gc_mark (me->accept_mods_); - scm_gc_mark (me->translator_mods_); - scm_gc_mark (me->property_ops_); - scm_gc_mark (me->translator_group_type_); - - return me->context_name_; -} +#include "context-def.hh" +#include "context.hh" +#include "context-mod.hh" +#include "international.hh" +#include "output-def.hh" +#include "translator.hh" +#include "warn.hh" Context_def::Context_def () { @@ -59,31 +37,39 @@ Context_def::Context_def () translator_mods_ = SCM_EOL; property_ops_ = SCM_EOL; context_name_ = SCM_EOL; + default_child_ = SCM_EOL; description_ = SCM_EOL; + input_location_ = SCM_EOL; smobify_self (); + input_location_ = Input ().smobbed_copy (); context_name_ = ly_symbol2scm (""); } -Context_def::~Context_def () +Input * +Context_def::origin () const { + return unsmob (input_location_); } -Context_def::Context_def (Context_def const & s) - : Input (s) +Context_def::Context_def (Context_def const &s) + : Smob () { context_aliases_ = SCM_EOL; translator_group_type_ = SCM_EOL; - accept_mods_ = SCM_EOL; + accept_mods_ = SCM_EOL; translator_mods_ = SCM_EOL; property_ops_ = SCM_EOL; context_name_ = SCM_EOL; description_ = SCM_EOL; - + default_child_ = SCM_EOL; + input_location_ = SCM_EOL; smobify_self (); - description_ = s.description_; + description_ = s.description_; + input_location_ = s.origin ()->smobbed_copy (); + default_child_ = s.default_child_; accept_mods_ = s.accept_mods_; property_ops_ = s.property_ops_; translator_mods_ = s.translator_mods_; @@ -92,281 +78,353 @@ Context_def::Context_def (Context_def const & s) context_name_ = s.context_name_; } +Context_def::~Context_def () +{ +} + +const char * const Context_def::type_p_name_ = "ly:context-def?"; + +int +Context_def::print_smob (SCM port, scm_print_state *) const +{ + scm_puts ("#location_string (); + scm_puts (loc.c_str (), port); + scm_puts (">", port); + return 1; +} + +SCM +Context_def::mark_smob () const +{ + ASSERT_LIVE_IS_ALLOWED (self_scm ()); + + scm_gc_mark (description_); + scm_gc_mark (context_aliases_); + scm_gc_mark (accept_mods_); + scm_gc_mark (translator_mods_); + scm_gc_mark (property_ops_); + scm_gc_mark (translator_group_type_); + scm_gc_mark (default_child_); + scm_gc_mark (input_location_); + + return context_name_; +} void Context_def::add_context_mod (SCM mod) { - SCM tag = ly_car (mod); - if (ly_symbol2scm ("description") == tag) + SCM tag = scm_car (mod); + if (scm_is_eq (tag, ly_symbol2scm ("description"))) { - description_ = ly_cadr (mod); - return ; + description_ = scm_cadr (mod); + return; } - SCM sym = ly_cadr (mod); - if (ly_string_p (sym)) + /* + other modifiers take symbols as argument. + */ + SCM sym = scm_cadr (mod); + if (scm_is_string (sym)) sym = scm_string_to_symbol (sym); - - if (ly_symbol2scm ("consists") == tag - || ly_symbol2scm ("consists-end") == tag - || ly_symbol2scm ("remove") == tag) - { - if (!get_translator (sym)) - error (_f ("Program has no such type: `%s'", ly_symbol2string (sym).to_str0 ())); - else - translator_mods_ = scm_cons (scm_list_2 (tag, sym), translator_mods_ ); - } - else if (ly_symbol2scm ("accepts") == tag - || ly_symbol2scm ("denies") == tag) - { - accept_mods_ = scm_cons (scm_list_2 (tag, sym), accept_mods_); - } - else if (ly_symbol2scm ("poppush") == tag - || ly_symbol2scm ("pop") == tag - || ly_symbol2scm ("push") == tag - || ly_symbol2scm ("assign") == tag - || ly_symbol2scm ("unset") == tag) - { - property_ops_ = scm_cons (mod, property_ops_); - } - else if (ly_symbol2scm ("alias") == tag) - { - context_aliases_ = scm_cons (sym, context_aliases_); - } - else if (ly_symbol2scm ("translator-type") == tag) - { - translator_group_type_ = sym; - } - else if (ly_symbol2scm ("context-name") == tag) + + if (scm_is_eq (tag, ly_symbol2scm ("default-child"))) + default_child_ = sym; + else if (scm_is_eq (tag, ly_symbol2scm ("consists")) + || scm_is_eq (tag, ly_symbol2scm ("remove"))) { - context_name_ = sym; + translator_mods_ = scm_cons (scm_list_2 (tag, sym), translator_mods_); } + else if (scm_is_eq (tag, ly_symbol2scm ("accepts")) + || scm_is_eq (tag, ly_symbol2scm ("denies"))) + accept_mods_ = scm_cons (scm_list_2 (tag, sym), accept_mods_); + else if (scm_is_eq (tag, ly_symbol2scm ("pop")) + || scm_is_eq (tag, ly_symbol2scm ("push")) + || scm_is_eq (tag, ly_symbol2scm ("assign")) + || scm_is_eq (tag, ly_symbol2scm ("unset")) + || scm_is_eq (tag, ly_symbol2scm ("apply"))) + property_ops_ = scm_cons (mod, property_ops_); + else if (scm_is_eq (tag, ly_symbol2scm ("alias"))) + context_aliases_ = scm_cons (sym, context_aliases_); + else if (scm_is_eq (tag, ly_symbol2scm ("translator-type"))) + translator_group_type_ = sym; + else if (scm_is_eq (tag, ly_symbol2scm ("context-name"))) + context_name_ = sym; else - { - programming_error ("Unknown context mod tag."); - } -} - - - -SCM -Context_def::get_context_name () const -{ - return context_name_; + programming_error ("unknown context mod tag"); } SCM Context_def::get_accepted (SCM user_mod) const { - SCM mods = scm_reverse_x (scm_list_copy (accept_mods_), - user_mod); + SCM mods = scm_reverse_x (scm_list_copy (accept_mods_), user_mod); SCM acc = SCM_EOL; - for (SCM s = mods; ly_pair_p (s); s = ly_cdr (s)) + for (SCM s = mods; scm_is_pair (s); s = scm_cdr (s)) + { + SCM tag = scm_caar (s); + SCM sym = scm_cadar (s); + if (scm_is_eq (tag, ly_symbol2scm ("accepts"))) + acc = scm_cons (sym, acc); + else if (scm_is_eq (tag, ly_symbol2scm ("denies"))) + acc = scm_delete_x (sym, acc); + } + + SCM def = get_default_child (user_mod); + if (scm_is_symbol (def)) { - SCM tag = ly_caar (s); - SCM sym = ly_cadar (s); - if (tag == ly_symbol2scm ("accepts")) - acc = scm_cons (sym, acc); - else if (tag == ly_symbol2scm ("denies")) - acc = scm_delete_x (sym, acc); + acc = scm_delete_x (def, acc); + acc = scm_cons (def, acc); } + return acc; } - -Link_array -Context_def::path_to_acceptable_context (SCM type_sym, Music_output_def* odef) const +SCM +Context_def::get_default_child (SCM user_mod) const { - assert (ly_symbol_p (type_sym)); - - SCM accepted = get_accepted (SCM_EOL); - - Link_array accepteds; - for (SCM s = accepted; ly_pair_p (s); s = ly_cdr (s)) + SCM name = default_child_; + for (SCM s = user_mod; scm_is_pair (s); s = scm_cdr (s)) { - Context_def *t = unsmob_context_def (odef->find_context_def (ly_car (s))); - if (!t) - continue; - accepteds.push (t); + SCM entry = scm_car (s); + if (scm_is_eq (scm_car (entry), ly_symbol2scm ("default-child"))) + { + name = scm_cadr (entry); + break; + } } - Link_array best_result; - for (int i=0; i < accepteds.size (); i++) + return name; +} + +/* + Given a name of a context that we want to create, finds a list of context + definitions such that: + - the first element in the list defines a context that is a valid child of + the context defined by this Context_def + - each subsequent element in the list defines a context that is a valid child + of the context defined by the preceding element in the list + - the last element in the list defines a context with the given name + + The ADDITIONAL_ACCEPTS parameter is a list of additional contexts that this + specific context def (but not any of the child context defs) should accept. +*/ +vector +Context_def::path_to_acceptable_context (SCM type_sym, + Output_def *odef, + SCM additional_accepts) const +{ + set seen; + return internal_path_to_acceptable_context (type_sym, odef, additional_accepts, &seen); +} + +/* +The SEEN parameter is a set which keeps track of visited contexts, allowing +contexts of the same type to be nested. +*/ +vector +Context_def::internal_path_to_acceptable_context (SCM type_sym, + Output_def *odef, + SCM additional_accepts, + set *seen) const +{ + assert (scm_is_symbol (type_sym)); + + SCM accepted = get_accepted (additional_accepts); + + vector accepteds; + for (SCM s = accepted; scm_is_pair (s); s = scm_cdr (s)) + if (Context_def *t = unsmob (find_context_def (odef, + scm_car (s)))) + accepteds.push_back (t); + + vector best_result; + for (vsize i = 0; i < accepteds.size (); i++) { - /* - don't check aliases, because \context Staff should not create RhythmicStaff. - */ - if (ly_equal_p (accepteds[i]->get_context_name (), type_sym)) - { - best_result.push (accepteds[i]); - return best_result; - } + /* do not check aliases, because \context Staff should not + create RhythmicStaff. */ + if (ly_is_equal (accepteds[i]->get_context_name (), type_sym)) + { + best_result.push_back (accepteds[i]); + return best_result; + } } - - int best_depth= INT_MAX; - for (int i=0; i < accepteds.size (); i++) + + seen->insert (this); + vsize best_depth = INT_MAX; + for (vsize i = 0; i < accepteds.size (); i++) { - Context_def * g = accepteds[i]; - - Link_array result - = g->path_to_acceptable_context (type_sym, odef); - if (result.size () && result.size () < best_depth) - { - result.insert (g,0); - best_result = result; - - /* - this following line was added in 1.9.3, but hsould've been - there all along... Let's hope it doesn't cause nightmares. - */ - best_depth = result.size (); - } + Context_def *g = accepteds[i]; + + if (!seen->count (g)) + { + vector result + = g->internal_path_to_acceptable_context (type_sym, odef, SCM_EOL, seen); + if (result.size () && result.size () < best_depth) + { + best_depth = result.size (); + result.insert (result.begin (), g); + best_result = result; + } + } } + seen->erase (this); return best_result; } -IMPLEMENT_SMOBS (Context_def); -IMPLEMENT_DEFAULT_EQUAL_P (Context_def); - - SCM Context_def::get_translator_names (SCM user_mod) const { SCM l1 = SCM_EOL; - SCM l2 = SCM_EOL; - SCM mods = scm_reverse_x (scm_list_copy (translator_mods_), - user_mod); - - for (SCM s = mods; ly_pair_p (s); s = ly_cdr (s)) - { - SCM tag = ly_caar (s); - SCM arg = ly_cadar (s); - - if (ly_string_p (arg)) - arg = scm_string_to_symbol (arg); - - if (ly_symbol2scm ("consists") == tag) - l1 = scm_cons (arg, l1); - else if (ly_symbol2scm ("consists-end") == tag) - l2 = scm_cons (arg, l2); - else if (ly_symbol2scm ("remove") == tag) - { - l1 = scm_delete_x (arg, l1); - l2 = scm_delete_x (arg, l2); - } - } - - return scm_append_x (scm_list_2 (l1, l2)); -} + SCM mods = scm_reverse_x (scm_list_copy (translator_mods_), user_mod); - -SCM -filter_performers (SCM l) -{ - for (SCM *tail = &l; ly_pair_p (*tail); tail = SCM_CDRLOC (*tail)) + for (SCM s = mods; scm_is_pair (s); s = scm_cdr (s)) { - if (dynamic_cast (unsmob_translator (ly_car (*tail)))) - { - *tail = ly_cdr (*tail); - } - } - return l; -} + SCM tag = scm_caar (s); + SCM arg = scm_cadar (s); + if (scm_is_string (arg)) + arg = scm_string_to_symbol (arg); -SCM -filter_engravers (SCM l) -{ - for (SCM *tail = &l; ly_pair_p (*tail) ; tail = SCM_CDRLOC (*tail)) - { - if (dynamic_cast (unsmob_translator (ly_car (*tail)))) - { - *tail = ly_cdr (*tail); - } + if (scm_is_eq (tag, ly_symbol2scm ("consists"))) + l1 = scm_cons (arg, l1); + else if (scm_is_eq (tag, ly_symbol2scm ("remove"))) + l1 = scm_delq_x (arg, l1); } - return l; -} + return l1; +} Context * Context_def::instantiate (SCM ops) { - Context * tg = 0; - - if (context_name_ == ly_symbol2scm ("Score")) - tg = new Score_context (); - else - tg = new Context (); - - tg->definition_ = self_scm (); - - SCM trans_names = get_translator_names (ops); - - Translator * g = get_translator (translator_group_type_); - g = g->clone (); - - g->simple_trans_list_ = names_to_translators (trans_names, tg); - tg->implementation_ = g->self_scm (); - if (dynamic_cast (g)) - g->simple_trans_list_ = filter_performers (g->simple_trans_list_); - else if (dynamic_cast (g)) - g->simple_trans_list_ = filter_engravers (g->simple_trans_list_); - - g->daddy_context_ = tg; - tg->aliases_ = context_aliases_ ; - - scm_gc_unprotect_object (g->self_scm ()); - - tg->accepts_list_ = get_accepted (ops); - - return tg; -} + Context *context = new Context (); + context->definition_ = self_scm (); + context->definition_mods_ = ops; + context->aliases_ = context_aliases_; + context->accepts_list_ = get_accepted (ops); + context->default_child_ = get_default_child (ops); -SCM -Context_def::clone_scm () const -{ - Context_def * t = new Context_def (*this); - - SCM x = t->self_scm (); - scm_gc_unprotect_object (x); - return x; + return context; } SCM Context_def::make_scm () { - Context_def* t = new Context_def; - - SCM x =t->self_scm (); - scm_gc_unprotect_object (x); - return x; + Context_def *t = new Context_def; + return t->unprotect (); } void Context_def::apply_default_property_operations (Context *tg) { - apply_property_operations (tg , property_ops_); + apply_property_operations (tg, scm_reverse (property_ops_)); } SCM Context_def::to_alist () const { - SCM l = SCM_EOL; + SCM ell = SCM_EOL; + + ell = scm_cons (scm_cons (ly_symbol2scm ("consists"), + get_translator_names (SCM_EOL)), ell); + ell = scm_cons (scm_cons (ly_symbol2scm ("description"), description_), ell); + ell = scm_cons (scm_cons (ly_symbol2scm ("aliases"), context_aliases_), ell); + ell = scm_cons (scm_cons (ly_symbol2scm ("accepts"), get_accepted (SCM_EOL)), + ell); + if (scm_is_symbol (default_child_)) + ell = scm_acons (ly_symbol2scm ("default-child"), default_child_, ell); + ell = scm_cons (scm_cons (ly_symbol2scm ("accepts"), get_accepted (SCM_EOL)), + ell); + ell = scm_cons (scm_cons (ly_symbol2scm ("property-ops"), property_ops_), + ell); + ell = scm_cons (scm_cons (ly_symbol2scm ("context-name"), context_name_), + ell); + + if (scm_is_symbol (translator_group_type_)) + ell = scm_cons (scm_cons (ly_symbol2scm ("group-type"), + translator_group_type_), ell); + return ell; +} - l = scm_cons (scm_cons (ly_symbol2scm ("consists"), - get_translator_names (SCM_EOL)), l); - l = scm_cons (scm_cons (ly_symbol2scm ("description"), description_), l); - l = scm_cons (scm_cons (ly_symbol2scm ("aliases"), context_aliases_), l); - l = scm_cons (scm_cons (ly_symbol2scm ("accepts"), get_accepted (SCM_EOL)), l); - l = scm_cons (scm_cons (ly_symbol2scm ("property-ops"), property_ops_), l); - l = scm_cons (scm_cons (ly_symbol2scm ("context-name"), context_name_), l); +SCM +Context_def::lookup (SCM sym) const +{ + if (scm_is_eq (ly_symbol2scm ("default-child"), sym)) + return default_child_; + else if (scm_is_eq (ly_symbol2scm ("consists"), sym)) + return get_translator_names (SCM_EOL); + else if (scm_is_eq (ly_symbol2scm ("description"), sym)) + return description_; + else if (scm_is_eq (ly_symbol2scm ("aliases"), sym)) + return context_aliases_; + else if (scm_is_eq (ly_symbol2scm ("accepts"), sym)) + return get_accepted (SCM_EOL); + else if (scm_is_eq (ly_symbol2scm ("property-ops"), sym)) + return property_ops_; + else if (scm_is_eq (ly_symbol2scm ("context-name"), sym)) + return context_name_; + else if (scm_is_eq (ly_symbol2scm ("group-type"), sym)) + return translator_group_type_; + return SCM_UNDEFINED; +} - if (ly_symbol_p (translator_group_type_)) - l = scm_cons (scm_cons (ly_symbol2scm ("group-type"), translator_group_type_), l); +bool +Context_def::is_alias (SCM sym) const +{ + if (scm_is_eq (sym, ly_symbol2scm ("Bottom"))) + return !scm_is_symbol (get_default_child (SCM_EOL)); - return l; + if (scm_is_eq (sym, get_context_name ())) + return true; + + return scm_is_true (scm_c_memq (sym, context_aliases_)); +} + +LY_DEFINE (ly_context_def_lookup, "ly:context-def-lookup", + 2, 1, 0, (SCM def, SCM sym, SCM val), + "Return the value of @var{sym} in context definition @var{def}" + " (e.g., @code{\\Voice}). If no value is found, return" + " @var{val} or @code{'()} if @var{val} is undefined." + " @var{sym} can be any of @samp{default-child}, @samp{consists}," + " @samp{description}, @samp{aliases}, @samp{accepts}," + " @samp{property-ops}, @samp{context-name}, @samp{group-type}.") +{ + LY_ASSERT_SMOB (Context_def, def, 1); + Context_def *cd = unsmob (def); + LY_ASSERT_TYPE (ly_is_symbol, sym, 2); + + SCM res = cd->lookup (sym); + + scm_remember_upto_here_1 (def); + + if (SCM_UNBNDP (res)) + res = SCM_EOL; + + if (scm_is_null (res) && !SCM_UNBNDP (val)) + return val; + + return res; } +LY_DEFINE (ly_context_def_modify, "ly:context-def-modify", + 2, 0, 0, (SCM def, SCM mod), + "Return the result of applying the context-mod @var{mod} to" + " the context definition @var{def}. Does not change @var{def}.") +{ + LY_ASSERT_SMOB (Context_def, def, 1); + LY_ASSERT_SMOB (Context_mod, mod, 2); + + Context_def *cd = unsmob (def)->clone (); + + for (SCM s = unsmob (mod)->get_mods (); + scm_is_pair (s); + s = scm_cdr (s)) + cd->add_context_mod (scm_car (s)); + + return cd->unprotect (); +}