cd0242be78426791570a52f794b1065486e5ffef
[simantics/platform.git] / bundles / org.simantics.scl.db / scl / Simantics / DB.scl
1 import "JavaBuiltin" as Java
2 include "http://www.simantics.org/Layer0-1.1" as L0
3 import "Map" as Map
4
5 infixl 5 (#)
6  
7 effect ReadGraph
8     "graph"
9     "org.simantics.db.ReadGraph"
10
11 effect WriteGraph
12     "graph"
13     "org.simantics.db.WriteGraph"
14     
15 importJava "org.simantics.db.Resource" where
16     "A resource is a node in a semantic graph."
17     data Resource
18     
19     "Returns the 64-bit unique identifier of the resource."
20     @JavaName getResourceId
21     resourceId :: Resource -> Long
22     
23     isPersistent :: Resource -> Boolean
24     
25 importJava "org.simantics.db.ReadGraph" where
26     data ReadGraphX
27     
28 instance Ord Resource where
29     compare a b = compare (resourceId a) (resourceId b)
30   
31 instance Show Resource where
32     show r = "#" + show (resourceId r)
33
34 instance Show Statement where
35     show s = "#" + show (resourceId ( subjectOf s)) + "#" + show (resourceId ( predicateOf s)) + "#" + show (resourceId ( objectOf s))
36
37 importJava "org.simantics.db.Statement" where
38     "A statement is an edge in a semantic graph."
39     data Statement
40     
41     @JavaName getSubject
42     subjectOf :: Statement -> Resource
43     @JavaName getPredicate
44     predicateOf :: Statement -> Resource
45     @JavaName getObject
46     objectOf :: Statement -> Resource
47     
48     isAsserted :: Statement -> Resource -> <ReadGraph> Boolean
49     
50 importJava "org.simantics.db.ReadGraph" where
51     "Converts an absolute URI to a resource or returns `Nothing` if there is no such resource."
52     @JavaName getPossibleResource
53     possibleResource :: String -> <ReadGraph> (Maybe Resource)
54     
55     getDataType :: Resource -> <ReadGraph> Datatype
56
57     @JavaName getSupertypes
58     superTypesOf :: Resource -> <ReadGraph> Set.T Resource
59     
60     @private
61     @JavaName getURI
62     uriOfResource :: Resource -> <ReadGraph> String
63
64     @private
65     @JavaName getPossibleURI
66     possibleUriOfResource :: Resource -> <ReadGraph> Maybe String
67     
68     @JavaName getObjects
69     objects_ :: Resource -> Resource -> <ReadGraph> Collection Resource
70     
71     @JavaName getStatements
72     statements_ :: Resource -> Resource -> <ReadGraph> Collection Statement
73     
74     @JavaName hasStatement
75     existsStatement :: Resource -> Resource -> <ReadGraph> Boolean
76     
77     @JavaName hasStatement
78     existsStatement3 :: Resource -> Resource -> Resource -> <ReadGraph> Boolean
79
80     "Assumes that there is exactly one object with the given subject and predicate and returns it."
81     @JavaName getSingleObject
82     singleObject :: Resource -> Resource -> <ReadGraph> Resource
83
84     """
85     If there is exactly one object with the given `subject` and `predicate`,
86     `possibleObject subject predicate` returns it. Otherwise, it returns
87     `Nothing`.
88     """
89     @JavaName getPossibleObject
90     possibleObject :: Resource -> Resource -> <ReadGraph> Maybe Resource
91
92     "Assumes that there is exactly one statement with the given subject and predicate and returns it."
93     @JavaName getSingleStatement
94     singleStatement :: Resource -> Resource -> <ReadGraph> Statement
95
96     @JavaName getPossibleStatement
97     possibleStatement :: Resource -> Resource -> <ReadGraph> Maybe Statement
98
99     @JavaName getRelatedVariantValue
100     relatedVariantValue :: Resource -> Resource -> <ReadGraph> Variant
101
102     @JavaName getRelatedValue
103     relatedValue_ :: Resource -> Resource -> Binding a -> <ReadGraph> a
104     
105     @JavaName getRelatedValue
106     untypedRelatedValue :: Resource -> Resource -> <ReadGraph> a
107
108     @JavaName getRelatedValue2
109     relatedValue2 :: Resource -> Resource -> <ReadGraph> a
110
111     @JavaName getRelatedVariantValue2
112     relatedVariantValue2 :: Resource -> Resource -> <ReadGraph> Variant
113     
114     @JavaName getPossibleRelatedValue
115     possibleRelatedValue_ :: Resource -> Resource -> Binding a -> <ReadGraph> Maybe a
116     
117     @JavaName getPossibleRelatedValue
118     untypedPossibleRelatedValue :: Resource -> Resource -> <ReadGraph> Maybe a
119     
120     @private
121     @JavaName getValue
122     valueOf_ :: Resource -> Binding a -> <ReadGraph> a
123     
124     @private
125     @JavaName getVariantValue
126     variantValueOf_ :: Resource -> <ReadGraph> Variant
127     
128     @JavaName getValue
129     untypedValueOf :: Resource -> <ReadGraph> Dynamic
130     
131     @JavaName getPossibleValue
132     untypedPossibleValueOf :: Resource -> <ReadGraph> Maybe Dynamic
133     
134     @JavaName getInverse
135     inverseOf :: Resource -> <ReadGraph> Resource
136     
137     @JavaName getSingleType
138     singleTypeOf :: Resource -> Resource -> <ReadGraph> Resource
139     
140     @JavaName getPossibleType
141     possibleTypeOf :: Resource -> Resource -> <ReadGraph> Maybe Resource
142     
143     "`isInstanceOf r t` returns true, if `r` is an instance of `t`"
144     isInstanceOf :: Resource -> Resource -> <ReadGraph> Boolean
145     isSubrelationOf :: Resource -> Resource -> <ReadGraph> Boolean
146     isInheritedFrom :: Resource -> Resource -> <ReadGraph> Boolean
147     
148     getRootLibrary :: () -> <ReadGraph> Resource
149     
150     @JavaName getPredicates
151     predicatesOf :: Resource -> <ReadGraph> [Resource]
152
153 importJava "org.simantics.db.layer0.util.ExtendedUris" where
154     "Converts an absolute URI to a resource"
155     @JavaName resolveAbsoluteUri    
156     resource :: String -> <ReadGraph> Resource
157     
158     "Converts a relative URI to a resource starting from the given resource"
159     @JavaName resolveRelativeUri
160     relativeResource :: Resource -> String -> <ReadGraph> Resource
161
162 "Reads the value of a literal that is an object with the given subject and predicate"
163 @inline
164 relatedValue :: Serializable a => Resource -> Resource -> <ReadGraph> a
165 relatedValue s p = relatedValue_ s p binding
166
167 @inline
168 possibleRelatedValue :: Serializable a => Resource -> Resource -> <ReadGraph> Maybe a
169 possibleRelatedValue s p = possibleRelatedValue_ s p binding
170
171 class Browsable a where
172     fromUri :: String -> <ReadGraph> a
173
174     "Returns the URI of the given value."
175     uriOf :: a -> <ReadGraph> String
176     
177     "Returns the URI of the given value if it exists or Nothing."
178     possibleUriOf :: a -> <ReadGraph> Maybe String
179     
180     "Reads the name of the value."
181     nameOf :: a -> <ReadGraph> String
182     possibleNameOf :: a -> <ReadGraph> Maybe String
183     
184     valueOf :: Serializable v => a -> <ReadGraph> v
185     
186     variantValueOf :: a -> <ReadGraph> Variant 
187     
188     children :: a -> <ReadGraph> [a]
189     parent :: a -> <ReadGraph> a
190     possibleParent :: a -> <ReadGraph> Maybe a
191     
192     child :: a -> String -> <ReadGraph> a
193     possibleChild :: a -> String -> <ReadGraph> Maybe a
194     
195 instance Browsable Resource where
196     fromUri = resource
197     uriOf = uriOfResource
198     possibleUriOf = possibleUriOfResource
199     nameOf r = relatedValue r L0.HasName
200     possibleNameOf r = possibleRelatedValue r L0.HasName
201     @inline
202     valueOf r = valueOf_ r binding
203     variantValueOf = variantValueOf_
204     
205     children r = r # L0.ConsistsOf
206     parent r = singleObject r L0.PartOf
207     possibleParent r = possibleObject r L0.PartOf
208     
209     possibleChild = possibleResourceChild
210     child r n = fromJust (possibleResourceChild r n)
211
212 importJava "org.simantics.db.WriteOnlyGraph" where
213     markUndoPoint :: () -> <WriteGraph> ()
214
215 importJava "org.simantics.db.WriteGraph" where
216     "Creates a new resource."
217     newResource :: () -> <WriteGraph> Resource
218     "Adds a statement to the semantic graph."
219     claim :: Resource -> Resource -> Resource -> <WriteGraph> ()
220     @JavaName claimLiteral
221     claimRelatedValue_ :: Resource -> Resource -> a -> Binding a -> <WriteGraph> ()
222     @JavaName claimLiteral
223     untypedClaimRelatedValue :: Resource -> Resource -> a -> <WriteGraph> ()
224     @JavaName claimValue
225     untypedClaimValue :: Resource -> a -> <WriteGraph> ()
226     @JavaName claimLiteral
227     claimRelatedValueWithType_ :: Resource -> Resource -> Resource -> a -> Binding a -> <WriteGraph> ()
228     "Removes a statement with the given subject, predicate and object"
229     deny :: Resource -> Resource -> Resource -> <WriteGraph> ()
230     @JavaName deny
231     denyByPredicate :: Resource -> Resource -> <WriteGraph> ()
232     @JavaName deny
233     denyAllStatements :: Resource -> <WriteGraph> ()
234     newClusterSet :: Resource -> <WriteGraph> ()
235     @JavaName denyValue
236     denyValue :: Resource -> <WriteGraph> ()
237
238 claimAssertion :: Resource -> Resource -> Resource -> <WriteGraph> ()
239 claimAssertion type_ predicate object = do
240     ass = newResource ()
241     claim ass L0.HasPredicate predicate
242     claim ass L0.HasObject object
243     claim type_ L0.Asserts ass
244
245 "Sets the value of the literal that is an object with the given subject and predicate."
246 @inline
247 claimRelatedValue :: Serializable a => Resource -> Resource -> a -> <WriteGraph> ()
248 claimRelatedValue s p v = claimRelatedValue_ s p v binding
249
250 @inline
251 claimRelatedValueWithType :: Serializable a => Resource -> Resource -> Resource -> a -> <WriteGraph> ()
252 claimRelatedValueWithType s p t v = claimRelatedValueWithType_ s p t v binding
253
254 importJava "org.simantics.layer0.utils.direct.GraphUtils" where
255     @JavaName getPossibleChild
256     possibleResourceChild :: Resource -> String -> <ReadGraph> (Maybe Resource)
257
258 @deprecated "Use function children instead."
259 resourceChildrenOf :: Resource -> <ReadGraph> [Resource]
260 resourceChildrenOf r = r # L0.ConsistsOf
261
262 importJava "org.simantics.db.common.utils.OrderedSetUtils" where
263     @JavaName add
264     addToOrderedSet :: Resource -> Resource -> <WriteGraph> Boolean
265     
266     @JavaName set
267     setOrderedSet :: Resource -> [Resource] -> <WriteGraph> Boolean
268     
269     @JavaName getSingleOwnerList
270     parentOrderedSet :: Resource -> <ReadGraph> Resource
271     
272     @JavaName toList
273     elementsOfOrderedSet :: Resource -> <ReadGraph> [Resource]
274     
275 importJava "org.simantics.db.common.utils.ListUtils" where
276     @JavaName toList
277     elementsOfList :: Resource -> <ReadGraph> [Resource]
278     
279     @JavaName create
280     createList :: [Resource] -> <WriteGraph> Resource
281
282     @JavaName create
283     createListWithType :: Resource -> [Resource] -> <WriteGraph> Resource
284     
285     @javaName insertBack
286     insertBack :: Resource -> [Resource] -> <WriteGraph> ()
287     
288     @javaName removeElement
289     removeElement :: Resource -> Resource -> <WriteGraph> Boolean
290     
291     @javaName swapWithPrevious
292     swapWithPrevious :: Resource -> Resource -> <WriteGraph> Boolean
293
294     @javaName swapWithNext
295     swapWithNext :: Resource -> Resource -> <WriteGraph> Boolean
296
297
298 importJava "org.simantics.db.common.utils.CommonDBUtils" where
299     isParent :: Resource -> Resource -> <ReadGraph> Boolean
300     possibleRelatedString :: Resource -> Resource -> <ReadGraph> Maybe String
301     possibleRelatedInteger :: Resource -> Resource -> <ReadGraph> Maybe Integer
302     objectsWithType :: Resource -> Resource -> Resource -> <ReadGraph> [Resource]
303     possibleObjectWithType :: Resource -> Resource -> Resource -> <ReadGraph> Maybe Resource
304
305 importJava "org.simantics.db.common.utils.NameUtils" where
306     findFreshName :: String -> Resource -> <ReadGraph> String
307     findFreshEscapedName :: String -> Resource -> <ReadGraph> String
308
309 "`subject # predicate` returns all objects with the given `subject` and `predicate`."
310 (#) :: Resource -> Resource -> <ReadGraph> [Resource]
311 subject # predicate = collectionToList $ objects_ subject predicate
312
313 "statements subject predicate` returns all statements with the given subject and predicate."
314 statements :: Resource -> Resource -> <ReadGraph> [Statement]
315 statements subject predicate = collectionToList $ statements_ subject predicate
316
317 importJava "org.simantics.scl.db.SCLFunctions" where
318     "Executes a read transaction and waits that it completes."
319     syncRead :: (() -> <Proc,ReadGraph> a) -> <Proc> a
320     "Executes a write transaction and waits that it completes."
321     syncWrite :: (() -> <Proc,ReadGraph,WriteGraph> a) -> <Proc> a
322     "Executes a delayed write transaction and waits that it completes."
323     delayedSyncWrite :: (() -> <Proc,WriteGraph> a) -> <Proc> a
324     
325     "Begins a read transaction and immediately returns."
326     asyncRead :: (() -> <Proc,ReadGraph> a) -> <Proc> ()
327     "Begins a write transaction and immediately returns."
328     asyncWrite :: (() -> <Proc,ReadGraph,WriteGraph> a) -> <Proc> ()
329     
330     virtualSyncWriteMem :: String -> (() -> <ReadGraph,WriteGraph> a) -> <WriteGraph> a
331     virtualSyncWriteWS :: String -> (() -> <ReadGraph,WriteGraph> a) -> <WriteGraph> a
332     
333     safeExec :: (() -> <Proc> a) -> <Proc> a
334     activateOnce :: Resource -> <Proc> ()
335     syncActivateOnce :: Resource -> <WriteGraph, Proc> ()
336     resourceFromId :: Long -> <ReadGraph> Resource
337     enableDependencies :: () -> <WriteGraph> ()
338     disableDependencies :: () -> <WriteGraph> ()
339     
340     unaryQuery :: (a -> <ReadGraph,e> b) -> a -> <ReadGraph> b
341     unaryQueryCached :: (a -> <ReadGraph,e> b) -> a -> <ReadGraph> b
342
343     "Makes a new read request with given procedure for calculating the result. The request is cached only if the current request is listened."
344     subquery :: (<ReadGraph,Proc> a) -> <ReadGraph,Proc> a
345     "Makes a new read request with given procedure for calculating the result. The request is always cached."
346     subqueryC :: (<ReadGraph,Proc> a) -> <ReadGraph,Proc> a
347     "Tries to convert the given Dynamic value to a value with the inferred type"
348     possibleFromDynamic :: Typeable a => String -> Dynamic -> Maybe a
349
350 importJava "org.simantics.db.layer0.util.Layer0Utils" where
351     undo :: () -> <Proc> String
352     undoOperations :: Integer -> <Proc> String
353     redo :: () -> <Proc> String
354     queryDebugSupport :: String -> <Proc> String
355     queryListSupport :: String -> <Proc> String
356     addCommentMetadata :: String -> <WriteGraph> ()
357     sortByCluster :: [a] -> (a->Resource) -> <ReadGraph> [a]
358     makeSynchronous :: Boolean -> <ReadGraph> ()
359     listOntologies :: () -> <ReadGraph> [Resource]
360     emptyTrashBin :: () -> <Proc> ()
361     purgeDatabase :: () -> <Proc> ()
362     prettyPrintResource :: Resource -> Boolean -> <ReadGraph> String
363
364     @private
365     @JavaName copyTo
366     copyTo_ :: Resource -> Resource -> <WriteGraph> Collection Resource
367     @JavaName getPossiblePredicateByName
368     possiblePredicateByName :: Resource -> String -> <ReadGraph> Maybe Resource
369     @JavaName getPossiblePredicateByNameFromType
370     possiblePredicateByNameFromType :: Resource -> String -> <ReadGraph> Maybe Resource
371     
372     addMetadataListener :: ChangeListener -> <Proc> ()
373     removeMetadataListener :: ChangeListener -> <Proc> ()
374
375 copyTo :: Resource -> Resource -> <WriteGraph> Resource
376 copyTo targetContainer source = do
377     (collectionToList $ copyTo_ targetContainer source)!0
378
379 importJava "org.simantics.db.common.utils.CommonDBUtils" where
380     selectClusterSet :: Resource -> <WriteGraph> () 
381
382 importJava "org.simantics.Simantics" where
383     @JavaName getProjectResource
384     currentProject :: () -> /*<Proc>*/ Resource
385
386 // Move to somewhere more generic module
387 importJava "java.util.Collection" where
388     data Collection a
389
390 importJava "java.util.ArrayList" where
391     @JavaName "<init>"
392     collectionToList :: Collection a -> [a]
393 /*@macro
394 collectionToList :: Collection a -> [a]
395 collectionToList x = Java.unsafeCoerce x
396 */ 
397
398 resourceToCollection :: a -> Collection a
399 resourceToCollection x = Java.unsafeCoerce x
400
401 newEntity :: [Resource -> <ReadGraph,WriteGraph> ()] -> <ReadGraph,WriteGraph> Resource
402 newEntity entitySpecs = do
403     entity = newResource ()
404     for entitySpecs (\spec -> spec entity)
405     entity
406
407 updateEntity :: Resource -> [Resource -> <ReadGraph,WriteGraph> ()] -> <ReadGraph,WriteGraph> Resource
408 updateEntity entity entitySpecs = do
409     for entitySpecs (\spec -> spec entity)
410     entity
411
412 hasStatement predicate object entity = 
413     claim entity predicate object
414 hasProperty relation value entity = 
415     claimRelatedValue entity relation value
416 hasPossibleProperty relation value entity =
417     match value with
418       Just v -> claimRelatedValue entity relation v
419       Nothing -> ()
420 hasTypedProperty relation value t entity = 
421     claimRelatedValueWithType entity relation t value        
422 hasName (n :: String) = hasProperty L0.HasName n
423 hasLabel (l :: String) = hasProperty L0.HasLabel l
424 hasType t = hasStatement L0.InstanceOf t
425 hasParent p = hasStatement L0.PartOf p
426
427 importJava "org.simantics.databoard.util.URIStringUtils" where
428     @JavaName splitURISCL
429     splitURI :: String -> [String]
430     @JavaName escape
431     escapeURI :: String -> String
432     @JavaName unescape
433     unescapeURI :: String -> String
434
435 @private
436 importJava "org.simantics.db.layer0.request.ActiveModels" where
437     @JavaName getPossibleActiveModel
438     activeModel :: Resource -> <ReadGraph> Maybe Resource
439
440 "Gives the current active model."
441 currentModel :: <ReadGraph> Resource
442 currentModel = match activeModel (currentProject ()) with
443     Just model -> model
444     Nothing -> fail "No active model."
445
446 "Gives the current active model if it exists or Nothing otherwise."
447 possibleCurrentModel :: <ReadGraph> Maybe Resource
448 possibleCurrentModel = activeModel (currentProject ())
449     
450 startUndoPoint :: String -> <WriteGraph> ()
451 startUndoPoint string = do
452     markUndoPoint ()
453     addCommentMetadata (string)
454     ()
455
456 @inline
457 lift1Read :: (a -> <ReadGraph,Proc> b) -> (a -> <Proc> b)
458 lift1Read f x = syncRead (\_ -> f x)
459
460 @inline
461 lift2Read :: (a -> b -> <ReadGraph,Proc> c) -> (a -> b -> <Proc> c)
462 lift2Read f x y = syncRead (\_ -> f x y)
463
464 @inline
465 lift3Read :: (a -> b -> c -> <ReadGraph,Proc> d) -> (a -> b -> c -> <Proc> d)
466 lift3Read f x y z = syncRead (\_ -> f x y z)
467
468 @inline
469 lift1Write :: (a -> <WriteGraph,Proc> b) -> (a -> <Proc> b)
470 lift1Write f x = syncWrite (\_ -> f x)
471
472 @inline
473 lift2Write :: (a -> b -> <WriteGraph,Proc> c) -> (a -> b -> <Proc> c)
474 lift2Write f x y = syncWrite (\_ -> f x y)
475
476 @inline
477 lift3Write :: (a -> b -> c -> <WriteGraph,Proc> d) -> (a -> b -> c -> <Proc> d)
478 lift3Write f x y z = syncWrite (\_ -> f x y z)
479
480 """
481 Returns a child Browsable of the specified parent that has that is the child
482 of the specified parent with the specified name path.
483 """
484 childWithPath :: Browsable a => a -> [String] -> <ReadGraph> a
485 childWithPath parent path = 
486     foldl (\r name -> match possibleChild r name with
487               Just c -> c
488               Nothing -> fail ("Didn't find " + name + ".") 
489           ) 
490           parent path
491
492 """
493 Like `childWithPath` but returns Maybe a which will be `Nothing` if no child
494 was found.
495 """
496 possibleChildWithPath :: Browsable a => a -> [String] -> <ReadGraph> Maybe a
497 possibleChildWithPath parent path = 
498     foldl (\r name -> match r with
499               Just c -> possibleChild c name
500               Nothing -> Nothing 
501           ) 
502           (Just parent) path
503
504 importJava "org.simantics.db.MetadataI" where
505     data MetadataI
506
507 importJava "org.simantics.db.event.ChangeListener" where
508     data ChangeListener
509
510 importJava "org.simantics.db.layer0.genericrelation.DependencyChanges" where
511     data DependencyChanges