<extension

         point="org.eclipse.ui.workbench.texteditor.outOfSyncHandler">

      <handler

            answer="Compare file system and editor versions"

            class="org.eclipse.compare.CompareOutOfSyncHandler">

      </handler>

   </extension>

/*******************************************************************************

 * Copyright (c) 2007, 2008 IBM Corporation and others.

 * All rights reserved. This program and the accompanying materials

 * are made available under the terms of the Eclipse Public License v1.0

 * which accompanies this distribution, and is available at

 * http://www.eclipse.org/legal/epl-v10.html

 *

 * Contributors:

 *     Renato Silva - initial prototype  

 *                    (http://bugs.eclipse.org/bugs/show_bug.cgi?id=261716)

 *******************************************************************************/

package org.eclipse.compare;

import java.io.BufferedReader;

import java.io.InputStream;

import java.io.InputStreamReader;

import org.eclipse.core.filesystem.EFS;

import org.eclipse.core.runtime.IProgressMonitor;

import org.eclipse.jface.dialogs.MessageDialog;

import org.eclipse.swt.widgets.Shell;

import org.eclipse.ui.IEditorInput;

import org.eclipse.ui.PlatformUI;

import org.eclipse.ui.editors.text.TextFileDocumentProvider;

import org.eclipse.ui.texteditor.IDocumentProvider;

import org.eclipse.ui.texteditor.OutOfSyncHandler;

public class CompareOutOfSyncHandler extends OutOfSyncHandler {

