X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fcontext-def.cc;h=b4e1e2567cc19397940b58e41a4852a1b9bb9ca2;hb=32a34dcef0c0041c6d62677487a380b5c8b85712;hp=8ae1f52b38fe8448747cea57d7d048e7fb678dd8;hpb=0eb7d103fae1508384b1918069f9b6ef16fe5837;p=lilypond.git diff --git a/lily/context-def.cc b/lily/context-def.cc index 8ae1f52b38..b4e1e2567c 100644 --- a/lily/context-def.cc +++ b/lily/context-def.cc @@ -1,9 +1,20 @@ /* - translator-def.cc -- implement Context_def + This file is part of LilyPond, the GNU music typesetter. - source file of the GNU LilyPond music typesetter + Copyright (C) 2000--2012 Han-Wen Nienhuys - (c) 2000--2005 Han-Wen Nienhuys + 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. + + 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 . */ /* TODO: should junk this class an replace by @@ -11,16 +22,13 @@ #include "context-def.hh" -#include "engraver.hh" +#include "context.hh" +#include "context-mod.hh" +#include "international.hh" #include "output-def.hh" -#include "performer.hh" -#include "score-context.hh" -#include "translator-group.hh" +#include "translator.hh" #include "warn.hh" -#include "engraver-group.hh" -#include "performer-group.hh" - Context_def::Context_def () { context_aliases_ = SCM_EOL; @@ -31,14 +39,21 @@ Context_def::Context_def () context_name_ = SCM_EOL; default_child_ = SCM_EOL; description_ = SCM_EOL; + input_location_ = SCM_EOL; smobify_self (); + input_location_ = make_input (Input ()); context_name_ = ly_symbol2scm (""); } +Input * +Context_def::origin () const +{ + return unsmob_input (input_location_); +} + Context_def::Context_def (Context_def const &s) - : Input (s) { context_aliases_ = SCM_EOL; translator_group_type_ = SCM_EOL; @@ -48,10 +63,11 @@ Context_def::Context_def (Context_def const &s) 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_ = make_input (*s.origin ()); default_child_ = s.default_child_; accept_mods_ = s.accept_mods_; property_ops_ = s.property_ops_; @@ -68,9 +84,10 @@ Context_def::~Context_def () #include "ly-smobs.icc" IMPLEMENT_SMOBS (Context_def); IMPLEMENT_DEFAULT_EQUAL_P (Context_def); +IMPLEMENT_TYPE_P (Context_def, "ly:context-def?"); int -Context_def::print_smob (SCM smob, SCM port, scm_print_state*) +Context_def::print_smob (SCM smob, SCM port, scm_print_state *) { Context_def *me = (Context_def *) SCM_CELL_WORD_1 (smob); @@ -83,6 +100,8 @@ Context_def::print_smob (SCM smob, SCM port, scm_print_state*) SCM Context_def::mark_smob (SCM smob) { + ASSERT_LIVE_IS_ALLOWED (smob); + Context_def *me = (Context_def *) SCM_CELL_WORD_1 (smob); scm_gc_mark (me->description_); @@ -92,6 +111,7 @@ Context_def::mark_smob (SCM smob) scm_gc_mark (me->property_ops_); scm_gc_mark (me->translator_group_type_); scm_gc_mark (me->default_child_); + scm_gc_mark (me->input_location_); return me->context_name_; } @@ -116,23 +136,18 @@ Context_def::add_context_mod (SCM mod) if (ly_symbol2scm ("default-child") == tag) default_child_ = sym; else if (ly_symbol2scm ("consists") == tag - || ly_symbol2scm ("consists-end") == tag - || ly_symbol2scm ("remove") == 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_); + translator_mods_ = scm_cons (scm_list_2 (tag, sym), translator_mods_); } else if (ly_symbol2scm ("accepts") == tag - || ly_symbol2scm ("denies") == 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) + else if (ly_symbol2scm ("pop") == tag + || ly_symbol2scm ("push") == tag + || ly_symbol2scm ("assign") == tag + || ly_symbol2scm ("unset") == tag + || ly_symbol2scm ("apply") == tag) property_ops_ = scm_cons (mod, property_ops_); else if (ly_symbol2scm ("alias") == tag) context_aliases_ = scm_cons (sym, context_aliases_); @@ -144,12 +159,6 @@ Context_def::add_context_mod (SCM mod) programming_error ("unknown context mod tag"); } -SCM -Context_def::get_context_name () const -{ - return context_name_; -} - SCM Context_def::get_accepted (SCM user_mod) const { @@ -160,16 +169,15 @@ Context_def::get_accepted (SCM user_mod) const SCM tag = scm_caar (s); SCM sym = scm_cadar (s); if (tag == ly_symbol2scm ("accepts")) - acc = scm_cons (sym, acc); + acc = scm_cons (sym, acc); else if (tag == ly_symbol2scm ("denies")) - acc = scm_delete_x (sym, acc); + acc = scm_delete_x (sym, acc); } SCM def = get_default_child (user_mod); if (scm_is_symbol (def)) { - if (scm_memq (def, acc)) - acc = scm_delete_x (def, acc); + acc = scm_delete_x (def, acc); acc = scm_cons (def, acc); } @@ -184,54 +192,87 @@ Context_def::get_default_child (SCM user_mod) const { SCM entry = scm_car (s); if (scm_car (entry) == ly_symbol2scm ("default-child")) - { - name = scm_cadr (entry); - break; - } + { + name = scm_cadr (entry); + break; + } } return name; } -Link_array -Context_def::path_to_acceptable_context (SCM type_sym, Output_def *odef) const +/* + 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 (SCM_EOL); + SCM accepted = get_accepted (additional_accepts); - Link_array accepteds; + vector accepteds; for (SCM s = accepted; scm_is_pair (s); s = scm_cdr (s)) if (Context_def *t = unsmob_context_def (find_context_def (odef, - scm_car (s)))) - accepteds.push (t); + scm_car (s)))) + accepteds.push_back (t); - Link_array best_result; - for (int i = 0; i < accepteds.size (); i++) + vector best_result; + for (vsize i = 0; i < accepteds.size (); i++) { /* do not check aliases, because \context Staff should not - create RhythmicStaff. */ + create RhythmicStaff. */ if (ly_is_equal (accepteds[i]->get_context_name (), type_sym)) - { - best_result.push (accepteds[i]); - return best_result; - } + { + 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) - { - best_depth = result.size (); - result.insert (g, 0); - best_result = result; - } + 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; } @@ -249,118 +290,33 @@ Context_def::get_translator_names (SCM user_mod) const SCM arg = scm_cadar (s); if (scm_is_string (arg)) - arg = scm_string_to_symbol (arg); + arg = scm_string_to_symbol (arg); if (ly_symbol2scm ("consists") == tag) - l1 = scm_cons (arg, l1); - else if (ly_symbol2scm ("remove") == tag) - l1 = scm_delete_x (arg, l1); + l1 = scm_cons (arg, l1); + else if (ly_symbol2scm ("remove") == tag + && (scm_is_pair (arg) + || ly_is_procedure (arg) + || get_translator (arg))) + l1 = scm_delete_x (arg, l1); } return l1; } -SCM -filter_performers (SCM ell) -{ - SCM *tail = ℓ - for (SCM p = ell; scm_is_pair (p); p = scm_cdr (p)) - { - if (dynamic_cast (unsmob_translator (scm_car (*tail)))) - *tail = scm_cdr (*tail); - else - tail = SCM_CDRLOC (*tail); - } - return ell; -} - -SCM -filter_engravers (SCM ell) -{ - SCM *tail = ℓ - for (SCM p = ell; scm_is_pair (p); p = scm_cdr (p)) - { - if (dynamic_cast (unsmob_translator (scm_car (*tail)))) - *tail = scm_cdr (*tail); - else - tail = SCM_CDRLOC (*tail); - } - return ell; -} - Context * -Context_def::instantiate (SCM ops, Object_key const *key) +Context_def::instantiate (SCM ops) { - Context *context = 0; - - if (context_name_ == ly_symbol2scm ("Score")) - context = new Score_context (key); - else - context = new Context (key); + Context *context = new Context (); context->definition_ = self_scm (); - - SCM trans_names = get_translator_names (ops); - - Translator_group *g = get_translator_group (translator_group_type_); - SCM trans_list = SCM_EOL; - - for (SCM s = trans_names; scm_is_pair (s); s = scm_cdr (s)) - { - Translator *t = get_translator (scm_car (s)); - if (!t) - warning (_f ("can't find: `%s'", s)); - else - { - Translator *tr = t->clone (); - SCM str = tr->self_scm (); - - if (tr->must_be_last ()) - { - SCM cons = scm_cons (str, SCM_EOL); - if (scm_is_pair (trans_list)) - scm_set_cdr_x (scm_last_pair (trans_list), cons); - else - trans_list = cons; - } - else - trans_list = scm_cons (str, trans_list); - - tr->daddy_context_ = context; - tr->unprotect (); - } - } - - /* - Ugh, todo: should just make a private - copy of Context_def with the user mods. - */ - - g->simple_trans_list_ = trans_list; - - context->implementation_ = g; - 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->context_ = context; + context->definition_mods_ = ops; context->aliases_ = context_aliases_; - - g->unprotect (); - context->accepts_list_ = get_accepted (ops); return context; } -SCM -Context_def::clone_scm () const -{ - Context_def *t = new Context_def (*this); - return t->unprotect (); -} - SCM Context_def::make_scm () { @@ -371,7 +327,7 @@ Context_def::make_scm () void Context_def::apply_default_property_operations (Context *tg) { - apply_property_operations (tg, property_ops_); + apply_property_operations (tg, scm_reverse (property_ops_)); } SCM @@ -380,19 +336,93 @@ Context_def::to_alist () const SCM ell = SCM_EOL; ell = scm_cons (scm_cons (ly_symbol2scm ("consists"), - get_translator_names (SCM_EOL)), ell); + 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); + ell); ell = scm_cons (scm_cons (ly_symbol2scm ("property-ops"), property_ops_), - ell); + ell); ell = scm_cons (scm_cons (ly_symbol2scm ("context-name"), context_name_), - ell); + ell); if (scm_is_symbol (translator_group_type_)) ell = scm_cons (scm_cons (ly_symbol2scm ("group-type"), - translator_group_type_), ell); + translator_group_type_), ell); return ell; } +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; +} + +bool +Context_def::is_alias (SCM sym) const +{ + if (scm_is_eq (sym, ly_symbol2scm ("Bottom"))) + return !scm_is_pair (get_accepted (SCM_EOL)); + + 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 output definition @var{def}" + " (e.g., @code{\\paper}). If no value is found, return" + " @var{val} or @code{'()} if @var{val} is undefined.") +{ + LY_ASSERT_SMOB (Context_def, def, 1); + Context_def *cd = unsmob_context_def (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_context_def (def)->clone (); + + for (SCM s = unsmob_context_mod (mod)->get_mods (); + scm_is_pair (s); + s = scm_cdr (s)) + cd->add_context_mod (scm_car (s)); + + return cd->unprotect (); +}