]> git.donarmstrong.com Git - lilypond.git/blob - lily/context-scheme.cc
Run grand-replace for 2010.
[lilypond.git] / lily / context-scheme.cc
1 /*
2   This file is part of LilyPond, the GNU music typesetter.
3
4   Copyright (C) 1998--2010 Jan Nieuwenhuizen <janneke@gnu.org>
5   Han-Wen Nienhuys <hanwen@xs4all.nl>
6
7   LilyPond is free software: you can redistribute it and/or modify
8   it under the terms of the GNU General Public License as published by
9   the Free Software Foundation, either version 3 of the License, or
10   (at your option) any later version.
11
12   LilyPond is distributed in the hope that it will be useful,
13   but WITHOUT ANY WARRANTY; without even the implied warranty of
14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15   GNU General Public License for more details.
16
17   You should have received a copy of the GNU General Public License
18   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
19 */
20
21 #include "context.hh"
22 #include "context-def.hh"
23 #include "dispatcher.hh"
24
25 LY_DEFINE (ly_context_current_moment,
26            "ly:context-current-moment",
27            1, 0, 0, (SCM context),
28            "Return the current moment of @var{context}.")
29 {
30   Context *tr = unsmob_context (context);
31
32   LY_ASSERT_SMOB (Context, context, 1);
33
34   return tr->now_mom ().smobbed_copy ();
35 }
36
37 LY_DEFINE (ly_context_id, "ly:context-id",
38            1, 0, 0, (SCM context),
39            "Return the ID string of @var{context},"
40            " i.e., for @code{\\context Voice = one @dots{}}"
41            " return the string @code{one}.")
42 {
43   Context *tr = unsmob_context (context);
44
45   LY_ASSERT_SMOB (Context, context, 1);
46
47   return ly_string2scm (tr->id_string ());
48 }
49
50 LY_DEFINE (ly_context_name, "ly:context-name",
51            1, 0, 0, (SCM context),
52            "Return the name of @var{context},"
53            " i.e., for @code{\\context Voice = one @dots{}}"
54            " return the symbol @code{Voice}.")
55 {
56   LY_ASSERT_SMOB (Context, context, 1);
57
58   Context *tr = unsmob_context (context);
59
60   return ly_symbol2scm (tr->context_name ().c_str ());
61 }
62
63 LY_DEFINE (ly_context_grob_definition, "ly:context-grob-definition",
64            2, 0, 0, (SCM context, SCM name),
65            "Return the definition of @var{name} (a symbol) within"
66            " @var{context} as an alist.")
67 {
68   Context *tr = unsmob_context (context);
69   
70   LY_ASSERT_SMOB (Context, context, 1);
71   LY_ASSERT_TYPE (ly_is_symbol, name, 2);
72
73   return updated_grob_properties (tr, name);
74 }
75
76 LY_DEFINE (ly_context_pushpop_property, "ly:context-pushpop-property",
77            3, 1, 0, (SCM context, SCM grob, SCM eltprop, SCM val),
78            "Do a single @code{\\override} or @code{\\revert} operation"
79            " in @var{context}.  The grob definition @var{grob} is extended"
80            " with @var{eltprop} (if @var{val} is specified) or reverted"
81            " (if unspecified).")
82 {
83   Context *tg = unsmob_context (context);
84
85   LY_ASSERT_SMOB (Context, context, 1);
86   LY_ASSERT_TYPE (ly_is_symbol, grob, 2);
87   LY_ASSERT_TYPE (ly_is_symbol, eltprop, 3);
88
89   execute_pushpop_property (tg, grob, eltprop, val);
90
91   return SCM_UNSPECIFIED;
92 }
93
94 LY_DEFINE (ly_context_property, "ly:context-property",
95            2, 0, 0, (SCM context, SCM sym),
96            "Return the value for property @var{sym} in @var{context}.")
97 {
98   LY_ASSERT_SMOB (Context, context, 1);
99   LY_ASSERT_TYPE (ly_is_symbol, sym, 2);
100
101   Context *t = unsmob_context (context);
102   return t->internal_get_property (sym);
103 }
104
105 LY_DEFINE (ly_context_set_property_x, "ly:context-set-property!",
106            3, 0, 0, (SCM context, SCM name, SCM val),
107            "Set value of property @var{name} in context @var{context}"
108            " to @var{val}.")
109 {
110   LY_ASSERT_SMOB (Context, context, 1);
111   LY_ASSERT_TYPE (ly_is_symbol, name, 2);
112
113   Context *tr = unsmob_context (context);
114
115   tr->set_property (name, val);
116
117   return SCM_UNSPECIFIED;
118 }
119
120 LY_DEFINE (ly_context_property_where_defined, "ly:context-property-where-defined",
121            2, 0, 0, (SCM context, SCM name),
122            "Return the context above @var{context}"
123            " where @var{name} is defined.")
124 {
125   LY_ASSERT_SMOB (Context, context, 1);
126   LY_ASSERT_TYPE (ly_is_symbol, name, 2);
127   
128   Context *tr = unsmob_context (context);
129
130   SCM val;
131   tr = tr->where_defined (name, &val);
132   if (tr)
133     return tr->self_scm ();
134
135   return SCM_EOL;
136 }
137
138 LY_DEFINE (ly_context_unset_property, "ly:context-unset-property", 2, 0, 0,
139            (SCM context, SCM name),
140            "Unset value of property @var{name} in context @var{context}.")
141 {
142   LY_ASSERT_SMOB (Context, context, 1);
143   LY_ASSERT_TYPE (ly_is_symbol, name, 2);
144   Context *tr = unsmob_context (context);
145   
146   tr->unset_property (name);
147   return SCM_UNSPECIFIED;
148 }
149
150 LY_DEFINE (ly_context_parent, "ly:context-parent",
151            1, 0, 0, (SCM context),
152            "Return the parent of @var{context}, @code{#f} if none.")
153 {
154   LY_ASSERT_SMOB (Context, context, 1);
155   Context *tr = unsmob_context (context);
156
157   tr = tr->get_parent_context ();
158   if (tr)
159     return tr->self_scm ();
160   else
161     return SCM_BOOL_F;
162 }
163
164 /* FIXME: todo: should support translator IDs, and creation? */
165 LY_DEFINE (ly_context_find, "ly:context-find",
166            2, 0, 0, (SCM context, SCM name),
167            "Find a parent of @var{context} that has name or alias @var{name}."
168            "  Return @code{#f} if not found.")
169 {
170   LY_ASSERT_SMOB (Context, context, 1);
171   LY_ASSERT_TYPE (ly_is_symbol, name, 2);
172   Context *tr = unsmob_context (context);
173
174   while (tr)
175     {
176       if (tr->is_alias (name))
177         return tr->self_scm ();
178       tr = tr->get_parent_context ();
179     }
180
181   return SCM_BOOL_F;
182 }
183
184 LY_DEFINE (ly_context_now, "ly:context-now",
185            1, 0, 0, (SCM context),
186            "Return @code{now-moment} of context @var{context}.")
187 {
188   LY_ASSERT_SMOB (Context, context, 1);
189   Context *ctx = unsmob_context (context);
190   return ctx->now_mom ().smobbed_copy ();
191 }
192
193 LY_DEFINE (ly_context_event_source, "ly:context-event-source",
194            1, 0, 0, (SCM context),
195            "Return @code{event-source} of context @var{context}.")
196 {
197   LY_ASSERT_SMOB (Context, context, 1);
198   Context *ctx = unsmob_context (context);
199   return ctx->event_source ()->self_scm ();
200 }
201
202 LY_DEFINE (ly_context_events_below, "ly:context-events-below",
203            1, 0, 0, (SCM context),
204            "Return a @code{stream-distributor} that distributes all events"
205            " from @var{context} and all its subcontexts.")
206 {
207   LY_ASSERT_SMOB (Context, context, 1);
208   Context *ctx = unsmob_context (context);
209   return ctx->events_below ()->self_scm ();
210 }