	public boolean handle(IDocumentProvider documentProvider, IEditorInput editorInput, IProgressMonitor monitor) {

		//TODO Actual implementation

		TextFileDocumentProvider provider = (TextFileDocumentProvider) documentProvider;

		StringBuilder sb = new StringBuilder();

		try {

			InputStream is = provider.getFileStore(editorInput).openInputStream(EFS.NONE, monitor);

			BufferedReader reader = new BufferedReader(new InputStreamReader(is));

			String line;

			while ((line = reader.readLine()) != null)

				sb.append(line + '\n');

		} catch (Exception e1) {

			e1.printStackTrace();

		}

		Shell shell = PlatformUI.getWorkbench().getActiveWorkbenchWindow().getShell();

		MessageDialog.openInformation(shell, "Editor version", documentProvider.getDocument(editorInput).get()); //$NON-NLS-1$

		MessageDialog.openInformation(shell, "File system version", sb.toString());  //$NON-NLS-1$

		MessageDialog.openInformation(shell, "Compare", "Compare plug-in handled file saving."); 		 //$NON-NLS-1$ //$NON-NLS-2$

		return true;

	}

}

 *     Renato Silva - out-of-sync extension point (http://bugs.eclipse.org/bugs/show_bug.cgi?id=261716)

 *      

import org.eclipse.jface.window.Window;

	/**

	 * Presents a dialog for asking what to do on out-of-sync saving errors.

	 * @param handlers the available handlers

	 * @return the selected handler or null otherwise

	 */

	protected OutOfSyncHandler selectOutOfSycHandler(OutOfSyncHandler[] handlers) {		

		OutOfSyncHandler defaultHandler = new OutOfSyncHandler(){			

			public String getAnswer() {

				return EditorMessages.Editor_error_save_outofsync_overwrite;

			}			

			public boolean handle(IDocumentProvider documentProvider, IEditorInput editorInput, IProgressMonitor progressMonitor) {

				performSave(true, progressMonitor); 

				return true;

			}			

		};		

		OutOfSyncHandlerSelectionDialog dialog = new OutOfSyncHandlerSelectionDialog(getSite().getShell(), handlers, defaultHandler, getEditorInput().getToolTipText());

		if (dialog.open() == Window.OK) 

			return dialog.getSelected();

		return null;

	}

OutOfSyncHandlerSelectionDialog_cancel=Cancel

OutOfSyncHandlerSelectionDialog_ok=Ok

	public static String Editor_error_save_outofsync_no_action_selected;

	public static String Editor_error_save_outofsync_overwrite;

	public static String OutOfSyncHandlerSelectionDialog_cancel;

	public static String OutOfSyncHandlerSelectionDialog_ok;

    <extension-point id="outOfSyncHandler" name="Out Of Sync Handler" schema="schema/outOfSyncHandler.exsd"/>

<?xml version='1.0' encoding='UTF-8'?>

<!-- Schema file written by PDE -->

<schema targetNamespace="org.eclipse.ui.workbench.texteditor" xmlns="http://www.w3.org/2001/XMLSchema">

<annotation>

      <appInfo>

         <meta.schema plugin="org.eclipse.ui.workbench.texteditor" id="outOfSyncHandler" name="Out Of Sync Handler"/>

      </appInfo>

      <documentation>

         Allows contributors to handle out-of-sync file savings.

      </documentation>

   </annotation>

   <element name="extension">

      <annotation>

         <appInfo>

            <meta.element />

         </appInfo>

      </annotation>

      <complexType>

         <choice>

            <element ref="handler"/>

         </choice>

         <attribute name="point" type="string" use="required">

            <annotation>

               <documentation>

               </documentation>

            </annotation>

         </attribute>

         <attribute name="id" type="string">

            <annotation>

               <documentation>

               </documentation>

            </annotation>

         </attribute>

         <attribute name="name" type="string">

            <annotation>

               <documentation>

               </documentation>

               <appInfo>

                  <meta.attribute translatable="true"/>

               </appInfo>

            </annotation>

         </attribute>

      </complexType>

   </element>

   <element name="handler">

      <complexType>

         <attribute name="class" type="string" use="required">

            <annotation>

               <documentation>

               </documentation>

               <appInfo>

                  <meta.attribute kind="java" basedOn="org.eclipse.ui.texteditor.OutOfSyncHandler:"/>

               </appInfo>

            </annotation>

         </attribute>

         <attribute name="answer" type="string" use="required">

            <annotation>

               <documentation>

                  Users will be prompted for what to do, and each implementation will be listed as an available action, using this attribute as action description.

For example, the value for a compare and merge handler could be "Compare and merge the versions".

               </documentation>

            </annotation>

         </attribute>

      </complexType>

   </element>

   <annotation>

      <appInfo>

         <meta.section type="since"/>

      </appInfo>

      <documentation>

         3.5

      </documentation>

   </annotation>

   <annotation>

      <appInfo>

         <meta.section type="examples"/>

      </appInfo>

      <documentation>

         [Enter extension point usage example here.]

      </documentation>

   </annotation>

   <annotation>

      <appInfo>

         <meta.section type="apiinfo"/>

      </appInfo>

      <documentation>

         [Enter API information here.]

      </documentation>

   </annotation>

   <annotation>

      <appInfo>

         <meta.section type="implementation"/>

      </appInfo>

      <documentation>

         [Enter information about supplied implementation of this extension point.]

      </documentation>

   </annotation>

</schema>

/*******************************************************************************

 * Copyright (c) 2007, 2008 IBM Corporation and others.

 * All rights reserved. This program and the accompanying materials

 * are made available under the terms of the Eclipse Public License v1.0

 * which accompanies this distribution, and is available at

 * http://www.eclipse.org/legal/epl-v10.html

 *

 * Contributors:

 *     Renato Silva - initial API and implementation 

 *                    (http://bugs.eclipse.org/bugs/show_bug.cgi?id=261716)

 *                    

 *******************************************************************************/

package org.eclipse.ui.texteditor;

import org.eclipse.core.runtime.CoreException;

import org.eclipse.core.runtime.IConfigurationElement;

import org.eclipse.core.runtime.IProgressMonitor;

import org.eclipse.core.runtime.Platform;

import org.eclipse.ui.IEditorInput;

/**

 * 

 * A handler for file saving when editor content is out-of-sync with the file system.

 */

public abstract class OutOfSyncHandler {

	private static String EXTENSION_POINT_ID = "org.eclipse.ui.workbench.texteditor.outOfSyncHandler"; //$NON-NLS-1$

	private static String ANSWER_ATTRIBUTE = "answer"; //$NON-NLS-1$

	private static String CLASS_ATTRIBUTE = "class"; //$NON-NLS-1$	

	private String answer;

	public static OutOfSyncHandler[] getContributors() {

		OutOfSyncHandler[] result;

		IConfigurationElement[] elements = Platform.getExtensionRegistry().getConfigurationElementsFor(EXTENSION_POINT_ID);

		result = new OutOfSyncHandler[elements.length];

		for (int i= 0; i < elements.length; i++) {

			IConfigurationElement element = elements[i];

			Object executable;

			try {

				executable= elements[i].createExecutableExtension(CLASS_ATTRIBUTE);

				if (executable instanceof OutOfSyncHandler) {

					OutOfSyncHandler handler = ((OutOfSyncHandler) executable);

					handler.answer = element.getAttribute(ANSWER_ATTRIBUTE);

					result[i] = handler;

				}

			} catch (CoreException e) {

				// TODO Log failed contributor instantiation

			}

		}

		return result;

	}

	/** 

	 *  Users will be prompted for what to do on out-of-sync situations.

	 *  This will return the matching answer for the underlying handler.  

	 *  @return the contributed answer

	 */

	public String getAnswer() {

		return answer;

	}

	/**

	 * Handles the file saving when editor content is out-of-sync with the file system. 

	 * Must be implemented appropriately by contributors.

	 * 

	 * @param documentProvider the document provider

	 * @param editorInput the editor input object

	 * @param monitor the progress monitor

	 * @return true for handle success, false for any error

	 */

	//TODO Define parameters (need to include the current text and a 

	//     file system reference to the underlying document

	public abstract boolean handle(IDocumentProvider documentProvider, IEditorInput editorInput, IProgressMonitor monitor); 	

}

/*******************************************************************************

 * Copyright (c) 2007, 2008 IBM Corporation and others.

 * All rights reserved. This program and the accompanying materials

 * are made available under the terms of the Eclipse Public License v1.0

 * which accompanies this distribution, and is available at

 * http://www.eclipse.org/legal/epl-v10.html

 *

 * Contributors:

 *     Renato Silva - initial API and implementation 

 *                    (http://bugs.eclipse.org/bugs/show_bug.cgi?id=261716)

 *                    

 *******************************************************************************/

package org.eclipse.ui.texteditor;

import org.eclipse.swt.SWT;

import org.eclipse.swt.events.SelectionEvent;

import org.eclipse.swt.events.SelectionListener;

import org.eclipse.swt.layout.GridData;

import org.eclipse.swt.layout.GridLayout;

import org.eclipse.swt.widgets.Button;

import org.eclipse.swt.widgets.Composite;

import org.eclipse.swt.widgets.Control;

import org.eclipse.swt.widgets.Shell;

import org.eclipse.jface.dialogs.MessageDialog;

import org.eclipse.ui.internal.texteditor.NLSUtility;

/**

 * Presents a dialog asking the user to choose an action to be performed

 * when an out-of-sync file saving occurs. Each option is related to

 * a out-of-sync handler extension.  

 */

public class OutOfSyncHandlerSelectionDialog extends MessageDialog {

	private OutOfSyncHandler[] handlers;	

	private OutOfSyncHandler defaultHandler;

	private OutOfSyncHandler selectedHandler;

	/**

	 * Initializes the dialog.

	 * 

	 * @param parentShell the parent shell

	 * @param handlers the available out-of-sync handlers

	 * @param defaultHandler an additional, non-registered default handler

	 * @param fileName The underlying file name

	 */

	public OutOfSyncHandlerSelectionDialog(Shell parentShell, OutOfSyncHandler[] handlers, OutOfSyncHandler defaultHandler, String fileName) {

		super(parentShell, EditorMessages.Editor_error_save_outofsync_title, 

			null, NLSUtility.format(EditorMessages.Editor_error_save_outofsync_message, fileName), WARNING, 

			new String[] { EditorMessages.OutOfSyncHandlerSelectionDialog_ok, 

						   EditorMessages.OutOfSyncHandlerSelectionDialog_cancel }, 0);		

		this.handlers = handlers;

		this.defaultHandler = defaultHandler;

	}

	private void updateSelection(OutOfSyncHandler selected) {

		this.selectedHandler = selected;

	}

	private void createOption(Composite buttonArea, final OutOfSyncHandler handler) {

		Button radioButton = new Button(buttonArea, SWT.RADIO);

		radioButton.setText(handler.getAnswer());

		radioButton.addSelectionListener(new SelectionListener(){

			public void widgetSelected(SelectionEvent e) {

				updateSelection(handler);

			}

			public void widgetDefaultSelected(SelectionEvent e) {

				updateSelection(handler);

			}

		});

	}

	protected Control createCustomArea(Composite parent) {		

		Composite buttonArea = new Composite(parent, SWT.NULL);

		buttonArea.setLayout(new GridLayout(1, true));

		GridData data = new GridData(SWT.FILL, SWT.FILL, true, false);

		data.horizontalIndent = 38;

		buttonArea.setLayoutData(data);		

		for (int i = 0; i < handlers.length; i++)

			if (handlers[i] != null)

				createOption(buttonArea, handlers[i]);

		createOption(buttonArea, defaultHandler);

		return parent;

	}

	/**

	 * Gets the selected handler. Should normally be called after an <code>open()</code>.

	 * @return the selected handler

	 */

	public OutOfSyncHandler getSelected() {

		return selectedHandler;

	}

}

	public IFileStore getFileStore(Object element) {

		FileInfo info= (FileInfo) fFileInfoMap.get(element);

		return getFileStore(info);

	}