bundles/org.simantics.scl.compiler/src/org/simantics/scl/compiler/elaboration/query/Query.java

   1 package org.simantics.scl.compiler.elaboration.query;
   2
   3 import java.util.ArrayList;
   4 import java.util.Set;
   5
   6 import org.simantics.scl.compiler.common.exceptions.InternalCompilerError;
   7 import org.simantics.scl.compiler.elaboration.contexts.ReplaceContext;
   8 import org.simantics.scl.compiler.elaboration.contexts.TranslationContext;
   9 import org.simantics.scl.compiler.elaboration.contexts.TypingContext;
  10 import org.simantics.scl.compiler.elaboration.expressions.EError;
  11 import org.simantics.scl.compiler.elaboration.expressions.Expression;
  12 import org.simantics.scl.compiler.elaboration.expressions.QueryTransformer;
  13 import org.simantics.scl.compiler.elaboration.expressions.StandardExpressionVisitor;
  14 import org.simantics.scl.compiler.elaboration.expressions.Variable;
  15 import org.simantics.scl.compiler.elaboration.expressions.VariableProcedure;
  16 import org.simantics.scl.compiler.elaboration.expressions.printing.ExpressionToStringVisitor;
  17 import org.simantics.scl.compiler.elaboration.query.compilation.ConstraintCollectionContext;
  18 import org.simantics.scl.compiler.elaboration.query.compilation.DerivateException;
  19 import org.simantics.scl.compiler.elaboration.query.compilation.DynamicProgrammingOrdering;
  20 import org.simantics.scl.compiler.elaboration.query.compilation.EnforcingContext;
  21 import org.simantics.scl.compiler.elaboration.query.compilation.QueryCompilationContext;
  22 import org.simantics.scl.compiler.elaboration.query.compilation.QueryConstraint;
  23 import org.simantics.scl.compiler.elaboration.query.compilation.UnsolvableQueryException;
  24 import org.simantics.scl.compiler.elaboration.relations.CompositeRelation;
  25 import org.simantics.scl.compiler.elaboration.relations.LocalRelation;
  26 import org.simantics.scl.compiler.elaboration.relations.SCLRelation;
  27 import org.simantics.scl.compiler.internal.parsing.Symbol;
  28
  29 import gnu.trove.map.hash.THashMap;
  30 import gnu.trove.map.hash.TIntObjectHashMap;
  31 import gnu.trove.map.hash.TObjectIntHashMap;
  32 import gnu.trove.set.hash.THashSet;
  33 import gnu.trove.set.hash.TIntHashSet;
  34
  35 public abstract class Query extends Symbol {
  36     public static final Query[] EMPTY_ARRAY = new Query[0];
  37
  38     public abstract void collectFreeVariables(THashSet<Variable> vars);
  39     public abstract void collectRefs(TObjectIntHashMap<Object> allRefs, TIntHashSet refs);
  40     public abstract void collectVars(TObjectIntHashMap<Variable> allVars, TIntHashSet vars);
  41     public abstract void checkType(TypingContext context);
  42
  43     public Query resolve(TranslationContext context) {
  44         throw new InternalCompilerError(location, getClass().getSimpleName() + " does not support resolve.");
  45     }
  46
  47     public Expression generateEnforce(EnforcingContext context) {
  48         context.getErrorLog().log(location, getClass().getSimpleName() + " does not support enforcing.");
  49         return new EError(location);
  50     }
  51
  52     public abstract void collectConstraints(ConstraintCollectionContext context) throws UnsolvableQueryException;
  53
  54     protected QueryConstraint[] getOrderedConstraints(QueryCompilationContext context) throws UnsolvableQueryException {
  55         ConstraintCollectionContext collectionContext = new ConstraintCollectionContext(context);
  56         collectConstraints(collectionContext);
  57         QueryConstraint[] constraints = collectionContext.getConstraints();
  58         DynamicProgrammingOrdering.order(collectionContext, constraints, 0L);
  59         return constraints;
  60     }
  61
  62     protected void applyConstraints(QueryCompilationContext context, QueryConstraint[] constraints) {
  63         for(int i=constraints.length-1;i>=0;--i)
  64             constraints[i].generateAndUpdateCost(context);
  65     }
  66
  67     public void generate(QueryCompilationContext context) throws UnsolvableQueryException {
  68         applyConstraints(context, getOrderedConstraints(context));
  69     }
  70
  71     protected static final TIntObjectHashMap<ArrayList<Query>> NO_DERIVATE = new TIntObjectHashMap<ArrayList<Query>>();
  72
  73     public static class Diffable {
  74         public int id;
  75         SCLRelation relation;
  76         public Variable[] parameters;
  77         public Diffable(int id, SCLRelation relation, Variable[] parameters) {
  78             this.id = id;
  79             this.relation = relation;
  80             this.parameters = parameters;
  81         }
  82     }
  83
  84     public static class Diff {
  85         public int id;
  86         public Query query;
  87
  88         public Diff(int id, Query query) {
  89             this.id = id;
  90             this.query = query;
  91         }
  92     }
  93
  94     public static final Diff[] NO_DIFF = new Diff[0];
  95
  96     public Diff[] derivate(THashMap<LocalRelation, Diffable> diffables) throws DerivateException {
  97         throw new DerivateException(location);
  98     }
  99
 100     public static final QDisjunction EMPTY_QUERY = new QDisjunction();
 101
 102     public Query removeRelations(Set<SCLRelation> relations) {
 103         throw new UnsupportedOperationException();
 104     }
 105
 106     public Query copy() {
 107         return replace(new ReplaceContext(null));
 108     }
 109
 110     public Query copy(TypingContext context) {
 111         return replace(new ReplaceContext(context));
 112     }
 113
 114     public abstract Query replace(ReplaceContext context);
 115
 116     public abstract void setLocationDeep(long loc);
 117
 118     public abstract void accept(QueryVisitor visitor);
 119
 120     public void collectRelationRefs(
 121             final TObjectIntHashMap<SCLRelation> allRefs, final TIntHashSet refs) {
 122         accept(new StandardExpressionVisitor() {
 123             @Override
 124             public void visit(QAtom query) {
 125                 visit(query.relation);
 126             }
 127             private void visit(SCLRelation relation) {
 128                 int id = allRefs.get(relation);
 129                 if(id >= 0)
 130                     refs.add(id);
 131                 else if(relation instanceof CompositeRelation)
 132                     for(SCLRelation subrelation : ((CompositeRelation)relation).getSubrelations())
 133                         visit(subrelation);
 134             }
 135         });
 136     }
 137
 138     public abstract void forVariables(VariableProcedure procedure);
 139
 140     public TIntObjectHashMap<ArrayList<Query>> splitToPhases() {
 141         TIntObjectHashMap<ArrayList<Query>> result = new TIntObjectHashMap<ArrayList<Query>>(2);
 142         splitToPhases(result);
 143         return result;
 144     }
 145
 146     public void splitToPhases(TIntObjectHashMap<ArrayList<Query>> result) {
 147         throw new UnsupportedOperationException(getClass().getSimpleName() + " does not support splitToPhases.");
 148     }
 149
 150     @Override
 151     public String toString() {
 152         StringBuilder b = new StringBuilder();
 153         ExpressionToStringVisitor visitor = new ExpressionToStringVisitor(b);
 154         accept(visitor);
 155         return b.toString();
 156     }
 157
 158     public abstract Query accept(QueryTransformer transformer);
 159 }