org.eclipse.xtext.ui.refactoring.IRenameStrategy Java Examples

@Override
public Map<URI, URI> renameAndTrack(Iterable<URI> renamedElementURIs, String newName, ResourceSet resourceSet, IRenameStrategy renameStrategy, IProgressMonitor monitor) {
	Map<EObject, URI> renamedElement2oldURI = resolveRenamedElements(renamedElementURIs, resourceSet);
	if (monitor.isCanceled()) {
		throw new OperationCanceledException();
	}
	renameStrategy.applyDeclarationChange(newName, resourceSet);
	if (monitor.isCanceled()) {
		throw new OperationCanceledException();
	}
	Map<URI, URI> old2newURI = relocateRenamedElements(renamedElement2oldURI);
	if (monitor.isCanceled()) {
		throw new OperationCanceledException();
	}
	renameStrategy.revertDeclarationChange(resourceSet);
	return old2newURI;
}
 

@Test public void testRenameElementStrategy() throws Exception {
	final XtextResource resource = getResourceFromString("A { B { C } }");
	EObject targetElement = resource.getContents().get(0).eContents().get(0);
	assertNotNull(targetElement);
	assertTrue(targetElement instanceof Element);
	assertEquals("A", ((Element) targetElement).getName());
	IRenameStrategy renameElementStrategy = strategyProvider.get(targetElement, null);
	assertNotNull(renameElementStrategy);
	assertEquals("A", renameElementStrategy.getOriginalName());
	RefactoringStatus validateNewNameStatus = renameElementStrategy.validateNewName("A");
	assertTrue(validateNewNameStatus.isOK());
	validateNewNameStatus = renameElementStrategy.validateNewName("}");
	assertTrue(validateNewNameStatus.hasFatalError());
	validateNewNameStatus = renameElementStrategy.validateNewName("ref");
	assertTrue(validateNewNameStatus.hasError());
	renameElementStrategy.applyDeclarationChange("D", resource.getResourceSet());
	assertEquals("D", ((Element) targetElement).getName());
	renameElementStrategy.createDeclarationUpdates("D", resource.getResourceSet(), this);
	assertEquals(0, changes.size());
	assertEquals(1, textEdits.size());
	assertTrue(textEdits.get(0) instanceof ReplaceEdit);
	ReplaceEdit renameEdit = (ReplaceEdit) textEdits.get(0);
	assertEquals(0, renameEdit.getOffset());
	assertEquals(1, renameEdit.getLength());
	assertEquals("D", renameEdit.getText());
}
 

@Test public void testInferredClassRenamed() throws Exception {
	XtendClass fooClass = (XtendClass) testHelper.xtendFile("Foo", "class Foo { }").getXtendTypes().get(0);
	IRenameStrategy renameStrategy = createRenameStrategy(fooClass);
	renameStrategy.applyDeclarationChange("Bar", fooClass.eResource().getResourceSet());
	JvmGenericType inferredType = associations.getInferredType(fooClass);
	JvmConstructor inferredConstructor = associations.getInferredConstructor(fooClass);
	assertEquals("Bar", fooClass.getName());
	assertEquals("Bar", inferredType.getSimpleName());
	assertEquals("Bar", inferredConstructor.getSimpleName());
	renameStrategy.revertDeclarationChange(fooClass.eResource().getResourceSet());
	inferredType = associations.getInferredType(fooClass);
	inferredConstructor = associations.getInferredConstructor(fooClass);
	assertEquals("Foo", fooClass.getName());
	assertEquals("Foo", inferredType.getSimpleName());
	assertEquals("Foo", inferredConstructor.getSimpleName());
}
 

