Attachment #127736 for bug #258853

Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.




/*******************************************************************************
 * Copyright (c) 2008, 2009 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

public class ActionMessages extends NLS {
	private static final String BUNDLE_NAME = "org.eclipse.pde.api.tools.ui.internal.actions.actionmessages"; //$NON-NLS-1$
	public static String ApiToolingSetupObjectContribution_0;
	public static String SelectABaseline;
	public static String SetAsDefault;
	public static String EnterFileName;
	public static String SelectFileName;
	public static String Browse;
	public static String ConvertToHtml;
	public static String CompareDialogTitle;
	public static String CompareDialogCollectingElementTaskName;
	public static String CompareDialogComputeDeltasTaskName;
	public static String CompareDialogCreateReportTaskName;

	static {
		// initialize resource bundle
		NLS.initializeMessages(BUNDLE_NAME, ActionMessages.class);




###############################################################################
# Copyright (c) 2008, 2009 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

#     IBM Corporation - initial API and implementation
###############################################################################
ApiToolingSetupObjectContribution_0=Set up API tooling
SelectABaseline=Select a baseline:
SetAsDefault={0} (default)
EnterFileName=Enter a file name for the report
SelectFileName=Select a file name
Browse=Browse...
ConvertToHtml=Convert to html
CompareDialogTitle=Compare With Baseline
CompareDialogCollectingElementTaskName=Collecting elements to compare
CompareDialogComputeDeltasTaskName=Compute deltas
CompareDialogCreateReportTaskName=Create report file

Lines 1-5 Link Here

(-)plugin.properties (-2 / +3 lines)
1	###############################################################################	1	###############################################################################
2	# Copyright (c) 2007, 2008 IBM Corporation and others.	2	# Copyright (c) 2007, 2009 IBM Corporation and others.
3	# All rights reserved. This program and the accompanying materials	3	# All rights reserved. This program and the accompanying materials
4	# are made available under the terms of the Eclipse Public License v1.0	4	# are made available under the terms of the Eclipse Public License v1.0
5	# which accompanies this distribution, and is available at	5	# which accompanies this distribution, and is available at
Lines 42-45 Link Here
42	MarkerCategory.name = API Problems	42	MarkerCategory.name = API Problems
43	ApiToolsJavadocProposals.name = API Tools Javadoc Proposals	43	ApiToolsJavadocProposals.name = API Tools Javadoc Proposals
44	MarkerGroupingEntryLabel=API Usage and Compatibility	44	MarkerGroupingEntryLabel=API Usage and Compatibility
45	ApiToolsProposalCategory.name = PDE API Tools Proposals	45	ApiToolsProposalCategory.name = PDE API Tools Proposals
		46	APICompare.name=Compare With...




               value="org.eclipse.pde.api.tools.apiAnalysisNature">
         </filter>
      </objectContribution>
      <objectContribution
            adaptable="false"
            id="org.eclipse.pde.api.tools.ui.compare"
            objectClass="org.eclipse.jdt.core.IJavaElement">
         <action
               class="org.eclipse.pde.api.tools.ui.internal.actions.CompareWithAction"
               enablesFor="+"
               id="org.eclipse.pde.api.tools.ui.action.compare"
               label="%APICompare.name"
               menubarPath="org.eclipse.pde.ui.project.tools/group1">
         </action>
         <menu
               id="org.eclipse.pde.ui.project.tools"
               label="%PdeTools.name">
            <separator
                  name="group1">
            </separator>
         </menu>
      </objectContribution>
   </extension>
   <extension
         point="org.eclipse.ui.propertyPages">




/*******************************************************************************
 * Copyright (c) 2009 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.pde.api.tools.ui.internal.actions;

import java.io.File;
import java.util.Arrays;

import org.eclipse.core.runtime.Path;
import org.eclipse.jface.dialogs.Dialog;
import org.eclipse.jface.window.IShellProvider;
import org.eclipse.osgi.util.NLS;
import org.eclipse.pde.api.tools.internal.provisional.ApiPlugin;
import org.eclipse.pde.api.tools.internal.provisional.IApiBaselineManager;
import org.eclipse.pde.api.tools.internal.provisional.model.IApiBaseline;
import org.eclipse.pde.api.tools.ui.internal.SWTFactory;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Combo;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.FileDialog;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.Text;

public class CompareDialog extends Dialog {

	public String baseline = null;
	public String reportFileName = null;
	private String title;
	public boolean convertToHtml;

	public CompareDialog(IShellProvider provider, String title) {
		super(provider);
		this.title = title;
	}

	protected void configureShell(Shell newShell) {
		super.configureShell(newShell);
		newShell.setText(this.title);
	}
	protected boolean isResizable() {
		return true;
	}
	protected Control createDialogArea(Composite parent) {
		Composite composite = (Composite) super.createDialogArea(parent);
		// add controls to composite as necessary
		Composite lcomp = new Composite(composite, SWT.NONE);
		GridLayout layout = new GridLayout(4, false);
		layout.marginWidth = 0;
		layout.marginHeight = 0;
		lcomp.setLayout(layout);
		lcomp.setFont(parent.getFont());
		GridData gd = new GridData(SWT.FILL, SWT.FILL, true, true);
		gd.minimumWidth = 310;
		gd.minimumHeight = 100;
		lcomp.setLayoutData(gd);

		SWTFactory.createWrapLabel(lcomp, ActionMessages.SelectABaseline, 4);
		IApiBaselineManager apiBaselineManager = ApiPlugin.getDefault().getApiBaselineManager();
		IApiBaseline defaultBaseline = apiBaselineManager.getDefaultApiBaseline();
		String defaultBaselineName = defaultBaseline != null ? defaultBaseline.getName() : null;
		IApiBaseline[] baselines = apiBaselineManager.getApiBaselines();
		int length = baselines.length;
		String[] baselinesItems = new String[length];
		String[] baselinesNames = new String[length];
		int index = 0;
		// set the names
		for (int i = 0; i < length; i++) {
			String currentBaselineName = baselines[i].getName();
			baselinesNames[i] = currentBaselineName;
		}
		Arrays.sort(baselinesNames);
		// set the labels
		for (int i = 0; i < length; i++) {
			String currentBaselineName = baselinesNames[i];
			if (defaultBaselineName != null && defaultBaselineName.equals(currentBaselineName)) {
				baselinesItems[i] = NLS.bind(ActionMessages.SetAsDefault, currentBaselineName);
				this.baseline = currentBaselineName;
				index = i;
			} else {
				baselinesItems[i] = currentBaselineName;
			}
		}
		Combo baselineCombo = new Combo(lcomp, SWT.BORDER | SWT.FLAT | SWT.READ_ONLY);
		gd = new GridData(SWT.FILL, SWT.CENTER, true, false, 4, 1);
		baselineCombo.setLayoutData(gd);
		baselineCombo.setItems(baselinesItems);
		baselineCombo.setData(baselinesNames);
		baselineCombo.select(index);

		baselineCombo.addSelectionListener(new SelectionAdapter(){
			public void widgetSelected(SelectionEvent e) {
				Combo combo = (Combo) e.widget;
				String[] baselineNames = (String[]) combo.getData();
				String selectedBaselineName = baselineNames[combo.getSelectionIndex()];
				CompareDialog.this.baseline = selectedBaselineName;
			}
		});
		SWTFactory.createWrapLabel(lcomp, ActionMessages.EnterFileName, 4);
		final Text fileNameText = new Text(lcomp, SWT.BORDER);
		fileNameText.setFont(lcomp.getFont());
		gd = new GridData(SWT.FILL, SWT.CENTER, true, false, 3, 1);
		fileNameText.setLayoutData(gd);

		Button browseButton = new Button(lcomp, SWT.PUSH);
		browseButton.setFont(parent.getFont());
		browseButton.setText(ActionMessages.Browse);
		gd = new GridData(SWT.RIGHT, SWT.CENTER, false, false, 1, 1);
		browseButton.setLayoutData(gd);

		browseButton.addSelectionListener(new SelectionAdapter() {
			public void widgetSelected(SelectionEvent e) {
				FileDialog dialog = new FileDialog(getShell());
				dialog.setText(ActionMessages.SelectFileName);
				String loctext = fileNameText.getText().trim();
				if (loctext.length() > 0) {
					File file = new File(loctext).getParentFile();
					if (file != null && file.exists()) {
						dialog.setFilterPath(file.getAbsolutePath());
					}
				}
				String newPath = dialog.open();
				if (newPath != null && !new Path(loctext).equals(new Path(newPath))) {
					/*
					 * If the path is identical, but there is no component loaded, we still
					 * want to reload. This might be the case if the combo is initialized by
					 * copy/paste with a path that points to a plugin directory
					 */
					fileNameText.setText(newPath);
					CompareDialog.this.reportFileName = newPath;
				}
			}
		});
		Button convertToHtmlButton = new Button(lcomp, SWT.CHECK);
		convertToHtmlButton.setFont(parent.getFont());
		convertToHtmlButton.setText(ActionMessages.ConvertToHtml);
		gd = new GridData(SWT.FILL, SWT.CENTER, false, false, 4, 1);
		convertToHtmlButton.setLayoutData(gd);
		convertToHtmlButton.setSelection(this.convertToHtml);
		convertToHtmlButton.addSelectionListener(new SelectionAdapter() {
			public void widgetSelected(SelectionEvent e) {
				CompareDialog.this.convertToHtml = !CompareDialog.this.convertToHtml;
			}
		});
		return composite;
	}
	
	
}




