lily/include/grob-interface.hh

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2002--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 INTERFACE_HH
  21 #define INTERFACE_HH
  22
  23 #include "lily-guile.hh"
  24
  25 class Grob;
  26
  27 // TODO: remove DECLARE_GROB_INTERFACE
  28 #define DECLARE_GROB_INTERFACE() \
  29   static bool has_interface (Grob *g)
  30
  31 // TODO: remove cl::has_interface and use ::has_interface directly
  32 #define ADD_INTERFACE(cl, b, c)                                 \
  33   Grob_interface<cl> cl ## _interface_initializer;              \
  34   template <> char const *Grob_interface<cl>::cxx_name_ (#cl);  \
  35   template <> char const *Grob_interface<cl>::description_ (b); \
  36   template <> char const *Grob_interface<cl>::variables_ (c);   \
  37   bool cl::has_interface (Grob *me)                             \
  38   {                                                             \
  39     return ::has_interface<cl> (me);                            \
  40   }
  41
  42 SCM add_interface (char const *cxx_name,
  43                    char const *descr,
  44                    char const *vars);
  45
  46 SCM ly_add_interface (SCM, SCM, SCM);
  47 void internal_add_interface (SCM, SCM, SCM);
  48 SCM ly_all_grob_interfaces ();
  49
  50 template <class Interface>
  51 class Grob_interface
  52 {
  53 public:
  54   Grob_interface ()
  55   {
  56     add_scm_init_func (Grob_interface::init);
  57   }
  58
  59 private:
  60   static void init ()
  61   {
  62     interface_symbol_ = ::add_interface (cxx_name_, description_, variables_);
  63   }
  64
  65   template <class T>
  66   friend bool has_interface(Grob *);
  67
  68 private:
  69   static SCM interface_symbol_;
  70   static char const *cxx_name_;
  71   static char const *description_;
  72   static char const *variables_;
  73 };
  74
  75 template <class Interface>
  76 SCM Grob_interface<Interface>::interface_symbol_;
  77
  78 #endif /* INTERFACE_HH */
  79