Revision as of 08:39, 3 December 2009

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 -
• SyncInfo -
• IResourceVariant -
• 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.core.runtime.adapters -

Tasks

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

Synchronize wizard

• Embed apply patch wizard into synchronize wizard so patch (input) can be selected
• 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)

Model Provider

• Display hunks in Sync view
• Don't block other model providers to participate in synchronization (applying patch)
• 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

Sync view

• Status line should display lines added/removed by the patch

Content provider

Label provider

• Display Patch options settings: fuzz factor, offset used, moved from(?)
• Use conflict ('double-headed red arrow') icon instead of 'red X' icon for unmatched hunks

Context menu

• Update means 'Apply'
• No 'Exclude' action available, replace with 'Remove from the view'

View toolbar

• 'Copy All Incoming Changes...' means 'Apply All'

Operations

Patch options

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

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.