Reducing helper methods in Standard.Base.Meta

CHANGELOG.md

@@ -20,8 +20,10 @@
 
 - [Allow using `/` to access files inside a directory reached through a data
   link.][11926]
+- [Reducing helper methods in `Standard.Base.Meta`.][12031]
 
 [11926]: https://github.com/enso-org/enso/pull/11926
+[12031]: https://github.com/enso-org/enso/pull/12031
 
 #### Enso Language & Runtime
 

distribution/lib/Standard/Base/0.0.0-dev/src/Internal/Instrumentor.enso

@@ -0,0 +1,92 @@
+private
+
+import project.Any.Any
+import project.Data.Text.Text
+import project.Function.Function
+import project.Meta
+import project.Internal.Meta_Helpers
+import project.Data.Vector.Vector
+import project.Nothing.Nothing
+import project.Runtime.Managed_Resource.Managed_Resource
+
+## PRIVATE
+   ADVANCED
+
+   Builder to create instrumentation for a function
+type Instrumentor
+    private Value impl
+
+    ## PRIVATE
+       ADVANCED
+
+       Registers callback to be executed at the begining of node/expression
+       execution. The callback `fn` gets UUID of the node/expression that is
+       being executed and can return `Nothing` to continue regular execution
+       or anything else to skip the execution and just return given value.
+
+       Arguments:
+       - fn: The callback function accepting UUID.
+    on_enter self (fn : Text -> Any | Nothing) =
+        new = Meta_Helpers.instrumentor_builtin "onEnter" [ self.impl, fn ]
+        Instrumentor.Value new
+
+    ## PRIVATE
+       ADVANCED
+
+       Registers callback to be executed when a node/expression evaluation
+       is over. The callback `fn` gets UUID and the computed value (or value
+       of `expression` if specified). Usually
+       the value is _cached_ and returned from `on_enter` callback next time
+       the same expression is evaluated.
+
+       > Example
+         Specify `expression` to _"inline evaluate"_ it.
+            see_a_b uuid:Text ~result =
+              if uuid == "expected-uuid" then
+                IO.println "evalutated to "+result.to_text
+
+            Meta.meta .fn . instrument . on_return fn=see_a_b expression="a+b" . activate
+
+       Arguments:
+       - fn: The callback function accepting UUID and computed value
+       - expression: Expression to evaluate on_return - by default Nothing -
+         e.g. to provide the return value of the function
+    on_return self (fn : Text -> Any -> Nothing) expression:(Text | Nothing)=Nothing =
+        new = Meta_Helpers.instrumentor_builtin "onReturn" [ self.impl, fn, expression ]
+        Instrumentor.Value new
+
+    ## PRIVATE
+       ADVANCED
+
+       Registers callback to be executed when a node/expression representing function is about to be called.
+       The callback `fn` shall accept three arguments. The UUID to identify the expression, the function to be
+       invoked and the arguments to pass to the function. The callback can return `Nothing`
+       (in such case the function gets executed with provided arguments) or some other value,
+       which is then returned instead of calling the function.
+
+       Arguments:
+       - fn: The callback function accepting UUID and function value
+    on_call self (fn : Text -> Function -> Vector Any -> Any | Nothing) =
+        new = Meta_Helpers.instrumentor_builtin "onCall" [ self.impl, fn ]
+        Instrumentor.Value new
+
+    ## PRIVATE
+       ADVANCED
+
+       Activates configured instrumentor. Returns managed resource to
+       deactivate the instrumentor later.
+
+       Arguments:
+       - value: The value of the atom in the meta representation.
+    activate self =
+        finalize_instrumentor impl = Meta_Helpers.instrumentor_builtin "deactivate" [ impl ]
+        create action = (Meta_Helpers.instrumentor_builtin action [ self.impl, finalize_instrumentor ]) : Managed_Resource
+        create "activate"
+
+
+    ## ADVANCED
+       GROUP Metadata
+       ICON metadata
+
+       Starts building an instrumentation for a given node
+Meta.Unresolved_Symbol.instrument self -> Instrumentor = Instrumentor.Value (Meta_Helpers.instrumentor_builtin "newBuilder" [ self.impl ])

distribution/lib/Standard/Base/0.0.0-dev/src/Internal/Meta_Helpers.enso

@@ -0,0 +1,25 @@
+private
+
+get_atom_constructor_builtin atom = @Builtin_Method "Meta.get_atom_constructor"
+get_atom_fields_builtin atom = @Builtin_Method "Meta.get_atom_fields"
+get_type_constructors_builtin typ factory = @Builtin_Method "Meta.get_type_constructors"
+get_type_methods_builtin typ = @Builtin_Method "Meta.get_type_methods"
+get_polyglot_language_builtin value = @Builtin_Method "Meta.get_polyglot_language"
+create_unresolved_symbol_builtin name symbol = @Builtin_Method "Meta.create_unresolved_symbol"
+get_unresolved_symbol_name_builtin symbol = @Builtin_Method "Meta.get_unresolved_symbol_name"
+get_constructor_fields_builtin atom_constructor = @Builtin_Method "Meta.get_constructor_fields"
+get_constructor_name_builtin atom_constructor = @Builtin_Method "Meta.get_constructor_name"
+new_atom_builtin constructor fields = @Builtin_Method "Meta.new_atom"
+atom_with_hole_builtin factory = @Builtin_Method "Meta.atom_with_hole_builtin"
+is_same_object_builtin value_1 value_2 = @Builtin_Method "Meta.is_same_object"
+is_a_builtin value typ = @Builtin_Method "Meta.is_a"
+type_of_builtin value = @Builtin_Method "Meta.type_of"
+get_annotation_builtin target method parameter_name = @Builtin_Method "Meta.get_annotation"
+find_atom_constructor_builtin value = @Builtin_Method "Meta.find_atom_constructor"
+get_kind_builtin value = @Builtin_Method "Meta.get_kind_builtin"
+get_simple_type_name_builtin value = @Builtin_Method "Meta.get_simple_type_name"
+get_qualified_type_name_builtin value = @Builtin_Method "Meta.get_qualified_type_name"
+get_short_type_name_builtin typ = @Builtin_Method "Meta.get_short_type_name"
+get_constructor_declaring_type_builtin constructor = @Builtin_Method "Meta.get_constructor_declaring_type"
+instrumentor_builtin op args = @Builtin_Method "Meta.instrumentor_builtin"
+find_type_by_qualified_name_builtin fqn = @Builtin_Method "Meta.find_type_by_qualified_name"