ReqSpecQuickfixProvider.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.reqspec.ui.quickfix;
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.Conversions;
import org.eclipse.xtext.xbase.lib.IterableExtensions;
import org.osate.aadl2.ComponentClassifier;
import org.osate.reqspec.reqSpec.DocumentSection;
import org.osate.reqspec.reqSpec.Goal;
import org.osate.reqspec.reqSpec.ReqDocument;
import org.osate.reqspec.reqSpec.ReqSpec;
import org.osate.reqspec.reqSpec.Requirement;
import org.osate.reqspec.reqSpec.StakeholderGoals;
import org.osate.reqspec.reqSpec.SystemRequirementSet;
import org.osate.reqspec.validation.ReqSpecValidator;
/**
* Custom quickfixes.
*
* see http://www.eclipse.org/Xtext/documentation.html#quickfixes
*/
@SuppressWarnings("all")
public class ReqSpecQuickfixProvider extends DefaultQuickfixProvider {
/**
* QuickFix for removing a goal duplicated within a StakeholdersGoals
* The issue data array is expected to have one element:
*
* issue.getData()[0]: The URI of the StakeHoldersGoals
*/
@Fix(ReqSpecValidator.DUPLICATE_GOAL_WITHIN_STAKEHOLDER_GOALS)
public void fixDuplicateGoal(final Issue issue, final IssueResolutionAcceptor acceptor) {
acceptor.accept(issue, "Remove goal", 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(IterableExtensions.<String>head(((Iterable<String>)Conversions.doWrapArray(issue.getData())))), true);
final StakeholderGoals stakeholderGoals = ((StakeholderGoals) _eObject);
final Goal goal = ((Goal) element);
stakeholderGoals.getGoals().remove(goal);
}
});
}
/**
* QuickFix for removing a duplicated StakeholderGoals
* The issue data array is expected to have two elements:
*
* issue.getData()[0]: The offset of the StakeholderGoals
* issue.getData()[1]: The length of the StakeholderGoals
*/
@Fix(ReqSpecValidator.DUPLICATE_STAKEHOLDER_GOALS)
public void fixDuplicateStakeholderGoals(final Issue issue, final IssueResolutionAcceptor acceptor) {
final int offset = Integer.parseInt(issue.getData()[0]);
final int length = Integer.parseInt(issue.getData()[1]);
acceptor.accept(issue, "Remove StakeholderGoals", null, null,
new IModification() {
@Override
public void apply(final IModificationContext context) throws Exception {
context.getXtextDocument().replace(offset, length, "");
}
});
}
/**
* QuickFix for rename a reqspec target to match a StakeholdersGoals target based on matching requirement and goal
* The issue data array is expected to have one element:
* issue.getData()[0]: The name the needs changed
* issue.getData()[1]: name it needs changed to
* issue.getData()[2]: the uri of what it needs changed to
*/
@Fix(ReqSpecValidator.REQSPEC_FOR_DIFFERS_FROM_STAKEHOLDERGOALS_FOR)
public void fixDifferingFor(final Issue issue, final IssueResolutionAcceptor acceptor) {
final String fromName = issue.getData()[0];
final String toName = issue.getData()[1];
final String fromURI = issue.getData()[2];
acceptor.accept(issue, (((("Change System Requirement \'for\' from \'" + fromName) + "\' to \'") + toName) + "\'"), 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(fromURI), true);
final ComponentClassifier classifier = ((ComponentClassifier) _eObject);
final SystemRequirementSet sysReqs = ((SystemRequirementSet) element);
sysReqs.setTarget(classifier);
}
});
}
/**
* QuickFix for removing a duplicated SystemRequirements
* The issue data array is expected to have two elements:
*
* issue.getData()[0]: The offset of the SystemRequirements
* issue.getData()[1]: The length of the SystemRequirements
*/
@Fix(ReqSpecValidator.DUPLICATE_REQUIREMENTS)
public void fixDuplicateSystemRequirements(final Issue issue, final IssueResolutionAcceptor acceptor) {
final int offset = Integer.parseInt(issue.getData()[0]);
final int length = Integer.parseInt(issue.getData()[1]);
acceptor.accept(issue, "Remove SystemsRequirement", null, null,
new IModification() {
@Override
public void apply(final IModificationContext context) throws Exception {
context.getXtextDocument().replace(offset, length, "");
}
});
}
/**
* QuickFix for removing a goal duplicated within a StakeholdersGoals
* The issue data array is expected to have one element:
*
* issue.getData()[0]: The URI of the StakeHoldersGoals
*/
@Fix(ReqSpecValidator.DUPLICATE_REQUIREMENT_WITHIN_REQUIREMENTS)
public void fixDuplicateRequirement(final Issue issue, final IssueResolutionAcceptor acceptor) {
acceptor.accept(issue, "Remove requirement", 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(IterableExtensions.<String>head(((Iterable<String>)Conversions.doWrapArray(issue.getData())))), true);
final SystemRequirementSet SystemRequirements = ((SystemRequirementSet) _eObject);
final Requirement requirement = ((Requirement) element);
SystemRequirements.getRequirements().remove(requirement);
}
});
}
/**
* QuickFix for removing a refined from a goal with cycle dependencies
* The issue data array is expected to have two elements:
*
* issue.getData()[0]: The name of the refined goal
* issue.getData()[1]: The uri of the refined goal
*/
@Fix(ReqSpecValidator.CYCLE_IN_GOAL_REFINE_HIERARCHY)
public void fixCycleInGoalRefineHierarchy(final Issue issue, final IssueResolutionAcceptor acceptor) {
final String refinedGoalName = IterableExtensions.<String>head(((Iterable<String>)Conversions.doWrapArray(issue.getData())));
final String refinedGoalURI = issue.getData()[1];
acceptor.accept(issue, ("Remove refines " + refinedGoalName), 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(refinedGoalURI), true);
final Goal refinedGoal = ((Goal) _eObject);
final Goal goal = ((Goal) element);
goal.getRefinesReference().remove(refinedGoal);
}
});
}
/**
* QuickFix for removing a refined from a requirement with cycle dependencies
* The issue data array is expected to have two elements:
*
* issue.getData()[0]: The name of the refined requirement
* issue.getData()[1]: The uri of the refined requirement
*/
@Fix(ReqSpecValidator.CYCLE_IN_REQUIREMENT_REFINE_HIERARCHY)
public void fixCycleInRequiremntRefineHierarchy(final Issue issue, final IssueResolutionAcceptor acceptor) {
final String refinedReqName = IterableExtensions.<String>head(((Iterable<String>)Conversions.doWrapArray(issue.getData())));
final String refinedReqURI = issue.getData()[1];
acceptor.accept(issue, ("Remove refines " + refinedReqName), 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(refinedReqURI), true);
final Requirement refinedReq = ((Requirement) _eObject);
final Requirement requirement = ((Requirement) element);
requirement.getRefinesReference().remove(refinedReq);
}
});
}
/**
* QuickFix for removing an illegal object from a document section of a reqdoc or goaldoc
* 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 section
*/
@Fix(ReqSpecValidator.ILLEGAL_OBJECT_FOR_FILETYPE_IN_DOCUMENTSECTION)
public void fixIllegalObjectForFileTypeInDocumentSection(final Issue issue, final IssueResolutionAcceptor acceptor) {
final String elementType = IterableExtensions.<String>head(((Iterable<String>)Conversions.doWrapArray(issue.getData())));
final String sectionURI = issue.getData()[1];
acceptor.accept(issue, (("Remove " + elementType) + " from section."), 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(sectionURI), true);
final DocumentSection section = ((DocumentSection) _eObject);
final EObject illegalObject = element;
section.getContent().remove(illegalObject);
}
});
}
/**
* QuickFix for removing an illegal object in a reqdoc or goaldoc
* 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(ReqSpecValidator.ILLEGAL_OBJECT_FOR_FILETYPE_IN_REQDOCUMENT)
public void fixIllegalObjectForFileTypeInReqDocument(final Issue issue, final IssueResolutionAcceptor acceptor) {
final String elementType = IterableExtensions.<String>head(((Iterable<String>)Conversions.doWrapArray(issue.getData())));
final String reqDocURI = 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(reqDocURI), true);
final ReqDocument reqDoc = ((ReqDocument) _eObject);
final EObject illegalObject = element;
reqDoc.getContent().remove(illegalObject);
}
});
}
/**
* QuickFix for removing an illegal object in a ReqSpec
* 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(ReqSpecValidator.ILLEGAL_OBJECT_FOR_FILETYPE_IN_REQSPEC)
public void fixIllegalObjectForFileTypeInReqSpec(final Issue issue, final IssueResolutionAcceptor acceptor) {
final String elementType = IterableExtensions.<String>head(((Iterable<String>)Conversions.doWrapArray(issue.getData())));
final String reqSpecURI = 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(reqSpecURI), true);
final ReqSpec reqSpec = ((ReqSpec) _eObject);
final EObject illegalObject = element;
reqSpec.getParts().remove(illegalObject);
}
});
}
}