2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2004--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/>.
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 static SCM mark_smob (SCM);
35 static int print_smob (SCM, SCM, scm_print_state *);
36 static const char type_p_name_[];
39 Scheme_hash_table *properties_dict () const;
40 Context (Context const &src);
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 Context *daddy_context_;
55 /* The used Context_def */
57 /* Additions to the Context_def, given by \with */
65 Translator_group *implementation_;
68 /* Events reported in the context is sent to this dispatcher. */
69 Dispatcher *event_source_;
71 /* Events reported to this context or recursively in any of its
72 children, are sent to this dispatcher. */
73 Dispatcher *events_below_;
75 // Translator_group is allowed to set implementation_.
76 friend class Translator_group;
77 // Context_def::instantiate initialises some protected members.
78 friend class Context_def;
79 // UGH! initialises implementation_
80 friend SCM ly_make_global_translator (SCM);
82 DECLARE_LISTENER (set_property_from_event);
83 DECLARE_LISTENER (unset_property_from_event);
86 string id_string () const { return id_string_; }
87 SCM children_contexts () const { return context_list_; }
88 SCM default_child_context_name () const;
90 Dispatcher *event_source () const { return event_source_; }
91 Dispatcher *events_below () const { return events_below_; }
92 void internal_send_stream_event (SCM type, Input *origin, SCM props[]);
94 SCM get_definition () const { return definition_; }
95 SCM get_definition_mods () const { return definition_mods_; }
97 Translator_group *implementation () const { return implementation_; }
98 Context *get_parent_context () const;
102 SCM internal_get_property (SCM name_sym) const;
103 SCM properties_as_alist () const;
104 Context *where_defined (SCM name_sym, SCM *value) const;
105 bool here_defined (SCM name_sym, SCM *value) const;
106 void unset_property (SCM var_sym);
108 void instrumented_set_property (SCM, SCM, const char *, int, const char *);
109 void internal_set_property (SCM var_sym, SCM value);
111 Context *create_context (Context_def *, const string&, SCM);
112 DECLARE_LISTENER (create_context_from_event);
113 DECLARE_LISTENER (acknowledge_infant);
114 DECLARE_LISTENER (remove_context);
115 DECLARE_LISTENER (change_parent);
116 void disconnect_from_parent ();
117 void check_removal ();
118 string context_name () const;
119 SCM context_name_symbol () const;
120 Global_context *get_global_context () const;
122 virtual Context *get_score_context () const;
123 virtual Output_def *get_output_def () const;
124 virtual Moment now_mom () const;
125 virtual Context *get_default_interpreter (const string &context_id = "");
127 bool is_alias (SCM) const;
128 void add_alias (SCM);
129 void add_context (Context *trans);
130 bool is_bottom_context () const;
131 bool is_removable () const;
133 Context *find_create_context (SCM context_name,
134 const string &id, SCM ops);
135 Context *create_unique_context (SCM context_name, const string &context_id,
137 vector<Context_def *> path_to_acceptable_context (SCM alias) const;
144 void apply_property_operations (Context *tg, SCM pre_init_ops);
145 void execute_pushpop_property (Context *trg, SCM prop, SCM eltprop, SCM val);
147 Context *find_context_below (Context *where,
148 SCM type_sym, const string &id);
149 bool melisma_busy (Context *);
151 Context *get_voice_to_lyrics (Context *lyrics);
152 Grob *get_current_note_head (Context *voice);
153 Grob *get_current_rest (Context *voice);
155 Moment measure_position (Context const *context);
156 Moment measure_position (Context const *context, Duration const *dur);
157 Rational measure_length (Context const *context);
158 int measure_number (Context const *context);
160 bool check_repeat_count_visibility (Context const *context, SCM count);
162 void set_context_property_on_children (Context *trans, SCM sym, SCM val);
164 /* Shorthand for creating and broadcasting stream events. */
165 #define send_stream_event(ctx, type, origin, ...) \
167 SCM props[] = { __VA_ARGS__, 0 }; \
168 ctx->internal_send_stream_event (ly_symbol2scm (type), origin, props); \
171 SCM nested_property_alist (SCM alist, SCM prop_path, SCM value);
172 SCM nested_create_alist (SCM prop_path, SCM value);
173 SCM partial_list_copy (SCM alist, SCM tail, SCM newtail);
174 SCM evict_from_alist (SCM, SCM, SCM);
175 SCM nalist_to_alist (SCM nalist, int nested);
177 #endif /* CONTEXT_HH */