lily/include/lily-guile-macros.hh

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2005--2014 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 LILY_GUILE_MACROS_HH
  21 #define LILY_GUILE_MACROS_HH
  22
  23 #include "config.hh"
  24
  25 #ifndef SMOB_FREE_RETURN_VAL
  26 #define SMOB_FREE_RETURN_VAL(CL) 0
  27 #endif
  28
  29 #ifndef SCM_PACK
  30 #define SCM_PACK(x) ((SCM) x)
  31 #endif
  32
  33 #ifndef SCM_UNPACK
  34 #define SCM_UNPACK(x) (x)
  35 #endif
  36
  37 /* For backward compatability with Guile 1.8 */
  38 #if !HAVE_GUILE_SUBR_TYPE
  39 typedef SCM (*scm_t_subr) (GUILE_ELLIPSIS);
  40 #endif
  41
  42 /* Unreliable with gcc-2.x
  43    FIXME: should add check for x86 as well?  */
  44 #define CACHE_SYMBOLS
  45
  46 #ifdef CACHE_SYMBOLS
  47
  48 /* this lets us "overload" macros such as get_property to take
  49    symbols as well as strings */
  50 inline SCM
  51 scm_or_str2symbol (char const *c) { return scm_from_locale_symbol (c); }
  52
  53 inline SCM
  54 scm_or_str2symbol (SCM s)
  55 {
  56   assert (scm_is_symbol (s));
  57   return s;
  58 }
  59
  60 /* Using this trick we cache the value of scm_from_locale_symbol ("fooo") where
  61    "fooo" is a constant string. This is done at the cost of one static
  62    variable per ly_symbol2scm() use, and one boolean evaluation for
  63    every call.
  64  */
  65 #define ly_symbol2scm(x)                                                \
  66   ({                                                                    \
  67     static SCM cached;                                                  \
  68     /* We store this one locally, since G++ -O2 fucks up else */        \
  69     SCM value = cached;                                                 \
  70     if (__builtin_constant_p ((x)))                                     \
  71       {                                                                 \
  72         if (!cached)                                                    \
  73           value = cached = scm_gc_protect_object (scm_or_str2symbol (x)); \
  74       }                                                                 \
  75     else                                                                \
  76       value = scm_or_str2symbol (x);                                    \
  77     value;                                                              \
  78   })
  79 #else
  80 inline SCM ly_symbol2scm (char const *x) { return scm_from_locale_symbol ((x)); }
  81 #endif
  82
  83 /*
  84   we don't have to protect the result; it's already part of the
  85   exports list of the module.
  86 */
  87
  88 #define ly_lily_module_constant(x)                                      \
  89   ({                                                                    \
  90     static SCM cached;                                                  \
  91     /* We store this one locally, since G++ -O2 fucks up else */        \
  92     SCM value = cached;                                                 \
  93     if (__builtin_constant_p ((x)))                                     \
  94       {                                                                 \
  95         if (!cached)                                                    \
  96           value = cached =                                              \
  97             scm_variable_ref (scm_c_module_lookup (global_lily_module, (x))); \
  98       }                                                                 \
  99     else                                                                \
 100       value =                                                           \
 101         scm_variable_ref (scm_c_module_lookup (global_lily_module, (x))); \
 102     value;                                                              \
 103   })
 104
 105 /*
 106   Adds the NAME as a Scheme function, and a variable to store the SCM
 107   version of the function in the static variable NAME_proc
 108 */
 109 #define DECLARE_SCHEME_CALLBACK(NAME, ARGS)     \
 110   static SCM NAME ARGS;                         \
 111   static SCM NAME ## _proc
 112
 113 string mangle_cxx_identifier (string);
 114
 115 void ly_add_type_predicate (void *ptr, const string &name);
 116 string predicate_to_typename (void *ptr);
 117
 118 /*
 119   Make TYPE::FUNC available as a Scheme function.
 120 */
 121 #define MAKE_SCHEME_CALLBACK_WITH_OPTARGS(TYPE, FUNC, ARGCOUNT, OPTIONAL_COUNT, DOC) \
 122   SCM TYPE ::FUNC ## _proc;                                             \
 123   void                                                                  \
 124   TYPE ## _ ## FUNC ## _init_functions ()                               \
 125   {                                                                     \
 126     string cxx = string (#TYPE) + "::" + string (#FUNC); \
 127     string id = mangle_cxx_identifier (cxx); \
 128     TYPE ::FUNC ## _proc = scm_c_define_gsubr (id.c_str(),                      \
 129                                                (ARGCOUNT-OPTIONAL_COUNT), OPTIONAL_COUNT, 0,    \
 130                                                (scm_t_subr) TYPE::FUNC); \
 131     ly_add_function_documentation (TYPE :: FUNC ## _proc, id.c_str(), "", \
 132                                    DOC);                                \
 133     scm_c_export (id.c_str (), NULL);                                   \
 134   }                                                                     \
 135                                                                         \
 136   ADD_SCM_INIT_FUNC (TYPE ## _ ## FUNC ## _callback,                    \
 137                      TYPE ## _ ## FUNC ## _init_functions);
 138
 139 #define MAKE_DOCUMENTED_SCHEME_CALLBACK(TYPE, FUNC, ARGCOUNT, DOC)              \
 140   MAKE_SCHEME_CALLBACK_WITH_OPTARGS(TYPE, FUNC, ARGCOUNT, 0, DOC);
 141
 142 #define MAKE_SCHEME_CALLBACK(TYPE, FUNC, ARGCOUNT)                      \
 143   MAKE_SCHEME_CALLBACK_WITH_OPTARGS(TYPE,FUNC,ARGCOUNT, 0, "");
 144
 145 void ly_add_function_documentation (SCM proc, const string &fname, const string &varlist, const string &doc);
 146 void ly_check_name (const string &cxx, const string &fname);
 147
 148 #define ADD_SCM_INIT_FUNC(name, func)           \
 149   class name ## _scm_initter                    \
 150   {                                             \
 151   public:                                       \
 152     name ## _scm_initter ()                     \
 153     {                                           \
 154       add_scm_init_func (func);                 \
 155     }                                           \
 156   }                                             \
 157     _ ## name ## _scm_initter;
 158
 159 /* end define */
 160
 161 #define LY_DEFINE_WITHOUT_DECL(INITPREFIX, FNAME, PRIMNAME, REQ, OPT, VAR, \
 162                                ARGLIST, DOCSTRING)                      \
 163   SCM FNAME ## _proc;                                                   \
 164   void                                                                  \
 165   INITPREFIX ## init ()                                                 \
 166   {                                                                     \
 167     FNAME ## _proc = scm_c_define_gsubr (PRIMNAME, REQ, OPT, VAR,       \
 168                                          (scm_t_subr) FNAME); \
 169     ly_check_name (#FNAME, PRIMNAME);\
 170     ly_add_function_documentation (FNAME ## _proc, PRIMNAME, #ARGLIST,  \
 171                                    DOCSTRING);                          \
 172     scm_c_export (PRIMNAME, NULL);                                      \
 173   }                                                                     \
 174   ADD_SCM_INIT_FUNC (INITPREFIX ## init_unique_prefix, INITPREFIX ## init); \
 175   SCM                                                                   \
 176   FNAME ARGLIST
 177
 178 #define LY_DEFINE(FNAME, PRIMNAME, REQ, OPT, VAR, ARGLIST, DOCSTRING)   \
 179   SCM FNAME ARGLIST;                                                    \
 180   LY_DEFINE_WITHOUT_DECL (FNAME, FNAME, PRIMNAME, REQ, OPT, VAR, ARGLIST, \
 181                           DOCSTRING)
 182
 183 #define LY_DEFINE_MEMBER_FUNCTION(CLASS, FNAME, PRIMNAME, REQ, OPT, VAR, \
 184                                   ARGLIST, DOCSTRING)                   \
 185   SCM FNAME ARGLIST;                                                    \
 186   LY_DEFINE_WITHOUT_DECL (CLASS ## FNAME, CLASS::FNAME, PRIMNAME, REQ, OPT, \
 187                           VAR, ARGLIST, DOCSTRING)
 188
 189 #define get_property(x) internal_get_property (ly_symbol2scm (x))
 190 #define get_pure_property(x,y,z) \
 191   internal_get_pure_property (ly_symbol2scm (x), y, z)
 192 #define get_maybe_pure_property(w,x,y,z) \
 193   internal_get_maybe_pure_property (ly_symbol2scm (w), x, y, z)
 194 #define get_property_data(x) internal_get_property_data (ly_symbol2scm (x))
 195 #define get_object(x) internal_get_object (ly_symbol2scm (x))
 196 #define set_object(x, y) internal_set_object (ly_symbol2scm (x), y)
 197 #define del_property(x) internal_del_property (ly_symbol2scm (x))
 198
 199 #ifndef NDEBUG
 200 /*
 201   TODO: include modification callback support here, perhaps
 202   through intermediate Grob::instrumented_set_property( .. __LINE__ ).
 203  */
 204 #define set_property(x, y) instrumented_set_property (ly_symbol2scm (x), y, __FILE__, __LINE__, __FUNCTION__)
 205 #else
 206 #define set_property(x, y) internal_set_property (ly_symbol2scm (x), y)
 207 #endif
 208
 209 #define LY_ASSERT_TYPE(pred, var, number)                                       \
 210   {                                                                     \
 211     if (!pred (var)) \
 212       {                                                                 \
 213         scm_wrong_type_arg_msg(mangle_cxx_identifier (__FUNCTION__).c_str(), \
 214                                number, var, \
 215                                predicate_to_typename ((void*) &pred).c_str()); \
 216       }                                                                 \
 217   }
 218
 219 #define LY_ASSERT_SMOB(klass, var, number) LY_ASSERT_TYPE(klass::is_smob, var, number)
 220
 221 #endif /* LILY_GUILE_MACROS_HH */