1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
package org.checkerframework.dataflow.util;
import com.sun.source.tree.MethodTree;
import java.util.ArrayList;
import java.util.List;
import javax.lang.model.element.AnnotationMirror;
import javax.lang.model.element.Element;
import org.checkerframework.dataflow.qual.Deterministic;
import org.checkerframework.dataflow.qual.Pure;
import org.checkerframework.dataflow.qual.Pure.Kind;
import org.checkerframework.dataflow.qual.SideEffectFree;
import org.checkerframework.javacutil.AnnotationProvider;
import org.checkerframework.javacutil.InternalUtils;
/**
* An utility class for working with the {@link SideEffectFree}, {@link Deterministic}, and {@link
* Pure} annotations.
*
* @see SideEffectFree
* @see Deterministic
* @see Pure
* @author Stefan Heule
*/
public class PurityUtils {
/** Does the method {@code tree} have any purity annotation? */
public static boolean hasPurityAnnotation(AnnotationProvider provider, MethodTree tree) {
return !getPurityKinds(provider, tree).isEmpty();
}
/** Does the method {@code methodElement} have any purity annotation? */
public static boolean hasPurityAnnotation(AnnotationProvider provider, Element methodElement) {
return !getPurityKinds(provider, methodElement).isEmpty();
}
/** Is the method {@code tree} deterministic? */
public static boolean isDeterministic(AnnotationProvider provider, MethodTree tree) {
Element methodElement = InternalUtils.symbol(tree);
return isDeterministic(provider, methodElement);
}
/** Is the method {@code methodElement} deterministic? */
public static boolean isDeterministic(AnnotationProvider provider, Element methodElement) {
List<Kind> kinds = getPurityKinds(provider, methodElement);
return kinds.contains(Kind.DETERMINISTIC);
}
/** Is the method {@code tree} side-effect-free? */
public static boolean isSideEffectFree(AnnotationProvider provider, MethodTree tree) {
Element methodElement = InternalUtils.symbol(tree);
return isSideEffectFree(provider, methodElement);
}
/** Is the method {@code methodElement} side-effect-free? */
public static boolean isSideEffectFree(AnnotationProvider provider, Element methodElement) {
List<Kind> kinds = getPurityKinds(provider, methodElement);
return kinds.contains(Kind.SIDE_EFFECT_FREE);
}
/** @return the types of purity of the method {@code tree}. */
public static List<Pure.Kind> getPurityKinds(AnnotationProvider provider, MethodTree tree) {
Element methodElement = InternalUtils.symbol(tree);
return getPurityKinds(provider, methodElement);
}
/**
* @return the types of purity of the method {@code methodElement}. TODO: should the return type
* be an EnumSet?
*/
public static List<Pure.Kind> getPurityKinds(
AnnotationProvider provider, Element methodElement) {
AnnotationMirror pureAnnotation = provider.getDeclAnnotation(methodElement, Pure.class);
AnnotationMirror sefAnnotation =
provider.getDeclAnnotation(methodElement, SideEffectFree.class);
AnnotationMirror detAnnotation =
provider.getDeclAnnotation(methodElement, Deterministic.class);
List<Pure.Kind> kinds = new ArrayList<>();
if (pureAnnotation != null) {
kinds.add(Kind.DETERMINISTIC);
kinds.add(Kind.SIDE_EFFECT_FREE);
}
if (sefAnnotation != null) {
kinds.add(Kind.SIDE_EFFECT_FREE);
}
if (detAnnotation != null) {
kinds.add(Kind.DETERMINISTIC);
}
return kinds;
}
}
|
