lily/include/translator.hh

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5
   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.
  10
  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.
  15
  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/>.
  18 */
  19
  20 #ifndef TRANSLATOR_HH
  21 #define TRANSLATOR_HH
  22
  23 #include "global-ctor.hh"
  24 #include "lily-proto.hh"
  25 #include "virtual-methods.hh"
  26 #include "callback.hh"
  27 #include "input.hh"             // for error reporting
  28 #include "smobs.hh"
  29 #include "std-vector.hh"
  30 #include "protected-scm.hh"
  31
  32 #define TRANSLATOR_FAMILY_DECLARATIONS(NAME)                            \
  33   public:                                                               \
  34   VIRTUAL_COPY_CONSTRUCTOR (Translator, NAME);                          \
  35   virtual void fetch_precomputable_methods (SCM methods[]);             \
  36   DECLARE_TRANSLATOR_CALLBACKS (NAME);                                  \
  37   TRANSLATOR_INHERIT (Translator)                                       \
  38   /* end #define */
  39
  40 #define TRANSLATOR_INHERIT(BASE)                                        \
  41   using BASE::method_finder;                                            \
  42   using BASE::ack_finder;
  43
  44 #define DECLARE_TRANSLATOR_CALLBACKS(NAME)                              \
  45   template <void (NAME::*mf)()>                                         \
  46   static SCM method_finder () { return method_find_base<NAME, mf> (); } \
  47   template <void (NAME::*callback)(Grob_info)>                          \
  48   static SCM ack_finder () { return ack_find_base<NAME, callback> (); } \
  49   /* end #define */
  50
  51 /*
  52   Each translator class has a static alist of event class symbols
  53   mapping to callbacks that are called with a translator instance and
  54   a stream event when an event of the appropriate event class is
  55   announced in a context.
  56 */
  57
  58 #define TRANSLATOR_DECLARATIONS(NAME)                                   \
  59   public:                                                               \
  60   TRANSLATOR_FAMILY_DECLARATIONS (NAME);                                \
  61   static Drul_array<Protected_scm> acknowledge_static_array_drul_;      \
  62   static SCM static_description_;                                       \
  63   static Protected_scm listener_list_;                                  \
  64   static SCM static_get_acknowledger (SCM sym, Direction start_end);    \
  65   virtual SCM get_acknowledger (SCM sym, Direction start_end)           \
  66   {                                                                     \
  67     return static_get_acknowledger (sym, start_end);                    \
  68   }                                                                     \
  69 public:                                                                 \
  70   NAME ();                                                              \
  71   static void boot ();                                                  \
  72   virtual SCM static_translator_description () const;                   \
  73   virtual SCM translator_description () const;                          \
  74   virtual SCM get_listener_list () const                                \
  75   {                                                                     \
  76     return listener_list_;                                              \
  77   }                                                                     \
  78   /* end #define */
  79
  80 enum Translator_precompute_index
  81 {
  82   START_TRANSLATION_TIMESTEP,
  83   STOP_TRANSLATION_TIMESTEP,
  84   PROCESS_MUSIC,
  85   PROCESS_ACKNOWLEDGED,
  86   TRANSLATOR_METHOD_PRECOMPUTE_COUNT,
  87 };
  88
  89 /*
  90   Translate music into grobs.
  91 */
  92 class Translator : public Smob<Translator>
  93 {
  94 public:
  95   int print_smob (SCM, scm_print_state *) const;
  96   SCM mark_smob () const;
  97   static const char type_p_name_[];
  98   virtual ~Translator ();
  99 private:
 100   void init ();
 101
 102 public:
 103   Context *context () const { return daddy_context_; }
 104
 105   Translator ();
 106   Translator (Translator const &);
 107
 108   SCM internal_get_property (SCM symbol) const;
 109
 110   virtual Output_def *get_output_def () const;
 111   virtual Translator_group *get_daddy_translator ()const;
 112   virtual Moment now_mom () const;
 113   virtual bool must_be_last () const;
 114
 115   virtual void initialize ();
 116   virtual void finalize ();
 117
 118   virtual void connect_to_context (Context *c);
 119   virtual void disconnect_from_context (Context *c);
 120
 121   void stop_translation_timestep ();
 122   void start_translation_timestep ();
 123   void process_music ();
 124   void process_acknowledged ();
 125
 126   Context *get_score_context () const;
 127   Global_context *get_global_context () const;
 128
 129   DECLARE_CLASSNAME (Translator);
 130   virtual Translator *clone () const = 0;
 131   virtual void fetch_precomputable_methods (SCM methods[]) = 0;
 132   virtual SCM get_listener_list () const = 0;
 133   virtual SCM translator_description () const = 0;
 134   virtual SCM get_acknowledger (SCM sym, Direction start_end) = 0;
 135
 136 protected:                      // should be private.
 137   Context *daddy_context_;
 138   void protect_event (SCM ev);
 139
 140   template <class T, void (T::*callback)(Stream_event *)>
 141   static SCM trampoline (SCM target, SCM event)
 142   {
 143     T *t = unsmob<T> (target);
 144     LY_ASSERT_SMOB (T, target, 1);
 145     LY_ASSERT_SMOB (Stream_event, event, 2);
 146
 147     t->protect_event (event);
 148     (t->*callback) (unsmob<Stream_event> (event));
 149     return SCM_UNSPECIFIED;
 150   }
 151
 152   template <class T, void (T::*mf)()>
 153   static SCM
 154   method_find_base () { return Callback0_wrapper::make_smob<T, mf> (); }
 155
 156   // Fallback for non-overriden callbacks for which &T::x degrades to
 157   // &Translator::x
 158   template <void (Translator::*)()>
 159   static SCM
 160   method_finder () { return SCM_UNDEFINED; }
 161
 162   // Overriden in Engraver.
 163   template <class T, void (T::*callback)(Grob_info)>
 164   static SCM
 165   ack_find_base () { return SCM_UNDEFINED; }
 166
 167   template <void (Translator::*)(Grob_info)>
 168   static SCM
 169   ack_finder () { return SCM_UNDEFINED; }
 170
 171   virtual void derived_mark () const;
 172   static SCM event_class_symbol (const char *ev_class);
 173   SCM static_translator_description (const char *grobs,
 174                                      const char *desc,
 175                                      SCM listener_list,
 176                                      const char *read,
 177                                      const char *write) const;
 178
 179   friend class Translator_group;
 180 };
 181
 182 void add_translator (Translator *trans);
 183
 184 Translator *get_translator (SCM s);
 185
 186 SCM
 187 generic_get_acknowledger (SCM sym, SCM ack_hash);
 188
 189 Moment get_event_length (Stream_event *s, Moment now);
 190 Moment get_event_length (Stream_event *s);
 191
 192 /*
 193   This helper is only meaningful inside listen_* methods.
 194 */
 195 extern bool internal_event_assignment (Stream_event **old_ev, Stream_event *new_ev, const char *function);
 196 #define ASSIGN_EVENT_ONCE(o,n) internal_event_assignment (&o, n, __FUNCTION__)
 197
 198 #endif // TRANSLATOR_HH