Apply patch in Sync view

This page is under construction: I haven't described the suggested solution in details neither I have listed up all the issues yet.

Problem

Provide an alternative way of applying patches. Desired behavior, which could in future replace the current one, is to use the Synchronize View to display content of a patch, resolve potential conflicts and apply the patch eventually. This way while the comparison is being done, other features of Eclipse are available to use, we are not bounded to the current Apply Patch wizard.

This is tracked by bug 236169.

Solution

The proposed solution consist of several parts:

• Subscriber - a subscriber implementation that provides synchronization between local resources to be patched and their in-memory representation with changes from the patch applied. As the result of it's nature, the subscriber does not contact any remote server. It's a three-way comparison, all changes from the patch are treated as incoming.
• SyncInfo - sync info node is returned to resources that would be affected by the patch. The direction of the sync info node can be either incoming or conflicting (for unmatched changes).
• IResourceVariant - represents local resource with changes from the patch
• ModelProvider -
  • model objects -
  • ResourceMappings -
• org.eclipse.team.ui.synchronizeWizards extension point -
• org.eclipse.team.ui.synchronizeParticipants extension point -
• org.eclipse.ui.navigator.navigatorContent extension point -
  • content providers -
  • label providers -
• org.eclipse.team.ui.teamContentProviders - associates the patch model provider with the patch content provider
• org.eclipse.core.runtime.adapters -

Tasks

Overall progress
21% (11/52)

Required changes are grouped in the following areas:

Synchronize participant, subscriber

• Add synchronize participant + subscriber
• IResourceVariant implementation should return patched files when asked for Storage
• Persistable, intitialized on startup; remember which hunks have been applied; remember patch options set
• Pinnable
• Listen to workspace changes, reapply all hunks for a file when needed using the patch options already set
• bug: Applying changes should remove it from the sync view - change state to 'in sync'
• Make sure non-workspace patches can be applied via Sync view as well
• Close (ask to close) participant when all hunks have been applied, so it won't bother about forthcoming resource changes (deltas)

Synchronize wizard

• Apply Patch sync participant/wizard should be available in the Synchronize wizard

• Embed apply patch wizard into synchronize wizard so patch (input) can be selected
• Setting bounds for a nested wizard is an issue, see bug 297470
• Add a page to the new wizard where user can select how the patch should be applied (traditionally, preview in the wizard or in Sync view)
• Add more options to the new wizard page, see bug 198149 and bug 117298

• Provide a proper icon for the participant
• Provide valid description for the participant

Model Provider

• Model objects for hunks
• Don't block other model providers to participate in synchronization (applying patch)
• Other model providers do not display hunks

• Use DiffProject, FilePatch2 and Hunk as model objects
• Use PatchDiffNodes as model objects, they represent the result of applying a patch (not the patch strucutre as types above) and they implement ICompareInput so are compare-ready
• Missing objects representing folders, the result is something like flat presentation
• Other models do not indicate any conflicts when applying a patch -> unmerged hunks should be treated as sync view conflicts, see also #Label provider

Sync view

• Status line should display lines added/removed by the patch
• NPE when trying to switch to a different synchronization when applying patch (see bug 256972)
• 'Schedule' action in the view's drop down menu should be disabled (or removed)
• Link with Editor

Content provider

• Display hunks in Sync view
• Hunks objects never have children, get rid of the [+] sign

Label provider

• Display Patch options settings: fuzz factor, offset used (bug 205762), moved from(?). All per hunk.
• Use conflict ('double-headed red arrow') icon instead of 'red X' icon for unmatched hunks
• Indicate when a project from the patch doesn't exist in the workspace

Context menu

• Update means now 'Apply'
• 'Apply' should work for projects, files and individual hunks
• 'Apply' should be disabled for unmatched hunks
• 'Apply' on file/project containing unmatched hunks should affect matched hunks only
• Do we need two 'Apply' variants: merge and overwrite-and-update?
• Add 'Open'/'Open With' actions
• Add 'Open in Compare' action
• 'Remove from View' means now 'Exclude'
• No 'Exclude' action available, replaced with 'Remove from the view'

View toolbar

• 'Copy All Incoming Changes...' / 'Merge All Non-conflicting Changes' means 'Apply All'
• Only 'Incoming' and 'Conflicts' mode should be available
• 'Flat presentation' is meaningless for Patch Model (see also bug 277107)

Operations

Make all operations in the Apply Patch wizard be available in the Sync view (when applying a patch).

Patch options

• Re-applying patch -> synchronize again
• Remember set options when re-applying: fuzz factor, ignored segments, moved hunks
• Ignore segments setting applies to all files in the patch -> re-apply
• Reverse patch on sync's view toolbar(?)
• Show matched Hunks: All hunks are shown
• Show excluded Hunks -> Sync's view drop down > Restore Removed Items
• Fuzz factor / Guess
• Generate .rej files for unmerged hunks - applies to all changes from the patch
• Move hunk

Compare Editor

• 'Open In Compare Editor' for a file should display full file content with changes from all hunks
• bug: Open in Compare editor for a file (in a patch) displays Hunks in the structure view. First hunk is select on start but nothing is displayed in the compare content area.

• 'Open In Compare Editor' should be available for hunks
• bug: No Java structure available for Java files; fine(?) for hunks

• bug: ClassCastException when right-clicking in comparison for a file

Source code

No source code is available yet, the plan is to commit to a public branch soon. Or at least submit a dirty patch on the bug 236169.