VerifyQuickfixProvider.java
/**
* Copyright (c) 2004-2025 Carnegie Mellon University and others. (see Contributors file).
* All Rights Reserved.
*
* NO WARRANTY. ALL MATERIAL IS FURNISHED ON AN "AS-IS" BASIS. CARNEGIE MELLON UNIVERSITY MAKES NO WARRANTIES OF ANY
* KIND, EITHER EXPRESSED OR IMPLIED, AS TO ANY MATTER INCLUDING, BUT NOT LIMITED TO, WARRANTY OF FITNESS FOR PURPOSE
* OR MERCHANTABILITY, EXCLUSIVITY, OR RESULTS OBTAINED FROM USE OF THE MATERIAL. CARNEGIE MELLON UNIVERSITY DOES NOT
* MAKE ANY WARRANTY OF ANY KIND WITH RESPECT TO FREEDOM FROM PATENT, TRADEMARK, OR COPYRIGHT INFRINGEMENT.
*
* This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0
* which is available at https://www.eclipse.org/legal/epl-2.0/
* SPDX-License-Identifier: EPL-2.0
*
* Created, in part, with funding and support from the United States Government. (see Acknowledgments file).
*
* This program includes and/or can make use of certain third party source code, object code, documentation and other
* files ("Third Party Software"). The Third Party Software that is used by this program is dependent upon your system
* configuration. By using this program, You agree to comply with any and all relevant Third Party Software terms and
* conditions contained in any such Third Party Software or separate license file distributed with such Third Party
* Software. The parties who own the Third Party Software ("Third Party Licensors") are intended third party benefici-
* aries to this license with respect to the terms applicable to their Third Party Software. Third Party Software li-
* censes only apply to the Third Party Software and not any other portion of this program or this program as a whole.
*/
package org.osate.verify.ui.quickfix;
import com.google.common.base.Objects;
import com.google.common.collect.Iterables;
import java.util.List;
import java.util.function.Consumer;
import org.eclipse.emf.common.util.EList;
import org.eclipse.emf.common.util.URI;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.resource.ResourceSet;
import org.eclipse.xtext.ui.editor.model.edit.IModification;
import org.eclipse.xtext.ui.editor.model.edit.IModificationContext;
import org.eclipse.xtext.ui.editor.model.edit.ISemanticModification;
import org.eclipse.xtext.ui.editor.quickfix.DefaultQuickfixProvider;
import org.eclipse.xtext.ui.editor.quickfix.Fix;
import org.eclipse.xtext.ui.editor.quickfix.IssueResolutionAcceptor;
import org.eclipse.xtext.validation.Issue;
import org.eclipse.xtext.xbase.lib.CollectionExtensions;
import org.eclipse.xtext.xbase.lib.Conversions;
import org.eclipse.xtext.xbase.lib.Functions.Function1;
import org.eclipse.xtext.xbase.lib.IterableExtensions;
import org.osate.reqspec.reqSpec.Requirement;
import org.osate.verify.validation.VerifyValidator;
import org.osate.verify.verify.Claim;
import org.osate.verify.verify.Verification;
import org.osate.verify.verify.VerificationActivity;
import org.osate.verify.verify.VerificationPlan;
import org.osate.verify.verify.VerifyFactory;
import org.osate.verify.verify.VerifyPackage;
/**
* Custom quickfixes.
*
* see http://www.eclipse.org/Xtext/documentation.html#quickfixes
*/
@SuppressWarnings("all")
public class VerifyQuickfixProvider extends DefaultQuickfixProvider {
protected VerifyPackage verifyPackage = VerifyPackage.eINSTANCE;
protected VerifyFactory verifyFactory = this.verifyPackage.getVerifyFactory();
/**
* QuickFix for adding a claim for a requirement
* The issue data array is expected to have two elements:
*
* issue.getData()[0]: The name of the requirement
* issue.getData()[1]: the uri of the requirement
*/
@Fix(VerifyValidator.MISSING_CLAIM_FOR_REQ)
public void fixMissingClaimForRequirement(final Issue issue, final IssueResolutionAcceptor acceptor) {
final String reqName = IterableExtensions.<String>head(((Iterable<String>)Conversions.doWrapArray(issue.getData())));
final String reqURI = issue.getData()[1];
acceptor.accept(issue, ("Add claim for " + reqName), null, null,
new ISemanticModification() {
@Override
public void apply(final EObject element, final IModificationContext context) throws Exception {
final ResourceSet resourceSet = element.eResource().getResourceSet();
EObject _eObject = resourceSet.getEObject(URI.createURI(reqURI), true);
final Requirement req = ((Requirement) _eObject);
final VerificationPlan verificationPlan = ((VerificationPlan) element);
final Claim claim = VerifyQuickfixProvider.this.verifyFactory.createClaim();
claim.setRequirement(req);
verificationPlan.getClaim().add(claim);
}
});
}
/**
* QuickFix for adding claims for multiple requirements
* The issue data array is expected to hold URIs
*
* issue.getData(): the URIs of the requirements
*/
@Fix(VerifyValidator.MISSING_CLAIM_FOR_MULTIPLE_REQ)
public void fixMissingClaimForMultipleRequirements(final Issue issue, final IssueResolutionAcceptor acceptor) {
acceptor.accept(issue, "Add a claim for each missing requirement", null, null,
new ISemanticModification() {
@Override
public void apply(final EObject element, final IModificationContext context) throws Exception {
final ResourceSet resourceSet = element.eResource().getResourceSet();
final Consumer<String> _function = (String reqURI) -> {
EObject _eObject = resourceSet.getEObject(URI.createURI(reqURI), true);
final Requirement req = ((Requirement) _eObject);
final VerificationPlan verificationPlan = ((VerificationPlan) element);
final Claim claim = VerifyQuickfixProvider.this.verifyFactory.createClaim();
claim.setRequirement(req);
verificationPlan.getClaim().add(claim);
};
((List<String>)Conversions.doWrapArray(issue.getData())).forEach(_function);
}
});
}
/**
* QuickFix for organizing claims when multiples are missing requirements
* The issue data array is expected to hold URIs
*
* issue.getData(): the URIs of the missing requirements
*/
@Fix(VerifyValidator.MISSING_REQUIREMENTS_FOR_MULTIPLE_CLAIMS)
public void fixOrganizeClaimsMissingRequirements(final Issue issue, final IssueResolutionAcceptor acceptor) {
acceptor.accept(issue, "Add claims for missing requirements", null, null,
new ISemanticModification() {
@Override
public void apply(final EObject element, final IModificationContext context) throws Exception {
final ResourceSet resourceSet = element.eResource().getResourceSet();
final Consumer<String> _function = (String reqURI) -> {
EObject _eObject = resourceSet.getEObject(URI.createURI(reqURI), true);
final Requirement req = ((Requirement) _eObject);
final VerificationPlan verificationPlan = ((VerificationPlan) element);
final Claim claim = VerifyQuickfixProvider.this.verifyFactory.createClaim();
claim.setRequirement(req);
verificationPlan.getClaim().add(claim);
};
((List<String>)Conversions.doWrapArray(issue.getData())).forEach(_function);
}
});
}
/**
* QuickFix for removing an illegal object in a Verification file
* The issue data array is expected to have two elements:
*
* issue.getData()[0]: The type of element
* issue.getData()[1]: The uri of the containing parent
*/
@Fix(VerifyValidator.ILLEGAL_OBJECT_FOR_FILETYPE)
public void fixIllegalObjectForFileTypeInVerify(final Issue issue, final IssueResolutionAcceptor acceptor) {
final String elementType = IterableExtensions.<String>head(((Iterable<String>)Conversions.doWrapArray(issue.getData())));
final String verificationURI = issue.getData()[1];
acceptor.accept(issue, (("Remove " + elementType) + "."), null, null,
new ISemanticModification() {
@Override
public void apply(final EObject element, final IModificationContext context) throws Exception {
final ResourceSet resourceSet = element.eResource().getResourceSet();
EObject _eObject = resourceSet.getEObject(URI.createURI(verificationURI), true);
final Verification verification = ((Verification) _eObject);
final EObject illegalObject = element;
verification.getContents().remove(illegalObject);
}
});
}
/**
* QuickFix for merging multiple calims with the same requirement
* The issue data array is expected to have multiple elements:
*
* issue.getData()[0]: The uri of the verification plan
* issue.getData()[1]: The name of the requirement duplicate by multiple claims
* issue.getData()[2..n]: The uris of the claims with duplicate requirements as the claim passed as the element
*/
@Fix(VerifyValidator.MULTIPLE_CLAIMS_WITH_DUPLICATE_REQUIREMENTS)
public void mergeMultipleClaimsWithDuplicateRequirements(final Issue issue, final IssueResolutionAcceptor acceptor) {
final String vpURI = IterableExtensions.<String>head(((Iterable<String>)Conversions.doWrapArray(issue.getData())));
final String reqName = issue.getData()[1];
final Iterable<String> duplicateClaimUris = IterableExtensions.<String>drop(((Iterable<String>)Conversions.doWrapArray(issue.getData())), 2);
acceptor.accept(issue, (("Merge claims for requirement " + reqName) + "."), null, null,
new ISemanticModification() {
@Override
public void apply(final EObject element, final IModificationContext context) throws Exception {
final ResourceSet resourceSet = element.eResource().getResourceSet();
final Claim claim = ((Claim) element);
EObject _eObject = resourceSet.getEObject(URI.createURI(vpURI), true);
final VerificationPlan vp = ((VerificationPlan) _eObject);
final Function1<String, Claim> _function = (String it) -> {
EObject _eObject_1 = resourceSet.getEObject(URI.createURI(it), true);
return ((Claim) _eObject_1);
};
final Iterable<Claim> duplicateClaims = IterableExtensions.<String, Claim>map(duplicateClaimUris, _function);
final Function1<Claim, EList<VerificationActivity>> _function_1 = (Claim it) -> {
return it.getActivities();
};
final Function1<VerificationActivity, String> _function_2 = (VerificationActivity it) -> {
return it.getName();
};
final Function1<List<VerificationActivity>, VerificationActivity> _function_3 = (List<VerificationActivity> it) -> {
return IterableExtensions.<VerificationActivity>head(it);
};
final Iterable<VerificationActivity> activitiesToMove = IterableExtensions.<List<VerificationActivity>, VerificationActivity>map(IterableExtensions.<String, VerificationActivity>groupBy(Iterables.<VerificationActivity>concat(IterableExtensions.<Claim, EList<VerificationActivity>>map(duplicateClaims, _function_1)), _function_2).values(), _function_3);
CollectionExtensions.<Claim>removeAll(vp.getClaim(), duplicateClaims);
final Function1<VerificationActivity, Boolean> _function_4 = (VerificationActivity actMov) -> {
final Function1<VerificationActivity, Boolean> _function_5 = (VerificationActivity it) -> {
String _name = it.getName();
String _name_1 = actMov.getName();
return Boolean.valueOf(Objects.equal(_name, _name_1));
};
boolean _exists = IterableExtensions.<VerificationActivity>exists(claim.getActivities(), _function_5);
return Boolean.valueOf((!_exists));
};
Iterables.<VerificationActivity>addAll(claim.getActivities(), IterableExtensions.<VerificationActivity>filter(activitiesToMove, _function_4));
}
});
}
/**
* QuickFix for fixing parameters that don't match the Resolute definition
* The issue data array is expected to have two elements:
*
* issue.getData()[0]: The text of the VerificationMethod
* issue.getData()[1]: The revised text of the VerificationMethod with corrected parameters
*/
@Fix(VerifyValidator.METHOD_PARMS_DO_NOT_MATCH_RESOLUTE_DEFINITION)
public void fixMethodParmsDoNotMatchResoluteDefinition(final Issue issue, final IssueResolutionAcceptor acceptor) {
final String oldVMText = IterableExtensions.<String>head(((Iterable<String>)Conversions.doWrapArray(issue.getData())));
final String newVMText = issue.getData()[1];
acceptor.accept(issue, "Change method parameters to match Resolute method parameters", null, null, new IModification() {
@Override
public void apply(final IModificationContext context) throws Exception {
final String docText = context.getXtextDocument().get();
final int vmIndex = docText.indexOf(oldVMText);
String _substring = docText.substring(0, vmIndex);
String _plus = (_substring + newVMText);
int _length = oldVMText.length();
int _plus_1 = (vmIndex + _length);
String _substring_1 = docText.substring(_plus_1);
final String newDocText = (_plus + _substring_1);
context.getXtextDocument().set(newDocText);
}
});
}
}