2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
6 LilyPond is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 LilyPond is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
20 #include "property-iterator.hh"
22 #include "context-def.hh"
23 #include "global-context.hh"
24 #include "international.hh"
27 bool check_grob (Music *mus, SCM sym);
30 There is no real processing to a property: just lookup the
31 translation unit, and set the property.
34 Property_iterator::process (Moment mom)
36 Context *o = get_outlet ();
37 Music *m = get_music ();
38 bool once = to_boolean (m->get_property ("once"));
39 SCM symbol = m->get_property ("symbol");
40 SCM previous_value = SCM_UNDEFINED;
42 Context *w = o->where_defined (symbol, &previous_value);
44 previous_value = SCM_UNDEFINED;
46 send_stream_event (o, "SetProperty", m->origin (),
47 ly_symbol2scm ("symbol"), symbol,
48 ly_symbol2scm ("value"), m->get_property ("value"));
50 /* For \once \set install a finalization hook to reset the property to the
51 * previous value after the timestep */
54 Global_context *tg = get_outlet ()->get_global_context ();
55 tg->add_finalization (scm_list_4 (once_finalization_proc,
56 o->self_scm (), m->self_scm (),
60 Simple_music_iterator::process (mom);
64 Property_unset_iterator::process (Moment mom)
66 Context *o = get_outlet ();
67 Music *m = get_music ();
68 bool once = to_boolean (m->get_property ("once"));
69 SCM symbol = m->get_property ("symbol");
70 SCM previous_value = SCM_UNDEFINED;
72 Context *w = o->where_defined (symbol, &previous_value);
74 previous_value = SCM_UNDEFINED;
76 send_stream_event (o, "UnsetProperty", m->origin (),
77 ly_symbol2scm ("symbol"), symbol);
79 /* For \once \unset install a finalization hook to reset the property to the
80 * previous value after the timestep */
81 if (once && !SCM_UNBNDP (previous_value))
83 Global_context *tg = get_outlet ()->get_global_context ();
84 tg->add_finalization (scm_list_4 (Property_iterator::once_finalization_proc,
85 o->self_scm (), m->self_scm (),
89 Simple_music_iterator::process (mom);
92 MAKE_SCHEME_CALLBACK (Property_iterator, once_finalization, 3);
94 Property_iterator::once_finalization (SCM ctx, SCM music, SCM previous_value)
96 Music *m = unsmob_music (music);
97 Context *c = unsmob_context (ctx);
99 // Do not use UnsetProperty, which sets the default, but rather
100 // cache the value before the \once \set command and restore it now
101 send_stream_event (c, "SetProperty", m->origin (),
102 ly_symbol2scm ("symbol"), m->get_property ("symbol"),
103 ly_symbol2scm ("value"), previous_value);
105 return SCM_UNSPECIFIED;
109 Property_iterator::do_quit ()
114 check_grob (Music *mus, SCM sym)
116 bool g = to_boolean (scm_object_property (sym, ly_symbol2scm ("is-grob?")));
119 mus->origin ()->warning (_f ("not a grob name, `%s'",
120 ly_symbol2string (sym)));
126 get_property_path (Music *m)
128 SCM grob_property_path = m->get_property ("grob-property-path");
130 SCM eprop = m->get_property ("grob-property");
131 if (scm_is_symbol (eprop))
133 grob_property_path = scm_list_1 (eprop);
136 return grob_property_path;
140 Push_property_iterator::process (Moment m)
142 SCM sym = get_music ()->get_property ("symbol");
143 if (check_grob (get_music (), sym))
145 SCM grob_property_path = get_property_path (get_music ());
146 SCM val = get_music ()->get_property ("grob-value");
148 if (to_boolean (get_music ()->get_property ("pop-first"))
149 && !to_boolean (get_music ()->get_property ("once")))
150 send_stream_event (get_outlet (), "Revert", get_music ()->origin (),
151 ly_symbol2scm ("symbol"), sym,
152 ly_symbol2scm ("property-path"), grob_property_path);
154 send_stream_event (get_outlet (), "Override", get_music ()->origin (),
155 ly_symbol2scm ("symbol"), sym,
156 ly_symbol2scm ("property-path"), grob_property_path,
157 ly_symbol2scm ("value"), val);
159 Simple_music_iterator::process (m);
162 MAKE_SCHEME_CALLBACK (Push_property_iterator, once_finalization, 2);
164 Push_property_iterator::once_finalization (SCM ctx, SCM music)
166 Music *mus = unsmob_music (music);
167 Context *c = unsmob_context (ctx);
169 SCM sym = mus->get_property ("symbol");
170 if (check_grob (mus, sym))
172 SCM grob_property_path = get_property_path (mus);
174 send_stream_event (c, "Revert", mus->origin (),
175 ly_symbol2scm ("symbol"), sym,
176 ly_symbol2scm ("property-path"), grob_property_path);
178 return SCM_UNSPECIFIED;
182 Push_property_iterator::do_quit ()
184 if (to_boolean (get_music ()->get_property ("once")))
186 SCM trans = get_outlet ()->self_scm ();
187 SCM music = get_music ()->self_scm ();
189 Global_context *tg = get_outlet ()->get_global_context ();
190 tg->add_finalization (scm_list_3 (once_finalization_proc,
196 Pop_property_iterator::process (Moment m)
198 SCM sym = get_music ()->get_property ("symbol");
200 if (check_grob (get_music (), sym))
202 SCM grob_property_path = get_property_path (get_music ());
204 send_stream_event (get_outlet (), "Revert", get_music ()->origin (),
205 ly_symbol2scm ("symbol"), sym,
206 ly_symbol2scm ("property-path"), grob_property_path);
208 Simple_music_iterator::process (m);
211 IMPLEMENT_CTOR_CALLBACK (Pop_property_iterator);
212 IMPLEMENT_CTOR_CALLBACK (Push_property_iterator);
213 IMPLEMENT_CTOR_CALLBACK (Property_iterator);
214 IMPLEMENT_CTOR_CALLBACK (Property_unset_iterator);