aboutsummaryrefslogtreecommitdiffstats
path: root/subprojects/language-ide/src/main/java/tools/refinery/language/ide/contentassist/ProblemCrossrefProposalProvider.java
blob: 8c787dfd5e334517b77d56259908293f4e9ee8b9 (plain) (blame)
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
/*
 * SPDX-FileCopyrightText: 2021-2023 The Refinery Authors <https://refinery.tools/>
 *
 * SPDX-License-Identifier: EPL-2.0
 */
package tools.refinery.language.ide.contentassist;

import com.google.inject.Inject;
import org.eclipse.emf.ecore.EClass;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.EReference;
import org.eclipse.emf.ecore.util.EcoreUtil;
import org.eclipse.xtext.CrossReference;
import org.eclipse.xtext.GrammarUtil;
import org.eclipse.xtext.ide.editor.contentassist.ContentAssistContext;
import org.eclipse.xtext.ide.editor.contentassist.IdeCrossrefProposalProvider;
import org.eclipse.xtext.naming.QualifiedName;
import org.eclipse.xtext.nodemodel.util.NodeModelUtils;
import org.eclipse.xtext.resource.IEObjectDescription;
import org.eclipse.xtext.scoping.IScope;
import org.eclipse.xtext.xtext.CurrentTypeFinder;
import org.jetbrains.annotations.Nullable;
import tools.refinery.language.model.problem.*;
import tools.refinery.language.resource.ProblemResourceDescriptionStrategy;
import tools.refinery.language.utils.BuiltinSymbols;
import tools.refinery.language.utils.ProblemDesugarer;
import tools.refinery.language.utils.ProblemUtil;
import tools.refinery.language.validation.ReferenceCounter;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Objects;

public class ProblemCrossrefProposalProvider extends IdeCrossrefProposalProvider {
	@Inject
	private CurrentTypeFinder currentTypeFinder;

	@Inject
	private ReferenceCounter referenceCounter;

	@Inject
	private ProblemDesugarer desugarer;

	@Override
	protected Iterable<IEObjectDescription> queryScope(IScope scope, CrossReference crossReference,
													   ContentAssistContext context) {
		var eObjectDescriptionsByName = new HashMap<QualifiedName, List<IEObjectDescription>>();
		for (var candidate : super.queryScope(scope, crossReference, context)) {
			if (isExistingObject(candidate, crossReference, context)) {
				// {@code getQualifiedName()} will refer to the full name for objects that are loaded from the global
				// scope, but {@code getName()} returns the qualified name that we set in
				// {@code ProblemResourceDescriptionStrategy}.
				var qualifiedName = candidate.getName();
				var candidateList = eObjectDescriptionsByName.computeIfAbsent(qualifiedName,
						ignored -> new ArrayList<>());
				candidateList.add(candidate);
			}
		}
		var eObjectDescriptions = new ArrayList<IEObjectDescription>();
		for (var candidates : eObjectDescriptionsByName.values()) {
			if (candidates.size() == 1) {
				var candidate = candidates.get(0);
				if (shouldBeVisible(candidate, crossReference, context)) {
					eObjectDescriptions.add(candidate);
				}
			}
		}
		return eObjectDescriptions;
	}

	protected boolean isExistingObject(IEObjectDescription candidate, CrossReference crossRef,
									   ContentAssistContext context) {
		var rootModel = context.getRootModel();
		var eObjectOrProxy = candidate.getEObjectOrProxy();
		if (!Objects.equals(rootModel.eResource(), eObjectOrProxy.eResource())) {
			return true;
		}
		var currentValue = getCurrentValue(crossRef, context);
		if (currentValue == null) {
			return true;
		}
		var eObject = EcoreUtil.resolve(eObjectOrProxy, rootModel);
		if (!Objects.equals(currentValue, eObject)) {
			return true;
		}
		if (!ProblemUtil.isImplicit(eObject)) {
			return true;
		}
		if (rootModel instanceof Problem problem) {
			return referenceCounter.countReferences(problem, eObject) >= 2;
		}
		return true;
	}

