1 files changed, 130 insertions, 0 deletions
diff --git a/third_party/checker_framework_dataflow/java/org/checkerframework/dataflow/analysis/RegularTransferResult.java b/third_party/checker_framework_dataflow/java/org/checkerframework/dataflow/analysis/RegularTransferResult.java
new file mode 100644
index 0000000000..8872e7f808
--- /dev/null
+++ b/third_party/checker_framework_dataflow/java/org/checkerframework/dataflow/analysis/RegularTransferResult.java
@@ -0,0 +1,130 @@
+package org.checkerframework.dataflow.analysis;
+
+import java.util.Map;
+
+import javax.lang.model.type.TypeMirror;
+
+/**
+ * Implementation of a {@link TransferResult} with just one non-exceptional
+ * store. The result of {@code getThenStore} and {@code getElseStore} is equal
+ * to the only underlying store.
+ *
+ * @author Stefan Heule
+ *
+ * @param <S>
+ *            The {@link Store} used to keep track of intermediate results.
+ */
+public class RegularTransferResult<A extends AbstractValue<A>, S extends Store<S>>
+        extends TransferResult<A, S> {
+
+    /** The regular result store. */
+    protected S store;
+    final private boolean storeChanged;
+
+    /**
+     * Create a {@code TransferResult} with {@code resultStore} as the resulting
+     * store. If the corresponding {@link org.checkerframework.dataflow.cfg.node.Node} is a boolean node, then
+     * {@code resultStore} is used for both the 'then' and 'else' edge.
+     *
+     * <p>
+     *
+     * <em>Exceptions</em>: If the corresponding {@link org.checkerframework.dataflow.cfg.node.Node} throws an
+     * exception, then it is assumed that no special handling is necessary and
+     * the store before the corresponding {@link org.checkerframework.dataflow.cfg.node.Node} will be passed along any
+     * exceptional edge.
+     *
+     * <p>
+     *
+     * <em>Aliasing</em>: {@code resultStore} is not allowed to be used anywhere
+     * outside of this class (including use through aliases). Complete control
+     * over the object is transfered to this class.
+     */
+    public RegularTransferResult(A value, S resultStore, boolean storeChanged) {
+        super(value);
+        this.store = resultStore;
+        this.storeChanged = storeChanged;
+    }
+
+    public RegularTransferResult(A value, S resultStore) {
+        this(value, resultStore, false);
+    }
+
+    /**
+     * Create a {@code TransferResult} with {@code resultStore} as the resulting
+     * store. If the corresponding {@link org.checkerframework.dataflow.cfg.node.Node} is a boolean node, then
+     * {@code resultStore} is used for both the 'then' and 'else' edge.
+     *
+     * For the meaning of storeChanged, see
+     * {@link org.checkerframework.dataflow.analysis.TransferResult#storeChanged}.
+     *
+     * <p>
+     *
+     * <em>Exceptions</em>: If the corresponding {@link org.checkerframework.dataflow.cfg.node.Node} throws an
+     * exception, then the corresponding store in {@code exceptionalStores} is
+     * used. If no exception is found in {@code exceptionalStores}, then it is
+     * assumed that no special handling is necessary and the store before the
+     * corresponding {@link org.checkerframework.dataflow.cfg.node.Node} will be passed along any exceptional edge.
+     *
+     * <p>
+     *
+     * <em>Aliasing</em>: {@code resultStore} and any store in
+     * {@code exceptionalStores} are not allowed to be used anywhere outside of
+     * this class (including use through aliases). Complete control over the
+     * objects is transfered to this class.
+     */
+    public RegularTransferResult(A value, S resultStore,
+            Map<TypeMirror, S> exceptionalStores, boolean storeChanged) {
+        super(value);
+        this.store = resultStore;
+        this.storeChanged = storeChanged;
+        this.exceptionalStores = exceptionalStores;
+    }
+
+    public RegularTransferResult(A value, S resultStore,
+        Map<TypeMirror, S> exceptionalStores) {
+        this(value, resultStore, exceptionalStores, false);
+    }
+
+    @Override
+    public S getRegularStore() {
+        return store;
+    }
+
+    @Override
+    public S getThenStore() {
+        return store;
+    }
+
+    @Override
+    public S getElseStore() {
+        // copy the store such that it is the same as the result of getThenStore
+        // (that is, identical according to equals), but two different objects.
+        return store.copy();
+    }
+
+    @Override
+    public boolean containsTwoStores() {
+        return false;
+    }
+
+    @Override
+    public String toString() {
+        StringBuilder result = new StringBuilder();
+        result.append("RegularTransferResult(");
+        result.append(System.getProperty("line.separator"));
+        result.append("resultValue = " + resultValue);
+        result.append(System.getProperty("line.separator"));
+        result.append("store = " + store);
+        result.append(System.getProperty("line.separator"));
+        result.append(")");
+        return result.toString();
+    }
+
+    /**
+     * @see org.checkerframework.dataflow.analysis.TransferResult#storeChanged()
+     */
+    @Override
+    public boolean storeChanged() {
+      return storeChanged;
+    }
+}