Improved Simantics/SCL module SCL module/script functionality

[simantics/platform.git] / bundles / org.simantics.modeling / scl / Simantics / SCL.scl

diff --git a/bundles/org.simantics.modeling/scl/Simantics/SCL.scl b/bundles/org.simantics.modeling/scl/Simantics/SCL.scl
index 32db0f4bc6545cca456aaa697aa49477aafe1ac3..d636ca8eff2a1c99574ec15125c5691f7ab0f852 100644 (file)
--- a/bundles/org.simantics.modeling/scl/Simantics/SCL.scl
+++ b/bundles/org.simantics.modeling/scl/Simantics/SCL.scl
@@ -12,14 +12,13 @@ importJava "org.simantics.scl.ui.editor.TextAndErrors" where
     createTextAndErrors :: String -> [CompilationError] -> TextAndErrors
 
 createSCLModuleAction :: Resource -> <Proc> ()
-createSCLModuleAction res = do
-  syncWrite (\() -> createSCLModuleDefault res)
-  ()
+createSCLModuleAction res = ignore $ syncWrite (\() -> createSCLModuleDefault res)
+
+createSCLScriptAction :: Resource -> <Proc> ()
+createSCLScriptAction res = ignore $ syncWrite (\() -> createSCLScriptDefault res)
 
 createPGraphAction :: Resource -> <Proc> ()
-createPGraphAction res = do
-  syncWrite (\() -> createPGraphDefault res)
-  ()
+createPGraphAction res = ignore $ syncWrite (\() -> createPGraphDefault res)
 
 createSCLValueIndependent :: Resource -> String -> <WriteGraph> Resource
 createSCLValueIndependent valueType expression = do
@@ -41,8 +40,60 @@ setExpression self expression = do
 
 importJava "org.simantics.modeling.ModelingUtils" where
     createSCLModuleDefault :: Resource -> <WriteGraph> ()
+    createSCLScriptDefault :: Resource -> <WriteGraph> ()
     createPGraphDefault :: Resource -> <WriteGraph> ()
+    "Use [createSCLModuleR](#createSCLModuleR) instead."
+    @deprecated
     createSCLModule :: Resource -> String -> <WriteGraph> ()
+    "Use [createSCLScriptR](#createSCLScriptR) instead."
+    @deprecated
+    createSCLScript :: Resource -> String -> <WriteGraph> ()
+    "Use [createPGraphR](#createPGraphR) instead."
+    @deprecated
+    createPGraph :: Resource -> String -> <WriteGraph> ()
+    """
+    `createSCLModuleR container name` creates a new empty SCL module under
+    the specified `container` with the specified `name` and returns the created
+    module's Resource.
+    """
+    @JavaName createSCLModule
+    createSCLModuleR :: Resource -> String -> <WriteGraph> Resource
+    """
+    `createSCLScriptR container name` creates a new empty SCL script under
+    the specified `container` with the specified `name` and returns the created
+    script's Resource.
+    """
+    @JavaName createSCLScript
+    createSCLScriptR :: Resource -> String -> <WriteGraph> Resource
+    """
+    `createPGraphR container name` creates a new empty partial graph
+    ontology definition (PGraph) under the specified `container` with
+    the specified `name` and returns the created ontology definition's
+    Resource.
+    """
+    @JavaName createPGraph
+    createPGraphR :: Resource -> String -> <WriteGraph> Resource
+    "`setSCLModuleDefinition module definition` sets the textual `definition` of the specified SCL `module`."
+    setSCLModuleDefinition :: Resource -> String -> <WriteGraph> Resource
+    "`setSCLScriptDefinition module definition` sets the textual `definition` of the specified SCL `module`."
+    setSCLScriptDefinition :: Resource -> String -> <WriteGraph> Resource
+    setPGraphDefinition :: Resource -> String -> <WriteGraph> Resource
+
+"""
+`createSCLModuleWithDefinition container name definition` creates a new SCL module under
+the specified `container` with the specified `name` and `definition` and returns
+the created module's Resource.
+"""
+createSCLModuleWithDefinition :: Resource -> String -> String -> <WriteGraph> Resource
+createSCLModuleWithDefinition container name definition = setSCLModuleDefinition (createSCLModuleR container name) definition
+
+"""
+`createSCLScriptWithDefinition container name definition` creates a new SCL script under
+the specified `container` with the specified `name` and `definition` and returns
+the created script's Resource.
+"""
+createSCLScriptWithDefinition :: Resource -> String -> String -> <WriteGraph> Resource
+createSCLScriptWithDefinition container name definition = setSCLScriptDefinition (createSCLScriptR container name) definition
 
 effect SCL 
     "scl"