@Test public void testResolveElements() throws Exception {
	URI resourceURI = URI.createFileURI("testresource.refactoringtestlanguage");
	String textualModel = "A { B { C { ref A.B } } ref B }";
	XtextResource resource = getResource(textualModel, resourceURI.toString());
	Element elementA = (Element) resource.getContents().get(0).eContents().get(0);
	Element elementB = elementA.getContained().get(0);
	Element elementC = elementB.getContained().get(0);

	URI uriB = EcoreUtil.getURI(elementB);
	URI uriC = EcoreUtil.getURI(elementC);
	String newName = "newB";

	List<URI> renamedElementURIs = newArrayList(uriB, uriC);
	IRenameStrategy renameStrategy = getInjector().getInstance(IRenameStrategy.Provider.class).get(elementB, null);

	IRenamedElementTracker renamedElementTracker = new RenamedElementTracker();
	Map<URI, URI> original2newElementURIs = renamedElementTracker.renameAndTrack(renamedElementURIs, newName,
			resource.getResourceSet(), renameStrategy, new NullProgressMonitor());

	assertEquals("B", elementB.getName());
	assertEquals(2, original2newElementURIs.size());
	assertEquals(resourceURI.appendFragment(newName), original2newElementURIs.get(uriB));
	assertEquals(uriC, original2newElementURIs.get(uriC));
}
 

@Override
protected IRenameStrategy createRenameStrategy(final EObject targetElement, final IRenameElementContext context) {
	return new XtextSwitch<IRenameStrategy>() {

		@Override
		public IRenameStrategy caseAbstractMetamodelDeclaration(AbstractMetamodelDeclaration metamodelDeclaration) {
			return metamodelDeclarationProvider.get();
		}

		@Override
		public IRenameStrategy caseAbstractRule(AbstractRule rule) {
			return ruleProvider.get();
		}

		@Override
		public IRenameStrategy caseGrammar(Grammar grammar) {
			return XtextRenameStrategyProvider.super.createRenameStrategy(targetElement, context);
		}
	}.doSwitch(targetElement);
}
 

@Override
public IRenameStrategy get(EObject targetEObject, IRenameElementContext renameElementContext) throws NoSuchStrategyException {
	IRenameStrategy renameStrategy = createRenameStrategy(targetEObject, renameElementContext);
	if (renameStrategy instanceof DefaultRenameStrategyProvider.IInitializable
			&& ((DefaultRenameStrategyProvider.IInitializable) renameStrategy).initialize(targetEObject,
					renameElementContext)) {
		return renameStrategy;
	}
	return null;
}
 

@Override
public void revertDeclarationChange(ResourceSet resourceSet) {
	for(IRenameStrategy child: children)
		child.revertDeclarationChange(resourceSet);
	for(JvmOperation dispatcher: dispatchers) {
		dispatcher.setSimpleName(getOriginalName());
	}
}
 

@Override
public void applyDeclarationChange(String newName, ResourceSet resourceSet) {
	for(IRenameStrategy child: children)
		child.applyDeclarationChange(newName, resourceSet);
	for(JvmOperation dispatcher: dispatchers) {
		dispatcher.setSimpleName(newName);
	}
}
 

@Override
protected IRenameStrategy createRenameStrategy(EObject targetEObject, IRenameElementContext renameElementContext) {
	if (renameElementContext instanceof DispatchMethodRenameContext) 
		return dispatchStrategyProvider.get();
	else
		return super.createRenameStrategy(targetEObject, renameElementContext);
}
 

@Override
public RefactoringStatus validateNewName(String newName) {
	RefactoringStatus status = new RefactoringStatus();
	for(IRenameStrategy child: children)
		status.merge(child.validateNewName(newName));
	return status;
}
 

@Test public void testInferredMethodRenamed() throws Exception {
	XtendFunction fooMethod = (XtendFunction) ((XtendClass)testHelper.xtendFile("Foo", "class Foo { def Foo foo() {this} }")
			.getXtendTypes().get(0)).getMembers().get(0);
	IRenameStrategy renameStrategy = createRenameStrategy(fooMethod);
	renameStrategy.applyDeclarationChange("bar", fooMethod.eResource().getResourceSet());
	assertEquals("bar", fooMethod.getName());
	JvmOperation inferredOperation = associations.getDirectlyInferredOperation(fooMethod);
	assertEquals("bar", inferredOperation.getSimpleName());
	renameStrategy.revertDeclarationChange(fooMethod.eResource().getResourceSet());
	inferredOperation = associations.getDirectlyInferredOperation(fooMethod);
	assertEquals("foo", fooMethod.getName());
	assertEquals("foo", inferredOperation.getSimpleName());
}
 

