/*
- context-property.cc -- implement manipulation of immutable Grob
- property lists.
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
+ Copyright (C) 2004--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
- (c) 2004 Han-Wen Nienhuys <hanwen@xs4all.nl>
+ 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 <http://www.gnu.org/licenses/>.
*/
#include "context.hh"
-#include "grob-selector.hh"
#include "engraver.hh"
+#include "international.hh"
#include "item.hh"
#include "main.hh"
+#include "simple-closure.hh"
#include "spanner.hh"
+#include "unpure-pure-container.hh"
#include "warn.hh"
+/*
+ like execute_general_pushpop_property(), but typecheck
+ grob_property_path and context_property.
+*/
+void
+general_pushpop_property (Context *context,
+ SCM context_property,
+ SCM grob_property_path,
+ SCM new_value)
+{
+ if (!scm_is_symbol (context_property)
+ || !scm_is_symbol (scm_car (grob_property_path)))
+ {
+ warning (_ ("need symbol arguments for \\override and \\revert"));
+ if (do_internal_type_checking_global)
+ assert (false);
+ }
+
+ sloppy_general_pushpop_property (context, context_property,
+ grob_property_path, new_value);
+}
+
/*
Grob descriptions (ie. alists with layout properties) are
represented as a (ALIST . BASED-ON) pair, where BASED-ON is the
alist defined in a parent context. BASED-ON should always be a tail
of ALIST.
-
- */
-/*
- Push or pop (depending on value of VAL) a single entry (ELTPROP . VAL)
- entry from a translator property list by name of PROP
+ Push or pop (depending on value of VAL) a single entry from a
+ translator property list by name of PROP. GROB_PROPERTY_PATH
+ indicates nested alists, eg. '(beamed-stem-lengths details)
*/
-
-
void
-execute_pushpop_property (Context * trg,
- SCM prop, SCM eltprop, SCM val)
+execute_override_property (Context *context,
+ SCM context_property,
+ SCM grob_property_path,
+ SCM new_value)
{
- if (scm_is_symbol (prop) && scm_is_symbol (eltprop))
+ SCM current_context_val = SCM_EOL;
+
+ Context *where = context->where_defined (context_property,
+ ¤t_context_val);
+
+ /*
+ Don't mess with MIDI.
+ */
+ if (!where)
+ return;
+
+ if (where != context)
{
- if (val != SCM_UNDEFINED)
- {
- SCM prev = SCM_EOL;
- Context * where = trg->where_defined (prop);
-
- /*
- Don't mess with MIDI.
- */
- if (!where)
- return ;
-
- if (where != trg)
- {
- SCM base = updated_grob_properties (trg, prop);
- prev = scm_cons (base, base);
- trg->internal_set_property (prop, prev);
- }
- else
- prev = trg->internal_get_property (prop);
-
- if (!scm_is_pair (prev))
- {
- programming_error ("Grob definition should be cons.");
- return ;
- }
-
- SCM prev_alist = scm_car (prev);
-
- if (scm_is_pair (prev_alist) || prev_alist == SCM_EOL)
- {
- bool ok = type_check_assignment (eltprop, val, ly_symbol2scm ("backend-type?"));
-
- /*
- tack onto alist:
- */
- if (ok)
- scm_set_car_x (prev, scm_acons (eltprop, val, prev_alist));
- }
- else
- {
- // warning here.
- }
- }
- else if (trg->where_defined (prop) == trg)
- {
- SCM prev = trg->internal_get_property (prop);
- SCM prev_alist = scm_car (prev);
- SCM daddy = scm_cdr (prev);
-
- SCM new_alist = SCM_EOL;
- SCM *tail = &new_alist;
-
- while (prev_alist != daddy)
- {
- if (ly_c_equal_p (scm_caar (prev_alist), eltprop))
- {
- prev_alist = scm_cdr (prev_alist);
- break ;
- }
-
-
- *tail = scm_cons (scm_car (prev_alist), SCM_EOL);
- tail = SCM_CDRLOC (*tail);
- prev_alist = scm_cdr (prev_alist);
- }
-
- if (new_alist == SCM_EOL && prev_alist == daddy)
- trg->unset_property (prop);
- else
- {
- *tail = prev_alist;
- trg->internal_set_property (prop, scm_cons (new_alist, daddy));
- }
- }
+ SCM base = updated_grob_properties (context, context_property);
+ current_context_val = scm_cons (base, base);
+ context->set_property (context_property, current_context_val);
}
+
+ if (!scm_is_pair (current_context_val))
+ {
+ programming_error ("Grob definition should be cons");
+ return;
+ }
+
+ SCM target_alist = scm_car (current_context_val);
+
+ /*
+ If the car is a list, the property path comes from a nested override
+ using list syntax inside a \context block
+ */
+ if (scm_is_pair (scm_car (grob_property_path)))
+ grob_property_path = scm_car (grob_property_path);
+
+ SCM symbol = scm_car (grob_property_path);
+ if (scm_is_pair (scm_cdr (grob_property_path)))
+ {
+ new_value = nested_property_alist (ly_assoc_get (symbol, target_alist,
+ SCM_EOL),
+ scm_cdr (grob_property_path),
+ new_value);
+ }
+
+ /* it's tempting to replace the head of the list if it's the same
+ property. However, we have to keep this info around, in case we have to
+ \revert back to it.
+ */
+ target_alist = scm_acons (symbol, new_value, target_alist);
+
+ bool ok = true;
+ bool pc = is_unpure_pure_container (new_value);
+ SCM vals[] = {pc ? unpure_pure_container_unpure_part (new_value) : new_value,
+ pc ? unpure_pure_container_pure_part (new_value) : SCM_BOOL_F
+ };
+
+ for (int i = 0; i < 2; i++)
+ if (!ly_is_procedure (vals[i])
+ && !is_simple_closure (vals[i]))
+ ok = ok && type_check_assignment (symbol, vals[i],
+ ly_symbol2scm ("backend-type?"));
+
+ /*
+ tack onto alist. We can use set_car, since
+ updated_grob_properties () in child contexts will check
+ for changes in the car.
+ */
+ if (ok)
+ {
+ scm_set_car_x (current_context_val, target_alist);
+ }
+}
+
+/*
+ do a pop (indicated by new_value==SCM_UNDEFINED) or push
+ */
+void
+sloppy_general_pushpop_property (Context *context,
+ SCM context_property,
+ SCM grob_property_path,
+ SCM new_value)
+{
+ if (new_value == SCM_UNDEFINED)
+ execute_revert_property (context, context_property,
+ grob_property_path);
else
+ execute_override_property (context, context_property,
+ grob_property_path,
+ new_value);
+}
+
+/*
+ Revert the property given by property_path.
+*/
+void
+execute_revert_property (Context *context,
+ SCM context_property,
+ SCM grob_property_path)
+{
+ SCM current_context_val = SCM_EOL;
+ if (context->where_defined (context_property, ¤t_context_val)
+ == context)
{
- warning ("Need symbol arguments for \\override and \\revert");
- if (internal_type_checking_global_b)
- assert (false);
+ SCM current_alist = scm_car (current_context_val);
+ SCM daddy = scm_cdr (current_context_val);
+
+ if (!scm_is_pair (grob_property_path)
+ || !scm_is_symbol (scm_car (grob_property_path)))
+ {
+ programming_error ("Grob property path should be list of symbols.");
+ return;
+ }
+
+ SCM symbol = scm_car (grob_property_path);
+ if (scm_is_pair (scm_cdr (grob_property_path)))
+ {
+ SCM current_sub_alist = ly_assoc_get (symbol, current_alist, SCM_EOL);
+ SCM new_val
+ = nested_property_revert_alist (current_sub_alist,
+ scm_cdr (grob_property_path));
+
+ if (scm_is_pair (current_alist)
+ && scm_caar (current_alist) == symbol
+ && current_alist != daddy)
+ current_alist = scm_cdr (current_alist);
+
+ current_alist = scm_acons (symbol, new_val, current_alist);
+ scm_set_car_x (current_context_val, current_alist);
+ }
+ else
+ {
+ SCM new_alist = evict_from_alist (symbol, current_alist, daddy);
+
+ if (new_alist == daddy)
+ context->unset_property (context_property);
+ else
+ context->set_property (context_property,
+ scm_cons (new_alist, daddy));
+ }
}
}
+/*
+ Convenience: a push/pop grob property using a single grob_property
+ as argument.
+*/
+void
+execute_pushpop_property (Context *context,
+ SCM context_property,
+ SCM grob_property,
+ SCM new_value)
+{
+ general_pushpop_property (context, context_property,
+ scm_list_1 (grob_property),
+ new_value);
+}
/*
PRE_INIT_OPS is in the order specified, and hence must be reversed.
- */
+*/
void
apply_property_operations (Context *tg, SCM pre_init_ops)
{
- SCM correct_order = scm_reverse (pre_init_ops);
- for (SCM s = correct_order; scm_is_pair (s); s = scm_cdr (s))
+ for (SCM s = pre_init_ops; scm_is_pair (s); s = scm_cdr (s))
{
SCM entry = scm_car (s);
SCM type = scm_car (entry);
- entry = scm_cdr (entry);
-
- if (type == ly_symbol2scm ("push") || type == ly_symbol2scm ("poppush"))
- {
- SCM val = scm_cddr (entry);
- val = scm_is_pair (val) ? scm_car (val) : SCM_UNDEFINED;
-
- execute_pushpop_property (tg, scm_car (entry), scm_cadr (entry), val);
- }
+ entry = scm_cdr (entry);
+ if (!scm_is_pair (entry))
+ continue;
+ SCM context_prop = scm_car (entry);
+ if (scm_is_pair (context_prop))
+ {
+ if (tg->is_alias (scm_car (context_prop)))
+ context_prop = scm_cdr (context_prop);
+ else
+ continue;
+ }
+
+ if (type == ly_symbol2scm ("push"))
+ {
+ SCM val = scm_cadr (entry);
+ SCM grob_prop_path = scm_cddr (entry);
+ sloppy_general_pushpop_property (tg, context_prop, grob_prop_path, val);
+ }
+ else if (type == ly_symbol2scm ("pop"))
+ {
+ SCM val = SCM_UNDEFINED;
+ SCM grob_prop_path = scm_cdr (entry);
+ sloppy_general_pushpop_property (tg, context_prop, grob_prop_path, val);
+ }
else if (type == ly_symbol2scm ("assign"))
- {
- tg->internal_set_property (scm_car (entry), scm_cadr (entry));
- }
+ tg->set_property (context_prop, scm_cadr (entry));
+ else if (type == ly_symbol2scm ("apply"))
+ scm_apply_1 (context_prop, tg->self_scm (), scm_cdr (entry));
}
}
/*
Return the object alist for SYM, checking if its base in enclosing
- contexts has changed. The alist is updated if necessary.
- */
+ contexts has changed. The alist is updated if necessary.
+*/
SCM
-updated_grob_properties (Context * tg, SCM sym)
+updated_grob_properties (Context *tg, SCM sym)
{
assert (scm_is_symbol (sym));
-
- tg = tg->where_defined (sym);
+
+ SCM props;
+ tg = tg->where_defined (sym, &props);
if (!tg)
return SCM_EOL;
-
+
SCM daddy_props
= (tg->get_parent_context ())
- ? updated_grob_properties (tg->get_parent_context (), sym)
- : SCM_EOL;
-
- SCM props = tg->internal_get_property (sym);
+ ? updated_grob_properties (tg->get_parent_context (), sym)
+ : SCM_EOL;
if (!scm_is_pair (props))
{
SCM based_on = scm_cdr (props);
if (based_on == daddy_props)
- {
- return scm_car (props);
- }
+ return scm_car (props);
else
{
SCM copy = daddy_props;
SCM *tail = ©
SCM p = scm_car (props);
- while (p != based_on)
- {
- *tail = scm_cons (scm_car (p), daddy_props);
- tail = SCM_CDRLOC (*tail);
- p = scm_cdr (p);
- }
-
+ while (p != based_on)
+ {
+ *tail = scm_cons (scm_car (p), daddy_props);
+ tail = SCM_CDRLOC (*tail);
+ p = scm_cdr (p);
+ }
+
scm_set_car_x (props, copy);
scm_set_cdr_x (props, daddy_props);
return copy;
}
}
-
-Item *
-make_item_from_properties (Translator *tr, SCM x, SCM cause)
-{
- Context *context = tr->context ();
-
- SCM props = updated_grob_properties (context, x);
- Item *it = new Item (props);
- Grob_selector::register_grob (context, it);
-
- dynamic_cast<Engraver*>(tr)->announce_grob (it, cause);
-
- return it;
-}
-
-Spanner*
-make_spanner_from_properties (Translator *tr, SCM x, SCM cause)
-{
- Context *tg = tr->context ();
-
- SCM props = updated_grob_properties (tg, x);
- Spanner *it = new Spanner (props);
-
- dynamic_cast<Engraver*>(tr)->announce_grob (it, cause);
-
- return it;
-}
projects / lilypond.git / blobdiff