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 #include "protected-scm.hh"
  25
  26 class Grob;
  27
  28 #define ADD_INTERFACE(cl, b, c)                                 \
  29   Grob_interface<cl> cl ## _interface_initializer;              \
  30   template <> char const *Grob_interface<cl>::cxx_name_ (#cl);  \
  31   template <> char const *Grob_interface<cl>::description_ (b); \
  32   template <> char const *Grob_interface<cl>::variables_ (c);
  33
  34 SCM add_interface (char const *cxx_name,
  35                    char const *descr,
  36                    char const *vars);
  37
  38 SCM ly_add_interface (SCM, SCM, SCM);
  39 void internal_add_interface (SCM, SCM, SCM);
  40 SCM ly_all_grob_interfaces ();
  41
  42 template <class Interface>
  43 class Grob_interface
  44 {
  45 public:
  46   Grob_interface ()
  47   {
  48     add_scm_init_func (Grob_interface::init);
  49   }
  50
  51 private:
  52   static void init ()
  53   {
  54     interface_symbol_ = ::add_interface (cxx_name_, description_, variables_);
  55   }
  56
  57   template <class T>
  58   friend bool has_interface(Grob *);
  59
  60 private:
  61   static Protected_scm interface_symbol_;
  62   static char const *cxx_name_;
  63   static char const *description_;
  64   static char const *variables_;
  65 };
  66
  67 template <class Interface>
  68 Protected_scm Grob_interface<Interface>::interface_symbol_;
  69
  70 #endif /* INTERFACE_HH */
  71