Fix type predicates/docstrings for two music properties.
[lilypond/mpolesky.git] / lily / include / translator-group.hh
blobd0f9cc6c8dddab99b12fa010efbc9a46ff5679df
1 /*
2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2010 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 #ifndef TRANSLATOR_GROUP_HH
21 #define TRANSLATOR_GROUP_HH
23 #include "listener.hh"
24 #include "translator.hh"
26 typedef void (Translator:: *Translator_method) (void);
27 typedef void (Translator_group:: *Translator_group_method) (void);
28 typedef void (*Translator_group_void_method) (Translator_group *);
30 struct Translator_method_binding
32 Translator *translator_;
33 Translator_void_method_ptr method_;
35 Translator_method_binding ()
38 Translator_method_binding (Translator *tr, Translator_void_method_ptr ptr)
40 translator_ = tr;
41 method_ = ptr;
43 void invoke ()
45 if (method_)
46 (*method_) (translator_);
50 class Translator_group
52 private:
53 void precompute_method_bindings ();
54 vector<Translator_method_binding>
55 precomputed_method_bindings_[TRANSLATOR_METHOD_PRECOMPUTE_COUNT];
57 Translator_group_void_method
58 precomputed_self_method_bindings_[TRANSLATOR_METHOD_PRECOMPUTE_COUNT];
60 SCM protected_events_;
62 DECLARE_LISTENER (create_child_translator);
64 public:
65 VIRTUAL_COPY_CONSTRUCTOR (Translator_group, Translator_group);
66 DECLARE_SMOBS (Translator_group);
68 public:
69 virtual void connect_to_context (Context *c);
70 virtual void disconnect_from_context ();
71 virtual SCM get_simple_trans_list ();
72 virtual void initialize ();
73 virtual void finalize ();
75 void protect_event (SCM ev);
77 void stop_translation_timestep ();
78 void start_translation_timestep ();
80 virtual void fetch_precomputable_methods (Translator_group_void_method[]);
82 Translator_group ();
84 void precomputed_translator_foreach (Translator_precompute_index);
85 void call_precomputed_self_method (Translator_precompute_index);
87 Context *context () const { return context_; }
88 protected:
89 SCM simple_trans_list_;
90 Context *context_;
92 friend class Context_def;
93 virtual void derived_mark () const;
96 SCM names_to_translators (SCM namelist, Context *tg);
97 void recurse_over_translators (Context *c, Translator_method ptr,
98 Translator_group_method ptr2, Direction);
99 void precomputed_recurse_over_translators (Context *c, Translator_precompute_index idx, Direction dir);
100 Translator_group *get_translator_group (SCM sym);
102 #define foobar
103 #define ADD_TRANSLATOR_GROUP(classname, desc, grobs, read, write) foobar
105 DECLARE_UNSMOB (Translator_group, translator_group);
107 #endif // TRANSLATOR_GROUP_HH