/*******************************************************************************
 * Copyright (c) 2009 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.pde.api.tools.ui.internal.actions;

import java.io.BufferedWriter;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.lang.reflect.InvocationTargetException;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.OperationCanceledException;
import org.eclipse.core.runtime.SubMonitor;
import org.eclipse.jdt.core.IClassFile;
import org.eclipse.jdt.core.ICompilationUnit;
import org.eclipse.jdt.core.IJavaElement;
import org.eclipse.jdt.core.IJavaProject;
import org.eclipse.jdt.core.IPackageFragment;
import org.eclipse.jdt.core.IPackageFragmentRoot;
import org.eclipse.jdt.core.IType;
import org.eclipse.jdt.core.JavaModelException;
import org.eclipse.jface.action.IAction;
import org.eclipse.jface.dialogs.ProgressMonitorDialog;
import org.eclipse.jface.operation.IRunnableWithProgress;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.window.Window;
import org.eclipse.pde.api.tools.internal.ApiBaselineManager;
import org.eclipse.pde.api.tools.internal.comparator.DeltaXmlVisitor;
import org.eclipse.pde.api.tools.internal.provisional.ApiPlugin;
import org.eclipse.pde.api.tools.internal.provisional.Factory;
import org.eclipse.pde.api.tools.internal.provisional.IApiAnnotations;
import org.eclipse.pde.api.tools.internal.provisional.IApiDescription;
import org.eclipse.pde.api.tools.internal.provisional.VisibilityModifiers;
import org.eclipse.pde.api.tools.internal.provisional.comparator.ApiComparator;
import org.eclipse.pde.api.tools.internal.provisional.comparator.ApiScope;
import org.eclipse.pde.api.tools.internal.provisional.comparator.IDelta;
import org.eclipse.pde.api.tools.internal.provisional.model.IApiBaseline;
import org.eclipse.pde.api.tools.internal.provisional.model.IApiComponent;
import org.eclipse.pde.api.tools.internal.provisional.model.IApiScope;
import org.eclipse.pde.api.tools.internal.provisional.model.IApiTypeRoot;
import org.eclipse.pde.api.tools.internal.util.Util;
import org.eclipse.pde.api.tools.ui.internal.ApiUIPlugin;
import org.eclipse.ui.IObjectActionDelegate;
import org.eclipse.ui.IWorkbenchPart;
import org.eclipse.ui.IWorkbenchPartSite;

public class CompareWithAction implements IObjectActionDelegate {

	private IWorkbenchPartSite workbenchPartSite;
	private ISelection selection = null;
	
	/**
	 * Constructor for Action1.
	 */
	public CompareWithAction() {
		super();
	}

	/**
	 * @see IObjectActionDelegate#setActivePart(IAction, IWorkbenchPart)
	 */
	public void setActivePart(IAction action, IWorkbenchPart targetPart) {
		workbenchPartSite = targetPart.getSite();
	}
	/**
	 * @see IActionDelegate#run(IAction)
	 */
	public void run(IAction action) {
		if (this.selection instanceof IStructuredSelection) {
			final IStructuredSelection structuredSelection=(IStructuredSelection) this.selection;
			CompareDialog dialog = new CompareDialog(workbenchPartSite, ActionMessages.CompareDialogTitle);
			int returnCode = dialog.open();
			if (returnCode == Window.CANCEL) return;
			final String baselineName = dialog.baseline;
			final String reportFileName = dialog.reportFileName;
			final boolean convertToHtml = dialog.convertToHtml;
			if (baselineName == null || reportFileName == null) return;
			final IApiBaseline baseline = ApiBaselineManager.getManager().getApiBaseline(baselineName);
			if (baseline == null) return;
			final ProgressMonitorDialog progressDialog=new ProgressMonitorDialog(workbenchPartSite.getShell());
			try {
				progressDialog.run(true, true, new IRunnableWithProgress() {
					public void run(IProgressMonitor monitor)
							throws InvocationTargetException, InterruptedException {
						// Convert the given monitor into a progress instance 
						SubMonitor progress = SubMonitor.convert(monitor, 100);
						progress.subTask(ActionMessages.CompareDialogCollectingElementTaskName);
						SubMonitor loopProgress = progress.newChild(10).setWorkRemaining(structuredSelection.size());
						final IApiScope scope = walkStructureSelection(structuredSelection, loopProgress);
						try {
							progress.subTask(ActionMessages.CompareDialogComputeDeltasTaskName);
							SubMonitor compareProgress = progress.newChild(98).setWorkRemaining(scope.getApiElement().length);
							IDelta delta = ApiComparator.compare(scope, baseline, VisibilityModifiers.API, compareProgress);
							progress.worked(1);
							progress.subTask(ActionMessages.CompareDialogCreateReportTaskName);
							Util.checkCanceled(progress);
							File outputFile = new File(reportFileName);
							BufferedWriter writer = null;
							try {
								if (outputFile.exists()) {
									outputFile.delete();
								}
								writer = new BufferedWriter(new FileWriter(outputFile));
								DeltaXmlVisitor visitor = new DeltaXmlVisitor();
								delta.accept(visitor);
								writer.write(visitor.getXML());
								writer.flush();
							} catch (IOException e) {
								ApiPlugin.log(e);
							} catch (CoreException e) {
								ApiPlugin.log(e);
							} catch(OperationCanceledException e) {
								// ignore
							} finally {
								try {
									if (writer != null) {
										writer.close();
									}
								} catch(IOException e) {
									// ignore
								}
							}
							progress.worked(1);
						} finally {
							monitor.done();
						}
						if(convertToHtml) {
							// remaining part is to convert the xml file to html using xslt
						}
					}
				});
			} catch (InvocationTargetException e) {
				ApiUIPlugin.log(e);
			} catch (InterruptedException e) {
				return;
			}
			return;
		}
	}

	public static ApiScope walkStructureSelection(
			IStructuredSelection structuredSelection,
			IProgressMonitor monitor) {
		Object[] selected=structuredSelection.toArray();
		ApiScope scope = new ApiScope();
		IApiBaseline workspaceBaseline = ApiBaselineManager.getManager().getWorkspaceBaseline();
		if (workspaceBaseline == null) {
			return scope;
		}
		for (int i=0, max = selected.length; i < max; i++) {
			Object currentSelection = selected[i];
			if (currentSelection instanceof IJavaElement) {
				monitor.worked(1);
				IJavaElement element =(IJavaElement) currentSelection;
				IJavaProject javaProject = element.getJavaProject();
				try {
					switch (element.getElementType()) {
						case IJavaElement.COMPILATION_UNIT: {
							ICompilationUnit compilationUnit = (ICompilationUnit) element;
							IApiComponent apiComponent = workspaceBaseline.getApiComponent(javaProject.getElementName());
							if (apiComponent != null) {
								addElementFor(compilationUnit, apiComponent, scope);
							}
							break;
						}
						case IJavaElement.PACKAGE_FRAGMENT: {
							IPackageFragment fragment = (IPackageFragment) element;
							IApiComponent apiComponent = workspaceBaseline.getApiComponent(javaProject.getElementName());
							IPackageFragmentRoot packageFragmentRoot = (IPackageFragmentRoot) fragment.getAncestor(IJavaElement.PACKAGE_FRAGMENT_ROOT);
							boolean isArchive = false;
							if (packageFragmentRoot != null) {
								isArchive = packageFragmentRoot.isArchive();
							}
							if (apiComponent != null) {
								addElementFor(fragment, isArchive, apiComponent, scope);
							}
							break;
						}
						case IJavaElement.PACKAGE_FRAGMENT_ROOT: {
							IPackageFragmentRoot fragmentRoot = (IPackageFragmentRoot) element;
							IApiComponent apiComponent = workspaceBaseline.getApiComponent(javaProject.getElementName());
							if (apiComponent != null) {
								addElementFor(fragmentRoot, apiComponent, scope);
							}
							break;
						}
						case IJavaElement.JAVA_PROJECT:
							IApiComponent apiComponent = workspaceBaseline.getApiComponent(javaProject.getElementName());
							IPackageFragmentRoot[] roots = javaProject.getPackageFragmentRoots();
							for (int j = 0, max2 = roots.length; j < max2; j++) {
								addElementFor(roots[j], apiComponent, scope);
							}
							break;
					}
				} catch (JavaModelException e) {
					ApiPlugin.log(e);
				} catch (CoreException e) {
					ApiPlugin.log(e);
				}
			}
		}
		return scope;
	}

	private static void addElementFor(
			IPackageFragmentRoot fragmentRoot, IApiComponent apiComponent,
			ApiScope scope) throws JavaModelException, CoreException {
		boolean isArchive = fragmentRoot.isArchive();
		IJavaElement[] packageFragments = fragmentRoot.getChildren();
		for (int j = 0, max2 = packageFragments.length; j < max2; j++) {
			IPackageFragment packageFragment = (IPackageFragment) packageFragments[j];
			addElementFor(packageFragment, isArchive, apiComponent, scope);
		}
	}

	private static void addElementFor(
			IPackageFragment packageFragment,
			boolean isArchive,
			IApiComponent apiComponent,
			ApiScope scope)
		throws JavaModelException, CoreException {

		// add package fragment elements only if this is an API package
		IApiDescription apiDescription = apiComponent.getApiDescription();
		IApiAnnotations annotations = apiDescription.resolveAnnotations(Factory.packageDescriptor(packageFragment.getElementName()));
		if (annotations == null || !VisibilityModifiers.isAPI(annotations.getVisibility())) {
			return;
		}
		if (isArchive) {
			IClassFile[] classFiles = packageFragment.getClassFiles();
			for (int i = 0, max= classFiles.length; i < max; i++) {
				addElementFor(classFiles[i], apiComponent, scope);
			}
		} else {
			ICompilationUnit[] units = packageFragment.getCompilationUnits();
			for (int i = 0, max= units.length; i < max; i++) {
				addElementFor(units[i], apiComponent, scope);
			}
		}
	}

	private static void addElementFor(IClassFile classFile,
			IApiComponent apiComponent, ApiScope scope) {
		try {
			IApiTypeRoot typeRoot = apiComponent.findTypeRoot(classFile.getType().getFullyQualifiedName());
			if (typeRoot != null) {
				scope.add(typeRoot);
			}
		} catch (CoreException e) {
			ApiPlugin.log(e);
		}
	}

	private static void addElementFor(ICompilationUnit compilationUnit, IApiComponent component, ApiScope scope) throws JavaModelException {
		IType[] types = compilationUnit.getTypes();
		for (int i = 0, max = types.length; i < max; i++) {
			try {
				IApiTypeRoot typeRoot = component.findTypeRoot(types[i].getFullyQualifiedName());
				if (typeRoot != null) {
					scope.add(typeRoot);
				}
			} catch (CoreException e) {
				ApiPlugin.log(e);
			}
		}
	}

	/**
	 * @see IActionDelegate#selectionChanged(IAction, ISelection)
	 */
	public void selectionChanged(IAction action, ISelection selection) {
		this.selection = selection;
	}

}

