lily/include/scheme-engraver.hh

   1 /*
   2   scheme-engraver.hh -- declare Scheme_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   Copyright (c) 2009--2015 Han-Wen Nienhuys <hanwen@lilypond.org>
   7
   8   LilyPond is free software: you can redistribute it and/or modify
   9   it under the terms of the GNU General Public License as published by
  10   the Free Software Foundation, either version 3 of the License, or
  11   (at your option) any later version.
  12
  13   LilyPond is distributed in the hope that it will be useful,
  14   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16   GNU General Public License for more details.
  17
  18   You should have received a copy of the GNU General Public License
  19   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  20 */
  21
  22 #ifndef SCHEME_ENGRAVER_HH
  23 #define SCHEME_ENGRAVER_HH
  24
  25 #include "engraver.hh"
  26
  27 class Scheme_engraver : public Engraver
  28 {
  29 public:
  30   void init_from_scheme (SCM definition);
  31   TRANSLATOR_DECLARATIONS_NO_LISTENER (Scheme_engraver);
  32
  33 protected:
  34   ~Scheme_engraver ();
  35
  36   void stop_translation_timestep ();
  37   void start_translation_timestep ();
  38   void process_music ();
  39   void process_acknowledged ();
  40
  41   virtual void initialize ();
  42   virtual void finalize ();
  43   virtual void derived_mark () const;
  44   virtual SCM get_listener_list () const;
  45   virtual bool must_be_last () const;
  46
  47 private:
  48   void acknowledge_grob_by_hash (Grob_info info, SCM iface_function_hash);
  49   void init_acknowledgers (SCM alist, SCM *hash);
  50
  51   DECLARE_ACKNOWLEDGER (grob);
  52   DECLARE_END_ACKNOWLEDGER (grob);
  53
  54   bool must_be_last_;
  55
  56   SCM acknowledge_grob_function_;
  57   SCM stop_translation_timestep_function_;
  58   SCM start_translation_timestep_function_;
  59   SCM process_music_function_;
  60   SCM process_acknowledged_function_;
  61   SCM initialize_function_;
  62   SCM finalize_function_;
  63
  64   // hashq table of interface-symbol -> scheme-function
  65   SCM interface_acknowledger_hash_;
  66   SCM interface_end_acknowledger_hash_;
  67
  68   // Alist of listened-symbol . scheme-function
  69   SCM listeners_alist_;
  70
  71   // We dont use this, but need it for the documentation boilerplate.
  72   static Protected_scm listener_list_;
  73   SCM per_instance_listeners_;
  74 };
  75
  76 #endif /* SCHEME_ENGRAVER_HH */
  77