mkxp-z/binding/disposable-binding.h

/*
** disposable-binding.h
**
** This file is part of mkxp.
**
** Copyright (C) 2013 - 2021 Amaryllis Kulla <ancurio@mapleshrine.eu>
**
** 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 DISPOSABLEBINDING_H
#define DISPOSABLEBINDING_H

#include "disposable.h"
#include "binding-util.h"
#include "graphics.h"

/* 'Children' are disposables that are disposed together
 * with their parent. Currently this is only used by Viewport
 * in RGSS1. */
inline void
disposableAddChild(VALUE disp, VALUE child)
{
    GFX_LOCK;
    if (NIL_P(disp) || NIL_P(child)) {
        return;
    }
    
    VALUE objID = rb_obj_id(child);
    
	VALUE children = rb_iv_get(disp, "children");
    
    bool exists = false;

	if (NIL_P(children))
	{
		children = rb_ary_new();
		rb_iv_set(disp, "children", children);
	}
    else {
        exists = RTEST(rb_funcall(children, rb_intern("include?"), 1, objID));
    }

    if (!exists) {
        rb_ary_push(children, objID);
        VALUE objectspace = rb_const_get(rb_cObject, rb_intern("ObjectSpace"));
        VALUE method = rb_funcall(disp, rb_intern("method"), 1, rb_id2sym(rb_intern("_sprite_finalizer")));
        rb_funcall(objectspace, rb_intern("define_finalizer"), 2, child, method);
    }
    GFX_UNLOCK;
}

inline void
disposableRemoveChild(VALUE disp, VALUE child)
{
    GFX_LOCK;
    if (NIL_P(disp) || NIL_P(child)) {
        return;
    }
    
    VALUE objID = rb_obj_id(child);
    
    VALUE children = rb_iv_get(disp, "children");
    if (NIL_P(children))
        return;
    
    VALUE index = rb_funcall(children, rb_intern("index"), 1, objID);
    if (NIL_P(index))
        return;
    
    rb_funcall(children, rb_intern("delete_at"), 1, index);
    GFX_UNLOCK;
}

inline void
disposableForgetChild(VALUE disp, VALUE child)
{
    VALUE children = rb_iv_get(disp, "children");
    
    if (NIL_P(children)) {
        return;
    }
    
    VALUE index = rb_funcall(children, rb_intern("index"), 1, child);
    if (NIL_P(index)) {
        return;
    }
    
    rb_funcall(children, rb_intern("delete_at"), 1, index);
}

inline void
disposableDisposeChildren(VALUE disp)
{
	VALUE children = rb_iv_get(disp, "children");

	if (NIL_P(children))
		return;

    for (long i = 0; i < RARRAY_LEN(children); ++i) {
        int state;
        rb_protect([](VALUE args){
            VALUE objectspace = rb_const_get(rb_cObject, rb_intern("ObjectSpace"));
            VALUE ref = rb_funcall(objectspace, rb_intern("_id2ref"), 1, args);
            rb_funcall(ref, rb_intern("_mkxp_dispose_alias"), 0);
            return Qnil;
        }, rb_ary_entry(children, i), &state);
    }
		//rb_funcall2(rb_ary_entry(children, i), dispFun, 0, 0);
}

template<class C>
RB_METHOD(disposableDispose)
{
	RB_UNUSED_PARAM;

	C *d = getPrivateData<C>(self);

	if (!d)
		return Qnil;

	/* Nothing to do if already disposed */
	if (d->isDisposed())
		return Qnil;

	if (rgssVer == 1)
		disposableDisposeChildren(self);

    GFX_LOCK;
	d->dispose();
    GFX_UNLOCK;

	return Qnil;
}

template<class C>
RB_METHOD(disposableIsDisposed)
{
	RB_UNUSED_PARAM;

	C *d = getPrivateData<C>(self);

	if (!d)
		return Qtrue;

	return rb_bool_new(d->isDisposed());
}

template<class C>
static void disposableBindingInit(VALUE klass)
{
	_rb_define_method(klass, "dispose", disposableDispose<C>);
	_rb_define_method(klass, "disposed?", disposableIsDisposed<C>);

	/* Make sure we always have access to the original method, even
	 * if it is overridden by user scripts */
	if (rgssVer == 1)
		rb_define_alias(klass, "_mkxp_dispose_alias", "dispose");
}

template<class C>
inline void
checkDisposed(VALUE self)
{
	if (disposableIsDisposed<C>(0, 0, self) == Qtrue)
		raiseDisposedAccess(self);
}

#endif // DISPOSABLEBINDING_H