Lines 20-26 Link Here

(-)META-INF/MANIFEST.MF (-1 / +1 lines)
20	org.eclipse.core.filesystem;bundle-version="1.2.0"	20	org.eclipse.core.filesystem;bundle-version="1.2.0"
21	Export-Package: org.eclipse.pde.api.tools.internal;x-friends:="org.eclipse.pde.api.tools.tests,org.eclipse.pde.api.tools.ui",	21	Export-Package: org.eclipse.pde.api.tools.internal;x-friends:="org.eclipse.pde.api.tools.tests,org.eclipse.pde.api.tools.ui",
22	org.eclipse.pde.api.tools.internal.builder;x-friends:="org.eclipse.pde.api.tools.ui",	22	org.eclipse.pde.api.tools.internal.builder;x-friends:="org.eclipse.pde.api.tools.ui",
23	org.eclipse.pde.api.tools.internal.comparator;x-internal:=true,	23	org.eclipse.pde.api.tools.internal.comparator;x-friends:="org.eclipse.pde.api.tools.ui",
24	org.eclipse.pde.api.tools.internal.descriptors;x-friends:="org.eclipse.pde.api.tools.tests,org.eclipse.pde.api.tools.ui",	24	org.eclipse.pde.api.tools.internal.descriptors;x-friends:="org.eclipse.pde.api.tools.tests,org.eclipse.pde.api.tools.ui",
25	org.eclipse.pde.api.tools.internal.model;x-friends:="org.eclipse.pde.api.tools.tests,org.eclipse.pde.api.tools.ui",	25	org.eclipse.pde.api.tools.internal.model;x-friends:="org.eclipse.pde.api.tools.tests,org.eclipse.pde.api.tools.ui",
26	org.eclipse.pde.api.tools.internal.natures;x-internal:=true,	26	org.eclipse.pde.api.tools.internal.natures;x-internal:=true,

