Replace BrowserTextAccessor with InputChangeListener for Javadoc views (eclipse-jdt#2168)

BrowserTextAccessor came with Javadoc styling enhancements and was used
to fill SignatureStylingMenuToolbarAction's menu based on the content of
the browser showing Javadoc. It is however not working with the Edge SWT
browser that is now default on Windows.

Fixes eclipse-jdt#2165

Author: RedeemerSK

org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/infoviews/JavadocView.java

@@ -72,6 +72,7 @@
 import org.eclipse.jface.text.Document;
 import org.eclipse.jface.text.IDocument;
 import org.eclipse.jface.text.IDocumentExtension3;
+import org.eclipse.jface.text.IInputChangedListener;
 import org.eclipse.jface.text.ITextSelection;
 import org.eclipse.jface.text.ITypedRegion;
 import org.eclipse.jface.text.Region;
@@ -155,7 +156,6 @@
 import org.eclipse.jdt.internal.ui.text.javadoc.JavadocContentAccess2;
 import org.eclipse.jdt.internal.ui.viewsupport.BindingLinkedLabelComposer;
 import org.eclipse.jdt.internal.ui.viewsupport.JavaElementLinks;
-import org.eclipse.jdt.internal.ui.viewsupport.browser.BrowserTextAccessor;
 import org.eclipse.jdt.internal.ui.viewsupport.javadoc.SignatureStylingMenuToolbarAction;
 
 
@@ -428,6 +428,12 @@ protected boolean canEnableFor(IStructuredSelection selection) {
 	 */
 	private volatile boolean fIgnoringNewInputOverride;
 
+	/**
+	 * The listeners to be notified when the input changed.
+	 * @since 3.35
+	 */
+	private ListenerList<IInputChangedListener> fInputChangeListeners= new ListenerList<>(ListenerList.IDENTITY);
+
 	/**
 	 * The Javadoc view's select all action.
 	 */
@@ -681,13 +687,13 @@ protected void fillToolBar(IToolBarManager tbm) {
 		tbm.add(new Separator());
 
 		if (fIsUsingBrowserWidget) {
-			BrowserTextAccessor browserAccessor= new BrowserTextAccessor(fBrowser);
 			Runnable viewRefreshTask= () -> {
 				fIgnoringNewInputOverride= true;
 				setLinkingEnabled(isLinkingEnabled()); // triggers refresh of the view using last set selection
 			};
 			// toolbar widget is being re-created later so we need to do our setup then
-			var stylingMenuAction= new SignatureStylingMenuToolbarAction(fBrowser.getParent().getShell(), browserAccessor, () -> fOriginalInput, viewRefreshTask) {
+			var stylingMenuAction= new SignatureStylingMenuToolbarAction(fBrowser.getParent().getShell(),
+					fInputChangeListeners::add, viewRefreshTask) {
 				// we take advantage of this method being called after toolbar item creation (in ActionContributionItem.fill()) which happens when whole toolbar is being re-created to be displayed
 				@Override
 				public void addPropertyChangeListener(IPropertyChangeListener listener) {
@@ -931,6 +937,9 @@ protected void doSetInput(Object input) {
 			fText.setText(javadocHtml);
 			TextPresentation.applyTextPresentation(fPresentation, fText);
 		}
+		for (IInputChangedListener listener : fInputChangeListeners) {
+			listener.inputChanged(javadocHtml);
+		}
 	}
 
 	/**

org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/java/hover/JavadocHover.java

@@ -133,7 +133,6 @@
 import org.eclipse.jdt.internal.ui.text.javadoc.JavadocContentAccess2;
 import org.eclipse.jdt.internal.ui.viewsupport.JavaElementLabelComposer;
 import org.eclipse.jdt.internal.ui.viewsupport.JavaElementLinks;
-import org.eclipse.jdt.internal.ui.viewsupport.browser.BrowserTextAccessor;
 import org.eclipse.jdt.internal.ui.viewsupport.javadoc.SignatureStylingMenuToolbarAction;
 
 
@@ -378,10 +377,8 @@ public IInformationControl doCreateInformationControl(Shell parent) {
 				};
 				ToolBarManager tbmSecondary= new ToolBarManager(SWT.FLAT);
 				tbmSecondary.createControl(toolbarComposite).setLayoutData(new GridData(SWT.END, SWT.BEGINNING, false, false));
-				BrowserTextAccessor browserAccessor= new BrowserTextAccessor(iControl);
-				var stylingMenuAction= new SignatureStylingMenuToolbarAction(iControl.getShell(), browserAccessor,
-						() -> iControl.getInput() == null ? null : iControl.getInput().getHtml(),
-						viewRefreshTask);
+				var stylingMenuAction= new SignatureStylingMenuToolbarAction(iControl.getShell(),
+						iControl::addInputChangeListener, viewRefreshTask);
 				tbmSecondary.add(stylingMenuAction);
 				tbmSecondary.update(true);
 				stylingMenuAction.setup(tbmSecondary.getControl());

org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/viewsupport/ArmListeningMenuItemsConfigurer.java

@@ -14,7 +14,6 @@
 package org.eclipse.jdt.internal.ui.viewsupport.javadoc;
 
 import java.util.Objects;
-import java.util.function.Supplier;
 import java.util.stream.Stream;
 
 import org.eclipse.swt.widgets.Control;
@@ -27,17 +26,18 @@
 import org.eclipse.jface.action.ActionContributionItem;
 import org.eclipse.jface.action.IAction;
 import org.eclipse.jface.action.IMenuCreator;
+import org.eclipse.jface.internal.text.html.BrowserInformationControlInput;
+
+import org.eclipse.jface.text.IInputChangedListener;
 
 import org.eclipse.jdt.internal.ui.JavaPluginImages;
 import org.eclipse.jdt.internal.ui.viewsupport.JavaElementLinks;
 import org.eclipse.jdt.internal.ui.viewsupport.JavaElementLinks.IStylingConfigurationListener;
-import org.eclipse.jdt.internal.ui.viewsupport.browser.BrowserTextAccessor;
-import org.eclipse.jdt.internal.ui.viewsupport.browser.BrowserTextAccessor.IBrowserContentChangeListener;
 
 /**
  * Toolbar item action for building & presenting javadoc styling menu.
  */
-public class SignatureStylingMenuToolbarAction extends Action implements IMenuCreator, IBrowserContentChangeListener, IStylingConfigurationListener {
+public class SignatureStylingMenuToolbarAction extends Action implements IMenuCreator, IInputChangedListener, IStylingConfigurationListener {
 	private final Action[] noStylingActions= { new NoStylingEnhancementsAction() };
 	private final Action[] enabledActions;
 	private final Shell parent;
@@ -46,36 +46,43 @@ public class SignatureStylingMenuToolbarAction extends Action implements IMenuCr
 	private Action[] actions;
 	protected Menu menu= null;
 	private boolean enhancementsEnabled= JavaElementLinks.getStylingEnabledPreference();
+	private String javadocContent;
 
-	public SignatureStylingMenuToolbarAction(Shell parent, BrowserTextAccessor browserAccessor, Supplier<String> javadocContentSupplier, Runnable enhancementsReconfiguredTask) {
+	public SignatureStylingMenuToolbarAction(Shell parent, JavadocContentInputAccessor contentInputAccessor, Runnable enhancementsReconfiguredTask) {
 		super(JavadocStylingMessages.JavadocStyling_enabledTooltip, IAction.AS_DROP_DOWN_MENU);
 		Objects.requireNonNull(parent);
+		Objects.requireNonNull(contentInputAccessor);
 		setImageDescriptor(JavaPluginImages.DESC_ETOOL_JDOC_HOVER_EDIT);
 		// SignatureStylingColorSubMenuItem requires top level shell to display native color picker
-		// JavadocView passes to level shell but JavadocHover passes hover's shell
+		// JavadocView passes top level shell but JavadocHover passes hover's shell
 		// (Display.getActiveShell() would not work since JavadocView is created when active shell is startup splash screen shell)
 		Shell topLevelShell = (parent.getParent() instanceof Shell parentShell) ? parentShell : parent;
 		enabledActions= new Action[] {
 				new ToggleSignatureTypeParametersColoringAction(),
-				new SignatureStylingColorSubMenuItem(topLevelShell, javadocContentSupplier)};
+				new SignatureStylingColorSubMenuItem(topLevelShell, () -> this.javadocContent)};
 		actions= noStylingActions;
 		setMenuCreator(this);
 		this.parent= parent;
 		this.enhancementsReconfiguredTask= enhancementsReconfiguredTask;
 		presentEnhancementsState();
 		setHoverImageDescriptor(null);
 		setId(SignatureStylingMenuToolbarAction.class.getSimpleName());
-		browserAccessor.addContentChangedListener(this); // remove not necessary since lifecycle of this action is the same as that of the browser widget
+		contentInputAccessor.addInputChangedListener(this);
 		JavaElementLinks.addStylingConfigurationListener(this);
 	}
 
 	@Override
-	public void browserContentChanged(Supplier<String> contentAccessor) {
+	public void inputChanged(Object newInput) {
+		javadocContent = null;
 		if (!enhancementsEnabled) {
 			return;
 		}
-		var content= contentAccessor.get();
-		if (content != null && !content.isBlank() && JavaElementLinks.isStylingPresent(content)) {
+		if (newInput instanceof String str) {
+			javadocContent = str;
+		} else if (newInput instanceof BrowserInformationControlInput bicInput) {
+			javadocContent = bicInput.getHtml();
+		}
+		if (javadocContent != null && !javadocContent.isBlank() && JavaElementLinks.isStylingPresent(javadocContent)) {
 			actions= enabledActions;
 		} else {
 			actions= noStylingActions;
@@ -127,7 +134,7 @@ public void stylingStateChanged(boolean isEnabled) {
 		parent.getDisplay().execute(() -> {
 			enhancementsEnabled= isEnabled;
 			presentEnhancementsState();
-			// even if enhancements switched from off to on, only browserContentChanged() sets enabledActions
+			// even if enhancements switched from off to on, only inputChanged() sets enabledActions
 			actions= noStylingActions;
 			runEnhancementsReconfiguredTask();
 		});
@@ -171,4 +178,8 @@ public void run() {
 		}
 
 	}
+
+	public interface JavadocContentInputAccessor {
+		void addInputChangedListener(IInputChangedListener changeListener);
+	}
 }