	protected boolean shouldBeVisible(IEObjectDescription candidate, CrossReference crossReference,
									  ContentAssistContext context) {
		var errorPredicate = candidate.getUserData(ProblemResourceDescriptionStrategy.ERROR_PREDICATE);
		if (ProblemResourceDescriptionStrategy.ERROR_PREDICATE_TRUE.equals(errorPredicate)) {
			return false;
		}

		var eReference = getEReference(crossReference);
		if (eReference == null) {
			return true;
		}

		var builtinSymbolsOption = desugarer.getBuiltinSymbols(context.getRootModel());
		if (builtinSymbolsOption.isEmpty()) {
			return true;
		}
		var builtinSymbols = builtinSymbolsOption.get();

		var candidateEObjectOrProxy = candidate.getEObjectOrProxy();

		if (eReference.equals(ProblemPackage.Literals.REFERENCE_DECLARATION__REFERENCE_TYPE) &&
				context.getCurrentModel() instanceof ReferenceDeclaration referenceDeclaration &&
				(referenceDeclaration.getKind() == ReferenceKind.CONTAINMENT ||
						referenceDeclaration.getKind() == ReferenceKind.CONTAINER)) {
			// Containment or container references must have a class type.
			// We don't support {@code node} as a container or contained type.
			return ProblemPackage.Literals.CLASS_DECLARATION.isSuperTypeOf(candidate.getEClass()) &&
					!builtinSymbols.node().equals(candidateEObjectOrProxy);
		}

		if (eReference.equals(ProblemPackage.Literals.REFERENCE_DECLARATION__REFERENCE_TYPE) ||
				eReference.equals(ProblemPackage.Literals.PARAMETER__PARAMETER_TYPE) ||
				eReference.equals(ProblemPackage.Literals.TYPE_SCOPE__TARGET_TYPE)) {
			if (builtinSymbols.exists().equals(candidateEObjectOrProxy)) {
				return false;
			}
			var arity = candidate.getUserData(ProblemResourceDescriptionStrategy.ARITY);
			return arity == null || arity.equals("1");
		}

		if (eReference.equals(ProblemPackage.Literals.CLASS_DECLARATION__SUPER_TYPES)) {
			return supertypeShouldBeVisible(candidate, context, builtinSymbols, candidateEObjectOrProxy);
		}

		if (eReference.equals(ProblemPackage.Literals.ASSERTION__RELATION)) {
			// Currently, we don't support assertions on the {@code contains} relation.
			return !builtinSymbols.contains().equals(candidateEObjectOrProxy) &&
					!builtinSymbols.contained().equals(candidateEObjectOrProxy);
		}

		return true;
	}

	private boolean supertypeShouldBeVisible(IEObjectDescription candidate, ContentAssistContext context,
											 BuiltinSymbols builtinSymbols, EObject candidateEObjectOrProxy) {
		if (!ProblemPackage.Literals.CLASS_DECLARATION.isSuperTypeOf(candidate.getEClass()) ||
				builtinSymbols.node().equals(candidateEObjectOrProxy) ||
				builtinSymbols.contained().equals(candidateEObjectOrProxy)) {
			return false;
		}
		if (context.getCurrentModel() instanceof ClassDeclaration classDeclaration &&
				candidateEObjectOrProxy instanceof ClassDeclaration candidateClassDeclaration) {
			return !classDeclaration.equals(candidateClassDeclaration) &&
					!classDeclaration.getSuperTypes().contains(candidateClassDeclaration);
		}
		return true;
	}

	@Nullable
	private EReference getEReference(CrossReference crossReference) {
		var type = currentTypeFinder.findCurrentTypeAfter(crossReference);
		if (!(type instanceof EClass eClass)) {
			return null;
		}
		return GrammarUtil.getReference(crossReference, eClass);
	}

	protected EObject getCurrentValue(CrossReference crossRef, ContentAssistContext context) {
		var value = getCurrentValue(crossRef, context.getCurrentModel());
		if (value != null) {
			return value;
		}
		var currentNodeSemanticObject = NodeModelUtils.findActualSemanticObjectFor(context.getCurrentNode());
		return getCurrentValue(crossRef, currentNodeSemanticObject);
	}

	protected EObject getCurrentValue(CrossReference crossRef, EObject context) {
		if (context == null) {
			return null;
		}
		var eReference = GrammarUtil.getReference(crossRef, context.eClass());
		if (eReference == null || eReference.isMany()) {
			return null;
		}
		return (EObject) context.eGet(eReference);
	}
}