Ruby scripting support #1726

remi6397 · 2021-12-08T19:23:43Z

Replaces #1006

This PR adds support for the Ruby programming language, or to be precise a lightweight implementation of Ruby called MRuby.

Resources

MRuby API documentation

pre-0.90 Description

This PR adds basic support for [Ruby](https://www.ruby-lang.org) scripting via [MRuby](https://mruby.org/).

I thought it'd be nice to have Ruby as an option for scripting, because it's widely used in WebDev (Rails, Sinatra, etc.), DevOps (Puppet, Chef, Vagrant), ITSec (Logstash, Metasploit) and probably in many more applications beyond my field of expertise (SketchUp being the first one to come to my mind).

If you decided to merge, Ruby would make the second most popular language of those available in TIC (right after JavaScript).

I've already tested this on Windows (10, x64) and Linux (openSUSE Tumbleweed) and it compiles without any problems. There are still ~~macOS~~, Emscripten and Android left to test, but: ~~1) I'd have to install XCode my Mac;~~ 2) I don't know how to x-compile for Emscripten; 3) I don't own any Android device.

Apart from that, everything seems to work flawlessly. 😉

EDIT: Ran build on my Mac, it works there too.

* Mention Ruby in features * Attribution

Current behavior assumes that comments comprise exactly two characters, such as "--" or "//". Many languages, such as Ruby and Python, use a single character, such as the pound sign or the ASCII quotation mark to signal a single-line comment.

Github Actions seems to also prefer the UNIX-native prefix on Windows CMake

Created a gembox containing only useful gems

This reverts commit 1a8bf83. It turns out that wrapping CMake's poor cross build support was not a good idea after all.

CMake's env helper is broken on Windows OS :/

* Genericize cross compilation * Clean mruby build artifacts with make/ninja clean

joshgoebel · 2021-12-08T19:35:55Z

CMakeLists.txt

        ${TIC80CORE_DIR}/api/lua.c 
        ${TIC80CORE_DIR}/api/moonscript.c 
        ${TIC80CORE_DIR}/api/fennel.c 
        ${TIC80CORE_DIR}/api/wren.c 
        ${TIC80CORE_DIR}/api/squirrel.c
+        ${TIC80CORE_DIR}/api/mrb.c


Could we name this mruby since that seems to be the name used everywhere else?

joshgoebel · 2021-12-08T19:37:23Z

README.md

