Preference store provider extension point

[angelozerr]

Preference store provider extension point

Signed-off-by: azerr [email protected]

[angelozerr]

This PR is just a draft, because it depends from another PRs:

• ITextEditorAware API to inject ITextEditor. #108
• API to Track TextViewer install/uninstall #107

It provides the capability to add custom IPreferenceStore in the store of the generic editor with a new extension point org.eclipse.ui.genericeditor.preferenceStoreProviders. I have 2 usecases for this requirement:

• support for .editorconfig Provide .editorconfig support eclipse.platform.ui#877:

   <extension
         point="org.eclipse.ui.genericeditor.preferenceStoreProviders">
      <provider
            class="org.eclipse.text.editorconfig.internal.EditorConfigPreferenceStoreProvider"
            contentType="org.eclipse.core.runtime.text">
      </provider>
   </extension>

• support for customize the insert spaces / tabWith in LSP4e as we have more and more complaints from user with WWD:

  • [XML] Preferences page for XML for spaces and tabs eclipse-wildwebdeveloper/wildwebdeveloper#872
  • Javascript editor 'Save actions' remove trailing whitespace spaces from all lines is not working eclipse-wildwebdeveloper/wildwebdeveloper#474 (comment)
  • How to control javascript formatting options? eclipse-wildwebdeveloper/wildwebdeveloper#225
  • More mature indent eclipse-wildwebdeveloper/wildwebdeveloper#457
  • WebTools code formatting options not used by Wild Web Developer eclipse-wildwebdeveloper/wildwebdeveloper#240

I have a POC to customize insert spaces for XML with UI preferences

I use the new extension point like this:

   <extension
         point="org.eclipse.ui.genericeditor.preferenceStoreProviders">
      <provider
            class="org.eclipse.wildwebdeveloper.xml.internal.ui.preferences.XMLPreferenceStoreProvider"
            contentType="org.eclipse.core.runtime.xml">
      </provider>
   </extension>

[angelozerr]

@mickaelistria I know we disccus about using adapter factory for .editorconfig, but insert spaces / tab width for WWD becomes a priority I think and after a long investigation with this topic, I can manage all usescases:

• editorconfig
• customize insert spaces for each language of LSP4e. The API is not linked to an editor or viewer.

The API is not linked to an editor or source viewer, just with IResource that it is requires for .editorconfig (give me the preference store of the given resource, so the preference store could not be linked to an editor, just a resource file):

package org.eclipse.core.resources.proposed;

import org.eclipse.core.resources.IResource;
import org.eclipse.jface.preference.IPreferenceStore;

public interface IPreferenceStoreProvider {

	IPreferenceStore getPreferenceStore(IResource resource);
}

See https://github.com/eclipse-platform/eclipse.platform.text/pull/109/files#diff-66a79c46ab5014d45f164ff0e7a1119c3744e77438d7cb7d311e085a9ecc8428

In the case of .editorconfig, I need to work with editor to retrieve the preference store and update it fire property declared in .editorconfig and update the editor with proper insert spaces / tab widh

See the following demo:

To access to the editor, I return an instance of IPreferenceStore which implements ITextEditorAware in order to the extension point inject the instance of the generic editor. I create the API in #108

[angelozerr]

I think this PR (which includes other PRs that I did) is very important for WWD specialy this issue eclipse-wildwebdeveloper/wildwebdeveloper#872

There are more and more users who complain that they cannot configure spaces / tabs for XML, HTML, etc although they could do that with Eclipse WTP and my fear is that users will start hating WWD because of missing preferences.

WWD with Generic Editor is so powerfull, combined with TM4e, LSP4e, and can provide the same features than other custom editor, but the custom preferences in Generic Editor is not possible and for a given editor I think it is very important to have the capability to customize it like insert spaces.

Once preference store provider for generic editor will be available, It will open the door for many features to customize the generic editor like

• customize spaces / tabs for a given language
• display max line height line renderer according line width of a given language (format)
• support for .editorconfig.

I know that @mickaelistria is very busy, so I wonder if some other people could help me to review some PRs to provide step by step this preference store provider extension point.

Thanks for your help.

[angelozerr]

Close for #130