@Override
public IRenameStrategy get(EObject targetEObject, IRenameElementContext renameElementContext) throws NoSuchStrategyException {
	if(targetEObject instanceof JvmMember) {
		JvmMemberRenameStrategy jvmMemberRenameStrategy = guiceStartegyProvider.get();
		jvmMemberRenameStrategy.initialize((JvmMember) targetEObject, renameElementContext);
		return jvmMemberRenameStrategy;
	}
	return delegate == null ? null : delegate.get(targetEObject, renameElementContext);
}
 

@Override
public IRenameStrategy get(EObject targetEObject, IRenameElementContext renameElementContext) throws NoSuchStrategyException {
	if(targetEObject instanceof XtendConstructor)
		// Xtend constructors can be ignored in rename refactorings
		return null;
	return super.get(targetEObject, renameElementContext);
}
 

public void configure(Binder binder) {
	binder.bind(IEObjectHoverProvider.class).to(JdtHoverProvider.class);
	binder.bind(IEObjectHoverDocumentationProvider.class).to(JdtHoverDocumentationProvider.class);
	binder.bind(IResourceServiceProvider.class).to(SharedCommonTypesResourceServiceProvider.class);
	binder.bind(IResourceSetProvider.class).to(XtextResourceSetProvider.class);
	binder.bindConstant().annotatedWith(Names.named(Constants.FILE_EXTENSIONS)).to("java");

	binder.bind(IQualifiedNameProvider.class).to(JvmIdentifiableQualifiedNameProvider.class);
	binder.bind(ICopyQualifiedNameService.class).to(DefaultCopyQualifiedNameService.class);
	binder.bind(IJvmTypeProvider.Factory.class).to(JdtTypeProviderFactory.class);
	binder.bind(IRenameRefactoringProvider.class).to(DefaultRenameRefactoringProvider.class);
	binder.bind(AbstractRenameProcessor.class).to(JvmMemberRenameProcessor.class);
	binder.bind(IRenameStrategy.Provider.class).to(JvmMemberRenameStrategy.Provider.class);
	binder.bind(RefactoringResourceSetProvider.class).to(JvmRefactoringResourceSetProvider.class);
	binder.bind(String.class).annotatedWith(Names.named(Constants.LANGUAGE_NAME)).toInstance("Java");

	binder.bind(IResourceDescriptions.class).annotatedWith(Names.named(ResourceDescriptionsProvider.LIVE_SCOPE))
			.to(LiveShadowedResourceDescriptions.class);
	binder.bind(IResourceDescriptions.class)
			.annotatedWith(Names.named(ResourceDescriptionsProvider.NAMED_BUILDER_SCOPE))
			.to(CurrentDescriptions.ResourceSetAware.class);
	binder.bind(IResourceDescriptions.class)
			.annotatedWith(Names.named(ResourceDescriptionsProvider.PERSISTED_DESCRIPTIONS))
			.to(IBuilderState.class);

	binder.bind(IWorkspaceRoot.class).toInstance(ResourcesPlugin.getWorkspace().getRoot());
	binder.bind(ITraceForStorageProvider.class).to(TraceForStorageProvider.class);

	binder.bind(IReferenceUpdater.class).to(NullReferenceUpdater.class);
}
 

protected boolean isRefactoringEnabled(IRenameElementContext renameElementContext, XtextResource resource) {
	ResourceSet resourceSet = resource.getResourceSet();
	if (renameElementContext != null && resourceSet != null) {
		EObject targetElement = resourceSet.getEObject(renameElementContext.getTargetElementURI(), true);
		if (targetElement != null && !targetElement.eIsProxy()) {
			if(targetElement.eResource() == resource && renameElementContext.getTriggeringEditorSelection() instanceof ITextSelection) {
				ITextSelection textSelection = (ITextSelection) renameElementContext.getTriggeringEditorSelection();
				ITextRegion selectedRegion = new TextRegion(textSelection.getOffset(), textSelection.getLength());
				INode crossReferenceNode = eObjectAtOffsetHelper.getCrossReferenceNode(resource, selectedRegion);
				if(crossReferenceNode == null) {
					// selection is on the declaration. make sure it's the name
					ITextRegion significantRegion = locationInFileProvider.getSignificantTextRegion(targetElement);
					if(!significantRegion.contains(selectedRegion)) 
						return false;
				}
			}
			IRenameStrategy.Provider renameStrategyProvider = globalServiceProvider.findService(targetElement,
					IRenameStrategy.Provider.class);
			try {
				if (renameStrategyProvider.get(targetElement, renameElementContext) != null) {
					return true;
				} else {
					IRenameStrategy2 strategy2 = globalServiceProvider.findService(targetElement, IRenameStrategy2.class); 
					ISimpleNameProvider simpleNameProvider = globalServiceProvider.findService(targetElement, ISimpleNameProvider.class); 
					return strategy2 != null && simpleNameProvider.canRename(targetElement);
				}
					
			} catch (NoSuchStrategyException e) {
				MessageDialog.openInformation(Display.getCurrent().getActiveShell(), "Cannot rename element",
						e.getMessage());
			}
		}
	}
	return false;
}
 

