[GR-45043] Prototype to use YARP - Yet Another Ruby Parser

PullRequest: truffleruby/3531

Author: eregon

doc/contributor/yarp.md

@@ -0,0 +1,16 @@
+# YARP
+
+## Update YARP
+
+* Clone `yarp` as a sibling of `truffleruby-ws`.
+* Run `tool/import-yarp.sh` in the truffleruby repo.
+* Commit the result with message `Import Shopify/yarp@COMMIT`
+
+## Print Detailed YARP AST
+
+```bash
+cd yarp
+chruby 3.2.
+bundle exec rake
+bundle exec ruby -Ilib -ryarp -e 'pp YARP.parse("1&.itself")'
+```

mx.truffleruby/mx_truffleruby.py

@@ -243,9 +243,11 @@ def verify_ci(args):
         'TruffleRuby license files': ('', []),
     },
     truffle_jars=[
+        # Distributions
         'truffleruby:TRUFFLERUBY',
         'truffleruby:TRUFFLERUBY-SHARED',
         'truffleruby:TRUFFLERUBY-ANNOTATIONS',
+        # Libraries
         'sdk:JLINE3',
         'truffleruby:JCODINGS',
         'truffleruby:JONI',

mx.truffleruby/suite.py

@@ -124,14 +124,23 @@
 
         # ------------- Projects -------------
 
+        "org.yarp": {
+            "dir": "src/yarp",
+            "sourceDirs": ["java"],
+            "jniHeaders": True,
+            "jacoco": "include",
+            "javaCompliance": "17+",
+            "workingSets": "TruffleRuby",
+            "license": ["MIT"],
+        },
+
         "org.truffleruby.annotations": {
             "dir": "src/annotations",
             "sourceDirs": ["java"],
             "jacoco": "include",
             "javaCompliance": "17+",
             "checkstyle": "org.truffleruby",
             "workingSets": "TruffleRuby",
-            "checkPackagePrefix": "false",
             "license": ["EPL-2.0"],
         },
 
@@ -194,6 +203,19 @@
             "ldflags": ["-pthread"],
         },
 
+        "org.yarp.libyarp": {
+            "dir": "src/main/c/yarp",
+            "native": "shared_lib",
+            "deliverable": "yarp",
+            "buildDependencies": [
+                "org.yarp", # for the generated JNI header file
+            ],
+            "use_jdk_headers": True, # the generated JNI header includes jni.h
+            "cflags": ["-g", "-Wall", "-Werror", "-pthread"],
+            "ldflags": ["-pthread"],
+            "description": "YARP + JNI bindings as a single lib"
+        },
+
         "org.truffleruby": {
             "dir": "src/main",
             "sourceDirs": ["java"],
@@ -204,15 +226,17 @@
                 "jdk.management",
                 "jdk.unsupported", # sun.misc.Signal
             ],
-            "dependencies": [ # Keep in sync with TRUFFLERUBY distDependencies and exclude
-                # Distributions
+            "dependencies": [
+                # Projects
+                "org.yarp",
+                # Distributions, keep in sync with TRUFFLERUBY.distDependencies
                 "truffleruby:TRUFFLERUBY-ANNOTATIONS",
                 "truffleruby:TRUFFLERUBY-SHARED",
                 "truffle:TRUFFLE_API",
                 "truffle:TRUFFLE_NFI",
                 "regex:TREGEX",
                 "sulong:SULONG_API",
-                # Libraries
+                # Libraries, keep in sync with TRUFFLERUBY.exclude and truffle_jars (in mx_truffleruby.py)
                 "sdk:JLINE3",
                 "truffleruby:JCODINGS",
                 "truffleruby:JONI",
@@ -230,7 +254,7 @@
                 "EPL-2.0",          # JRuby (we're choosing EPL out of EPL,GPL,LGPL)
                 "BSD-new",          # Rubinius
                 "BSD-simplified",   # MRI
-                "MIT",              # Joni, JCodings
+                "MIT",              # Joni, JCodings, YARP
             ],
         },
 
@@ -274,11 +298,13 @@
             "sourceDirs": ["java", "ruby"],
             "requires": ["java.scripting", "java.management", "jdk.management"],
             "dependencies": [
-                "org.truffleruby",
-                "org.truffleruby.services",
+                # Distributions
+                "sdk:LAUNCHER_COMMON",
+                "TRUFFLERUBY",
+                "TRUFFLERUBY-SERVICES",
+                # Libraries
                 "mx:JUNIT",
                 "truffleruby:NETBEANS-LIB-PROFILER",
-                "sdk:LAUNCHER_COMMON"
             ],
             "javaCompliance": "17+",
             "checkstyle": "org.truffleruby",
@@ -456,6 +482,7 @@
                     "file:lib/mri",
                     "file:lib/patches",
                     "file:lib/truffle",
+                    "dependency:org.yarp.libyarp",
                 ],
                 "lib/cext/": [
                     "file:lib/cext/*.rb",
@@ -560,16 +587,15 @@
             "dependencies": [
                 "org.truffleruby.test",
             ],
-            "exclude": [
-                "mx:HAMCREST",
-                "mx:JUNIT",
-                "truffleruby:NETBEANS-LIB-PROFILER",
-            ],
             "distDependencies": [
                 "sdk:LAUNCHER_COMMON",
                 "TRUFFLERUBY",
                 "TRUFFLERUBY-SERVICES",
-                "TRUFFLERUBY_GRAALVM_SUPPORT",
+            ],
+            "exclude": [
+                "mx:HAMCREST",
+                "mx:JUNIT",
+                "truffleruby:NETBEANS-LIB-PROFILER",
             ],
             "javaProperties": {
                 "org.graalvm.language.ruby.home": "<path:TRUFFLERUBY_GRAALVM_SUPPORT>"