/*******************************************************************************
* Copyright (c) 2000, 2006 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.rubypeople.rdt.internal.debug.ui.rubyvms;
import java.io.File;
import java.util.Iterator;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Path;
import org.eclipse.core.runtime.Status;
import org.eclipse.jface.dialogs.IDialogSettings;
import org.eclipse.jface.viewers.ISelectionChangedListener;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.viewers.SelectionChangedEvent;
import org.eclipse.jface.viewers.TreeViewer;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.events.SelectionListener;
import org.eclipse.swt.graphics.Font;
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.DirectoryDialog;
import org.eclipse.swt.widgets.Label;
import org.rubypeople.rdt.debug.ui.RdtDebugUiConstants;
import org.rubypeople.rdt.internal.debug.ui.RdtDebugUiPlugin;
import org.rubypeople.rdt.launching.IVMInstall;
import org.rubypeople.rdt.launching.IVMInstallType;
import org.rubypeople.rdt.launching.RubyRuntime;
/**
* Control used to edit the libraries associated with a VM install
*/
public class VMLibraryBlock implements SelectionListener, ISelectionChangedListener {
/**
* Attribute name for the last path used to open a file/directory chooser
* dialog.
*/
protected static final String LAST_PATH_SETTING = "LAST_PATH_SETTING"; //$NON-NLS-1$
/**
* the prefix for dialog setting pertaining to this block
*/
protected static final String DIALOG_SETTINGS_PREFIX = "VMLibraryBlock"; //$NON-NLS-1$
protected boolean fInCallback = false;
protected IVMInstall fVmInstall;
protected IVMInstallType fVmInstallType;
protected File fHome;
//widgets
protected LibraryContentProvider fLibraryContentProvider;
protected AddVMDialog fDialog = null;
protected TreeViewer fLibraryViewer;
private Button fUpButton;
private Button fDownButton;
private Button fRemoveButton;
private Button fAddButton;
protected Button fDefaultButton;
/**
* Constructor for VMLibraryBlock.
*/
public VMLibraryBlock(AddVMDialog dialog) {
fDialog = dialog;
}
/**
* Creates and returns the source lookup control.
*
* @param parent the parent widget of this control
*/
public Control createControl(Composite parent) {
Font font = parent.getFont();
Composite comp = new Composite(parent, SWT.NONE);
GridLayout topLayout = new GridLayout();
topLayout.numColumns = 2;
topLayout.marginHeight = 0;
topLayout.marginWidth = 0;
comp.setLayout(topLayout);
GridData gd = new GridData(GridData.FILL_BOTH);
comp.setLayoutData(gd);
fLibraryViewer= new TreeViewer(comp);
gd = new GridData(GridData.FILL_BOTH);
gd.heightHint = 6;
fLibraryViewer.getControl().setLayoutData(gd);
fLibraryContentProvider= new LibraryContentProvider();
fLibraryViewer.setContentProvider(fLibraryContentProvider);
fLibraryViewer.setLabelProvider(new LibraryLabelProvider());
fLibraryViewer.setInput(this);
fLibraryViewer.addSelectionChangedListener(this);
Composite pathButtonComp = new Composite(comp, SWT.NONE);
GridLayout pathButtonLayout = new GridLayout();
pathButtonLayout.marginHeight = 0;
pathButtonLayout.marginWidth = 0;
pathButtonComp.setLayout(pathButtonLayout);
gd = new GridData(GridData.VERTICAL_ALIGN_BEGINNING | GridData.HORIZONTAL_ALIGN_FILL);
pathButtonComp.setLayoutData(gd);
pathButtonComp.setFont(font);
fAddButton= createPushButton(pathButtonComp, RubyVMMessages.VMLibraryBlock_7);
fAddButton.addSelectionListener(this);
fRemoveButton= createPushButton(pathButtonComp, RubyVMMessages.VMLibraryBlock_6);
fRemoveButton.addSelectionListener(this);
fUpButton= createPushButton(pathButtonComp, RubyVMMessages.VMLibraryBlock_4);
fUpButton.addSelectionListener(this);
fDownButton= createPushButton(pathButtonComp, RubyVMMessages.VMLibraryBlock_5);
fDownButton.addSelectionListener(this);
fDefaultButton= createPushButton(pathButtonComp, RubyVMMessages.VMLibraryBlock_9);
fDefaultButton.addSelectionListener(this);
return comp;
}
/**
* The "default" button has been toggled
*/
public void restoreDefaultLibraries() {
IPath[] libs = null;
File installLocation = getHomeDirectory();
if (installLocation == null) {
libs = new IPath[0];
} else {
libs = getVMInstallType().getDefaultLibraryLocations(installLocation);
}
fLibraryContentProvider.setLibraries(libs);
update();
}
/**
* Creates and returns a button
*
* @param parent parent widget
* @param label label
* @return Button
*/
protected Button createPushButton(Composite parent, String label) {
Button button = new Button(parent, SWT.PUSH);
button.setFont(parent.getFont());
button.setText(label);
fDialog.setButtonLayoutData(button);
return button;
}
/**
* Create some empty space
*/
protected void createVerticalSpacer(Composite comp, int colSpan) {
Label label = new Label(comp, SWT.NONE);
GridData gd = new GridData();
gd.horizontalSpan = colSpan;
label.setLayoutData(gd);
}
/**
* Initializes this control based on the settings in the given
* vm install and type.
*
* @param vm vm or <code>null</code> if none
* @param type type of vm install
*/
public void initializeFrom(IVMInstall vm, IVMInstallType type) {
fVmInstall = vm;
fVmInstallType = type;
if (vm != null) {
setHomeDirectory(vm.getInstallLocation());
fLibraryContentProvider.setLibraries(RubyRuntime.getLibraryLocations(getVMInstall()));
}
update();
}
/**
* Sets the home directory of the VM Install the user has chosen
*/
public void setHomeDirectory(File file) {
fHome = file;
}
/**
* Returns the home directory
*/
protected File getHomeDirectory() {
return fHome;
}
/**
* Updates buttons and status based on current libraries
*/
public void update() {
updateButtons();
IStatus status = Status.OK_STATUS;
if (fLibraryContentProvider.getLibraries().length == 0) { // && !isDefaultSystemLibrary()) {
status = new Status(IStatus.ERROR, RdtDebugUiPlugin.getUniqueIdentifier(), RdtDebugUiConstants.INTERNAL_ERROR,
RubyVMMessages.VMLibraryBlock_Libraries_cannot_be_empty__1, null);
}
LibraryStandin[] standins = fLibraryContentProvider.getStandins();
for (int i = 0; i < standins.length; i++) {
IStatus st = standins[i].validate();
if (!st.isOK()) {
status = st;
break;
}
}
fDialog.setSystemLibraryStatus(status);
fDialog.updateStatusLine();
}
/**
* Saves settings in the given working copy
*/
public void performApply(IVMInstall vm) {
if (isDefaultLocations()) {
vm.setLibraryLocations(null);
} else {
IPath[] libs = fLibraryContentProvider.getLibraries();
vm.setLibraryLocations(libs);
}
}
/**
* Determines if the present setup is the default location s for this JRE
* @return true if the current set of locations are the defaults, false otherwise
*/
protected boolean isDefaultLocations() {
IPath[] libraryLocations = fLibraryContentProvider.getLibraries();
IVMInstall install = getVMInstall();
if (install == null || libraryLocations == null) {
return true;
}
File installLocation = install.getInstallLocation();
if (installLocation != null) {
IPath[] def = getVMInstallType().getDefaultLibraryLocations(installLocation);
if (def.length == libraryLocations.length) {
for (int i = 0; i < def.length; i++) {
if (!def[i].equals(libraryLocations[i])) {
return false;
}
}
return true;
}
}
return false;
}
/**
* Returns the vm install associated with this library block.
*
* @return vm install
*/
protected IVMInstall getVMInstall() {
return fVmInstall;
}
/**
* Returns the vm install type associated with this library block.
*
* @return vm install
*/
protected IVMInstallType getVMInstallType() {
return fVmInstallType;
}
/* (non-Javadoc)
* @see org.eclipse.swt.events.SelectionListener#widgetSelected(org.eclipse.swt.events.SelectionEvent)
*/
public void widgetSelected(SelectionEvent e) {
Object source= e.getSource();
if (source == fUpButton) {
fLibraryContentProvider.up((IStructuredSelection) fLibraryViewer.getSelection());
} else if (source == fDownButton) {
fLibraryContentProvider.down((IStructuredSelection) fLibraryViewer.getSelection());
} else if (source == fRemoveButton) {
fLibraryContentProvider.remove((IStructuredSelection) fLibraryViewer.getSelection());
} else if (source == fAddButton) {
add((IStructuredSelection) fLibraryViewer.getSelection());
}
else if (source == fDefaultButton) {
restoreDefaultLibraries();
}
update();
}
/* (non-Javadoc)
* @see org.eclipse.swt.events.SelectionListener#widgetDefaultSelected(org.eclipse.swt.events.SelectionEvent)
*/
public void widgetDefaultSelected(SelectionEvent e) {}
/**
* Open the file selection dialog, and add the return jars as libraries.
*/
private void add(IStructuredSelection selection) {
IDialogSettings dialogSettings= RdtDebugUiPlugin.getDefault().getDialogSettings();
String lastUsedPath= dialogSettings.get(LAST_PATH_SETTING);
if (lastUsedPath == null) {
lastUsedPath= ""; //$NON-NLS-1$
}
DirectoryDialog dialog= new DirectoryDialog(fLibraryViewer.getControl().getShell(), SWT.MULTI);
dialog.setMessage(RubyVMMessages.VMLibraryBlock_10);
dialog.setFilterPath(lastUsedPath);
String res= dialog.open();
if (res == null) {
return;
}
dialogSettings.put(LAST_PATH_SETTING, res);
fLibraryContentProvider.add(new IPath[] {Path.fromOSString(res)}, selection);
}
/* (non-Javadoc)
* @see org.eclipse.jface.viewers.ISelectionChangedListener#selectionChanged(org.eclipse.jface.viewers.SelectionChangedEvent)
*/
public void selectionChanged(SelectionChangedEvent event) {
updateButtons();
}
/**
* Refresh the enable/disable state for the buttons.
*/
private void updateButtons() {
IStructuredSelection selection = (IStructuredSelection) fLibraryViewer.getSelection();
fRemoveButton.setEnabled(!selection.isEmpty());
boolean enableUp = true,
enableDown = true,
allRoots = true;
Object[] libraries = fLibraryContentProvider.getElements(null);
if (selection.isEmpty() || libraries.length == 0) {
enableUp = false;
enableDown = false;
} else {
Object first = libraries[0];
Object last = libraries[libraries.length - 1];
for (Iterator iter= selection.iterator(); iter.hasNext();) {
Object element= iter.next();
Object lib = element;
if (lib == first) {
enableUp = false;
}
if (lib == last) {
enableDown = false;
}
}
}
fUpButton.setEnabled(enableUp);
fDownButton.setEnabled(enableDown);
}
}