, arg:&JsValue)
@@ -231,7 +238,7 @@ impl Instance {
let frp = visualization::instance::Frp::new(&network);
let model = InstanceModel::from_class(class,scene)?;
model.set_dom_layer(&scene.dom.layers.back);
- Ok(Instance{model,frp,network}.init_frp(&scene).inti_preprocessor_change_callback())
+ Ok(Instance{model,frp,network}.init_frp(&scene).init_preprocessor_change_callback())
}
fn init_frp(self, scene:&Scene) -> Self {
@@ -250,12 +257,20 @@ impl Instance {
self
}
- fn inti_preprocessor_change_callback(self) -> Self {
+ fn init_preprocessor_change_callback(self) -> Self {
// FIXME Does it leak memory? To be checked.
- let change = &self.frp.preprocessor_change;
- let callback = f!((s:String) change.emit(&s.into()));
+ let change = self.frp.preprocessor_change.clone_ref();
+ let callback = move |preprocessor_config| {
+ change.emit(preprocessor_config)
+ };
let callback = Box::new(callback);
self.model.preprocessor_change.borrow_mut().replace(callback);
+ if let Err(js_error) = self.model.update_preprocessor() {
+ use enso_frp::web::js_to_string;
+ let logger = self.model.logger.clone();
+ error!(logger,"Failed to trigger initial preprocessor update from JS: \
+ {js_to_string(js_error)}");
+ }
self
}
diff --git a/ide/src/rust/ide/view/graph-editor/src/component/visualization/foreign/java_script/visualization.js b/ide/src/rust/ide/view/graph-editor/src/component/visualization/foreign/java_script/visualization.js
index 009408b66ad1..e64cd77f369e 100644
--- a/ide/src/rust/ide/view/graph-editor/src/component/visualization/foreign/java_script/visualization.js
+++ b/ide/src/rust/ide/view/graph-editor/src/component/visualization/foreign/java_script/visualization.js
@@ -1,10 +1,130 @@
export class Visualization {
+ /**
+ * Class constructor.
+ *
+ * The argument is IDE's implementation detail.
+ *
+ * When subclassing and using custom constructor, the argument must be passed
+ * to this constructor and visualization implementation is not allowed to
+ * perform any other operation on it.
+ *
+ * @param api an internal IDE structure. Should be passed intact by a subclass
+ * constructor (if present).
+ */
constructor(api) {
+ // These go before `api` assignment so the `undefined` is not emitted to IDE.
+ // First we will give deriving type a chance to overwrite them, then IDE will
+ // invoke `__emitPreprocessorChange__()` on this.
+ this.__preprocessorCode__ = null
+ this.__preprocessorModule__ = null
+
this.dom = api.root()
this.__api__ = api
}
- setPreprocessor(code) {
- this.__api__.emit_preprocessor_change(code)
+
+ /**
+ * Notify IDE that preprocessor settings have changed.
+ * @private
+ */
+ __emitPreprocessorChange__() {
+ this.__api__.emit_preprocessor_change(
+ this.__preprocessorCode__,
+ this.__preprocessorModule__
+ )
+ }
+
+ /**
+ * Get the current preprocessor code. See {@link setPreprocessorCode} for
+ * more information about purpose of setting preprocessor code.
+ *
+ * @returns {string} Preprocessor code or `null` if no code was set.
+ */
+ getPreprocessorCode() {
+ return this.__preprocessorCode__
+ }
+
+ /**
+ * Set new preprocessor code.
+ *
+ * When visualization is attached to a node, each time a new value is produced from node,
+ * the preprocessor shall be invoked with it. Result such call shall be serialized and
+ * transported to visualization by invoking onDataReceived(data) method.
+ *
+ * Typically the preprocessor is a lambda, like the example below:
+ *
+ * `x -> x.to_default_visualization_data`
+ *
+ *
+ * The code by default runs in the context of the current project's `Main` module.
+ * If other context is needed (e.g. due to required import or other module-specific
+ * context dependency), the {@link setPreprocessorModule} should be used to provide
+ * the module's name.
+ *
+ * Please refer to [documentation]{@link https://dev.enso.org/docs/ide/product/visualizations.html#lazy-visualizations}
+ * for details.
+ *
+ * @param {string} code text code in Enso. It must be invokable with one argument and return
+ * JSON-compatible result. For example:
+ * x -> x.to_default_visualization_data
+ */
+ setPreprocessorCode(code) {
+ if (code !== this.__preprocessorCode__) {
+ this.__preprocessorCode__ = code
+ this.__emitPreprocessorChange__()
+ }
+ }
+
+ /**
+ * Get the current preprocessor's context module.
+ *
+ * See the [setter documentation]{@link setPreprocessorModule} for more information.
+ *
+ * @returns {string} Qualified name to preprocessor's context module.
+ */
+ getPreprocessorModule() {
+ return this.__preprocessorModule__
+ }
+
+ /**
+ * Set preprocessor's context module.
+ *
+ * [Preprocessor code]{@link setPreprocessorCode} is executed in the context of
+ * certain Enso module. This decides what symbols are visible and available to
+ * preprocessor, as everything that preprocessor uses must defined or imported
+ * in the context module.
+ *
+ * If never set, Engine will use the current project's `Main` module as the context.
+ *
+ * @param module
+ */
+ setPreprocessorModule(module) {
+ if (module !== this.__preprocessorModule__) {
+ this.__preprocessorModule__ = module
+ this.__emitPreprocessorChange__()
+ } else {
+ console.error('skipping, as', module, ' === ', this.__preprocessorModule__)
+ }
+ }
+
+ /**
+ * Set both preprocessor's code and context module.
+ *
+ * This is like calling both {@link setPreprocessorModule} and
+ * {@link setPreprocessorCode}, however may be more efficient, as it will emit
+ * only one update request.
+ *
+ * During the visualization construction phase no partial updates are emitted,
+ * so using this method gives no additional benefit.
+ *
+ * @param code preprocessor code to be set.
+ * @param module context module for the preprocessor execution.
+ */
+ setPreprocessor(code, module) {
+ if (code !== this.__preprocessorCode__ || code !== this.__preprocessorModule__) {
+ this.__preprocessorCode__ = code
+ this.__preprocessorModule__ = module
+ this.__emitPreprocessorChange__()
+ }
}
}
diff --git a/ide/src/rust/ide/view/graph-editor/src/component/visualization/instance.rs b/ide/src/rust/ide/view/graph-editor/src/component/visualization/instance.rs
index db652aa5b468..e482cbd8ce43 100644
--- a/ide/src/rust/ide/view/graph-editor/src/component/visualization/instance.rs
+++ b/ide/src/rust/ide/view/graph-editor/src/component/visualization/instance.rs
@@ -20,6 +20,84 @@ pub const DEFAULT_VISUALIZATION_EXPRESSION:&str = "x -> x.to_default_visualizati
+// ====================
+// === Preprocessor ===
+// ====================
+
+// === ContextModule ===
+
+/// Designation of the module to be used as a context for preprocessor evaluation.
+#[derive(Clone,CloneRef,Debug)]
+pub enum ContextModule {
+ /// Current project's `Main` module.
+ ProjectMain,
+ /// Specific module of known name.
+ Specific(enso::Module)
+}
+
+impl Default for ContextModule {
+ fn default() -> Self {
+ ContextModule::ProjectMain
+ }
+}
+
+impl ContextModule {
+ /// Create a context from optional string with module's type.
+ ///
+ /// If there is no explicit module's type provided, the default (project's main) will be used.
+ pub fn new(module_type:impl Into) -> Self {
+ Self::Specific(module_type.into())
+ }
+}
+
+
+// === PreprocessorConfiguration ===
+
+/// Information on how the preprocessor should be set up for the visualization.
+#[derive(Clone,CloneRef,Debug)]
+pub struct PreprocessorConfiguration {
+ /// The code of the preprocessor. Should be a lambda that transforms node value into whatever
+ /// that visualizations expect.
+ pub code : enso::Code,
+ /// The module that provides context for `code` evaluation.
+ pub module : ContextModule,
+}
+
+impl PreprocessorConfiguration {
+ /// Like `new` but arguments are optional. If `None` is given, default value will be used.
+ pub fn from_options
+ (code:Option>, module:Option>) -> Self {
+ let mut ret = Self::default();
+ if let Some(code) = code {
+ ret.code = code.into()
+ }
+ if let Some(module) = module {
+ ret.module = ContextModule::Specific(module.into())
+ }
+ ret
+ }
+
+ /// Create a configuration that runs the given code in the context of the given module.
+ pub fn new
+ (code:impl Into, module:impl Into) -> PreprocessorConfiguration {
+ PreprocessorConfiguration {
+ module : ContextModule::Specific(module.into()),
+ code : code.into(),
+ }
+ }
+}
+
+impl Default for PreprocessorConfiguration {
+ fn default() -> Self {
+ Self {
+ code : DEFAULT_VISUALIZATION_EXPRESSION.into(),
+ module : default(),
+ }
+ }
+}
+
+
+
// ===========
// === FRP ===
// ===========
@@ -48,7 +126,7 @@ pub struct Frp {
#[shrinkwrap(main_field)]
pub inputs : FrpInputs,
- pub on_preprocessor_change : frp::Sampler,
+ pub on_preprocessor_change : frp::Sampler,
pub on_data_receive_error : frp::Stream>,
pub is_active : frp::Stream,
@@ -59,7 +137,7 @@ pub struct Frp {
/// a function called on the Engine side before sending data to IDE, allowing us to do some
/// compression or filtering for the best performance. See also _Lazy Visualization_ section
/// [here](http://dev.enso.org/docs/ide/product/visualizations.html).
- pub preprocessor_change : frp::Source,
+ pub preprocessor_change : frp::Source,
}
impl FrpInputs {
@@ -85,7 +163,7 @@ impl Frp {
def data_receive_error = source();
is_active <- bool(&inputs.deactivate,&inputs.activate);
};
- preprocessor_change.emit(enso::Code::new(DEFAULT_VISUALIZATION_EXPRESSION));
+ preprocessor_change.emit(PreprocessorConfiguration::default());
let on_data_receive_error = data_receive_error.clone_ref().into();
Self {on_preprocessor_change,on_data_receive_error,is_active,preprocessor_change,inputs
,data_receive_error}
diff --git a/ide/src/rust/ide/view/graph-editor/src/component/visualization/metadata.rs b/ide/src/rust/ide/view/graph-editor/src/component/visualization/metadata.rs
index 33b3b7401b81..e97ba81c7a49 100644
--- a/ide/src/rust/ide/view/graph-editor/src/component/visualization/metadata.rs
+++ b/ide/src/rust/ide/view/graph-editor/src/component/visualization/metadata.rs
@@ -2,7 +2,7 @@
use crate::prelude::*;
-use crate::data::enso;
+use crate::component::visualization::instance::PreprocessorConfiguration;
/// Description of the visualization state, emitted with visualization_enabled event in GraphEditor.
#[derive(Clone,Debug,Default)]
@@ -10,5 +10,5 @@ pub struct Metadata {
/// An Enso lambda, called on the Engine side before sending data to IDE, allowing us to do some
/// compression or filtering for the best performance. See also _Lazy Visualization_ section
/// [here](http://dev.enso.org/docs/ide/product/visualizations.html).
- pub preprocessor: enso::Code,
+ pub preprocessor:PreprocessorConfiguration,
}
diff --git a/ide/src/rust/ide/view/graph-editor/src/component/visualization/path.rs b/ide/src/rust/ide/view/graph-editor/src/component/visualization/path.rs
index 7a1aa06ae23d..6b89ab411db1 100644
--- a/ide/src/rust/ide/view/graph-editor/src/component/visualization/path.rs
+++ b/ide/src/rust/ide/view/graph-editor/src/component/visualization/path.rs
@@ -16,6 +16,18 @@ im_string_newtype!{
Name
}
+/// Identifier to the project owning the visualizaiton.
+#[derive(Clone,CloneRef,Debug,Eq,Hash,PartialEq)]
+pub enum Project {
+ /// Temporary placeholder for the visualizations embedded in the IDE.
+ /// Eventually will be replaced with Standard Library.
+ Builtin,
+ /// The current project (i.e. the project that user has open in the project manager).
+ CurrentProject,
+ /// An external library (i.e. the dependency of the current project).
+ Library(enso::LibraryName),
+}
+
// ============
@@ -27,22 +39,20 @@ im_string_newtype!{
#[derive(Clone,CloneRef,Debug,Eq,Hash,PartialEq)]
#[allow(missing_docs)]
pub struct Path {
- pub library : enso::LibraryName,
+ pub project : Project,
pub name : Name,
}
impl Path {
/// Constructor.
- pub fn new(library:impl Into, name:impl Into) -> Self {
- let library = library.into();
+ pub fn new(project:Project, name:impl Into) -> Self {
let name = name.into();
- Self {library,name}
+ Self {project,name}
}
/// Constructor for builtin visualizations.
pub fn builtin(name:impl Into) -> Self {
- let library = enso::builtin_library();
- Self::new(library,name)
+ Self::new(Project::Builtin,name)
}
}
diff --git a/ide/src/rust/ide/view/graph-editor/src/data.rs b/ide/src/rust/ide/view/graph-editor/src/data.rs
index 45c256b389c8..ce9f92912b78 100644
--- a/ide/src/rust/ide/view/graph-editor/src/data.rs
+++ b/ide/src/rust/ide/view/graph-editor/src/data.rs
@@ -16,6 +16,9 @@ pub mod enso {
/// The Enso type representation. Can be a complex type, like `String|Int`.
Type,
+
+ /// The Enso module represented as qualified path, like `Project.Data.Vector`.
+ Module,
}
impl Type {
@@ -24,9 +27,4 @@ pub mod enso {
"Any".into()
}
}
-
- /// Builtin library name. For internal usage only.
- pub fn builtin_library() -> LibraryName {
- "builtin".into()
- }
}
diff --git a/ide/src/rust/ide/view/graph-editor/src/lib.rs b/ide/src/rust/ide/view/graph-editor/src/lib.rs
index 52d1ba3cb61e..b524e495b324 100644
--- a/ide/src/rust/ide/view/graph-editor/src/lib.rs
+++ b/ide/src/rust/ide/view/graph-editor/src/lib.rs
@@ -36,6 +36,7 @@ pub mod data;
use crate::component::node;
use crate::component::visualization;
+use crate::component::visualization::instance::PreprocessorConfiguration;
use crate::component::visualization::MockDataGenerator3D;
use crate::component::type_coloring;
@@ -516,7 +517,7 @@ ensogl::define_endpoints! {
visualization_enabled (NodeId,visualization::Metadata),
visualization_disabled (NodeId),
visualization_enable_fullscreen (NodeId),
- visualization_preprocessor_changed ((NodeId,data::enso::Code)),
+ visualization_preprocessor_changed ((NodeId,PreprocessorConfiguration)),
visualization_registry_reload_requested (),
on_visualization_select (Switch),
@@ -1087,13 +1088,14 @@ impl GraphEditorModelWithNetwork {
selected <- vis_is_selected.on_true();
deselected <- vis_is_selected.on_false();
output.source.visualization_preprocessor_changed <+
- node.model.visualization.frp.preprocessor.map(move |code| (node_id,code.clone()));
+ node.model.visualization.frp.preprocessor.map(move |preprocessor|
+ (node_id,preprocessor.clone()));
output.source.on_visualization_select <+ selected.constant(Switch::On(node_id));
output.source.on_visualization_select <+ deselected.constant(Switch::Off(node_id));
metadata <- any(...);
- metadata <+ node.model.visualization.frp.preprocessor.map(move |code| {
- let preprocessor = code.clone();
+ metadata <+ node.model.visualization.frp.preprocessor.map(move |preprocessor| {
+ let preprocessor = preprocessor.clone();
visualization::Metadata{preprocessor}
});
// Ensure the graph editor knows about internal changes to the visualisation. If the
diff --git a/ide/src/rust/ide/view/src/debug_scenes/visualization.rs b/ide/src/rust/ide/view/src/debug_scenes/visualization.rs
index c325e6c83ac6..ea1b70eb9cfb 100644
--- a/ide/src/rust/ide/view/src/debug_scenes/visualization.rs
+++ b/ide/src/rust/ide/view/src/debug_scenes/visualization.rs
@@ -3,7 +3,6 @@
use crate::graph_editor::component::visualization::Data;
use crate::graph_editor::component::visualization;
use crate::graph_editor::component::visualization::Registry;
-use crate::graph_editor::data::enso;
use ensogl::application::Application;
use ensogl::display::navigation::navigator::Navigator;
@@ -73,7 +72,7 @@ fn constructor_graph() -> visualization::java_script::Definition {
return Graph
"#;
- visualization::java_script::Definition::new(enso::builtin_library(),source).unwrap()
+ visualization::java_script::Definition::new_builtin(source).unwrap()
}
#[wasm_bindgen]
diff --git a/ide/src/rust/ide/view/src/documentation.rs b/ide/src/rust/ide/view/src/documentation.rs
index a66b92046a1e..4a7db9453445 100644
--- a/ide/src/rust/ide/view/src/documentation.rs
+++ b/ide/src/rust/ide/view/src/documentation.rs
@@ -205,7 +205,8 @@ impl Model {
return Err(visualization::DataError::InternalComputationError);
}
}
- _ => return Err(visualization::DataError::InvalidDataType),
+ visualization::Data::Binary =>
+ return Err(visualization::DataError::BinaryNotSupported),
};
self.display_doc(&string, InputFormat::Docstring);
Ok(())