mkxp/binding-mri/binding-util.h

388 lines
8.4 KiB
C
Raw Normal View History

2013-09-01 14:27:21 +00:00
/*
** binding-util.h
**
** This file is part of mkxp.
**
** Copyright (C) 2013 - 2021 Amaryllis Kulla <ancurio@mapleshrine.eu>
2013-09-01 14:27:21 +00:00
**
** mkxp is free software: you can redistribute it and/or modify
** it under the terms of the GNU General Public License as published by
** the Free Software Foundation, either version 2 of the License, or
** (at your option) any later version.
**
** mkxp is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with mkxp. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef BINDING_UTIL_H
#define BINDING_UTIL_H
#include <ruby.h>
2013-09-01 14:27:21 +00:00
2013-12-31 21:25:07 +00:00
#include "exception.h"
2013-09-01 14:27:21 +00:00
enum RbException
{
RGSS = 0,
Reset,
2013-09-01 14:27:21 +00:00
PHYSFS,
SDL,
2013-09-03 13:22:00 +00:00
MKXP,
2013-09-01 14:27:21 +00:00
ErrnoENOENT,
IOError,
TypeError,
ArgumentError,
RbExceptionsMax
};
struct RbData
{
VALUE exc[RbExceptionsMax];
/* Input module (RGSS3) */
VALUE buttoncodeHash;
2013-09-01 14:27:21 +00:00
RbData();
~RbData();
};
RbData *getRbData();
struct Exception;
void
raiseRbExc(const Exception &exc);
#define DECL_TYPE(Klass) \
extern rb_data_type_t Klass##Type
2013-09-01 14:27:21 +00:00
/* 2.1 has added a new field (flags) to rb_data_type_t */
#include <ruby/version.h>
#if RUBY_API_VERSION_MAJOR >= 2 && RUBY_API_VERSION_MINOR >= 1
/* TODO: can mkxp use RUBY_TYPED_FREE_IMMEDIATELY here? */
#define DEF_TYPE_FLAGS 0
#else
#define DEF_TYPE_FLAGS
#endif
2013-09-01 14:27:21 +00:00
#define DEF_TYPE_CUSTOMNAME_AND_FREE(Klass, Name, Free) \
rb_data_type_t Klass##Type = { \
Name, { 0, Free, 0, { 0, 0 } }, 0, 0, DEF_TYPE_FLAGS \
}
#define DEF_TYPE_CUSTOMFREE(Klass, Free) \
DEF_TYPE_CUSTOMNAME_AND_FREE(Klass, #Klass, Free)
#define DEF_TYPE_CUSTOMNAME(Klass, Name) \
DEF_TYPE_CUSTOMNAME_AND_FREE(Klass, Name, freeInstance<Klass>)
#define DEF_TYPE(Klass) DEF_TYPE_CUSTOMNAME(Klass, #Klass)
2013-09-01 14:27:21 +00:00
template<rb_data_type_t *rbType>
static VALUE classAllocate(VALUE klass)
{
/* 2.3 has changed the name of this function */
#if RUBY_API_VERSION_MAJOR >= 2 && RUBY_API_VERSION_MINOR >= 3
return rb_data_typed_object_wrap(klass, 0, rbType);
#else
return rb_data_typed_object_alloc(klass, 0, rbType);
#endif
}
2013-09-01 14:27:21 +00:00
template<class C>
static void freeInstance(void *inst)
2013-09-01 14:27:21 +00:00
{
delete static_cast<C*>(inst);
}
void
raiseDisposedAccess(VALUE self);
2013-09-01 14:27:21 +00:00
template<class C>
inline C *
2013-09-01 14:27:21 +00:00
getPrivateData(VALUE self)
{
C *c = static_cast<C*>(RTYPEDDATA_DATA(self));
return c;
2013-09-01 14:27:21 +00:00
}
template<class C>
static inline C *
getPrivateDataCheck(VALUE self, const rb_data_type_t &type)
2013-09-01 14:27:21 +00:00
{
void *obj = Check_TypedStruct(self, &type);
2013-09-01 14:27:21 +00:00
return static_cast<C*>(obj);
}
static inline void
setPrivateData(VALUE self, void *p)
2013-09-01 14:27:21 +00:00
{
RTYPEDDATA_DATA(self) = p;
2013-09-01 14:27:21 +00:00
}
inline VALUE
wrapObject(void *p, const rb_data_type_t &type,
VALUE underKlass = rb_cObject)
2013-09-01 14:27:21 +00:00
{
VALUE klass = rb_const_get(underKlass, rb_intern(type.wrap_struct_name));
2013-09-01 14:27:21 +00:00
VALUE obj = rb_obj_alloc(klass);
setPrivateData(obj, p);
2013-09-01 14:27:21 +00:00
return obj;
}
inline VALUE
wrapProperty(VALUE self, void *prop, const char *iv,
const rb_data_type_t &type,
VALUE underKlass = rb_cObject)
2013-09-01 14:27:21 +00:00
{
VALUE propObj = wrapObject(prop, type, underKlass);
2013-09-01 14:27:21 +00:00
rb_iv_set(self, iv, propObj);
return propObj;
}
/* Implemented: oSszfibn| */
2013-09-01 14:27:21 +00:00
int
rb_get_args(int argc, VALUE *argv, const char *format, ...);
/* Always terminate 'rb_get_args' with this */
#ifndef NDEBUG
# define RB_ARG_END_VAL ((void*) -1)
# define RB_ARG_END ,RB_ARG_END_VAL
#else
# define RB_ARG_END
#endif
2013-09-01 14:27:21 +00:00
typedef VALUE (*RubyMethod)(int argc, VALUE *argv, VALUE self);
static inline void
_rb_define_method(VALUE klass, const char *name, RubyMethod func)
{
rb_define_method(klass, name, RUBY_METHOD_FUNC(func), -1);
}
static inline void
rb_define_class_method(VALUE klass, const char *name, RubyMethod func)
{
rb_define_singleton_method(klass, name, RUBY_METHOD_FUNC(func), -1);
}
static inline void
_rb_define_module_function(VALUE module, const char *name, RubyMethod func)
{
rb_define_module_function(module, name, RUBY_METHOD_FUNC(func), -1);
}
#define GUARD_EXC(exp) \
{ try { exp } catch (const Exception &exc) { raiseRbExc(exc); } }
2013-09-01 14:27:21 +00:00
template<class C>
static inline VALUE
objectLoad(int argc, VALUE *argv, VALUE self)
2013-09-01 14:27:21 +00:00
{
const char *data;
int dataLen;
rb_get_args(argc, argv, "s", &data, &dataLen RB_ARG_END);
2013-09-01 14:27:21 +00:00
VALUE obj = rb_obj_alloc(self);
C *c = 0;
GUARD_EXC( c = C::deserialize(data, dataLen); );
2013-09-01 14:27:21 +00:00
setPrivateData(obj, c);
2013-09-01 14:27:21 +00:00
return obj;
}
static inline VALUE
rb_bool_new(bool value)
{
return value ? Qtrue : Qfalse;
}
inline void
rb_float_arg(VALUE arg, double *out, int argPos = 0)
{
switch (rb_type(arg))
{
case RUBY_T_FLOAT :
*out = RFLOAT_VALUE(arg);
break;
case RUBY_T_FIXNUM :
*out = FIX2INT(arg);
break;
default:
rb_raise(rb_eTypeError, "Argument %d: Expected float", argPos);
}
}
inline void
rb_int_arg(VALUE arg, int *out, int argPos = 0)
{
switch (rb_type(arg))
{
case RUBY_T_FLOAT :
// FIXME check int range?
*out = NUM2LONG(arg);
break;
case RUBY_T_FIXNUM :
*out = FIX2INT(arg);
break;
default:
rb_raise(rb_eTypeError, "Argument %d: Expected fixnum", argPos);
}
}
inline void
rb_bool_arg(VALUE arg, bool *out, int argPos = 0)
{
switch (rb_type(arg))
{
case RUBY_T_TRUE :
*out = true;
break;
case RUBY_T_FALSE :
case RUBY_T_NIL :
*out = false;
break;
default:
rb_raise(rb_eTypeError, "Argument %d: Expected bool", argPos);
}
}
inline void
rb_check_argc(int actual, int expected)
{
if (actual != expected)
rb_raise(rb_eArgError, "wrong number of arguments (%d for %d)",
actual, expected);
}
2013-09-01 14:27:21 +00:00
#define RB_METHOD(name) \
static VALUE name(int argc, VALUE *argv, VALUE self)
#define RB_UNUSED_PARAM \
{ (void) argc; (void) argv; (void) self; }
#define MARSH_LOAD_FUN(Typ) \
RB_METHOD(Typ##Load) \
{ \
return objectLoad<Typ>(argc, argv, self); \
2013-09-01 14:27:21 +00:00
}
#define INITCOPY_FUN(Klass) \
RB_METHOD(Klass##InitializeCopy) \
2013-09-01 14:27:21 +00:00
{ \
VALUE origObj; \
rb_get_args(argc, argv, "o", &origObj RB_ARG_END); \
if (!OBJ_INIT_COPY(self, origObj)) /* When would this fail??*/\
return self; \
Klass *orig = getPrivateData<Klass>(origObj); \
Klass *k = 0; \
GUARD_EXC( k = new Klass(*orig); ) \
setPrivateData(self, k); \
return self; \
2013-09-01 14:27:21 +00:00
}
/* Object property which is copied by reference, with allowed NIL
* FIXME: Getter assumes prop is disposable,
* because self.disposed? is not checked in this case.
* Should make this more clear */
#define DEF_PROP_OBJ_REF(Klass, PropKlass, PropName, prop_iv) \
2013-09-01 14:27:21 +00:00
RB_METHOD(Klass##Get##PropName) \
{ \
RB_UNUSED_PARAM; \
return rb_iv_get(self, prop_iv); \
} \
RB_METHOD(Klass##Set##PropName) \
{ \
RB_UNUSED_PARAM; \
rb_check_argc(argc, 1); \
2013-09-01 14:27:21 +00:00
Klass *k = getPrivateData<Klass>(self); \
VALUE propObj = *argv; \
2013-09-01 14:27:21 +00:00
PropKlass *prop; \
if (NIL_P(propObj)) \
prop = 0; \
else \
prop = getPrivateDataCheck<PropKlass>(propObj, PropKlass##Type); \
2013-09-01 14:27:21 +00:00
GUARD_EXC( k->set##PropName(prop); ) \
rb_iv_set(self, prop_iv, propObj); \
return propObj; \
}
/* Object property which is copied by value, not reference */
#define DEF_PROP_OBJ_VAL(Klass, PropKlass, PropName, prop_iv) \
2013-09-01 14:27:21 +00:00
RB_METHOD(Klass##Get##PropName) \
{ \
RB_UNUSED_PARAM; \
checkDisposed<Klass>(self); \
2013-09-01 14:27:21 +00:00
return rb_iv_get(self, prop_iv); \
} \
RB_METHOD(Klass##Set##PropName) \
{ \
rb_check_argc(argc, 1); \
2013-09-01 14:27:21 +00:00
Klass *k = getPrivateData<Klass>(self); \
VALUE propObj = *argv; \
2013-09-01 14:27:21 +00:00
PropKlass *prop; \
prop = getPrivateDataCheck<PropKlass>(propObj, PropKlass##Type); \
GUARD_EXC( k->set##PropName(*prop); ) \
2013-09-01 14:27:21 +00:00
return propObj; \
}
#define DEF_PROP(Klass, type, PropName, arg_fun, value_fun) \
2013-09-01 14:27:21 +00:00
RB_METHOD(Klass##Get##PropName) \
{ \
RB_UNUSED_PARAM; \
Klass *k = getPrivateData<Klass>(self); \
2014-10-01 04:29:20 +00:00
type value = 0; \
GUARD_EXC( value = k->get##PropName(); ) \
return value_fun(value); \
2013-09-01 14:27:21 +00:00
} \
RB_METHOD(Klass##Set##PropName) \
{ \
rb_check_argc(argc, 1); \
2013-09-01 14:27:21 +00:00
Klass *k = getPrivateData<Klass>(self); \
type value; \
rb_##arg_fun##_arg(*argv, &value); \
2013-09-01 14:27:21 +00:00
GUARD_EXC( k->set##PropName(value); ) \
return *argv; \
2013-09-01 14:27:21 +00:00
}
#define DEF_PROP_I(Klass, PropName) \
DEF_PROP(Klass, int, PropName, int, rb_fix_new)
2013-09-01 14:27:21 +00:00
#define DEF_PROP_F(Klass, PropName) \
DEF_PROP(Klass, double, PropName, float, rb_float_new)
2013-09-01 14:27:21 +00:00
#define DEF_PROP_B(Klass, PropName) \
DEF_PROP(Klass, bool, PropName, bool, rb_bool_new)
2013-09-01 14:27:21 +00:00
#define INIT_PROP_BIND(Klass, PropName, prop_name_s) \
{ \
_rb_define_method(klass, prop_name_s, Klass##Get##PropName); \
_rb_define_method(klass, prop_name_s "=", Klass##Set##PropName); \
}
#endif // BINDING_UTIL_H