Lines 2229-2232 Link Here

(-)src/org/eclipse/pde/api/tools/internal/util/Util.java (+5 lines)
2229	return 0;	2229	return 0;
2230	}	2230	}
2231	};	2231	};
		2232
		2233	public static void checkCanceled(IProgressMonitor monitor) {
		2234	if (monitor.isCanceled())
		2235	throw new OperationCanceledException();
		2236	}
2232	}	2237	}

Lines 133-139 Link Here

(-)src_ant/org/eclipse/pde/api/tools/internal/tasks/CompareTask.java (-1 / +1 lines)
133	scope.add(currentBaseline);	133	scope.add(currentBaseline);
134	}	134	}
135	try {	135	try {
136	delta = ApiComparator.compare(scope, referenceBaseline, this.visibilityModifiers);	136	delta = ApiComparator.compare(scope, referenceBaseline, this.visibilityModifiers, null);
137	} finally {	137	} finally {
138	referenceBaseline.dispose();	138	referenceBaseline.dispose();
139	currentBaseline.dispose();	139	currentBaseline.dispose();




import java.util.Set;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.jdt.core.Flags;
import org.eclipse.pde.api.tools.internal.comparator.ClassFileComparator;
import org.eclipse.pde.api.tools.internal.comparator.Delta;

	 * @param scope the given scope for the comparison
	 * @param baseline the given API baseline to compare with
	 * @param visibilityModifiers the given visibility that triggers what visibility should be used for the comparison
	 * @param monitor the progress monitor to use for reporting progress to the user. It is the caller's responsibility
	 * to call done() on the given monitor. Accepts null, indicating that no progress should be
	 * reported and that the operation cannot be canceled.
	 * 
	 * @return a delta, an empty delta if no difference is found or null if the delta detection failed
	 * @throws IllegalArgumentException if one of the two baselines is null
	 */
	public static IDelta compare(
			final IApiScope scope,
			final IApiBaseline baseline,
			final int visibilityModifiers,
			final IProgressMonitor monitor) {
		try {
			if (scope == null || baseline == null) {
				throw new IllegalArgumentException("None of the scope or the baseline must be null"); //$NON-NLS-1$
			}
			IProgressMonitor currentMonitor = null;
			if (monitor == null) {
				currentMonitor = new NullProgressMonitor();
			} else {
				currentMonitor = monitor;
			}
			final Set deltas = new HashSet();
			final CompareApiScopeVisitor visitor = new CompareApiScopeVisitor(deltas, baseline, visibilityModifiers, currentMonitor);
			scope.accept(visitor);
			if (visitor.containsError()) {
				return null;

Lines 1-5 Link Here

(-)src/org/eclipse/pde/api/tools/internal/provisional/comparator/CompareApiScopeVisitor.java (-71 / +99 lines)
1	/*******************************************************************************	1	/*******************************************************************************
2	* Copyright (c) 2008 IBM Corporation and others.	2	* Copyright (c) 2008, 2009 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials	3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0	4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at	5	* which accompanies this distribution, and is available at
Lines 13-18 Link Here
13	import java.util.Set;	13	import java.util.Set;
14		14
15	import org.eclipse.core.runtime.CoreException;	15	import org.eclipse.core.runtime.CoreException;
		16	import org.eclipse.core.runtime.IProgressMonitor;
		17	import org.eclipse.core.runtime.NullProgressMonitor;
16	import org.eclipse.pde.api.tools.internal.provisional.ApiPlugin;	18	import org.eclipse.pde.api.tools.internal.provisional.ApiPlugin;
17	import org.eclipse.pde.api.tools.internal.provisional.model.ApiScopeVisitor;	19	import org.eclipse.pde.api.tools.internal.provisional.model.ApiScopeVisitor;
18	import org.eclipse.pde.api.tools.internal.provisional.model.ApiTypeContainerVisitor;	20	import org.eclipse.pde.api.tools.internal.provisional.model.ApiTypeContainerVisitor;
Lines 20-25 Link Here
20	import org.eclipse.pde.api.tools.internal.provisional.model.IApiComponent;	22	import org.eclipse.pde.api.tools.internal.provisional.model.IApiComponent;
21	import org.eclipse.pde.api.tools.internal.provisional.model.IApiTypeContainer;	23	import org.eclipse.pde.api.tools.internal.provisional.model.IApiTypeContainer;
22	import org.eclipse.pde.api.tools.internal.provisional.model.IApiTypeRoot;	24	import org.eclipse.pde.api.tools.internal.provisional.model.IApiTypeRoot;
		25	import org.eclipse.pde.api.tools.internal.util.Util;
23		26
24	/**	27	/**
25	* ApiScope visitor implementation to run the comparison on all elements of the scope.	28	* ApiScope visitor implementation to run the comparison on all elements of the scope.
Lines 30-129 Link Here
30	IApiBaseline referenceBaseline;	33	IApiBaseline referenceBaseline;
31	int visibilityModifiers;	34	int visibilityModifiers;
32	boolean containsErrors = false;	35	boolean containsErrors = false;
		36	IProgressMonitor monitor;
33		37
34	public CompareApiScopeVisitor(final Set deltas, final IApiBaseline baseline, final int visibilityModifiers) {	38	public CompareApiScopeVisitor(final Set deltas, final IApiBaseline baseline, final int visibilityModifiers,
		39	IProgressMonitor monitor) {
35	this.deltas = deltas;	40	this.deltas = deltas;
36	this.referenceBaseline = baseline;	41	this.referenceBaseline = baseline;
37	this.visibilityModifiers = visibilityModifiers;	42	this.visibilityModifiers = visibilityModifiers;
		43	this.monitor = monitor == null ? new NullProgressMonitor() : monitor;
38	}	44	}
39		45
40	public boolean visit(IApiBaseline baseline) throws CoreException {	46	public boolean visit(IApiBaseline baseline) throws CoreException {
41	IDelta delta = ApiComparator.compare(this.referenceBaseline, baseline, this.visibilityModifiers);	47	try {
42	if (delta != null) {	48	Util.checkCanceled(this.monitor);
43	delta.accept(new DeltaVisitor() {	49	IDelta delta = ApiComparator.compare(this.referenceBaseline, baseline, this.visibilityModifiers);
44	public void endVisit(IDelta localDelta) {	50	if (delta != null) {
45	if (localDelta.getChildren().length == 0) {	51	delta.accept(new DeltaVisitor() {
46	CompareApiScopeVisitor.this.deltas.add(localDelta);	52	public void endVisit(IDelta localDelta) {
		53	if (localDelta.getChildren().length == 0) {
		54	CompareApiScopeVisitor.this.deltas.add(localDelta);
		55	}
47	}	56	}
48	}	57	});
49	});	58	} else {
50	} else {	59	this.containsErrors = true;
51	this.containsErrors = true;	60	}
		61	} finally {
		62	monitor.worked(1);
52	}	63	}
53	return false;	64	return false;
54	}	65	}
55		66
56	public boolean visit(IApiTypeContainer container) throws CoreException {	67	public boolean visit(IApiTypeContainer container) throws CoreException {
57	container.accept(new ApiTypeContainerVisitor() {	68	try {
58	public void visit(String packageName, IApiTypeRoot typeroot) {	69	Util.checkCanceled(this.monitor);
59	try {	70	container.accept(new ApiTypeContainerVisitor() {
60	CompareApiScopeVisitor.this.visit(typeroot);	71	public void visit(String packageName, IApiTypeRoot typeroot) {
61	} catch (CoreException e) {	72	try {
62	ApiPlugin.log(e);	73	CompareApiScopeVisitor.this.visit(typeroot);
		74	} catch (CoreException e) {
		75	ApiPlugin.log(e);
		76	}
63	}	77	}
64	}	78	});
65	});	79	} catch (Exception e) {
		80	monitor.worked(1);
		81	}
66	return false;	82	return false;
67	}	83	}
68		84
69	public boolean visit(IApiComponent component) throws CoreException {	85	public boolean visit(IApiComponent component) throws CoreException {
70	if (component.getErrors() != null) {	86	try {
71	this.containsErrors = true;	87	if (component.getErrors() != null) {
72	return false;	88	this.containsErrors = true;
73	}	89	return false;
74	IApiComponent referenceComponent = this.referenceBaseline.getApiComponent(component.getId());	90	}
75	if (referenceComponent.getErrors() != null) {	91	Util.checkCanceled(this.monitor);
76	this.containsErrors = true;	92	IApiComponent referenceComponent = this.referenceBaseline.getApiComponent(component.getId());
77	return false;	93	if (referenceComponent.getErrors() != null) {
78	}	94	this.containsErrors = true;
79	IDelta delta = ApiComparator.compare(referenceComponent, component, this.visibilityModifiers);	95	return false;
80	if (delta != null) {	96	}
81	delta.accept(new DeltaVisitor() {	97	Util.checkCanceled(this.monitor);
82	public void endVisit(IDelta localDelta) {	98	IDelta delta = ApiComparator.compare(referenceComponent, component, this.visibilityModifiers);
83	if (localDelta.getChildren().length == 0) {	99	if (delta != null) {
84	CompareApiScopeVisitor.this.deltas.add(localDelta);	100	delta.accept(new DeltaVisitor() {
		101	public void endVisit(IDelta localDelta) {
		102	if (localDelta.getChildren().length == 0) {
		103	CompareApiScopeVisitor.this.deltas.add(localDelta);
		104	}
85	}	105	}
86	}	106	});
87	});	107	} else {
88	} else {	108	this.containsErrors = true;
89	this.containsErrors = true;	109	}
		110	} finally {
		111	monitor.worked(1);
90	}	112	}
91	return false;	113	return false;
92	}	114	}
93		115
94	public void visit(IApiTypeRoot root) throws CoreException {	116	public void visit(IApiTypeRoot root) throws CoreException {
95	IApiComponent apiComponent = root.getApiComponent();	117	try {
96	if (apiComponent == null) {	118	IApiComponent apiComponent = root.getApiComponent();
97	return;	119	if (apiComponent == null) {
98	}	120	return;
99	if (apiComponent.getErrors() != null) {	121	}
100	this.containsErrors = true;	122	if (apiComponent.getErrors() != null) {
101	return;	123	this.containsErrors = true;
102	}	124	return;
103	IApiComponent referenceComponent = this.referenceBaseline.getApiComponent(apiComponent.getId());	125	}
104	if (referenceComponent == null) return;	126	Util.checkCanceled(this.monitor);
105	if (referenceComponent.getErrors() != null) {	127	IApiComponent referenceComponent = this.referenceBaseline.getApiComponent(apiComponent.getId());
106	this.containsErrors = true;	128	if (referenceComponent == null) return;
107	return;	129	if (referenceComponent.getErrors() != null) {
108	}	130	this.containsErrors = true;
109	IApiBaseline baseline = referenceComponent.getBaseline();	131	return;
110	IDelta delta = ApiComparator.compare(	132	}
111	root,	133	IApiBaseline baseline = referenceComponent.getBaseline();
112	apiComponent,	134	Util.checkCanceled(this.monitor);
113	referenceComponent,	135	IDelta delta = ApiComparator.compare(
114	this.referenceBaseline,	136	root,
115	baseline,	137	apiComponent,
116	this.visibilityModifiers);	138	referenceComponent,
117	if (delta != null) {	139	this.referenceBaseline,
118	delta.accept(new DeltaVisitor() {	140	baseline,
119	public void endVisit(IDelta localDelta) {	141	this.visibilityModifiers);
120	if (localDelta.getChildren().length == 0) {	142	if (delta != null) {
121	CompareApiScopeVisitor.this.deltas.add(localDelta);	143	delta.accept(new DeltaVisitor() {
		144	public void endVisit(IDelta localDelta) {
		145	if (localDelta.getChildren().length == 0) {
		146	CompareApiScopeVisitor.this.deltas.add(localDelta);
		147	}
122	}	148	}
123	}	149	});
124	});	150	} else {
125	} else {	151	this.containsErrors = true;
126	this.containsErrors = true;	152	}
		153	} finally {
		154	monitor.worked(1);
127	}	155	}
128	}	156	}
129		157

Return to bug 258853

Lines 1-5 Link Here

(-)src/org/eclipse/pde/api/tools/ui/internal/actions/ActionMessages.java (-1 / +12 lines)
1	/*******************************************************************************	1	/*******************************************************************************
2	* Copyright (c) 2008 IBM Corporation and others.	2	* Copyright (c) 2008, 2009 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials	3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0	4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at	5	* which accompanies this distribution, and is available at
Lines 18-23 Link Here
18	public class ActionMessages extends NLS {	18	public class ActionMessages extends NLS {
19	private static final String BUNDLE_NAME = "org.eclipse.pde.api.tools.ui.internal.actions.actionmessages"; //$NON-NLS-1$	19	private static final String BUNDLE_NAME = "org.eclipse.pde.api.tools.ui.internal.actions.actionmessages"; //$NON-NLS-1$
20	public static String ApiToolingSetupObjectContribution_0;	20	public static String ApiToolingSetupObjectContribution_0;
		21	public static String SelectABaseline;
		22	public static String SetAsDefault;
		23	public static String EnterFileName;
		24	public static String SelectFileName;
		25	public static String Browse;
		26	public static String ConvertToHtml;
		27	public static String CompareDialogTitle;
		28	public static String CompareDialogCollectingElementTaskName;
		29	public static String CompareDialogComputeDeltasTaskName;
		30	public static String CompareDialogCreateReportTaskName;
		31
21	static {	32	static {
22	// initialize resource bundle	33	// initialize resource bundle
23	NLS.initializeMessages(BUNDLE_NAME, ActionMessages.class);	34	NLS.initializeMessages(BUNDLE_NAME, ActionMessages.class);

Lines 114-119 Link Here

(-)plugin.xml (+19 lines)
114	value="org.eclipse.pde.api.tools.apiAnalysisNature">	114	value="org.eclipse.pde.api.tools.apiAnalysisNature">
115	</filter>	115	</filter>
116	</objectContribution>	116	</objectContribution>
		117	<objectContribution
		118	adaptable="false"
		119	id="org.eclipse.pde.api.tools.ui.compare"
		120	objectClass="org.eclipse.jdt.core.IJavaElement">
		121	<action
		122	class="org.eclipse.pde.api.tools.ui.internal.actions.CompareWithAction"
		123	enablesFor="+"
		124	id="org.eclipse.pde.api.tools.ui.action.compare"
		125	label="%APICompare.name"
		126	menubarPath="org.eclipse.pde.ui.project.tools/group1">
		127	</action>
		128	<menu
		129	id="org.eclipse.pde.ui.project.tools"
		130	label="%PdeTools.name">
		131	<separator
		132	name="group1">
		133	</separator>
		134	</menu>
		135	</objectContribution>
117	</extension>	136	</extension>
118	<extension	137	<extension
119	point="org.eclipse.ui.propertyPages">	138	point="org.eclipse.ui.propertyPages">

Added Link Here

(-)src/org/eclipse/pde/api/tools/ui/internal/actions/CompareDialog.java (+161 lines)
1	/*******************************************************************************
2	* Copyright (c) 2009 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* IBM Corporation - initial API and implementation
10	*******************************************************************************/
11	package org.eclipse.pde.api.tools.ui.internal.actions;
12
13	import java.io.File;
14	import java.util.Arrays;
15
16	import org.eclipse.core.runtime.Path;
17	import org.eclipse.jface.dialogs.Dialog;
18	import org.eclipse.jface.window.IShellProvider;
19	import org.eclipse.osgi.util.NLS;
20	import org.eclipse.pde.api.tools.internal.provisional.ApiPlugin;
21	import org.eclipse.pde.api.tools.internal.provisional.IApiBaselineManager;
22	import org.eclipse.pde.api.tools.internal.provisional.model.IApiBaseline;
23	import org.eclipse.pde.api.tools.ui.internal.SWTFactory;
24	import org.eclipse.swt.SWT;
25	import org.eclipse.swt.events.SelectionAdapter;
26	import org.eclipse.swt.events.SelectionEvent;
27	import org.eclipse.swt.layout.GridData;
28	import org.eclipse.swt.layout.GridLayout;
29	import org.eclipse.swt.widgets.Button;
30	import org.eclipse.swt.widgets.Combo;
31	import org.eclipse.swt.widgets.Composite;
32	import org.eclipse.swt.widgets.Control;
33	import org.eclipse.swt.widgets.FileDialog;
34	import org.eclipse.swt.widgets.Shell;
35	import org.eclipse.swt.widgets.Text;
36
37	public class CompareDialog extends Dialog {
38
39	public String baseline = null;
40	public String reportFileName = null;
41	private String title;
42	public boolean convertToHtml;
43
44	public CompareDialog(IShellProvider provider, String title) {
45	super(provider);
46	this.title = title;
47	}
48
49	protected void configureShell(Shell newShell) {
50	super.configureShell(newShell);
51	newShell.setText(this.title);
52	}
53	protected boolean isResizable() {
54	return true;
55	}
56	protected Control createDialogArea(Composite parent) {
57	Composite composite = (Composite) super.createDialogArea(parent);
58	// add controls to composite as necessary
59	Composite lcomp = new Composite(composite, SWT.NONE);
60	GridLayout layout = new GridLayout(4, false);
61	layout.marginWidth = 0;
62	layout.marginHeight = 0;
63	lcomp.setLayout(layout);
64	lcomp.setFont(parent.getFont());
65	GridData gd = new GridData(SWT.FILL, SWT.FILL, true, true);
66	gd.minimumWidth = 310;
67	gd.minimumHeight = 100;
68	lcomp.setLayoutData(gd);
69
70	SWTFactory.createWrapLabel(lcomp, ActionMessages.SelectABaseline, 4);
71	IApiBaselineManager apiBaselineManager = ApiPlugin.getDefault().getApiBaselineManager();
72	IApiBaseline defaultBaseline = apiBaselineManager.getDefaultApiBaseline();
73	String defaultBaselineName = defaultBaseline != null ? defaultBaseline.getName() : null;
74	IApiBaseline[] baselines = apiBaselineManager.getApiBaselines();
75	int length = baselines.length;
76	String[] baselinesItems = new String[length];
77	String[] baselinesNames = new String[length];
78	int index = 0;
79	// set the names
80	for (int i = 0; i < length; i++) {
81	String currentBaselineName = baselines[i].getName();
82	baselinesNames[i] = currentBaselineName;
83	}
84	Arrays.sort(baselinesNames);
85	// set the labels
86	for (int i = 0; i < length; i++) {
87	String currentBaselineName = baselinesNames[i];
88	if (defaultBaselineName != null && defaultBaselineName.equals(currentBaselineName)) {
89	baselinesItems[i] = NLS.bind(ActionMessages.SetAsDefault, currentBaselineName);
90	this.baseline = currentBaselineName;
91	index = i;
92	} else {
93	baselinesItems[i] = currentBaselineName;
94	}
95	}
96	Combo baselineCombo = new Combo(lcomp, SWT.BORDER \| SWT.FLAT \| SWT.READ_ONLY);
97	gd = new GridData(SWT.FILL, SWT.CENTER, true, false, 4, 1);
98	baselineCombo.setLayoutData(gd);
99	baselineCombo.setItems(baselinesItems);
100	baselineCombo.setData(baselinesNames);
101	baselineCombo.select(index);
102
103	baselineCombo.addSelectionListener(new SelectionAdapter(){
104	public void widgetSelected(SelectionEvent e) {
105	Combo combo = (Combo) e.widget;
106	String[] baselineNames = (String[]) combo.getData();
107	String selectedBaselineName = baselineNames[combo.getSelectionIndex()];
108	CompareDialog.this.baseline = selectedBaselineName;
109	}
110	});
111	SWTFactory.createWrapLabel(lcomp, ActionMessages.EnterFileName, 4);
112	final Text fileNameText = new Text(lcomp, SWT.BORDER);
113	fileNameText.setFont(lcomp.getFont());
114	gd = new GridData(SWT.FILL, SWT.CENTER, true, false, 3, 1);
115	fileNameText.setLayoutData(gd);
116
117	Button browseButton = new Button(lcomp, SWT.PUSH);
118	browseButton.setFont(parent.getFont());
119	browseButton.setText(ActionMessages.Browse);
120	gd = new GridData(SWT.RIGHT, SWT.CENTER, false, false, 1, 1);
121	browseButton.setLayoutData(gd);
122
123	browseButton.addSelectionListener(new SelectionAdapter() {
124	public void widgetSelected(SelectionEvent e) {
125	FileDialog dialog = new FileDialog(getShell());
126	dialog.setText(ActionMessages.SelectFileName);
127	String loctext = fileNameText.getText().trim();
128	if (loctext.length() > 0) {
129	File file = new File(loctext).getParentFile();
130	if (file != null && file.exists()) {
131	dialog.setFilterPath(file.getAbsolutePath());
132	}
133	}
134	String newPath = dialog.open();
135	if (newPath != null && !new Path(loctext).equals(new Path(newPath))) {
136	/*
137	* If the path is identical, but there is no component loaded, we still
138	* want to reload. This might be the case if the combo is initialized by
139	* copy/paste with a path that points to a plugin directory
140	*/
141	fileNameText.setText(newPath);
142	CompareDialog.this.reportFileName = newPath;
143	}
144	}
145	});
146	Button convertToHtmlButton = new Button(lcomp, SWT.CHECK);
147	convertToHtmlButton.setFont(parent.getFont());
148	convertToHtmlButton.setText(ActionMessages.ConvertToHtml);
149	gd = new GridData(SWT.FILL, SWT.CENTER, false, false, 4, 1);
150	convertToHtmlButton.setLayoutData(gd);
151	convertToHtmlButton.setSelection(this.convertToHtml);
152	convertToHtmlButton.addSelectionListener(new SelectionAdapter() {
153	public void widgetSelected(SelectionEvent e) {
154	CompareDialog.this.convertToHtml = !CompareDialog.this.convertToHtml;
155	}
156	});
157	return composite;
158	}
159
160
161	}