bundles/org.simantics.scl.runtime/scl/Databoard.scl

   1 import "Prelude"\r
   2 import "Random"\r
   3 \r
   4 /// Datatype ///\r
   5 \r
   6 "A data type component with component name and data type"\r
   7 @JavaType "org.simantics.databoard.type.Component"\r
   8 @FieldNames [name, "type"]\r
   9 data DatatypeComponent = DatatypeComponent String Datatype\r
  10 \r
  11 """A data type that represents the data types supported by the Simantics\r
  12 Databoard plugin."""\r
  13 @JavaType "org.simantics.databoard.type.Datatype"\r
  14 data Datatype =\r
  15     @JavaType "org.simantics.databoard.type.BooleanType"\r
  16     BooleanType\r
  17   | @JavaType "org.simantics.databoard.type.ByteType"\r
  18     ByteType\r
  19   | @JavaType "org.simantics.databoard.type.IntegerType"\r
  20     IntegerType\r
  21   | @JavaType "org.simantics.databoard.type.LongType"\r
  22     LongType\r
  23   | @JavaType "org.simantics.databoard.type.FloatType"\r
  24     FloatType\r
  25   | @JavaType "org.simantics.databoard.type.DoubleType"\r
  26     DoubleType\r
  27   | @JavaType "org.simantics.databoard.type.StringType"\r
  28     StringType\r
  29   | @JavaType "org.simantics.databoard.type.ArrayType"\r
  30     @FieldNames [componentType]\r
  31     ArrayType Datatype\r
  32   | @JavaType "org.simantics.databoard.type.OptionalType"\r
  33     @FieldNames [componentType]\r
  34     OptionalType Datatype\r
  35   | @JavaType "org.simantics.databoard.type.MapType"\r
  36     @FieldNames [keyType, valueType]\r
  37     MapType Datatype Datatype\r
  38   | @JavaType "org.simantics.databoard.type.RecordType"\r
  39     @FieldNames [components]\r
  40     RecordType (Vector DatatypeComponent)\r
  41   | @JavaType "org.simantics.databoard.type.UntionType"\r
  42     @FieldNames [components]\r
  43     UnionType (Vector DatatypeComponent)\r
  44   | @JavaType "org.simantics.databoard.type.VariantType"\r
  45     VariantType\r
  46 \r
  47 importJava "org.simantics.databoard.type.Datatype" where\r
  48     @private\r
  49     @JavaName toString\r
  50     showDatatype :: Datatype -> String\r
  51     \r
  52     "Get the number of type components in an data type"\r
  53     @JavaName getComponentCount\r
  54     datatypeCompnentCount :: Datatype -> Integer\r
  55 \r
  56     "Get a component type of a composite data type"\r
  57     @JavaName getComponentType\r
  58     datatypeComponentType :: Datatype -> ChildReference -> Datatype\r
  59 \r
  60 \r
  61 instance Show Datatype where\r
  62     show = showDatatype\r
  63 \r
  64 /// Binding ///\r
  65 \r
  66 importJava "org.simantics.databoard.binding.Binding" where\r
  67     "Check whether a dynamic object is an instance of a given binding"\r
  68     @JavaName isInstance\r
  69     isBindingInstance :: Binding Dynamic -> Dynamic -> Boolean\r
  70 \r
  71     "Create a serializable object from a textual representation"\r
  72     parseValueDefinition :: Serializable a => String -> a\r
  73     \r
  74     "Compare two serializable objects\n\nResult is -1, 0 or 1 depending the partial ordering of the objects."\r
  75     @JavaName compare\r
  76     compareObjects :: Serializable a => a -> a -> Integer\r
  77 \r
  78     "The default value of a serializable type"\r
  79     @JavaName createDefault\r
  80     serializableDefaultValue :: Serializable a => a\r
  81     \r
  82     "Create a random value of a serializable type"\r
  83     @JavaName createRandom\r
  84     serializableRandomValue :: Serializable a => <Random> a\r
  85     \r
  86     "Get a textual representation of a serializable value"\r
  87     @JavaName toString\r
  88     showSerializable :: Serializable a => a -> String\r
  89     \r
  90     @private\r
  91     @JavaName getComponent \r
  92     getSerializableComponent_ :: Serializable a => a -> ChildReference -> Binding b -> b \r
  93 \r
  94     "Get a component binding"\r
  95     @JavaName getComponentBinding\r
  96     getComponentBinding :: Binding a -> ChildReference -> Binding b\r
  97     \r
  98 "Get a child data component of a composite serializable value"\r
  99 getSerializableComponent :: Serializable a => Serializable b => a -> ChildReference -> b\r
 100 getSerializableComponent object ref = getSerializableComponent_ object ref binding\r
 101 \r
 102 /// Serializer ///\r
 103 \r
 104 importJava "org.simantics.databoard.serialization.Serializer" where\r
 105     "A data serializer for SCL type a" \r
 106     data Serializer a\r
 107 \r
 108     @private\r
 109     @JavaName "serialize"    \r
 110     serialize_ :: Serializer a -> a -> ByteArray\r
 111     \r
 112     @private\r
 113     @JavaName "deserialize"\r
 114     deserialize_ :: Serializer a -> ByteArray -> a\r
 115 \r
 116 importJava "org.simantics.databoard.Bindings" where\r
 117     @private\r
 118     @JavaName "getSerializer"\r
 119     serializerOf :: Binding a -> Serializer a\r
 120     \r
 121     @private\r
 122     @JavaName toString\r
 123     bindingToString :: Binding a -> String\r
 124 \r
 125     "Adapt between types using explicitly provided binding objects: `adapt_ value from to`"\r
 126     @JavaName adapt\r
 127     adapt_ :: a -> Binding a -> Binding b -> b\r
 128     \r
 129 "Adapt value from one serializable type to another"\r
 130 adapt :: Serializable a => Serializable b => a -> b\r
 131 adapt x = adapt_ x binding binding\r
 132     \r
 133 instance Show (Binding a) where\r
 134     show = bindingToString\r
 135 \r
 136 "Serializes a value to a byte array using default serializer."\r
 137 serialize :: Serializable a => a -> ByteArray\r
 138 serialize v = serialize_ (serializerOf binding) v\r
 139 \r
 140 "Deserializes a value from a byte array using default serializer."\r
 141 deserialize :: Serializable a => ByteArray -> a\r
 142 deserialize ba = deserialize_ (serializerOf binding) ba\r
 143 \r
 144 importJava "org.simantics.databoard.Bindings" where\r
 145     "Get a default binding for a given data type" \r
 146     @JavaName getBinding    \r
 147     datatypeBinding :: Datatype -> Binding Dynamic\r
 148 \r
 149 importJava "org.simantics.databoard.Datatypes" where\r
 150     "Get a data type from a string representation"\r
 151     @JavaName translate\r
 152     translateDatatype :: String -> Datatype\r
 153 \r
 154 importJava "org.simantics.databoard.binding.mutable.Variant" where\r
 155     // data Variant (in Builtins)\r
 156     "Create a variant using an explicitly provided binding value (unchecked cast)"\r
 157     @JavaName "<init>"\r
 158     createVariant_ :: Binding Dynamic -> Dynamic -> Variant\r
 159     \r
 160     "Get the data type of a variant object"\r
 161     @JavaName "type"\r
 162     variantDatatype :: Variant -> Datatype\r
 163     \r
 164     "Get raw value contained by a variant (unchecked cast)"\r
 165     @JavaName getValue\r
 166     rawVariantValue :: Variant -> a\r
 167     \r
 168     "Create a variant from a raw object (based on Java class)"\r
 169     @JavaName ofInstance\r
 170     variantOf :: a -> Variant\r
 171     \r
 172     "Create a variant with explicitly provided binding and value"\r
 173     @JavaName "<init>"\r
 174     variant_ :: Binding a -> a -> Variant\r
 175     \r
 176     "Get value from a variant using a given binding"\r
 177     @JavaName getValue\r
 178     variantValue_ :: Variant -> Binding a -> a\r
 179     \r
 180     @private\r
 181     @JavaName toString\r
 182     showVariant :: Variant -> String\r
 183     \r
 184     "Get a component of compound data value in a variant"\r
 185     @JavaName getComponent\r
 186     variantComponent :: Variant -> ChildReference -> Variant\r
 187 \r
 188 "Create a variant of a given data type from an object in the default binding (unchecked, use with extreme caution)"\r
 189 createVariant :: Datatype -> Dynamic -> Variant\r
 190 createVariant dt v = createVariant_ (datatypeBinding dt) v\r
 191 \r
 192 "Create a variant from a serializable value"\r
 193 variant :: Serializable a => a -> Variant\r
 194 variant v = variant_ binding v\r
 195 \r
 196 "Get the value of a variant in a serializable type"\r
 197 variantValue :: Serializable a => Variant -> a\r
 198 variantValue v = variantValue_ v binding\r
 199 \r
 200 instance Show Variant where\r
 201     show = showVariant\r
 202 \r
 203 "Get an element of a compound variant value using an index reference" \r
 204 variantElement :: Serializable a => Variant -> Integer -> a\r
 205 variantElement v i = variantValue (variantComponent v (indexReference i))\r
 206 \r
 207 importJava "org.simantics.databoard.accessor.reference.ChildReference" where\r
 208     "A reference to a child element in a composite data type/binding or value"\r
 209     data ChildReference\r
 210 \r
 211     "Combine a list of child data object references into a single path reference"\r
 212     @JavaName compile    \r
 213     compileReference :: [ChildReference] -> ChildReference\r
 214 \r
 215 importJava "org.simantics.databoard.accessor.reference.IndexReference" where\r
 216     """Get a reference to a child data object using an index (zero-based)\r
 217 * Element index of an array object\r
 218 * Field index of a record or union type\r
 219 * 0:\r
 220   * Key component of a map type/binding\r
 221   * Component of any single-component type/binding (optional, array)\r
 222   * Contained value/type of any single-element object (optional, union, variant)\r
 223 * 1:\r
 224   * Value component of a map type/binding\r
 225     """\r
 226     @JavaName "<init>"\r
 227     indexReference :: Integer -> ChildReference\r
 228 \r
 229 importJava "org.simantics.databoard.accessor.reference.KeyReference" where\r
 230     """Get a reference to a MapType child data object using a given key value\r
 231 * Contained value of a map object for a given key value\r
 232     """\r
 233     @JavaName "<init>"\r
 234     keyReference :: Variant -> ChildReference\r
 235 \r
 236 importJava "org.simantics.databoard.accessor.reference.NameReference" where\r
 237     """Get a reference to a child data object using a field name\r
 238 * A component name of a record or union data type/binding\r
 239 * "key": The key component of a map data type/binding\r
 240 * "value": The value component of a map data type/binding\r
 241     """\r
 242     @JavaName "<init>"\r
 243     nameReference :: String -> ChildReference\r
 244     \r
 245 importJava "org.simantics.databoard.accessor.reference.LabelReference" where\r
 246     """Get a reference to a child data object using a label\r
 247 * A component name of a record or union data type/binding\r
 248 * A string representation of the index of a record or union data type/binding component\r
 249 * "v": The component type of an array/optional data type/binding\r
 250 * "0"/"key": The key component of a map data type/binding\r
 251 * "1"/"value": The value component of a map data type/binding\r
 252     """\r
 253     @JavaName "<init>"\r
 254     labelReference :: String -> ChildReference\r
 255 \r
 256 importJava "org.simantics.databoard.accessor.reference.ComponentReference" where\r
 257     """Get a reference to a component child data object\r
 258 * Component of an array/optional data type/binding\r
 259 * Contained value of an optional/variant/union object\r
 260     """\r
 261     @JavaName "<init>"\r
 262     componentReference :: ChildReference\r