/*
- context-scheme.cc -- Context bindings
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
-
- (c) 1998--2007 Jan Nieuwenhuizen <janneke@gnu.org>
+ Copyright (C) 1998--2015 Jan Nieuwenhuizen <janneke@gnu.org>
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 "context-def.hh"
#include "dispatcher.hh"
+#include "grob-properties.hh"
+
+LY_DEFINE (ly_context_current_moment,
+ "ly:context-current-moment",
+ 1, 0, 0, (SCM context),
+ "Return the current moment of @var{context}.")
+{
+ Context *tr = unsmob<Context> (context);
+
+ LY_ASSERT_SMOB (Context, context, 1);
+
+ return tr->now_mom ().smobbed_copy ();
+}
LY_DEFINE (ly_context_id, "ly:context-id",
- 1, 0, 0, (SCM context),
- "Return the id string of @var{context}, "
- "i.e. for @code{\\context Voice = one .. } "
- "return the string @code{one}.")
+ 1, 0, 0, (SCM context),
+ "Return the ID string of @var{context},"
+ " i.e., for @code{\\context Voice = \"one\" @dots{}}"
+ " return the string @code{one}.")
{
- Context *tr = unsmob_context (context);
- SCM_ASSERT_TYPE (tr, context, SCM_ARG1, __FUNCTION__, "Context");
+ Context *tr = unsmob<Context> (context);
+
+ LY_ASSERT_SMOB (Context, context, 1);
return ly_string2scm (tr->id_string ());
}
LY_DEFINE (ly_context_name, "ly:context-name",
- 1, 0, 0, (SCM context),
- "Return the name of @var{context}, "
- "i.e. for @code{\\context Voice = one .. } "
- "return the symbol @code{Voice}.")
+ 1, 0, 0, (SCM context),
+ "Return the name of @var{context},"
+ " i.e., for @code{\\context Voice = \"one\" @dots{}}"
+ " return the symbol @code{Voice}.")
{
- Context *tr = unsmob_context (context);
- SCM_ASSERT_TYPE (tr, context, SCM_ARG1, __FUNCTION__, "Context");
+ LY_ASSERT_SMOB (Context, context, 1);
+
+ Context *tr = unsmob<Context> (context);
+
return ly_symbol2scm (tr->context_name ().c_str ());
}
LY_DEFINE (ly_context_grob_definition, "ly:context-grob-definition",
- 2, 0, 0, (SCM context, SCM name),
- "Return the definition of @var{name} (a symbol) within @var{context} "
- "as an alist")
+ 2, 0, 0, (SCM context, SCM name),
+ "Return the definition of @var{name} (a symbol) within"
+ " @var{context} as an alist.")
{
- Context *tr = unsmob_context (context);
- SCM_ASSERT_TYPE (tr, context, SCM_ARG1, __FUNCTION__, "Context");
- SCM_ASSERT_TYPE (scm_is_symbol (name), name, SCM_ARG2, __FUNCTION__, "symbol");
+ Context *tr = unsmob<Context> (context);
- return updated_grob_properties (tr, name);
+ LY_ASSERT_SMOB (Context, context, 1);
+ LY_ASSERT_TYPE (ly_is_symbol, name, 2);
+
+ return Grob_property_info (tr, name).updated ();
}
LY_DEFINE (ly_context_pushpop_property, "ly:context-pushpop-property",
- 3, 1, 0, (SCM context, SCM grob, SCM eltprop, SCM val),
- "Do a single @code{\\override} or @code{\\revert} operation "
- "in @var{context}. The grob definition @code{grob} is extended "
- "with @code{eltprop} (if @var{val} is specified) "
- "or reverted (if unspecified).")
+ 3, 1, 0, (SCM context, SCM grob, SCM eltprop, SCM val),
+ "Do @code{\\temporary \\override} or @code{\\revert} operation"
+ " in @var{context}. The grob definition @var{grob} is extended"
+ " with @var{eltprop} (if @var{val} is specified) or reverted"
+ " (if unspecified).")
{
- Context *tg = unsmob_context (context);
- SCM_ASSERT_TYPE (tg, context, SCM_ARG1, __FUNCTION__, "context");
- SCM_ASSERT_TYPE (scm_is_symbol (grob), grob, SCM_ARG2, __FUNCTION__, "symbol");
- SCM_ASSERT_TYPE (scm_is_symbol (eltprop), eltprop, SCM_ARG3, __FUNCTION__, "symbol");
+ Context *tg = unsmob<Context> (context);
+
+ LY_ASSERT_SMOB (Context, context, 1);
+ LY_ASSERT_TYPE (ly_is_symbol, grob, 2);
+ LY_ASSERT_TYPE (ly_is_symbol, eltprop, 3);
execute_pushpop_property (tg, grob, eltprop, val);
return SCM_UNSPECIFIED;
}
+LY_DEFINE (ly_context_matched_pop_property, "ly:context-matched-pop-property",
+ 3, 0, 0, (SCM context, SCM grob, SCM cell),
+ "This undoes a particular @code{\\override},"
+ " @code{\\once \\override} or @code{\\once \\revert}"
+ " when given the specific alist pair to undo.")
+{
+ Context *tg = LY_ASSERT_SMOB (Context, context, 1);
+ LY_ASSERT_TYPE (ly_is_symbol, grob, 2);
+ Grob_property_info (tg, grob).matched_pop (cell);
+ return SCM_UNSPECIFIED;
+}
+
+
LY_DEFINE (ly_context_property, "ly:context-property",
- 2, 0, 0, (SCM c, SCM name),
- "Return the value of @var{name} from context @var{c}")
+ 2, 1, 0, (SCM context, SCM sym, SCM def),
+ "Return the value for property @var{sym} in @var{context}."
+ " If @var{def} is given, and property value is @code{'()},"
+ " return @var{def}.")
{
- Context *t = unsmob_context (c);
- Context *tr = (t);
- SCM_ASSERT_TYPE (tr, c, SCM_ARG1, __FUNCTION__, "Translator group");
- SCM_ASSERT_TYPE (scm_is_symbol (name), name, SCM_ARG2, __FUNCTION__, "symbol");
+ LY_ASSERT_SMOB (Context, context, 1);
+ LY_ASSERT_TYPE (ly_is_symbol, sym, 2);
- return tr->internal_get_property (name);
+ Context *t = unsmob<Context> (context);
+ SCM result = t->get_property (sym);
+ return !SCM_UNBNDP (def) && scm_is_null (result) ? def : result;
}
-LY_DEFINE (ly_context_set_property, "ly:context-set-property!",
- 3, 0, 0, (SCM context, SCM name, SCM val),
- "Set value of property @var{name} in context @var{context} "
- "to @var{val}.")
+LY_DEFINE (ly_context_set_property_x, "ly:context-set-property!",
+ 3, 0, 0, (SCM context, SCM name, SCM val),
+ "Set value of property @var{name} in context @var{context}"
+ " to @var{val}.")
{
- Context *tr = unsmob_context (context);
- SCM_ASSERT_TYPE (tr, context, SCM_ARG1, __FUNCTION__, "Context");
- SCM_ASSERT_TYPE (scm_is_symbol (name), name, SCM_ARG2, __FUNCTION__, "symbol");
+ LY_ASSERT_SMOB (Context, context, 1);
+ LY_ASSERT_TYPE (ly_is_symbol, name, 2);
+
+ Context *tr = unsmob<Context> (context);
tr->set_property (name, val);
}
LY_DEFINE (ly_context_property_where_defined, "ly:context-property-where-defined",
- 2, 0, 0, (SCM context, SCM name),
- "Return the context above @var{context} "
- "where @var{name} is defined.")
+ 2, 0, 0, (SCM context, SCM name),
+ "Return the context above @var{context}"
+ " where @var{name} is defined.")
{
- Context *tr = unsmob_context (context);
- SCM_ASSERT_TYPE (tr, context, SCM_ARG1, __FUNCTION__, "Context");
- SCM_ASSERT_TYPE (scm_is_symbol (name), name, SCM_ARG2, __FUNCTION__, "symbol");
+ LY_ASSERT_SMOB (Context, context, 1);
+ LY_ASSERT_TYPE (ly_is_symbol, name, 2);
+
+ Context *tr = unsmob<Context> (context);
SCM val;
tr = tr->where_defined (name, &val);
return SCM_EOL;
}
-LY_DEFINE (ly_unset_context_property, "ly:context-unset-property", 2, 0, 0,
- (SCM context, SCM name),
- "Unset value of property @var{name} in context @var{context}.")
+LY_DEFINE (ly_context_unset_property, "ly:context-unset-property", 2, 0, 0,
+ (SCM context, SCM name),
+ "Unset value of property @var{name} in context @var{context}.")
{
- Context *tr = unsmob_context (context);
- SCM_ASSERT_TYPE (tr, context, SCM_ARG1, __FUNCTION__, "Context");
- SCM_ASSERT_TYPE (scm_is_symbol (name), name, SCM_ARG2, __FUNCTION__, "symbol");
+ LY_ASSERT_SMOB (Context, context, 1);
+ LY_ASSERT_TYPE (ly_is_symbol, name, 2);
+ Context *tr = unsmob<Context> (context);
tr->unset_property (name);
return SCM_UNSPECIFIED;
}
LY_DEFINE (ly_context_parent, "ly:context-parent",
- 1, 0, 0, (SCM context),
- "Return the parent of @var{context}, @code{#f} if none.")
+ 1, 0, 0, (SCM context),
+ "Return the parent of @var{context}, @code{#f} if none.")
{
- Context *tr = unsmob_context (context);
- SCM_ASSERT_TYPE (tr, context, SCM_ARG1, __FUNCTION__, "Context");
+ LY_ASSERT_SMOB (Context, context, 1);
+ Context *tr = unsmob<Context> (context);
tr = tr->get_parent_context ();
if (tr)
/* FIXME: todo: should support translator IDs, and creation? */
LY_DEFINE (ly_context_find, "ly:context-find",
- 2, 0, 0, (SCM context, SCM name),
- "Find a parent of @var{context} that has name or alias @var{name}. "
- "Return @code{#f} if not found.")
+ 2, 0, 0, (SCM context, SCM name),
+ "Find a parent of @var{context} that has name or alias @var{name}."
+ " Return @code{#f} if not found.")
{
- Context *tr = unsmob_context (context);
- SCM_ASSERT_TYPE (tr, context, SCM_ARG1, __FUNCTION__, "context");
- SCM_ASSERT_TYPE (scm_is_symbol (name), name, SCM_ARG2, __FUNCTION__, "symbol");
+ LY_ASSERT_SMOB (Context, context, 1);
+ LY_ASSERT_TYPE (ly_is_symbol, name, 2);
+ Context *tr = unsmob<Context> (context);
while (tr)
{
if (tr->is_alias (name))
- return tr->self_scm ();
+ return tr->self_scm ();
tr = tr->get_parent_context ();
}
}
LY_DEFINE (ly_context_now, "ly:context-now",
- 1, 0, 0, (SCM context),
- "Return now-moment of context CONTEXT")
+ 1, 0, 0, (SCM context),
+ "Return @code{now-moment} of context @var{context}.")
{
- Context *ctx = unsmob_context (context);
- SCM_ASSERT_TYPE (ctx, context, SCM_ARG1, __FUNCTION__, "Context");
+ LY_ASSERT_SMOB (Context, context, 1);
+ Context *ctx = unsmob<Context> (context);
return ctx->now_mom ().smobbed_copy ();
}
LY_DEFINE (ly_context_event_source, "ly:context-event-source",
1, 0, 0, (SCM context),
- "Return event-source of context CONTEXT")
+ "Return @code{event-source} of context @var{context}.")
{
- Context *ctx = unsmob_context (context);
- SCM_ASSERT_TYPE (ctx, context, SCM_ARG1, __FUNCTION__, "Context");
+ LY_ASSERT_SMOB (Context, context, 1);
+ Context *ctx = unsmob<Context> (context);
return ctx->event_source ()->self_scm ();
}
LY_DEFINE (ly_context_events_below, "ly:context-events-below",
1, 0, 0, (SCM context),
- "Return a stream-distributor that distributes all events\n"
+ "Return a @code{stream-distributor} that distributes all events"
" from @var{context} and all its subcontexts.")
{
- Context *ctx = unsmob_context (context);
- SCM_ASSERT_TYPE (ctx, context, SCM_ARG1, __FUNCTION__, "Context");
+ LY_ASSERT_SMOB (Context, context, 1);
+ Context *ctx = unsmob<Context> (context);
return ctx->events_below ()->self_scm ();
}
projects / lilypond.git / blobdiff