Eclipse Community Forums: TMF (Xtext) » Recommended way to use IOutlineTreeProvider.Background

Home » Modeling » TMF (Xtext) » Recommended way to use IOutlineTreeProvider.Background

Mon, 04 May 2020 05:16

Eclipse User

We noticed that opening an Xtext editor can cause UI freezes due to synchronous outline computation. Next we found the marker interface IOutlineTreeProvider.Background which allows to push outline computation to the background.

Seeing that IOutlineTreeProvider.Background is not added by OutlineTreeProviderFragment2, I wonder if for some reasons this interface is not recommended, or would it make sense to make it the default?

We actually saw a few deadlocks when blindly using IOutlineTreeProvider.Background, but we found that the real culprits where in our own code. Is risk of deadlock one reason why this is not the default?

Does anyone know best practices of using IOutlineTreeProvider.Background without risk of deadlock? For example, in one situation we observed the outline needing the UI thread for creating icons, I don't remember if this surfaced as illegal thread access or used syncExec, thus risking deadlock. Perhaps, background outline requires a specific style of label provider?

Lastly, I wonder what is the relation between Background (since 2.8) and BackgroundOutlineTreeProvider (since 2.4). Which one of these should be preferred nowadays?

Mon, 04 May 2020 05:37

Eclipse User

Hi Stephan,

changing the default to background would have been a breaking change, that's why it's still only an opt-in. Existing clients would run into the problems that you faced: Rather than working with image descriptors, default impl work with images directly which do need a UI thread.
The Xtend outline implementation uses the background tree provider since its early days and we did not see any deadlocks so far.

Best practices: Hard to tell. It's certainly not possible anymore to work with SWT objects directly, e.g all image computation must be based on image descriptors (see IOutlineNode.Extension and AbstractOutlineNode.setImageDescriptor(ImageDescriptor)).

I hope this helps
Sebastian

Mon, 04 May 2020 08:43

Eclipse User

Compatibility is a very good reason, indeed.
Thanks for the hint about the Xtend implementation.
I think we can work it out from here.

thanks,
Stephan

Previous Topic:	Illegal reflective access operation has occurred (guice3.0)
Next Topic:	Serialization of unordered, optional attributes

Goto Forum:

-=] Back to Top [=-

Current Time: Sun Jul 06 05:49:21 EDT 2025

.:: Contact :: Home ::.

Breadcrumbs

Sign up to our Newsletter