protected String getOriginalName(final XtextEditor xtextEditor) {
	return xtextEditor.getDocument().tryReadOnly(new IUnitOfWork<String, XtextResource>() {
		@Override
		public String exec(XtextResource state) throws Exception {
			EObject targetElement = state.getResourceSet().getEObject(renameElementContext.getTargetElementURI(),
					false);
			if (targetElement == null) {
				return null;
			}
			IRenameStrategy.Provider strategyProvider = globalServiceProvider.findService(targetElement,
					IRenameStrategy.Provider.class);
			try {
				if (strategyProvider != null) {
					IRenameStrategy strategy = strategyProvider.get(targetElement, renameElementContext);
					if (strategy != null)
						return strategy.getOriginalName();
				}
			} catch(NoSuchStrategyException e) {
				// null
			}
			ISimpleNameProvider simpleNameProvider = globalServiceProvider.findService(targetElement, ISimpleNameProvider.class);
			if (simpleNameProvider != null)
				return simpleNameProvider.getSimpleName(targetElement);
			else
				return null;
		}
	});
}
 

@Override
protected IRenameStrategy createRenameStrategy(EObject targetEObject, IRenameElementContext renameElementContext) {
	if (targetEObject instanceof SarlScript) {
		return this.guiceEcorePackageStrategyProvider.get();
	}
	return super.createRenameStrategy(targetEObject, renameElementContext);
}
 

public Class<? extends IRenameStrategy> bindIRenameStrategy() {
	return DefaultJvmModelRenameStrategy.class;
}
 

public Class<? extends IRenameStrategy> bindIRenameStrategy() {
	return DefaultJvmModelRenameStrategy.class;
}
 

public Class<? extends IRenameStrategy> bindIRenameStrategy() {
	return DefaultJvmModelRenameStrategy.class;
}
 

public Class<? extends IRenameStrategy> bindIRenameStrategy() {
	return DefaultJvmModelRenameStrategy.class;
}
 

public void configureJvmMemberRenameStrategy$Provider$Delegate(Binder binder) {
	binder.bind(IRenameStrategy.Provider.class).annotatedWith(JvmMemberRenameStrategy.Provider.Delegate.class).to(DefaultRenameStrategyProvider.class);
}
 

public Class<? extends IRenameStrategy.Provider> bindIRenameStrategy$Provider() {
	return JvmMemberRenameStrategy.Provider.class;
}
 

public Class<? extends IRenameStrategy> bindIRenameStrategy() {
	return DefaultRenameStrategy.class;
}
 

public void configureJvmMemberRenameStrategy$Provider$Delegate(Binder binder) {
	binder.bind(IRenameStrategy.Provider.class).annotatedWith(JvmMemberRenameStrategy.Provider.Delegate.class).to(DefaultRenameStrategyProvider.class);
}
 

public Class<? extends IRenameStrategy.Provider> bindIRenameStrategy$Provider() {
	return SARLRenameStrategyProvider.class;
}
 

public Class<? extends IRenameStrategy> bindIRenameStrategy() {
	return XbaseRenameStrategy.class;
}
 

public Class<? extends IRenameStrategy> bindIRenameStrategy() {
	return XbaseRenameStrategy.class;
}
 

public Class<? extends IRenameStrategy> bindIRenameStrategy() {
	return XtendRenameStrategy.class;
}
 

protected IRenameStrategy createRenameElementStrategy(EObject targetElement,
		IRenameElementContext renameElementContext) throws NoSuchStrategyException {
	IRenameStrategy result = strategyProvider.get(targetElement, renameElementContext);
	return result;
}