2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2004--2015 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/>.
23 #include "duration.hh"
24 #include "lily-proto.hh"
25 #include "listener.hh"
27 #include "scm-hash.hh"
28 #include "std-vector.hh"
29 #include "virtual-methods.hh"
31 class Context : public Smob<Context>
34 SCM mark_smob () const;
35 int print_smob (SCM, scm_print_state *) const;
36 static const char * const type_p_name_;
39 Scheme_hash_table *properties_dict () const;
40 Context (Context const &src); // Do not define! Not copyable!
42 DECLARE_CLASSNAME (Context);
46 friend class Context_handle;
47 /* how many Context_handles point to this Context */
50 /* Used internally by create_context */
51 Stream_event *infant_event_;
54 virtual void derived_mark () const;
55 Context *daddy_context_;
56 /* The used Context_def */
58 /* Additions to the Context_def, given by \with */
66 Translator_group *implementation_;
69 /* Events reported in the context is sent to this dispatcher. */
70 Dispatcher *event_source_;
72 /* Events reported to this context or recursively in any of its
73 children, are sent to this dispatcher. */
74 Dispatcher *events_below_;
76 // Translator_group is allowed to set implementation_.
77 friend class Translator_group;
78 // Context_def::instantiate initialises some protected members.
79 friend class Context_def;
80 // UGH! initialises implementation_
81 friend SCM ly_make_global_translator (SCM);
83 void set_property_from_event (SCM);
84 void unset_property_from_event (SCM);
87 string id_string () const { return id_string_; }
88 SCM children_contexts () const { return context_list_; }
89 SCM default_child_context_name () const;
91 Dispatcher *event_source () const { return event_source_; }
92 Dispatcher *events_below () const { return events_below_; }
93 void internal_send_stream_event (SCM type, Input *origin);
94 void internal_send_stream_event (SCM type, Input *origin,
96 void internal_send_stream_event (SCM type, Input *origin,
97 SCM prop, SCM val, SCM prop2, SCM val2);
98 void internal_send_stream_event (SCM type, Input *origin,
99 SCM prop, SCM val, SCM prop2, SCM val2,
100 SCM prop3, SCM val3);
101 void internal_send_stream_event (SCM type, Input *origin,
102 SCM prop, SCM val, SCM prop2, SCM val2,
103 SCM prop3, SCM val3, SCM prop4, SCM val4);
104 SCM get_definition () const { return definition_; }
105 SCM get_definition_mods () const { return definition_mods_; }
107 Translator_group *implementation () const { return implementation_; }
108 Context *get_parent_context () const;
112 SCM internal_get_property (SCM name_sym) const;
113 SCM properties_as_alist () const;
114 Context *where_defined (SCM name_sym, SCM *value) const;
115 bool here_defined (SCM name_sym, SCM *value) const;
116 void unset_property (SCM var_sym);
118 void instrumented_set_property (SCM, SCM, const char *, int, const char *);
119 void internal_set_property (SCM var_sym, SCM value);
121 Context *create_context (Context_def *, const string&, SCM);
122 void create_context_from_event (SCM);
123 void acknowledge_infant (SCM);
124 void remove_context (SCM);
125 void change_parent (SCM);
126 void disconnect_from_parent ();
127 void check_removal ();
128 string context_name () const;
129 SCM context_name_symbol () const;
130 Global_context *get_global_context () const;
132 virtual Context *get_score_context () const;
133 virtual Output_def *get_output_def () const;
134 virtual Moment now_mom () const;
135 virtual Context *get_default_interpreter (const string &context_id = "");
137 bool is_alias (SCM) const;
138 void add_alias (SCM);
139 void add_context (Context *trans);
140 bool is_bottom_context () const;
141 bool is_removable () const;
143 Context *find_create_context (SCM context_name,
144 const string &id, SCM ops);
145 Context *create_unique_context (SCM context_name, const string &context_id,
147 vector<Context_def *> path_to_acceptable_context (SCM alias) const;
154 void apply_property_operations (Context *tg, SCM pre_init_ops);
155 void execute_pushpop_property (Context *trg, SCM prop, SCM eltprop, SCM val);
157 // Search for a context of the given type starting from the given context and
158 // moving toward the root of the tree. If the starting context matches, it is
160 Context *find_context_above (Context *where, SCM type_sym);
162 // Search for a context of the given type starting from the given context and
163 // moving toward the root of the tree. If found, return its child that was
164 // found on the way there.
165 Context *find_context_above_by_parent_type (Context *where, SCM parent_type);
167 // Search for a context of the given type and ID starting from the given
168 // context and moving toward the leaves of the tree. If the starting context
169 // matches, it is returned. An empty ID matches any context of the given type.
170 Context *find_context_below (Context *where,
171 SCM type_sym, const string &id);
173 // Search for a context of the given type and ID starting with the given
174 // context, then searching its descendants, then its parent's descendants, etc.
175 // An empty ID matches any context of the given type.
176 Context *find_context_near (Context *where,
177 SCM type_sym, const string &id);
179 // Search for the top context (i.e. the ancestor with no parent) starting with
180 // the given context.
181 Context *find_top_context (Context *where);
183 bool melisma_busy (Context *);
185 Context *get_voice_to_lyrics (Context *lyrics);
186 Grob *get_current_note_head (Context *voice);
187 Grob *get_current_rest (Context *voice);
189 Moment measure_position (Context const *context);
190 Moment measure_position (Context const *context, Duration const *dur);
191 Rational measure_length (Context const *context);
192 int measure_number (Context const *context);
194 bool check_repeat_count_visibility (Context const *context, SCM count);
196 void set_context_property_on_children (Context *trans, SCM sym, SCM val);
198 /* Shorthand for creating and broadcasting stream events. */
199 #define send_stream_event(ctx, type, origin, ...) \
200 ctx->internal_send_stream_event (ly_symbol2scm (type), origin, ##__VA_ARGS__)
202 SCM nested_property_alist (SCM alist, SCM prop_path, SCM value);
203 SCM nested_property (SCM alist, SCM prop_path, SCM fallback = SCM_EOL);
204 SCM nested_create_alist (SCM prop_path, SCM value);
205 SCM partial_list_copy (SCM alist, SCM tail, SCM newtail);
206 SCM assq_tail (SCM key, SCM alist, SCM alist_end);
207 SCM assv_tail (SCM key, SCM alist, SCM alist_end);
208 SCM assoc_tail (SCM key, SCM alist, SCM alist_end);
209 SCM evict_from_alist (SCM, SCM, SCM);
210 SCM nalist_to_alist (SCM nalist, int nested);
211 extern SCM ly_context_set_property_x_proc;
212 extern SCM ly_context_unset_property_proc;
213 extern SCM ly_context_matched_pop_property_proc;
215 #endif /* CONTEXT_HH */