Fix mruby bindings #197

pulsejet · 2018-04-28T09:16:47Z

The bindings currently provided are really old and incompatible with API changes. mkxp compiles and runs against the latest mruby with these changes.

carstene1ns · 2018-04-28T09:21:08Z

Good to see someone work on this! 👍

pulsejet · 2018-04-28T11:03:08Z

@Ancurio any reason why the RPG module is defined differently for mruby and MRI? The current mruby module gives me really cryptic errors; just adding the scripts from MRI to my Scripts.rxdata works pretty well. With only minor changes, the game seems to work (sorta), though for some reason no events are being triggered as I interact with them :(

Ancurio

Looks good overall; sorry for the state the mruby binding has been in, I haven't used it in a long while and thus neglected maintenance. Would be great if there was an actual use for it besides just simple test scripts.
Thanks for working on it.

Ancurio · 2018-04-29T09:25:55Z

binding-mruby/binding-mruby.cpp

@@ -117,7 +117,7 @@ static void mrbBindingInit(mrb_state *mrb)
 	/* Load global constants */
 	mrb_define_global_const(mrb, "MKXP", mrb_true_value());

-	mrb_value debug = rb_bool_new(shState->config().editor.debug);
+	mrb_value debug = mrb_bool_value(shState->config().editor.debug);


hm, rb_ is from the MRI binding, so this probably slipped in with PR #191.

Ancurio · 2018-04-29T09:26:45Z

binding-mruby/binding-util.cpp

@@ -72,7 +72,7 @@ static const MrbExcData excData[] =
 	{ PHYSFS,   "PHYSFSError" },
 	{ SDL,      "SDLError"    },
 	{ MKXP,     "MKXPError"   },
-	{ IO,       "IOError"     }
+	{ IO,       "IOError2"     }


Why the rename? Is IOError already defined by mruby?

Yeah. If I remember right, this throws up some error about IOError already existing.

Should I rename this to something better?

This is from the io-gem too, right. Just delete this entry in the array, and query the existing error class like done here: https://github.com/Ancurio/mkxp/blob/master/binding-mruby/binding-util.cpp#L120

Did this, but tbh I've no idea what's going on here

binding-mruby/font-binding.cpp

Ancurio · 2018-04-29T09:33:05Z

binding-mruby/font-binding.cpp

-
-	return mrb_str_new_cstr(mrb, f->getName());
+	/* FIXME: getName method is missing from Font */
+	return mrb_str_new_cstr(mrb, "name");


Return the saved IV here (see below).

Ancurio · 2018-04-29T09:34:13Z

binding-mruby/font-binding.cpp

@@ -137,15 +144,19 @@ DEF_KLASS_PROP(Font, mrb_bool, DefaultShadow,  "b", bool)

 MRB_FUNCTION(FontGetDefaultName)
 {
-	return mrb_str_new_cstr(mrb, Font::getDefaultName());
+	/* FIXME: getDefaultName method is missing from Font */
+	return mrb_str_new_cstr(mrb, "default_name");


Same as with get/SetName, except that the IV is stored in the Class object.

Ancurio · 2018-04-29T09:35:03Z

binding-mruby/mrb-ext/file.cpp

@@ -596,7 +596,7 @@ fileBindingInit(mrb_state *mrb)
 	mrb_define_method(mrb, klass, "path", fileGetPath, MRB_ARGS_NONE());

 	/* FileTest */
-	RClass *module = mrb_define_module(mrb, "FileTest");
+	RClass *module = mrb_define_module(mrb, "MKXPFileTest");


With this rename the class becomes pointless (scripts expect this standard name, which is also mentioned in the RGSS documentation); why was it necessary? Is there a native implementation now?

Yup, it is in the mruby-io mrbgem that is included with the default build (check this, for some reason, the documentation doesn't list this). I'm a bit inclined towards keeping this code for a while since I haven't really tested much yet, so just renamed it to MKXPFileTest. What do you think?

Renaming the Module defeats the entire purpose of having it; code expecting FileTest functions will not work. Could you check whether the mruby-io gem covers all of the functions mentioned in the RGSS1 documentation? Either we require the gem to be disabled for mkxp, or drop the mkxp code in favor of the gem.

@Ancurio just checked, it does implement everything we want (and much more) for FileTest and nothing for File (so no overlapping symbols). Actually I'm strongly against disabling mruby-io, since being a core mrbgem, this will definitely break something else (mruby-marshal for a start)

@pulsejet Oh I'm sorry, I just finally understood why you renamed the module; my brain must have been lagging. The rename is fine (although I'd like to delete my code as soon as possible), with a comment about why the old classes exist.
I'm still confused about File though; why did you not have to rename that to MKXPFile?

Weirdly, the File class of the mruby-io is completely different, while FileTest is exactly the same, so we need File (though I've not tried removing it). Not really sure about anything here, but one thing I can confirm is that this code works :P

https://github.com/mruby/mruby/blob/b724e06cf25eee4c05dcc0e3a1a65bb608091cc4/mrbgems/mruby-io/src/file.c#L395

https://github.com/mruby/mruby/blob/b724e06cf25eee4c05dcc0e3a1a65bb608091cc4/mrbgems/mruby-io/src/file_test.c#L365

So it's IO::File in mruby while FileTest is defined in the global namespace? That's weird.

binding-mruby/mrb-ext/kernel.cpp

binding-mruby/mrb-ext/marshal.cpp

Ancurio · 2018-04-29T09:36:07Z

binding-mruby/mrb-ext/marshal.cpp

-	if (mrb->arena_idx > maxArena)
-		maxArena = mrb->arena_idx;
+	if (mrb->gc.arena_idx > maxArena)
+		maxArena = mrb->gc.arena_idx;


I don't remember the internals of mruby too well so I'll just trust that this does the right thing :)

Ancurio · 2018-04-29T09:55:50Z

@pulsejet

any reason why the RPG module is defined differently for mruby and MRI? The current mruby module gives me really cryptic errors; just adding the scripts from MRI to my Scripts.rxdata works pretty well. With only minor changes, the game seems to work (sorta), though for some reason no events are being triggered as I interact with them :(

The mruby RPG module is the pre-compiled bytecode version; if there was a way to do this with MRI I would, but atm I can only feed it plain Ruby source code. You should be able to use your up-to-date version of mruby to update the precompiled bytecode.

pulsejet · 2018-04-29T13:23:40Z

binding-mruby/font-binding.cpp

@@ -135,17 +142,21 @@ DEF_KLASS_PROP(Font, mrb_bool, DefaultItalic,  "b", bool)
 DEF_KLASS_PROP(Font, mrb_bool, DefaultOutline, "b", bool)
 DEF_KLASS_PROP(Font, mrb_bool, DefaultShadow,  "b", bool)

-MRB_FUNCTION(FontGetDefaultName)
+MRB_METHOD(FontGetDefaultName)


Needed to change this to MRB_METHOD for self to be defined. Not sure what the change really means...

It's what you said; only a method has an object to operate on (self), functions don't. The FUNCTION macro was to avoid having to (void) the self argument every time in module functions.

pulsejet · 2018-04-29T13:48:28Z

@Ancurio

The mruby RPG module is the pre-compiled bytecode version; if there was a way to do this with MRI I would, but atm I can only feed it plain Ruby source code.

Would there be any realistic advantage of doing this?

Fixed up the requested changes and updated the RPG module. Decided to move the bytecode to a separate xxd file the way the mri bindings do; is there any argument against this?

Ancurio · 2018-05-01T11:39:55Z

Would there be any realistic advantage of doing this?

Maybe it just irks me to parse the same source code every time on startup; but you're right, it might be less of a headache to always just parse source instead having to compile against a possibly changing bytecode-specification (like with mruby); and I believe there might be far heavier tasks going on at startup.

Ideally though, the bytecode compilation would be integrated in mkxp's build process,

Ancurio · 2018-05-01T11:49:45Z

Could you please compile mruby without the io gem and only keep the fixes required to get that running? We can move eventual changes from replacing my custom code with the gem into a separate issue/PR.

pulsejet · 2018-05-05T09:08:43Z

Sorry I didn't see this. Going out of town for now; I'll fix this when I get back. @Ancurio do we also want to make the change to to mruby-marshal? It seems to be much more complete and saving/loading works with minor changes (you can dump/load only once) unlike the current marshal class. One downside is that it depends on onig.

Ancurio · 2018-05-05T09:34:35Z

@pulsejet Wait, my marshal code can only dump / load once? That's not supposed to happen.. I think. The Marshal gem by @take-cheeze is not merged into mruby, is it? I would consider switching to it; the more code being shared, the better, especially if it's more complete.
Do you know the status of regular expressions in mruby? I also remember having quite a few problems with that in the past.

pulsejet · 2018-05-05T10:21:44Z

Noo @take-cheeze's mruby-marshal can load only once in the sense that you can't get variables by doing variable_name = Marshal.load(file) repeatedly, as it will set the entire contents of the file to variable_name and for dump any repeated calls are ignored. That part isn't merged yet. Sorry for the confusion.
For Regex, I'm using mruby-onig-regexp, but I've also tried mruby-regexp-pcre and both seem to work fine, at least as far as I tested.

Ancurio · 2018-05-05T10:54:08Z

I wonder if @take-cheeze 's implementation can be configured for different RegExp implementations. Also on the dumping / loading only working once, that's a different behavior from MRI then, isn't it? I wonder if that is intentional or a bug.

pulsejet · 2018-05-05T11:00:35Z

Might be intentional, not sure. How is the behavior of MRI supposed to be implemented anyway? As for regex, I think using onig might be recommendable anyway, since the PCRE implementation says that you might want to use onig if you want better compatibility with MRI.

pulsejet · 2018-11-25T12:04:59Z

Sorry I completely forgot about this. Removed the IOError2 thing (don't even remember much now) and right now this just works with mruby 1.4.1 compiled with the default gems (which includes io, btw), and the default game seems to run fine (with the exception of save/load, of course). @Ancurio could you please go over this quickly one more time?

Ancurio requested changes Apr 29, 2018

View reviewed changes

pulsejet force-pushed the mrb branch from dffd705 to cb682a3 Compare April 29, 2018 13:15

pulsejet commented Apr 29, 2018

View reviewed changes

pulsejet added 3 commits April 29, 2018 18:56

Fix up build with mruby binding

39ac6ae

Fix segmentation fault while passing data in mruby binding

8b21699

Fix FontGetName and FontGetDefaultName in mruby binding

a996d36

pulsejet force-pushed the mrb branch from cb682a3 to a996d36 Compare April 29, 2018 13:27

Update RPG Module for mruby bindings

b90aa74

Ghabry mentioned this pull request Apr 30, 2018

Compiling with Emscripten #195

Closed

Get rid of IOError2

6fccac8

pulsejet force-pushed the mrb branch from 25cdd4a to 6fccac8 Compare November 25, 2018 12:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix mruby bindings #197

Fix mruby bindings #197

pulsejet commented Apr 28, 2018

carstene1ns commented Apr 28, 2018

pulsejet commented Apr 28, 2018

Ancurio left a comment •

edited

Loading

Ancurio Apr 29, 2018

Ancurio Apr 29, 2018

pulsejet Apr 29, 2018

pulsejet Apr 29, 2018

Ancurio May 5, 2018

pulsejet Nov 25, 2018

Ancurio Apr 29, 2018

Ancurio Apr 29, 2018

Ancurio Apr 29, 2018

pulsejet Apr 29, 2018

Ancurio May 1, 2018

pulsejet May 5, 2018

Ancurio May 5, 2018

pulsejet May 5, 2018

Ancurio May 5, 2018

Ancurio Apr 29, 2018

Ancurio commented Apr 29, 2018

pulsejet Apr 29, 2018 •

edited

Loading

Ancurio May 1, 2018

pulsejet commented Apr 29, 2018

Ancurio commented May 1, 2018

Ancurio commented May 1, 2018

pulsejet commented May 5, 2018 •

edited

Loading

Ancurio commented May 5, 2018

pulsejet commented May 5, 2018

Ancurio commented May 5, 2018 •

edited

Loading

pulsejet commented May 5, 2018

pulsejet commented Nov 25, 2018

Fix mruby bindings #197

Are you sure you want to change the base?

Fix mruby bindings #197

Conversation

pulsejet commented Apr 28, 2018

carstene1ns commented Apr 28, 2018

pulsejet commented Apr 28, 2018

Ancurio left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Ancurio commented Apr 29, 2018

pulsejet Apr 29, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pulsejet commented Apr 29, 2018

Ancurio commented May 1, 2018

Ancurio commented May 1, 2018

pulsejet commented May 5, 2018 • edited Loading

Ancurio commented May 5, 2018

pulsejet commented May 5, 2018

Ancurio commented May 5, 2018 • edited Loading

pulsejet commented May 5, 2018

pulsejet commented Nov 25, 2018

Ancurio left a comment •

edited

Loading

pulsejet Apr 29, 2018 •

edited

Loading

pulsejet commented May 5, 2018 •

edited

Loading

Ancurio commented May 5, 2018 •

edited

Loading