ITextEditorAware API to inject ITextEditor.

[angelozerr]

ITextEditorAware API to inject ITextEditor.

Signed-off-by: azerr [email protected]

[angelozerr]

ITextEditorAware API allows to inject an instance of ITextEditor.

I create this API because I need it for eclipse-platform/eclipse.platform.ui#877

More I think this API can be very helpfull for generic editor. My idea is when generic editor creates a custom reconciler for instance, it check that the instanciated class implemented ITextEditorAware and in this case it set the editor to the contribution here

eclipse.platform.text/org.eclipse.ui.genericeditor/src/org/eclipse/ui/internal/genericeditor/GenericContentTypeRelatedExtension.java

Line 59 in 1900585

return (T) extension.createExecutableExtension(CLASS_ATTRIBUTE);

With this code:

@SuppressWarnings("unchecked")
public T createDelegate(ITextEditor editor) {
try {
	T delegateInstance = (T) extension.createExecutableExtension(CLASS_ATTRIBUTE);
	if (delegateInstance instanceof ITextEditorAware) {
		((ITextEditorAware) delegateInstance).setEditor(editor);
	}
	return delegateInstance;
} catch (CoreException e) {
	GenericEditorPlugin.getDefault().getLog()
			.log(new Status(IStatus.ERROR, GenericEditorPlugin.BUNDLE_ID, e.getMessage(), e));
}
return null;
}

A good usecase is in LSP4e https://github.com/eclipse/lsp4e/blob/c6859853bd37c5ae70e9ee9ba43495ff28d668d3/org.eclipse.lsp4e/src/org/eclipse/lsp4e/operations/completion/LSContentAssistProcessor.java#L197

Here the required editor is get with a static method, by getting the current activate editor. It should be cleaner to do like this:

public class LSContentAssistProcessor implements IContentAssistProcessor, ITextEditorAware {

    private TextEditor editor;

    @Override
    public void setEditor(ITextEditor editor) {
       this.editor = editor;
   }
  ...
}

@mickaelistria do you like this idea?

[angelozerr]

Ok I have updated my PR to use ITextEditorAware with generic editor. It will opens the door to access to the generic editor in any contribution.

The main idea is to avoid getting the activated editor to get the editor in each contribution. I see that:

• in tm4e https://github.com/eclipse/tm4e/blob/cb5f4728cd3f0f1b2eaa4f2836519309ffacd20c/org.eclipse.tm4e.languageconfiguration/src/main/java/org/eclipse/tm4e/languageconfiguration/internal/LanguageConfigurationAutoEditStrategy.java#L293
• in lsp4e https://github.com/eclipse/lsp4e/blob/c6859853bd37c5ae70e9ee9ba43495ff28d668d3/org.eclipse.lsp4e/src/org/eclipse/lsp4e/operations/completion/LSContentAssistProcessor.java#L197

[angelozerr]

@mickaelistria here a concrete sample in the PR eclipse-tm4e/tm4e#461 which uses ITextEditorAware to have cleaner code in TM4e language configuration

• to acces to the editor https://github.com/eclipse/tm4e/pull/461/files#diff-2961979865d7499073f384bc8a71472fb1d5298dd54d3c4713c8f6ed94405801R52
• and access to the editor preference store https://github.com/eclipse/tm4e/pull/461/files#diff-2961979865d7499073f384bc8a71472fb1d5298dd54d3c4713c8f6ed94405801R295

[szarnekow]

Since the API ITextEditorAware was added in ui.workbench.texteditor, I'd expect it to be respected there, too. Right now, it looks as if something was added in ui.workbench just for the sake of ui.genericeditor. This has a bad smell to me.

[angelozerr]

I agree with you @szarnekow I think more and more that this API should be hosted in generic editor.

I think too ItextViewerLyfecicle #107 should be hosted in generic editor

@mickaelistria are you OK with that.

[szarnekow]

Please try to add documentation what an implementor can expect to happen if his random class implements the "API to inject an ITextEditor".

[mickaelistria]

eclipse-pde/eclipse.pde#402 should fix further issues.

[vogella]

Is this PR still relevant?

[angelozerr]

I think so, iy should avoid writing that https://github.com/eclipse/lsp4e/blob/c6859853bd37c5ae70e9ee9ba43495ff28d668d3/org.eclipse.lsp4e/src/org/eclipse/lsp4e/operations/completion/LSContentAssistProcessor.java#L197

[laeubi]

This repository was merged with https://github.com/eclipse-platform/eclipse.platform.ui if your pull-request is still relevant please rebase the code and push it to the new repository.