bundles/org.simantics.scl.compiler/src/org/simantics/scl/compiler/elaboration/java/Builtins.java

   1 package org.simantics.scl.compiler.elaboration.java;
   2
   3 import org.cojen.classfile.TypeDesc;
   4 import org.simantics.databoard.binding.mutable.Variant;
   5 import org.simantics.scl.compiler.common.datatypes.Constructor;
   6 import org.simantics.scl.compiler.common.names.Name;
   7 import org.simantics.scl.compiler.common.names.Names;
   8 import org.simantics.scl.compiler.common.precedence.Associativity;
   9 import org.simantics.scl.compiler.common.precedence.Precedence;
  10 import org.simantics.scl.compiler.constants.BooleanConstant;
  11 import org.simantics.scl.compiler.constants.Constant;
  12 import org.simantics.scl.compiler.constants.JavaStaticField;
  13 import org.simantics.scl.compiler.constants.JavaStaticMethod;
  14 import org.simantics.scl.compiler.constants.NoRepConstant;
  15 import org.simantics.scl.compiler.constants.SCLConstant;
  16 import org.simantics.scl.compiler.constants.SCLConstructor;
  17 import org.simantics.scl.compiler.constants.singletons.BindingConstant;
  18 import org.simantics.scl.compiler.constants.singletons.FailFunction;
  19 import org.simantics.scl.compiler.constants.singletons.JustConstant;
  20 import org.simantics.scl.compiler.constants.singletons.NothingConstant;
  21 import org.simantics.scl.compiler.constants.singletons.TypeOfConstant;
  22 import org.simantics.scl.compiler.constants.singletons.TypeOfProxyConstant;
  23 import org.simantics.scl.compiler.constants.singletons.TypeProxyConstant;
  24 import org.simantics.scl.compiler.elaboration.fundeps.Fundep;
  25 import org.simantics.scl.compiler.elaboration.modules.Documentation;
  26 import org.simantics.scl.compiler.elaboration.modules.SCLValue;
  27 import org.simantics.scl.compiler.elaboration.modules.TypeClass;
  28 import org.simantics.scl.compiler.errors.Locations;
  29 import org.simantics.scl.compiler.internal.codegen.effects.EffectConstructor;
  30 import org.simantics.scl.compiler.internal.codegen.references.BoundVar;
  31 import org.simantics.scl.compiler.internal.codegen.ssa.SSABlock;
  32 import org.simantics.scl.compiler.internal.codegen.ssa.SSAFunction;
  33 import org.simantics.scl.compiler.internal.codegen.ssa.exits.Jump;
  34 import org.simantics.scl.compiler.internal.codegen.ssa.statements.LetApply;
  35 import org.simantics.scl.compiler.internal.codegen.types.MaybeType;
  36 import org.simantics.scl.compiler.internal.codegen.types.StandardTypeConstructor;
  37 import org.simantics.scl.compiler.internal.codegen.types.VectorType;
  38 import org.simantics.scl.compiler.internal.codegen.utils.Constants;
  39 import org.simantics.scl.compiler.module.ConcreteModule;
  40 import org.simantics.scl.compiler.types.TApply;
  41 import org.simantics.scl.compiler.types.TCon;
  42 import org.simantics.scl.compiler.types.TFun;
  43 import org.simantics.scl.compiler.types.TPred;
  44 import org.simantics.scl.compiler.types.TUnion;
  45 import org.simantics.scl.compiler.types.TVar;
  46 import org.simantics.scl.compiler.types.Type;
  47 import org.simantics.scl.compiler.types.Types;
  48 import org.simantics.scl.compiler.types.kinds.Kind;
  49 import org.simantics.scl.compiler.types.kinds.Kinds;
  50 import org.simantics.scl.runtime.chr.CHRContext;
  51 import org.simantics.scl.runtime.profiling.BranchPoint;
  52
  53 public class Builtins extends ConcreteModule {
  54
  55     public static final SCLValue[] TUPLE_CONSTRUCTORS = new SCLValue[Constants.MAX_TUPLE_LENGTH+1];
  56     public static final SCLValue[] LIST_CONSTRUCTORS = new SCLValue[Constants.MAX_LIST_LITERAL_LENGTH+1];
  57
  58     public static Builtins INSTANCE = new Builtins();
  59
  60     public static SCLValue Nothing;
  61     public static SCLValue Just;
  62
  63     public static SCLValue EQUALS;
  64
  65     private Builtins() {
  66         super(Types.BUILTIN);
  67
  68         TVar A = Types.var(Kinds.STAR);
  69
  70         StandardTypeConstructor Boolean = new StandardTypeConstructor(Types.BOOLEAN, Kinds.STAR, TypeDesc.BOOLEAN);
  71         Boolean.documentation = "Data type representing truth values `True` and `False`.";
  72         addTypeDescriptor("Boolean", Boolean);
  73         addTypeDescriptor("Byte", new StandardTypeConstructor(Types.BYTE, Kinds.STAR, TypeDesc.BYTE,
  74                 "8-bit signed integer"));
  75         addTypeDescriptor("Character", new StandardTypeConstructor(Types.CHARACTER, Kinds.STAR, TypeDesc.CHAR,
  76                 "16-bit Unicode character."));
  77         addTypeDescriptor("Short", new StandardTypeConstructor(Types.SHORT, Kinds.STAR, TypeDesc.SHORT,
  78                 "16-bit signed integer"));
  79         addTypeDescriptor("Integer", new StandardTypeConstructor(Types.INTEGER, Kinds.STAR, TypeDesc.INT,
  80                 "32-bit signed integer"));
  81         addTypeDescriptor("Long", new StandardTypeConstructor(Types.LONG, Kinds.STAR, TypeDesc.LONG,
  82                 "64-bit signed integer"));
  83         addTypeDescriptor("Float", new StandardTypeConstructor(Types.FLOAT, Kinds.STAR, TypeDesc.FLOAT,
  84                 "32-bit floating point number"));
  85         addTypeDescriptor("Double", new StandardTypeConstructor(Types.DOUBLE, Kinds.STAR, TypeDesc.DOUBLE,
  86                 "64-bit floating point number"));
  87         addTypeDescriptor("String", new StandardTypeConstructor(Types.STRING, Kinds.STAR, TypeDesc.STRING,
  88                 "Unicode string"));
  89
  90         addTypeDescriptor("BooleanArray", new StandardTypeConstructor(Types.BOOLEAN_ARRAY, Kinds.STAR, TypeDesc.forClass(boolean[].class)));
  91         addTypeDescriptor("ByteArray", new StandardTypeConstructor(Types.BYTE_ARRAY, Kinds.STAR, TypeDesc.forClass(byte[].class)));
  92         addTypeDescriptor("CharacterArray", new StandardTypeConstructor(Types.CHARACTER_ARRAY, Kinds.STAR, TypeDesc.forClass(char[].class)));
  93         addTypeDescriptor("ShortArray", new StandardTypeConstructor(Types.SHORT_ARRAY, Kinds.STAR, TypeDesc.forClass(short[].class)));
  94         addTypeDescriptor("IntegerArray", new StandardTypeConstructor(Types.INTEGER_ARRAY, Kinds.STAR, TypeDesc.forClass(int[].class)));
  95         addTypeDescriptor("LongArray", new StandardTypeConstructor(Types.LONG_ARRAY, Kinds.STAR, TypeDesc.forClass(long[].class)));
  96         addTypeDescriptor("FloatArray", new StandardTypeConstructor(Types.FLOAT_ARRAY, Kinds.STAR, TypeDesc.forClass(float[].class)));
  97         addTypeDescriptor("DoubleArray", new StandardTypeConstructor(Types.DOUBLE_ARRAY, Kinds.STAR, TypeDesc.forClass(double[].class)));
  98
  99         addTypeDescriptor("Array", new StandardTypeConstructor(Types.con(Types.BUILTIN, "Array"), Kinds.STAR_TO_STAR, TypeDesc.forClass(Object[].class)));
 100
 101         addTypeDescriptor("Maybe", MaybeType.INSTANCE);
 102
 103         addTypeDescriptor("Variant", new StandardTypeConstructor(Types.VARIANT, Kinds.STAR, TypeDesc.forClass(Variant.class)));
 104
 105         addEffectConstructor("Proc", new EffectConstructor(Types.PROC));
 106
 107         //addTypeDescriptor("->", new StandardTypeConstructor(Kinds.STAR_TO_STAR_TO_STAR, Constants.FUNCTION));
 108         addTypeDescriptor("[]", new StandardTypeConstructor(Types.LIST, Kinds.STAR_TO_STAR, Constants.LIST));
 109         addTypeDescriptor("@", new StandardTypeConstructor(Types.PUNIT, Kinds.STAR, Constants.TUPLE[0]));
 110         addTypeDescriptor("TypeProxy", new StandardTypeConstructor(Types.TYPE_PROXY, Kinds.STAR_TO_STAR, Constants.TUPLE[0]));
 111
 112         // *** Tuples ***
 113
 114         Kind tupleKind = Kinds.STAR;
 115         for(int arity=0;arity<=Constants.MAX_TUPLE_LENGTH;++arity) {
 116             if(arity != 1) {
 117                 TVar[] vars = new TVar[arity];
 118                 for(int i=0;i<vars.length;++i)
 119                     vars[i] = Types.var(Kinds.STAR);
 120                 TCon constructor = Types.tupleConstructor(arity);
 121                 StandardTypeConstructor typeConstructor =
 122                         new StandardTypeConstructor(constructor, tupleKind, Constants.TUPLE[arity]);
 123                 addTypeDescriptor(constructor.name, typeConstructor);
 124                 Type returnType = Types.apply(constructor, vars);
 125                 typeConstructor.setType(constructor, vars);
 126                 Constant cons;
 127                 String javaName = "org/simantics/scl/runtime/tuple/Tuple"+arity;
 128                 if(arity == 0) {
 129                     cons = new NoRepConstant(returnType);
 130                     typeConstructor.setConstructors(new Constructor(Locations.NO_LOCATION, typeConstructor,
 131                             Name.create(Types.BUILTIN, constructor.name),
 132                             vars, javaName)
 133                             );
 134                 }
 135                 else {
 136                     cons = new SCLConstructor(constructor.name,
 137                             javaName, vars, 0, returnType, vars);
 138                     typeConstructor.setConstructors(
 139                             new Constructor(Locations.NO_LOCATION, typeConstructor,
 140                                     Name.create(Types.BUILTIN, constructor.name),
 141                                     vars, javaName)
 142                             );
 143                 }
 144                 typeConstructor.isOpen = false;
 145                 SCLValue value = new SCLValue(Name.create(Types.BUILTIN, constructor.name), cons);
 146                 addValue(value);
 147                 TUPLE_CONSTRUCTORS[arity] = value;
 148             }
 149             tupleKind = Kinds.arrow(Kinds.STAR, tupleKind);
 150         }
 151
 152         // *** Lists ***
 153
 154         for(int arity=0;arity<=Constants.MAX_LIST_LITERAL_LENGTH;++arity) {
 155             LIST_CONSTRUCTORS[arity] = addValue("_list_literal_" + arity + "_",
 156                     arity == 0 ? new EmptyListConstructor() :
 157                         new ListConstructor(arity)
 158                     );
 159         }
 160
 161         // *** Boolean ***
 162
 163         SCLValue True = addValue("True", new BooleanConstant(true));
 164         SCLValue False = addValue("False", new BooleanConstant(false));
 165         Boolean.setConstructors(
 166                 new Constructor(Locations.NO_LOCATION, Boolean, False.getName(), Type.EMPTY_ARRAY, null),
 167                 new Constructor(Locations.NO_LOCATION, Boolean, True.getName(), Type.EMPTY_ARRAY, null)
 168                 );
 169         Boolean.isOpen = false;
 170
 171         // *** Maybe ***
 172
 173         Nothing = addValue("Nothing", NothingConstant.INSTANCE);
 174         Just = addValue("Just", JustConstant.INSTANCE);
 175         MaybeType.INSTANCE.setConstructors(
 176                 new Constructor(Locations.NO_LOCATION, MaybeType.INSTANCE, Nothing.getName(), Type.EMPTY_ARRAY, null),
 177                 new Constructor(Locations.NO_LOCATION, MaybeType.INSTANCE, Just.getName(), new Type[] {MaybeType.INSTANCE.parameters[0]}, null)
 178                 );
 179
 180         // *** Vector ***
 181
 182         TypeClass VecCompC = new TypeClass(Locations.NO_LOCATION,
 183                 TPred.EMPTY_ARRAY,
 184                 Types.VEC_COMP,
 185                 "java/lang/Class",
 186                 new TVar[] {A},
 187                 Fundep.EMPTY_ARRAY);
 188         addTypeClass("VecComp", VecCompC);
 189
 190         addTypeDescriptor("Vector", new VectorType(Types.VECTOR));
 191         addValue("getVector", new GetVector(Types.NO_EFFECTS, Types.VECTOR));
 192         addValue("lengthVector", new LengthVector(Types.VECTOR));
 193         //addValue("createVectorFromList", CreateVectorFromList.INSTANCE);
 194
 195         addTypeDescriptor("MVector", new VectorType(Types.MVECTOR));
 196         addValue("createMVector", CreateMVector.INSTANCE);
 197         addValue("createMVectorProto", CreateMVectorProto.INSTANCE);
 198         addValue("getMVector", new GetVector(Types.PROC, Types.MVECTOR));
 199         addValue("lengthMVector", new LengthVector(Types.MVECTOR));
 200         addValue("freezeMVector", new FreezeMVector());
 201         addValue("setMVector", SetMVector.INSTANCE);
 202
 203         // *** fail ***
 204
 205         addValue("fail", FailFunction.INSTANCE).documentation =
 206                 "Throws a runtime exeception with the given string as a description.";
 207
 208         // *** runProc ***
 209
 210         {
 211             TVar a = Types.var(Kinds.STAR);
 212             TVar e = Types.var(Kinds.EFFECT);
 213             SSAFunction runProcFunction = new SSAFunction(new TVar[] {a,e}, e, a);
 214             Type parameterType = Types.functionE(Types.PUNIT, Types.union(new Type[] {Types.PROC,e}), a);
 215             SSABlock block = new SSABlock(parameterType);
 216             BoundVar[] parameters = block.getParameters();
 217
 218             BoundVar x = new BoundVar(a);
 219             LetApply apply = new LetApply(x, Types.PROC, parameters[0].createOccurrence(),
 220                     new NoRepConstant(Types.PUNIT).createOccurrence()
 221                     );
 222             block.addStatement(apply);
 223
 224             block.setExit(new Jump(runProcFunction.getReturnCont().createOccurrence(),
 225                     x.createOccurrence()));
 226
 227             runProcFunction.addBlock(block);
 228             SCLConstant runProc = new SCLConstant(Names.Builtin_runProc, runProcFunction.getType());
 229             runProc.setDefinition(runProcFunction);
 230             runProc.setInlineArity(1, 0xffffffff);
 231             runProc.setBase(new JavaStaticMethod("org/simantics/scl/runtime/procedure/Procedures",
 232                     "runProc", a, parameterType));
 233             addValue("runProc", runProc);
 234         }
 235
 236         // *** Typeable ***
 237
 238         {
 239             /* class Typeable a
 240              */
 241             TypeClass TypeableC = new TypeClass(Locations.NO_LOCATION,
 242                     TPred.EMPTY_ARRAY,
 243                     Types.TYPEABLE,
 244                     Type.class.getName(),
 245                     new TVar[] {A},
 246                     Fundep.EMPTY_ARRAY);
 247             TypeableC.documentation = "A class of types that can be reified with `typeOf` function.";
 248             addTypeClass("Typeable", TypeableC);
 249
 250             /* data Type = TCon String String
 251              *           | TApply Type Type
 252              */
 253             final TCon Type = Types.con(Types.BUILTIN, "Type");
 254             final TypeDesc TypeD = TypeDesc.forClass(Type.class);
 255             addValue("TCon", new JavaStaticMethod(
 256                     Types.class.getName().replace('.', '/'),
 257                     "con",
 258                     TypeDesc.forClass(TCon.class), new TypeDesc[] {TypeDesc.STRING, TypeDesc.STRING},
 259                     Type, Types.STRING, Types.STRING));
 260             addValue("TApply", new JavaStaticMethod(
 261                     "org/simantics/scl/compiler/types/Types",
 262                     "apply",
 263                     TypeDesc.forClass(TApply.class), new TypeDesc[] {TypeD, TypeD},
 264                     Type, Type, Type));
 265             addValue("TFun", new JavaStaticMethod(
 266                     "org/simantics/scl/compiler/types/Types",
 267                     "functionE",
 268                     TypeDesc.forClass(TFun.class), new TypeDesc[] {TypeD, TypeD, TypeD},
 269                     Type, Type, Type, Type));
 270             addValue("TPure", new JavaStaticField(
 271                     "org/simantics/scl/compiler/types/Types",
 272                     "NO_EFFECTS",
 273                     Types.NO_EFFECTS,
 274                     TypeDesc.forClass(TUnion.class),
 275                     Type, -1));
 276             addValue("TUnion2", new JavaStaticMethod(
 277                     "org/simantics/scl/compiler/types/Types",
 278                     "union",
 279                     Types.NO_EFFECTS,
 280                     Type, Type, Type));
 281
 282             StandardTypeConstructor TypeC = new StandardTypeConstructor(Type, Kinds.STAR,
 283                     TypeDesc.forClass("org/simantics/scl/compiler/types/Type"));
 284             TypeC.setType(Type);
 285             TypeC.isOpen = true;
 286             TypeC.documentation = "Represents an SCL data type.";
 287             addTypeDescriptor("Type", TypeC);
 288
 289             // typeOf :: Typeable a => a -> Type
 290             addValue("typeOf", TypeOfConstant.INSTANCE)
 291             .documentation = "Returns the type of the value given as a parameter.";
 292             addValue("typeOfProxy", TypeOfProxyConstant.INSTANCE)
 293             .documentation = "Returns the type of the type proxy given as a parameter.";
 294             addValue("TypeProxy", TypeProxyConstant.INSTANCE);
 295         }
 296
 297         // *** Serializable ***
 298
 299         {
 300             /* class Serializable a
 301              */
 302             TypeClass SerializableC = new TypeClass(Locations.NO_LOCATION,
 303                     TPred.EMPTY_ARRAY,
 304                     Types.SERIALIZABLE,
 305                     "org/simantics/databoard/binding/Binding",
 306                     new TVar[] {A},
 307                     Fundep.EMPTY_ARRAY);
 308             SerializableC.documentation = "A class of types having a `Binding`";
 309             addTypeClass("Serializable", SerializableC);
 310
 311             /* data TypeRep = TCon String
 312              *              | TApply TypeRep TypeRep
 313              */
 314
 315             StandardTypeConstructor BindingC = new StandardTypeConstructor(Types.BINDING, Kinds.STAR_TO_STAR,
 316                     TypeDesc.forClass("org/simantics/databoard/binding/Binding"));
 317             BindingC.setType(Types.BINDING, A);
 318             BindingC.documentation = "`Binding` represents a data type in the form supported by Databoard library. " +
 319                     "It is used to serialize and deserialize values.";
 320             addTypeDescriptor("Binding", BindingC);
 321
 322             // typeOf :: Typeable a => a -> TypeReps
 323             addValue("binding", BindingConstant.INSTANCE)
 324             .documentation = "Gives a binding for the required type.";
 325
 326         }
 327
 328         // Relations
 329
 330         {
 331             addRelation("Eq", EqRelation.INSTANCE);
 332             addRelation("Optional", OptionalRelation.INSTANCE);
 333             addRelation("Execute", new ExecuteRelation(0));
 334             addRelation("Execute10", new ExecuteRelation(10));
 335         }
 336
 337         {
 338             EQUALS = new SCLValue(Names.Builtin_equals, EqualsFunction.INSTANCE);
 339             EQUALS.setPrecedence(new Precedence(4, Associativity.NONASSOC));
 340             addValue(EQUALS);
 341             addValue("hashCode", HashCodeFunction.INSTANCE);
 342         }
 343
 344         // Coverage
 345         {
 346             StandardTypeConstructor branchPoint = new StandardTypeConstructor(Types.BRANCH_POINT, Kinds.STAR,
 347                     TypeDesc.forClass(BranchPoint.class));
 348             addTypeDescriptor("BranchPoint", branchPoint);
 349
 350             addValue("visitBranchPoint", VisitBranchPoint.INSTANCE);
 351         }
 352
 353         setParentClassLoader(getClass().getClassLoader());
 354
 355         // CHR
 356
 357         addTypeDescriptor("CHRContext", new StandardTypeConstructor(Types.CHRContext, Kinds.STAR, TypeDesc.forClass(CHRContext.class)));
 358     }
 359
 360     @Override
 361     public Documentation getDocumentation() {
 362         return documentation;
 363     }
 364
 365         public static void flush() {
 366                 INSTANCE = new Builtins();
 367         }
 368
 369 }