@@ -18,6 +18,7 @@ To make a retro styled game, the whole process of creation and execution takes p
 - Multiple programming languages: [Lua](https://www.lua.org),
  [Moonscript](https://moonscript.org),
  [Javascript](https://developer.mozilla.org/en-US/docs/Web/JavaScript),
+  [Ruby](https://www.ruby-lang.org/en/),


I think this should be https://mruby.org

MRuby and Ruby are NOT quite the same project. It's certainly possible to embed Ruby also, but since we're not doing that we should be clear that we're using MRuby, at the very least the link here should point to MRuby I'd think.

Yes, I've been thinking of that too, there is some source-level incompatibility between the two, but at the same time we shouldn't create any more confusion to the end users.

IMO it's something worth mentioning in the documentation.

we shouldn't create any more confusion to the end users.

I think [Ruby](https://mruby.org) would solve the issue, no?

I think Ruby would solve the issue, no?

Ruby is the language, MRuby is just one of the available implementations.

Just like with Javascript (or should I say ECMAscript); duktape isn't perfectly compliant either:

[Javascript](https://developer.mozilla.org/en-US/docs/Web/JavaScript),

src/studio/demos.c

joshgoebel · 2021-12-08T19:40:06Z

This is MUCH cleaner PR. :) Nice!

ref. https://cmake.org/cmake/help/latest/variable/CMAKE_ANDROID_API.html

nesbox · 2021-12-10T16:21:11Z

@remi6397 I see N3DS is fixed, how did you do it?

remi6397 · 2021-12-10T16:23:49Z

@remi6397 I see N3DS is fixed, how did you do it?

That's because I got rid of IO-related gems, I think.

This reverts commit 6164e0b.

More consistent with the rest of the project tree

nesbox · 2021-12-10T16:39:41Z

Please try to add $(TIC80LIB)/libmruby.a \
here https://github.com/remi6397/TIC-80/blob/master/build/baremetalpi/Makefile#L23

LIBS :=  \
	$(TIC80LIB)/libtic80studio.a \
	$(TIC80LIB)/libtic80core.a \
	$(TIC80LIB)/libgiflib.a \
	$(TIC80LIB)/liblpeg.a \
 	$(TIC80LIB)/liblua.a \
	$(TIC80LIB)/libzip.a \
	$(TIC80LIB)/libblipbuf.a \
	$(TIC80LIB)/libsquirrel.a \
	$(TIC80LIB)/libwren.a \
	$(TIC80LIB)/libargparse.a \
	$(TIC80LIB)/libwave_writer.a \
	$(TIC80LIB)/libduktape.a \
	$(TIC80LIB)/libzlib.a \
	$(TIC80LIB)/libpng.a \
	$(NEWLIBDIR)/lib/libc.a \
        $(NEWLIBDIR)/lib/libcirclenewlib.a \
	$(CIRCLEHOME)/addon/vc4/sound/libvchiqsound.a \
        $(CIRCLEHOME)/addon/vc4/vchiq/libvchiq.a \
        $(CIRCLEHOME)/addon/linux/liblinuxemu.a \
 	$(CIRCLEHOME)/addon/SDCard/libsdcard.a \
 	$(CIRCLEHOME)/addon/fatfs/libfatfs.a \
  	$(CIRCLEHOME)/lib/usb/libusb.a \
 	$(CIRCLEHOME)/lib/input/libinput.a \
 	$(CIRCLEHOME)/lib/fs/fat/libfatfs.a \
 	$(CIRCLEHOME)/lib/fs/libfs.a \
  	$(CIRCLEHOME)/lib/net/libnet.a \
  	$(CIRCLEHOME)/lib/sched/libsched.a \
  	$(CIRCLEHOME)/lib/libcircle.a \
	$(NEWLIBDIR)/lib/libm.a

This will possibly fix the rpi-baremetal build.

nesbox · 2021-12-10T16:57:32Z

Left to win Android

This reverts commit 375ca37.

RobLoach · 2021-12-10T20:54:37Z

Would love to keep backwards compatibility when Rake isn't available. Here's a Pull Request that disables mruby if Rake isn't there: remi6397#6

remi6397 · 2021-12-11T14:30:40Z

And Bob's your uncle, everything builds successfully now! 🎉

nesbox · 2021-12-11T17:06:21Z

Awesome, so we're ready to merge :)
Thanks for your persistence and for not abandoning the PR 👍

nesbox

Thank you, the job well done 👍

nesbox · 2021-12-11T17:11:19Z

.github/workflows/build.yml

+        for ARCH in arm arm64 x86 x86_64; do \
+          API=24; \
+          SYSROOT=$ANDROID_NDK_HOME/platforms/android-$API/arch-$ARCH; \
+          python3 "$ANDROID_NDK_HOME/build/tools/make_standalone_toolchain.py" \


I'm going to move this part to the Docker initialization part after merging the PR

nesbox · 2021-12-11T17:13:15Z

.github/workflows/build.yml

@@ -588,7 +678,7 @@ jobs:
    runs-on: ubuntu-latest
    strategy:
      matrix:
-        script: [lua, moon, fennel, js, wren, squirrel]
+        script: [lua, moon, fennel, mruby, js, wren, squirrel]


We have to rename it to ruby here or the export ruby %name% command won't work.

Or, we can use export mruby as a variant.
Any thoughts?

nesbox · 2021-12-11T17:20:17Z

src/api/mruby.c

+            mrb_funcall(mrb, mrb_top_self(mrb), TicFunc, 0);
+            catcherr(machine);
+
+            if (mrb_respond_to(mrb, mrb_top_self(mrb), mrb_intern_cstr(mrb, OvrFunc)))


We don't need to call OVR() here for new languages, it's for compatibility, so we can remove this callback here.

Jeremiasz Nelz added 24 commits December 4, 2021 11:05

Register submodule for mruby

4e9042e

Link binaries against static mruby

0410bab

Adapt old mrb_api.c code to current internal API-s

429ccd5

Create Ruby demos

fab63db

Mention Ruby support in README.md

40e5ba1

* Mention Ruby in features * Attribution

Fix broken demos

b2452c6

Add mruby WASM target

b449feb

Fix compatibility with old CMake versions

a83b5f7

Fix segfault when opening outline

a039f09

Actions: Install Ruby where not present

206f832

Honor Windows MRuby static exts

7afc231

Build mruby with /MT on Windows

415a6f3

Force mruby to use .a suffix for static libraries

9c3ae71

Github Actions seems to also prefer the UNIX-native prefix on Windows CMake

Do not build redundant mrbgems

2e96ab6

Created a gembox containing only useful gems

Infer mruby CFLAGS from CMake

7ff8827

Pass CMake flags to MRuby cross target

1a8bf83

Revert "Pass CMake flags to MRuby cross target"

a883fc9

This reverts commit 1a8bf83. It turns out that wrapping CMake's poor cross build support was not a good idea after all.

Refactor mruby build configuration sets

d6a7fde

mruby toolchain switching from CMake

fdd3ef9

Guess CMAKE_COMMAND on Windows OS

5b2cd1d

[mruby] Delegate ENV passing to rake invocation

5423701

CMake's env helper is broken on Windows OS :/

Enforce certain mruby toolchains from CMake side

bc190da

Simplify mruby build system

cf97eb4

* Genericize cross compilation * Clean mruby build artifacts with make/ninja clean

remi6397 mentioned this pull request Dec 8, 2021

Ruby scripting support #1006

Closed

Force mruby bootstrap to use MSVC where applicable

10d6a95

joshgoebel reviewed Dec 8, 2021

View reviewed changes

src/studio/demos.c Outdated Show resolved Hide resolved

Use CMake-native target version inference

6164e0b

ref. https://cmake.org/cmake/help/latest/variable/CMAKE_ANDROID_API.html

Jeremiasz Nelz added 5 commits December 10, 2021 17:25

Do not link mruby against winsock on WinNT

8cba92c

Add mruby target to stub export action

141f1a3

Revert "Use CMake-native target version inference"

b8a3a43

This reverts commit 6164e0b.

Explicitly set ANDROID_API from gradle

b0e6043

Move: /mruby/ -> /build/mruby/

9aeef12

More consistent with the rest of the project tree

baremetalpi: Link against libmruby

8f3e6b1

Jeremiasz Nelz added 3 commits December 10, 2021 18:39

Prepare standalone NDK toolchains in Actions

ec23e04

Link sysroot in standalone NDK

fa05a14

Patch mruby with modern NDK support

b15328b

remi6397 force-pushed the feature/mruby branch from e96224c to 2189e34 Compare December 10, 2021 19:53

Actions: Provision Git to allow "am" patching

375ca37

remi6397 force-pushed the feature/mruby branch from 2189e34 to 375ca37 Compare December 10, 2021 19:54

Jeremiasz Nelz added 2 commits December 10, 2021 21:40

Revert "Actions: Provision Git to allow "am" patching"

a0a15cf

This reverts commit 375ca37.

Patch mruby during the configuration step

a47c803

Jeremiasz Nelz added 3 commits December 10, 2021 23:49

Github Actions: Recreate standalone NDK toolchains

40b4951

Fix mruby build on Android

355a9aa

Update build instructions

47f42d1

nesbox approved these changes Dec 11, 2021

View reviewed changes

nesbox merged commit c656bdf into nesbox:master Dec 11, 2021

nesbox assigned remi6397 Dec 11, 2021

remi6397 mentioned this pull request Dec 11, 2021

Small changes to the Ruby bindings #1733

Merged

nesbox added a commit that referenced this pull request Dec 12, 2021

some Ruby build fixes #1726

f56def3

Uh oh!

Ruby scripting support #1726

Ruby scripting support #1726

Uh oh!

Conversation

remi6397 commented Dec 8, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Resources

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joshgoebel Dec 8, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

joshgoebel commented Dec 8, 2021

Uh oh!

nesbox commented Dec 10, 2021

Uh oh!

remi6397 commented Dec 10, 2021

Uh oh!

nesbox commented Dec 10, 2021

Uh oh!

nesbox commented Dec 10, 2021

Uh oh!

RobLoach commented Dec 10, 2021

Uh oh!

remi6397 commented Dec 11, 2021

Uh oh!

nesbox commented Dec 11, 2021

Uh oh!

nesbox left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

remi6397 commented Dec 8, 2021 •

edited

Loading

joshgoebel Dec 8, 2021 •

edited

Loading