Function metadata call

[wdanilo]

This task is automatically imported from the old Task Issue Board and it was originally created by James Dunkerley.
Original issue is here.

---

It would be useful to be able to acquire the metadata about a function's parameters.

Ideally would like to be able to get:

• list of the parameter names.
• the type of the argument.
• if the parameter has a default.

This would help us answer the metadata for widget.
Could also use to provide a visualization for a function without all the defaults.

[JaroslavTulach]

First of all we should polish content of Meta.enso by creating Meta_Helpers.enso and moving all builtins there: #12031

[farmaazon]

I wonder if this task is still needed (it's very old) - the current implementation rely on Suggestion Database and seems working enough. @Frizi can you confirm?

[enso-bot]

Jaroslav Tulach reports a new STANDUP for yesterday (2025-01-13):

Progress: .

• cleaning up Meta: https://github.com/enso-org/enso/pull/12031/files#r1912749147
• type private tweaks: 4ef7d8b
• Base_Tests compile: b4f4483
• standups It should be finished by 2025-01-21.

GitHub

Moving @Builtin_Method definitions outside of Meta by JaroslavTulach · Pull Request #12031 · enso-org/enso

Pull Request Description Let's reduce the amount of code inside of Meta.enso in preparation of #5226. Important Notes Turning Meta.is_a from a builtin into regular method had its issues - solve...

[JaroslavTulach]

Very important issue related to Meta.meta is the meta representation of no argument constructors. The following program:

from Standard.Base import all

type X
    W
    V a b c


main =
    run
    
run =
    w = X.W...
    w1 = X.W
    ac = Meta.is_atom_constructor w...
    at = Meta.is_atom w ...

    [ac, at, Meta.meta w, Meta.meta w1]

shall print [True, True, (Constructor.Value W), (Atom.Value W)]. It does, with following patch:

diff --git distribution/lib/Standard/Base/0.0.0-dev/src/Meta.enso distribution/lib/Standard/Base/0.0.0-dev/src/Meta.enso
index 79f6c30639..834ad909ee 100644
--- distribution/lib/Standard/Base/0.0.0-dev/src/Meta.enso
+++ distribution/lib/Standard/Base/0.0.0-dev/src/Meta.enso
@@ -299,13 +299,14 @@ atom_with_hole factory = @Tail_Call Meta_Helpers.atom_with_hole_builtin factory
    Arguments:
    - value: The runtime entity to get the meta representation of.
 meta : Any -> Atom | Constructor | Primitive | Polyglot | Unresolved_Symbol | Error
-meta value = if Meta_Helpers.is_atom_builtin value then Atom.Value value else
-    if Meta_Helpers.is_atom_constructor_builtin value then Constructor.Value value else
-        if Meta_Helpers.is_polyglot_builtin value then Polyglot.Value value else
-            if Meta_Helpers.is_unresolved_symbol_builtin value then Unresolved_Symbol.Value value else
-                if Meta_Helpers.is_error_builtin value then Error.Value value.catch else
-                    if Meta_Helpers.is_type_builtin value then Type.Value value.catch else
-                        Primitive.Value value
+meta ~value = 
+    if Meta_Helpers.is_atom_constructor_builtin value... then Constructor.Value value... else
+        if Meta_Helpers.is_atom_builtin value... then Atom.Value value else
+            if Meta_Helpers.is_polyglot_builtin value then Polyglot.Value value else
+                if Meta_Helpers.is_unresolved_symbol_builtin value then Unresolved_Symbol.Value value else
+                    if Meta_Helpers.is_error_builtin value then Error.Value value.catch else
+                        if Meta_Helpers.is_type_builtin value then Type.Value value.catch else
+                            Primitive.Value value
 
 ## PRIVATE
    ADVANCED
@@ -379,7 +380,7 @@ type Language
    Arguments:
    - value: The value to check.
 is_atom_constructor : Any -> Boolean
-is_atom_constructor value = @Tail_Call Meta_Helpers.is_atom_constructor_builtin value
+is_atom_constructor ~value = @Tail_Call Meta_Helpers.is_atom_constructor_builtin value
 
 ## PRIVATE
 
diff --git engine/runtime/src/main/java/org/enso/interpreter/node/expression/builtin/meta/IsAtomConstructorNode.java engine/runtime/src/main/java/org/enso/interpreter/node/expression/builtin/meta/IsAtomConstructorNode.java
index 46abd9e29f..c930b91660 100644
--- engine/runtime/src/main/java/org/enso/interpreter/node/expression/builtin/meta/IsAtomConstructorNode.java
+++ engine/runtime/src/main/java/org/enso/interpreter/node/expression/builtin/meta/IsAtomConstructorNode.java
@@ -3,6 +3,10 @@ package org.enso.interpreter.node.expression.builtin.meta;
 import com.oracle.truffle.api.nodes.Node;
 import org.enso.interpreter.dsl.AcceptsError;
 import org.enso.interpreter.dsl.BuiltinMethod;
+import org.enso.interpreter.dsl.Suspend;
+import org.enso.interpreter.node.MethodRootNode;
+import org.enso.interpreter.runtime.callable.function.Function;
+import org.enso.interpreter.runtime.data.atom.AtomConstructor;
 import org.enso.interpreter.runtime.type.TypesGen;
 
 @BuiltinMethod(
@@ -11,7 +15,18 @@ import org.enso.interpreter.runtime.type.TypesGen;
     description = "Checks if the argument is a constructor.",
     autoRegister = false)
 public class IsAtomConstructorNode extends Node {
-  boolean execute(@AcceptsError Object value) {
-    return TypesGen.isAtomConstructor(value);
+  boolean execute(@Suspend @AcceptsError Object value) {
+    if (TypesGen.isAtomConstructor(value)) {
+      return true;
+    }
+    if (value instanceof Function fn) {
+      if (AtomConstructor.accessorFor(fn) != null) {
+        return true;
+      }
+      if (MethodRootNode.constructorFor(fn) != null) {
+        return true;
+      }
+    }
+    return false;
   }
 }
diff --git engine/runtime/src/main/java/org/enso/interpreter/runtime/data/atom/QualifiedAccessorNode.java engine/runtime/src/main/java/org/enso/interpreter/runtime/data/atom/QualifiedAccessorNode.java
index 2be3a62f49..8844ff5a34 100644
--- engine/runtime/src/main/java/org/enso/interpreter/runtime/data/atom/QualifiedAccessorNode.java
+++ engine/runtime/src/main/java/org/enso/interpreter/runtime/data/atom/QualifiedAccessorNode.java
@@ -54,7 +54,7 @@ final class QualifiedAccessorNode extends EnsoRootNode {
       } else if (atomConstructor == falseCtor) {
         return false;
       } else {
-        return atomConstructor.newInstance();
+        return atomConstructor.getConstructorFunction();
       }
     } else {
       return atomConstructor;

time to productize that code!

[enso-bot]

Jaroslav Tulach reports a new STANDUP for yesterday (2025-01-14):

Progress: .

• PR for dispatch on modules merged: Prefer module methods over Any instance ones #12048
• Quick Fix Import PR: Quick Fix Import button #12051
• created PR for types without constructors: Types with private constructors can be public #12052
• types.md docs update: Marking docs/types/types.md as (mostly) outdated #12049
• review ENSO_LAUNCHER: Introduce ENSO_LAUNCHER env var to configure behavior of buildEngineDistribution #12035 (review)
• fighting with Meta.Constructor: Function metadata call #5226 (comment)
• planning meeting It should be finished by 2025-01-21.

[enso-bot]

Jaroslav Tulach reports a new STANDUP for yesterday (2025-01-15):

Progress: .

• merged closed types PR: Types with private constructors can be public #12052
• Meta.meta T.A... works: d426ab3
• implementing API check of Meta.enso via --docs: Infrastructure for enso --docs option & signature generator #10291 (comment)
• private types discussion: Types with private constructors can be public #12052 (comment)
• revive docs PR: https://github.co m/Automatic check of API backward compatibility #10507#issuecomment-2591766018
• VisJS review: IRDumper uses VisJS instead of GraphViz #12056 (review)
• meetings & standups It should be finished by 2025-01-21.

GitHub

GitHub · Build and ship software on a single, collaborative platform

Join the world's most widely adopted, AI-powered developer platform where millions of developers, businesses, and the largest open source community build software that advances humanity.

[enso-bot]

Jaroslav Tulach reports a new STANDUP for yesterday (2025-01-16):

Progress: .

• --docs=api PR ready for review: Infrastructure for enso --docs option & signature generator #10291
• documentation PR merged: Marking docs/types/types.md as (mostly) outdated #12049
• discussing Radek's presentation: https://discord.com/channels/@me/964018046375190528/1329456342146224218 It should be finished by 2025-01-21.

Discord

Discord - Group Chat That’s All Fun & Games

Discord is great for playing games and chilling with friends, or even building a worldwide community. Customize your own space to talk, play, and hang out.