Merge "Remove unnecessary getComparableKey from HashMapBinding"
[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 getPossibleRelatedValue2
112     possibleRelatedValue2 :: Resource -> Resource -> <ReadGraph> Maybe a
113
114     @JavaName getRelatedVariantValue2
115     relatedVariantValue2 :: Resource -> Resource -> <ReadGraph> Variant
116     
117     @JavaName getPossibleRelatedValue
118     possibleRelatedValue_ :: Resource -> Resource -> Binding a -> <ReadGraph> Maybe a
119     
120     @JavaName getPossibleRelatedValue
121     untypedPossibleRelatedValue :: Resource -> Resource -> <ReadGraph> Maybe a
122     
123     @private
124     @JavaName getValue
125     valueOf_ :: Resource -> Binding a -> <ReadGraph> a
126     
127     @private
128     @JavaName getVariantValue
129     variantValueOf_ :: Resource -> <ReadGraph> Variant
130     
131     @JavaName getValue
132     untypedValueOf :: Resource -> <ReadGraph> Dynamic
133     
134     @JavaName getPossibleValue
135     untypedPossibleValueOf :: Resource -> <ReadGraph> Maybe Dynamic
136     
137     @JavaName getInverse
138     inverseOf :: Resource -> <ReadGraph> Resource
139     @JavaName getPossibleInverse
140     possibleInverseOf :: Resource -> <ReadGraph> Maybe Resource
141     
142     @JavaName getSingleType
143     singleTypeOf :: Resource -> Resource -> <ReadGraph> Resource
144     
145     @JavaName getPossibleType
146     possibleTypeOf :: Resource -> Resource -> <ReadGraph> Maybe Resource
147     
148     "`isInstanceOf r t` returns true, if `r` is an instance of `t`"
149     isInstanceOf :: Resource -> Resource -> <ReadGraph> Boolean
150     isSubrelationOf :: Resource -> Resource -> <ReadGraph> Boolean
151     isInheritedFrom :: Resource -> Resource -> <ReadGraph> Boolean
152     
153     getRootLibrary :: () -> <ReadGraph> Resource
154     
155     @JavaName getPredicates
156     predicatesOf :: Resource -> <ReadGraph> [Resource]
157     
158     isImmutable :: Resource -> <ReadGraph> Boolean
159
160 importJava "org.simantics.db.layer0.util.ExtendedUris" where
161     "Converts an absolute URI to a resource"
162     @JavaName resolveAbsoluteUri    
163     resource :: String -> <ReadGraph> Resource
164     
165     "Converts a relative URI to a resource starting from the given resource"
166     @JavaName resolveRelativeUri
167     relativeResource :: Resource -> String -> <ReadGraph> Resource
168
169 "Reads the value of a literal that is an object with the given subject and predicate"
170 @inline
171 relatedValue :: Serializable a => Resource -> Resource -> <ReadGraph> a
172 relatedValue s p = relatedValue_ s p binding
173
174 @inline
175 possibleRelatedValue :: Serializable a => Resource -> Resource -> <ReadGraph> Maybe a
176 possibleRelatedValue s p = possibleRelatedValue_ s p binding
177
178 class Browsable a where
179     fromUri :: String -> <ReadGraph> a
180
181     "Returns the URI of the given value."
182     uriOf :: a -> <ReadGraph> String
183     
184     "Returns the URI of the given value if it exists or Nothing."
185     possibleUriOf :: a -> <ReadGraph> Maybe String
186     
187     "Reads the name of the value."
188     nameOf :: a -> <ReadGraph> String
189     possibleNameOf :: a -> <ReadGraph> Maybe String
190     
191     valueOf :: Serializable v => a -> <ReadGraph> v
192     
193     genericRelatedValue :: a -> Resource -> <ReadGraph> t
194     genericPossibleRelatedValue :: a -> Resource -> <ReadGraph> Maybe t
195     
196     variantValueOf :: a -> <ReadGraph> Variant 
197     
198     children :: a -> <ReadGraph> [a]
199     parent :: a -> <ReadGraph> a
200     possibleParent :: a -> <ReadGraph> Maybe a
201     
202     child :: a -> String -> <ReadGraph> a
203     possibleChild :: a -> String -> <ReadGraph> Maybe a
204     
205 instance Browsable Resource where
206     fromUri = resource
207     uriOf = uriOfResource
208     possibleUriOf = possibleUriOfResource
209     nameOf r = relatedValue r L0.HasName
210     possibleNameOf r = possibleRelatedValue r L0.HasName
211     @inline
212     valueOf r = valueOf_ r binding
213     variantValueOf = variantValueOf_
214     
215     genericRelatedValue = relatedValue2
216     genericPossibleRelatedValue = possibleRelatedValue2
217     
218     children r = r # L0.ConsistsOf
219     parent r = singleObject r L0.PartOf
220     possibleParent r = possibleObject r L0.PartOf
221     
222     possibleChild = possibleResourceChild
223     child r n = fromJust (possibleResourceChild r n)
224
225 importJava "org.simantics.db.WriteOnlyGraph" where
226     markUndoPoint :: () -> <WriteGraph> ()
227
228 importJava "org.simantics.db.WriteGraph" where
229     "Creates a new resource."
230     newResource :: () -> <WriteGraph> Resource
231     "Adds a statement to the semantic graph."
232     claim :: Resource -> Resource -> Resource -> <WriteGraph> ()
233     @JavaName claim
234     claimWithInverse :: Resource -> Resource -> Maybe Resource -> Resource -> <WriteGraph> ()
235     @JavaName claimLiteral
236     claimRelatedValue_ :: Resource -> Resource -> a -> Binding a -> <WriteGraph> ()
237     @JavaName claimLiteral
238     untypedClaimRelatedValue :: Resource -> Resource -> a -> <WriteGraph> ()
239     @JavaName claimValue
240     untypedClaimValue :: Resource -> a -> <WriteGraph> ()
241     @JavaName claimLiteral
242     claimRelatedValueWithType_ :: Resource -> Resource -> Resource -> a -> Binding a -> <WriteGraph> ()
243     "Removes a statement with the given subject, predicate and object"
244     deny :: Resource -> Resource -> Resource -> <WriteGraph> ()
245     @JavaName deny
246     denyByPredicate :: Resource -> Resource -> <WriteGraph> ()
247     @JavaName deny
248     denyAllStatements :: Resource -> <WriteGraph> ()
249     newClusterSet :: Resource -> <WriteGraph> ()
250     @JavaName denyValue
251     denyValue :: Resource -> <WriteGraph> ()
252
253 claimAssertion :: Resource -> Resource -> Resource -> <WriteGraph> ()
254 claimAssertion type_ predicate object = do
255     ass = newResource ()
256     claim ass L0.HasPredicate predicate
257     claim ass L0.HasObject object
258     claim type_ L0.Asserts ass
259
260 "Sets the value of the literal that is an object with the given subject and predicate."
261 @inline
262 claimRelatedValue :: Serializable a => Resource -> Resource -> a -> <WriteGraph> ()
263 claimRelatedValue s p v = claimRelatedValue_ s p v binding
264
265 @inline
266 claimRelatedValueWithType :: Serializable a => Resource -> Resource -> Resource -> a -> <WriteGraph> ()
267 claimRelatedValueWithType s p t v = claimRelatedValueWithType_ s p t v binding
268
269 importJava "org.simantics.layer0.utils.direct.GraphUtils" where
270     @JavaName getPossibleChild
271     possibleResourceChild :: Resource -> String -> <ReadGraph> (Maybe Resource)
272
273 @deprecated "Use function children instead."
274 resourceChildrenOf :: Resource -> <ReadGraph> [Resource]
275 resourceChildrenOf r = r # L0.ConsistsOf
276
277 importJava "org.simantics.db.common.utils.OrderedSetUtils" where
278     "`addToOrderedSet s e` adds element `e` to ordered set `s`"
279     @JavaName add
280     addToOrderedSet :: Resource -> Resource -> <WriteGraph> Boolean
281     
282     "`addFirstToOrderedSet s e` adds element `e` to ordered set `s` as the first element"
283     @JavaName addFirst
284     addFirstToOrderedSet :: Resource -> Resource -> <WriteGraph> Boolean
285     
286     "`addAfterToOrderedSet s p e` adds element `e` to ordered set `s` after element `p`"
287     @JavaName addAfter
288     addAfterToOrderedSet :: Resource -> Resource -> Resource -> <WriteGraph> Boolean
289     
290     "`addBeforeToOrderedSet s p e` adds element `e` to ordered set `s` before element `p`"
291     @JavaName addBefore
292     addBeforeToOrderedSet :: Resource -> Resource -> Resource -> <WriteGraph> Boolean
293     
294     "`removeFromOrderedSet s e` removes element `e` from ordered set `s`"
295     @JavaName remove
296     removeFromOrderedSet :: Resource -> Resource -> <WriteGraph> Boolean
297     
298     @JavaName set
299     setOrderedSet :: Resource -> [Resource] -> <WriteGraph> Boolean
300     
301     @JavaName getSingleOwnerList
302     parentOrderedSet :: Resource -> <ReadGraph> Resource
303     
304     @JavaName toList
305     elementsOfOrderedSet :: Resource -> <ReadGraph> [Resource]
306     
307 importJava "org.simantics.db.common.utils.ListUtils" where
308     @JavaName toList
309     elementsOfList :: Resource -> <ReadGraph> [Resource]
310     
311     @JavaName create
312     createList :: [Resource] -> <WriteGraph> Resource
313
314     @JavaName create
315     createListWithType :: Resource -> [Resource] -> <WriteGraph> Resource
316     
317     @javaName insertBack
318     insertBack :: Resource -> [Resource] -> <WriteGraph> ()
319     
320     @javaName removeElement
321     removeElement :: Resource -> Resource -> <WriteGraph> Boolean
322     
323     @javaName swapWithPrevious
324     swapWithPrevious :: Resource -> Resource -> <WriteGraph> Boolean
325
326     @javaName swapWithNext
327     swapWithNext :: Resource -> Resource -> <WriteGraph> Boolean
328
329
330 importJava "org.simantics.db.common.utils.CommonDBUtils" where
331     isParent :: Resource -> Resource -> <ReadGraph> Boolean
332     possibleRelatedString :: Resource -> Resource -> <ReadGraph> Maybe String
333     possibleRelatedInteger :: Resource -> Resource -> <ReadGraph> Maybe Integer
334     objectsWithType :: Resource -> Resource -> Resource -> <ReadGraph> [Resource]
335     possibleObjectWithType :: Resource -> Resource -> Resource -> <ReadGraph> Maybe Resource
336
337 importJava "org.simantics.db.common.utils.NameUtils" where
338     findFreshName :: String -> Resource -> <ReadGraph> String
339     findFreshEscapedName :: String -> Resource -> <ReadGraph> String
340
341 "`subject # predicate` returns all objects with the given `subject` and `predicate`."
342 (#) :: Resource -> Resource -> <ReadGraph> [Resource]
343 subject # predicate = collectionToList $ objects_ subject predicate
344
345 "statements subject predicate` returns all statements with the given subject and predicate."
346 statements :: Resource -> Resource -> <ReadGraph> [Statement]
347 statements subject predicate = collectionToList $ statements_ subject predicate
348
349 importJava "org.simantics.scl.db.SCLFunctions" where
350     "Executes a read transaction and waits that it completes."
351     syncRead :: (() -> <Proc,ReadGraph> a) -> <Proc> a
352     "Executes a write transaction and waits that it completes."
353     syncWrite :: (() -> <Proc,ReadGraph,WriteGraph> a) -> <Proc> a
354     "Executes a delayed write transaction and waits that it completes."
355     delayedSyncWrite :: (() -> <Proc,WriteGraph> a) -> <Proc> a
356     
357     "Begins a read transaction and immediately returns."
358     asyncRead :: (() -> <Proc,ReadGraph> a) -> <Proc> ()
359     "Begins a write transaction and immediately returns."
360     asyncWrite :: (() -> <Proc,ReadGraph,WriteGraph> a) -> <Proc> ()
361     
362     virtualSyncWriteMem :: String -> (() -> <e,WriteGraph> a) -> <e,WriteGraph> a
363     virtualSyncWriteWS :: String -> (() -> <e,WriteGraph> a) -> <e,WriteGraph> a
364     
365     safeExec :: (() -> <Proc> a) -> <Proc> a
366     activateOnce :: Resource -> <Proc> ()
367     syncActivateOnce :: Resource -> <WriteGraph, Proc> ()
368     resourceFromId :: Long -> <ReadGraph> Resource
369     enableDependencies :: () -> <WriteGraph> ()
370     disableDependencies :: () -> <WriteGraph> ()
371     
372     unaryQuery :: (a -> <ReadGraph,e> b) -> a -> <ReadGraph> b
373     unaryQueryCached :: (a -> <ReadGraph,e> b) -> a -> <ReadGraph> b
374
375     "Makes a new read request with given procedure for calculating the result. The request is cached only if the current request is listened."
376     subquery :: (<ReadGraph,Proc> a) -> <ReadGraph,Proc> a
377     "Makes a new read request with given procedure for calculating the result. The request is always cached."
378     subqueryC :: (<ReadGraph,Proc> a) -> <ReadGraph,Proc> a
379     "Makes a new read asynchronous request with function to handle the request result. The last `isDisposed` function parameter is used to determine if the listener is still alive or not."
380     subqueryL :: (<ReadGraph,Proc> a) -> (a -> <ReadGraph, e> ()) -> (Throwable -> <ReadGraph, e> ()) -> (<e> Boolean) -> <ReadGraph, Proc, e> ()
381     "Tries to convert the given Dynamic value to a value with the inferred type"
382     possibleFromDynamic :: Typeable a => String -> Dynamic -> Maybe a
383
384 importJava "org.simantics.db.layer0.util.Layer0Utils" where
385     undo :: () -> <Proc> String
386     undoOperations :: Integer -> <Proc> String
387     redo :: () -> <Proc> String
388     queryDebugSupport :: String -> <Proc> String
389     queryListSupport :: String -> <Proc> String
390     addCommentMetadata :: String -> <WriteGraph> ()
391     sortByCluster :: [a] -> (a->Resource) -> <ReadGraph> [a]
392     makeSynchronous :: Boolean -> <ReadGraph> ()
393     listOntologies :: () -> <ReadGraph> [Resource]
394     emptyTrashBin :: () -> <Proc> ()
395     purgeDatabase :: () -> <Proc> ()
396     prettyPrintResource :: Resource -> Boolean -> <ReadGraph> String
397
398     @private
399     @JavaName copyTo
400     copyTo_ :: Resource -> Resource -> <WriteGraph> Collection Resource
401     @JavaName getPossiblePredicateByName
402     possiblePredicateByName :: Resource -> String -> <ReadGraph> Maybe Resource
403     @JavaName getPossiblePredicateByNameFromType
404     possiblePredicateByNameFromType :: Resource -> String -> <ReadGraph> Maybe Resource
405     
406     addMetadataListener :: ChangeListener -> <Proc> ()
407     removeMetadataListener :: ChangeListener -> <Proc> ()
408
409 copyTo :: Resource -> Resource -> <WriteGraph> Resource
410 copyTo targetContainer source = do
411     (collectionToList $ copyTo_ targetContainer source)!0
412
413 importJava "org.simantics.db.common.utils.CommonDBUtils" where
414     selectClusterSet :: Resource -> <WriteGraph> () 
415
416 importJava "org.simantics.Simantics" where
417     @JavaName getProjectResource
418     currentProject :: () -> /*<Proc>*/ Resource
419
420 // Move to somewhere more generic module
421 importJava "java.util.Collection" where
422     data Collection a
423
424 importJava "java.util.ArrayList" where
425     @JavaName "<init>"
426     collectionToList :: Collection a -> [a]
427 /*@macro
428 collectionToList :: Collection a -> [a]
429 collectionToList x = Java.unsafeCoerce x
430 */ 
431
432 resourceToCollection :: a -> Collection a
433 resourceToCollection x = Java.unsafeCoerce x
434
435 newEntity :: [Resource -> <ReadGraph,WriteGraph> ()] -> <ReadGraph,WriteGraph> Resource
436 newEntity entitySpecs = do
437     entity = newResource ()
438     for entitySpecs (\spec -> spec entity)
439     entity
440
441 updateEntity :: Resource -> [Resource -> <ReadGraph,WriteGraph> ()] -> <ReadGraph,WriteGraph> Resource
442 updateEntity entity entitySpecs = do
443     for entitySpecs (\spec -> spec entity)
444     entity
445
446 hasStatement predicate object entity = 
447     claim entity predicate object
448 hasProperty relation value entity = 
449     claimRelatedValue entity relation value
450 hasPossibleProperty relation value entity =
451     match value with
452       Just v -> claimRelatedValue entity relation v
453       Nothing -> ()
454 hasTypedProperty relation value t entity = 
455     claimRelatedValueWithType entity relation t value        
456 hasName (n :: String) = hasProperty L0.HasName n
457 hasLabel (l :: String) = hasProperty L0.HasLabel l
458 hasType t = hasStatement L0.InstanceOf t
459 hasParent p = hasStatement L0.PartOf p
460
461 importJava "org.simantics.databoard.util.URIStringUtils" where
462     @JavaName splitURISCL
463     splitURI :: String -> [String]
464     @JavaName escape
465     escapeURI :: String -> String
466     @JavaName unescape
467     unescapeURI :: String -> String
468
469 @private
470 importJava "org.simantics.db.layer0.request.ActiveModels" where
471     @JavaName getPossibleActiveModel
472     activeModel :: Resource -> <ReadGraph> Maybe Resource
473
474 "Gives the current active model."
475 currentModel :: <ReadGraph> Resource
476 currentModel = match activeModel (currentProject ()) with
477     Just model -> model
478     Nothing -> fail "No active model."
479
480 "Gives the current active model if it exists or Nothing otherwise."
481 possibleCurrentModel :: <ReadGraph> Maybe Resource
482 possibleCurrentModel = activeModel (currentProject ())
483     
484 startUndoPoint :: String -> <WriteGraph> ()
485 startUndoPoint string = do
486     markUndoPoint ()
487     addCommentMetadata (string)
488     ()
489
490 @inline
491 lift1Read :: (a -> <ReadGraph,Proc> b) -> (a -> <Proc> b)
492 lift1Read f x = syncRead (\_ -> f x)
493
494 @inline
495 lift2Read :: (a -> b -> <ReadGraph,Proc> c) -> (a -> b -> <Proc> c)
496 lift2Read f x y = syncRead (\_ -> f x y)
497
498 @inline
499 lift3Read :: (a -> b -> c -> <ReadGraph,Proc> d) -> (a -> b -> c -> <Proc> d)
500 lift3Read f x y z = syncRead (\_ -> f x y z)
501
502 @inline
503 lift1Write :: (a -> <WriteGraph,Proc> b) -> (a -> <Proc> b)
504 lift1Write f x = syncWrite (\_ -> f x)
505
506 @inline
507 lift2Write :: (a -> b -> <WriteGraph,Proc> c) -> (a -> b -> <Proc> c)
508 lift2Write f x y = syncWrite (\_ -> f x y)
509
510 @inline
511 lift3Write :: (a -> b -> c -> <WriteGraph,Proc> d) -> (a -> b -> c -> <Proc> d)
512 lift3Write f x y z = syncWrite (\_ -> f x y z)
513
514 """
515 Returns a child Browsable of the specified parent that has that is the child
516 of the specified parent with the specified name path.
517 """
518 childWithPath :: Browsable a => a -> [String] -> <ReadGraph> a
519 childWithPath parent path = 
520     foldl (\r name -> match possibleChild r name with
521               Just c -> c
522               Nothing -> fail ("Didn't find " + name + ".") 
523           ) 
524           parent path
525
526 """
527 Like `childWithPath` but returns Maybe a which will be `Nothing` if no child
528 was found.
529 """
530 possibleChildWithPath :: Browsable a => a -> [String] -> <ReadGraph> Maybe a
531 possibleChildWithPath parent path = 
532     foldl (\r name -> match r with
533               Just c -> possibleChild c name
534               Nothing -> Nothing 
535           ) 
536           (Just parent) path
537
538 importJava "org.simantics.db.MetadataI" where
539     data MetadataI
540
541 importJava "org.simantics.db.event.ChangeListener" where
542     data ChangeListener
543
544 importJava "org.simantics.db.layer0.genericrelation.DependencyChanges" where
545     data DependencyChanges