mirrors/mkxp-z - Incest Forge: Beyond sex. We incest.

mirrors/mkxp-z

mirror of https://github.com/mkxp-z/mkxp-z.git synced 2024-10-28 11:19:36 +01:00

73 lines

1.6 KiB

C

Raw Normal View History

Initial commit 2013-09-01 16:27:21 +02:00			`/*`
			`** disposable-binding.h`
			`**`
			`** This file is part of mkxp.`
			`**`
Update ancurio's copyright notice (#29) 2023-10-04 21:07:34 +02:00			`** Copyright (C) 2013 - 2021 Amaryllis Kulla <ancurio@mapleshrine.eu>`
Initial commit 2013-09-01 16:27:21 +02: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 DISPOSABLEBINDING_H`
			`#define DISPOSABLEBINDING_H`

			`#include "disposable.h"`
			`#include "binding-util.h"`
Prevent relevant functions from stepping over Graphics.update when threading 2021-06-04 20:29:45 +02:00			`#include "graphics.h"`
Initial commit 2013-09-01 16:27:21 +02:00
			`template<class C>`
			`RB_METHOD(disposableDispose)`
			`{`
			`RB_UNUSED_PARAM;`
Properly handle uninitialized and reinitialized objects In RGSS, uninitialized disposable objects (and Fonts, sort of) are technically disposed, and other objects (Tone, Color, Rect, and Table) are created with all values set to 0. It's also possible to reinitialize them, although reinitializing disposables leaks memory. This commit causes MiniFFI and FileInt objects to improperly raise disposed errors if used while uninitialized, but that feels acceptable to me. 2024-06-17 18:49:56 +02:00
			`C *d = getPrivateDataNoRaise<C>(self);`
Revert Disposable concept back into core Pretty much a revert of e858bbdcf5cc8120dd169d7efb8ae8d13ab0b5c5. We need this in core to properly implement F12 reset. 2014-09-23 21:12:58 +02:00
			`if (!d)`
			`return Qnil;`
Lift 'Disposable' concept from core into bindings Instead of replicating the RGSS Disposable interface in C++ and merely binding it, redefine the 'disposed' state as the entire core object being deleted (and the binding object's private pointer being null). This makes the behavior more accurate in regard to RMXP. It is now for example possible to subclass disposable classes and access their 'dispose'/'disposed?' methods without initializing the base class first (because the internal pointer is simply null before initialization). Accessing any other base methods will still raise an exception. There are some quirks and irregular behavior in RMXP; eg. most nullable bitmap attributes of disposable classes (Sprite, Plane etc.) can still be queried afterwards, but some cannot (Tilemap#tileset), and disposing certain attributes crashes RMXP entirely (Tilemap#autotiles[n]). mkxp tries to behave as close possible, but will be more lenient some circumstances. To the core, disposed bitmap attributes will look identically to null, which slightly diverges from RMXP (where they're treated as still existing, but aren't drawn). The Disposable interface has been retained containing a single signal, for the binding to inform core when objects are disposed (so active attributes can be set to null). 2014-08-09 18:35:01 +02:00
Revert Disposable concept back into core Pretty much a revert of e858bbdcf5cc8120dd169d7efb8ae8d13ab0b5c5. We need this in core to properly implement F12 reset. 2014-09-23 21:12:58 +02:00			`d->dispose();`
Initial commit 2013-09-01 16:27:21 +02:00
			`return Qnil;`
			`}`

Revert Disposable concept back into core Pretty much a revert of e858bbdcf5cc8120dd169d7efb8ae8d13ab0b5c5. We need this in core to properly implement F12 reset. 2014-09-23 21:12:58 +02:00			`template<class C>`
Initial commit 2013-09-01 16:27:21 +02:00			`RB_METHOD(disposableIsDisposed)`
			`{`
			`RB_UNUSED_PARAM;`

Properly handle uninitialized and reinitialized objects In RGSS, uninitialized disposable objects (and Fonts, sort of) are technically disposed, and other objects (Tone, Color, Rect, and Table) are created with all values set to 0. It's also possible to reinitialize them, although reinitializing disposables leaks memory. This commit causes MiniFFI and FileInt objects to improperly raise disposed errors if used while uninitialized, but that feels acceptable to me. 2024-06-17 18:49:56 +02:00			`C *d = getPrivateDataNoRaise<C>(self);`
Revert Disposable concept back into core Pretty much a revert of e858bbdcf5cc8120dd169d7efb8ae8d13ab0b5c5. We need this in core to properly implement F12 reset. 2014-09-23 21:12:58 +02:00
			`if (!d)`
			`return Qtrue;`

			`return rb_bool_new(d->isDisposed());`
Initial commit 2013-09-01 16:27:21 +02:00			`}`

			`template<class C>`
			`static void disposableBindingInit(VALUE klass)`
			`{`
			`_rb_define_method(klass, "dispose", disposableDispose<C>);`
Revert Disposable concept back into core Pretty much a revert of e858bbdcf5cc8120dd169d7efb8ae8d13ab0b5c5. We need this in core to properly implement F12 reset. 2014-09-23 21:12:58 +02:00			`_rb_define_method(klass, "disposed?", disposableIsDisposed<C>);`
			`}`

			`template<class C>`
			`inline void`
			`checkDisposed(VALUE self)`
			`{`
			`if (disposableIsDisposed<C>(0, 0, self) == Qtrue)`
			`raiseDisposedAccess(self);`
Initial commit 2013-09-01 16:27:21 +02:00			`}`

			`#endif // DISPOSABLEBINDING_H`