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_n (once_finalization_proc,
56 o->self_scm (), m->self_scm (),
57 ly_quote_scm (previous_value), SCM_UNDEFINED));
60 Simple_music_iterator::process (mom);
64 Property_unset_iterator::process (Moment m)
66 SCM sym = get_music ()->get_property ("symbol");
67 send_stream_event (get_outlet (), "UnsetProperty", get_music ()->origin (),
68 ly_symbol2scm ("symbol"), sym);
70 Simple_music_iterator::process (m);
73 MAKE_SCHEME_CALLBACK (Property_iterator, once_finalization, 3);
75 Property_iterator::once_finalization (SCM ctx, SCM music, SCM previous_value)
77 Music *m = unsmob_music (music);
78 Context *c = unsmob_context (ctx);
80 // Do not use UnsetProperty, which sets the default, but rather
81 // cache the value before the \once \set command and restore it now
82 send_stream_event (c, "SetProperty", m->origin (),
83 ly_symbol2scm ("symbol"), m->get_property ("symbol"),
84 ly_symbol2scm ("value"), previous_value);
86 return SCM_UNSPECIFIED;
90 Property_iterator::do_quit ()
95 check_grob (Music *mus, SCM sym)
97 bool g = to_boolean (scm_object_property (sym, ly_symbol2scm ("is-grob?")));
100 mus->origin ()->warning (_f ("not a grob name, `%s'",
101 ly_symbol2string (sym)));
107 get_property_path (Music *m)
109 SCM grob_property_path = m->get_property ("grob-property-path");
111 SCM eprop = m->get_property ("grob-property");
112 if (scm_is_symbol (eprop))
114 grob_property_path = scm_list_1 (eprop);
117 return grob_property_path;
121 Push_property_iterator::process (Moment m)
123 SCM sym = get_music ()->get_property ("symbol");
124 if (check_grob (get_music (), sym))
126 SCM grob_property_path = get_property_path (get_music ());
127 SCM val = get_music ()->get_property ("grob-value");
129 if (to_boolean (get_music ()->get_property ("pop-first"))
130 && !to_boolean (get_music ()->get_property ("once")))
131 send_stream_event (get_outlet (), "Revert", get_music ()->origin (),
132 ly_symbol2scm ("symbol"), sym,
133 ly_symbol2scm ("property-path"), grob_property_path);
135 send_stream_event (get_outlet (), "Override", get_music ()->origin (),
136 ly_symbol2scm ("symbol"), sym,
137 ly_symbol2scm ("property-path"), grob_property_path,
138 ly_symbol2scm ("value"), val);
140 Simple_music_iterator::process (m);
143 MAKE_SCHEME_CALLBACK (Push_property_iterator, once_finalization, 2);
145 Push_property_iterator::once_finalization (SCM ctx, SCM music)
147 Music *mus = unsmob_music (music);
148 Context *c = unsmob_context (ctx);
150 SCM sym = mus->get_property ("symbol");
151 if (check_grob (mus, sym))
153 SCM grob_property_path = get_property_path (mus);
155 send_stream_event (c, "Revert", mus->origin (),
156 ly_symbol2scm ("symbol"), sym,
157 ly_symbol2scm ("property-path"), grob_property_path);
159 return SCM_UNSPECIFIED;
163 Push_property_iterator::do_quit ()
165 if (to_boolean (get_music ()->get_property ("once")))
167 SCM trans = get_outlet ()->self_scm ();
168 SCM music = get_music ()->self_scm ();
170 Global_context *tg = get_outlet ()->get_global_context ();
171 tg->add_finalization (scm_list_n (once_finalization_proc,
172 trans, music, SCM_UNDEFINED));
177 Pop_property_iterator::process (Moment m)
179 SCM sym = get_music ()->get_property ("symbol");
181 if (check_grob (get_music (), sym))
183 SCM grob_property_path = get_property_path (get_music ());
185 send_stream_event (get_outlet (), "Revert", get_music ()->origin (),
186 ly_symbol2scm ("symbol"), sym,
187 ly_symbol2scm ("property-path"), grob_property_path);
189 Simple_music_iterator::process (m);
192 IMPLEMENT_CTOR_CALLBACK (Pop_property_iterator);
193 IMPLEMENT_CTOR_CALLBACK (Push_property_iterator);
194 IMPLEMENT_CTOR_CALLBACK (Property_iterator);
195 IMPLEMENT_CTOR_CALLBACK (Property_unset_iterator);