core/com.nokia.carbide.cpp.sdk.ui/src/com/nokia/carbide/cpp/sdk/ui/shared/AddSDKDialog.java
First pass refactoring ISymbianSDK.
/*
* Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies).
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of the License "Eclipse Public License v1.0"
* which accompanies this distribution, and is available
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description:
*
*/
package com.nokia.carbide.cpp.sdk.ui.shared;
import java.io.File;
import java.util.List;
import org.eclipse.jface.dialogs.IDialogConstants;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.jface.dialogs.TrayDialog;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.events.SelectionListener;
import org.eclipse.swt.graphics.Point;
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.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.Text;
import org.eclipse.ui.PlatformUI;
import org.osgi.framework.Version;
import com.nokia.carbide.cpp.internal.api.sdk.ISBSv1BuildInfo;
import com.nokia.carbide.cpp.internal.sdk.core.model.SymbianSDK;
import com.nokia.carbide.cpp.internal.sdk.ui.Messages;
import com.nokia.carbide.cpp.internal.sdk.ui.SDKUIHelpIds;
import com.nokia.carbide.cpp.sdk.core.ISymbianBuilderID;
import com.nokia.carbide.cpp.sdk.core.ISymbianSDK;
import com.nokia.carbide.cpp.sdk.core.SDKCorePlugin;
import com.nokia.carbide.cpp.sdk.core.SymbianSDKFactory;
import com.nokia.cpp.internal.api.utils.core.HostOS;
import com.nokia.cpp.internal.api.utils.ui.BrowseDialogUtils;
/**
* Dialog that allows the user to add a new Symbian OS SDK or custkit
* to the devices.xml file.
*/
public class AddSDKDialog extends TrayDialog {
private Text deviceIDtext;
private Text epocRootText;
private Button browseEPOCROOTButton;
/**
* Create the dialog
* @param parentShell
*/
public AddSDKDialog(Shell parentShell) {
super(parentShell);
}
/**
* Create contents of the button bar
* @param parent
*/
@Override
protected void createButtonsForButtonBar(Composite parent) {
createButton(parent, IDialogConstants.OK_ID, IDialogConstants.OK_LABEL,
true);
createButton(parent, IDialogConstants.CANCEL_ID,
IDialogConstants.CANCEL_LABEL, false);
}
/**
* Create contents of the dialog
* @param parent
*/
@Override
protected Control createDialogArea(Composite parent) {
Composite container = (Composite) super.createDialogArea(parent);
final GridLayout gridLayout = new GridLayout();
gridLayout.numColumns = 3;
container.setLayout(gridLayout);
final Label deviceIdLabel = new Label(container, SWT.NONE);
deviceIdLabel.setToolTipText(Messages.getString("AddSDKDialog.Enter_unique_id_for_sdk")); //$NON-NLS-1$
deviceIdLabel.setText(Messages.getString("AddSDKDialog.SDK_ID")); //$NON-NLS-1$
deviceIDtext = new Text(container, SWT.BORDER);
deviceIDtext.setLayoutData(new GridData(263, SWT.DEFAULT));
new Label(container, SWT.NONE);
final Label epocrootLabel = new Label(container, SWT.NONE);
epocrootLabel.setToolTipText(Messages.getString("AddSDKDialog.Enter_location_where_epoc32_folder")); //$NON-NLS-1$
epocrootLabel.setText("EPOCROOT:"); //$NON-NLS-1$
epocRootText = new Text(container, SWT.BORDER);
epocRootText.setLayoutData(new GridData(263, SWT.DEFAULT));
browseEPOCROOTButton = new Button(container, SWT.NONE);
browseEPOCROOTButton.setToolTipText(Messages.getString("AddSDKDialog.Choose_folder_where_epoc32_exists")); //$NON-NLS-1$
browseEPOCROOTButton.setText(Messages.getString("AddSDKDialog.Browse")); //$NON-NLS-1$
addButtonListener(browseEPOCROOTButton);
PlatformUI.getWorkbench().getHelpSystem().setHelp(parent, SDKUIHelpIds.SDK_ADD_DIALOG);
return container;
}
/* (non-Javadoc)
* @see org.eclipse.jface.window.Window#configureShell(org.eclipse.swt.widgets.Shell)
*/
protected void configureShell(Shell shell) {
super.configureShell(shell);
shell.setText(Messages.getString("AddSDKDialog.Add_New_SDK")); //$NON-NLS-1$
}
/**
* Return the initial size of the dialog
*/
@Override
protected Point getInitialSize() {
//return new Point(428, 256);
return super.getInitialSize();
}
/*
* (non-Javadoc)
* @see org.eclipse.jface.dialogs.Dialog#okPressed()
*/
@Override
protected void okPressed() {
if (deviceIDtext.getText().length() > 0){
if (!isValidIDName(deviceIDtext.getText())){
return;
}
} else {
MessageDialog.openError(getShell(), Messages.getString("AddSDKDialog.Missing_SDK_ID"), Messages.getString("AddSDKDialog.Enter_SDK_ID")); //$NON-NLS-1$ //$NON-NLS-2$
return;
}
if (epocRootText.getText().length() > 1){
if (HostOS.IS_WIN32 && epocRootText.getText().charAt(1) != ':'){
MessageDialog.openError(getShell(), Messages.getString("AddSDKDialog.Malformed_EPOCROOT"), Messages.getString("AddSDKDialog.EPOCROOT_drive_spec")); //$NON-NLS-1$ //$NON-NLS-2$
return;
}
if (epocRootText.getText().toUpperCase().endsWith("EPOC32") || epocRootText.getText().toUpperCase().endsWith("EPOC32\\")){ //$NON-NLS-1$ //$NON-NLS-2$
if (!MessageDialog.openConfirm(getShell(), Messages.getString("AddSDKDialog.Possible_wrong_epocroot"), Messages.getString("AddSDKDialog.EPOCROOT_Should_Point"))){ //$NON-NLS-1$ //$NON-NLS-2$
return;
}
} else {
File epocRootFile = new File(epocRootText.getText());
if (!epocRootFile.exists()){
if (!MessageDialog.openConfirm(getShell(), Messages.getString("AddSDKDialog.EPOCROOT_does_not_exist"), Messages.getString("AddSDKDialog.EPOCROOT_does_not_exist_msg"))){ //$NON-NLS-1$ //$NON-NLS-2$
return;
}
}
if (epocRootFile.toString().indexOf(" ") != -1){
// Paths should not have spaces...
MessageDialog.openError(getShell(), "EPOC Root Contains Spaces", Messages.getString("AddSDKDialog.EPOCROOT_contains_spaces")); //$NON-NLS-1$ //$NON-NLS-2$
return;
}
}
} else {
if (epocRootText.getText().length() == 1 && epocRootText.getText().charAt(0) == '\\'){
// OK - Currently accept only a '\'. May need to reconsider side-effects
} else {
MessageDialog.openError(getShell(), Messages.getString("AddSDKDialog.Missing_EPOCROOT"), Messages.getString("AddSDKDialog.Please_enter_an_EPOCROOT")); //$NON-NLS-1$ //$NON-NLS-2$
return;
}
}
// No objections raised, write the new device entry
String vendorName = ISBSv1BuildInfo.S60_SDK_NAME;
Version osVersion = new Version("9.4.0"); //$NON-NLS-1$
String osBranch = ""; //$NON-NLS-1$
Version sdkVersion = new Version("0.0"); //$NON-NLS-1$
ISymbianSDK sdk = SymbianSDKFactory.createInstance(deviceIDtext.getText(),
epocRootText.getText(),
vendorName,
osVersion,
osBranch,
sdkVersion,
false);
((SymbianSDK)sdk).setEnabled(true);
SDKCorePlugin.getSDKManager().addSDK(sdk);
List<ISymbianSDK> sdkList = SDKCorePlugin.getSDKManager().getSDKList();
if (sdkList != null){
sdkList.add(sdk);
}
ISBSv1BuildInfo sbsv1BuildInfo = (ISBSv1BuildInfo)sdk.getBuildInfo(ISymbianBuilderID.SBSV1_BUILDER);
if (sbsv1BuildInfo != null) {
sbsv1BuildInfo.setIsDefaultSDK(sdk, false);
}
super.okPressed();
}
/**
* Sets the listener event to a button.
*
* @param aButton
*/
private void addButtonListener(final Button aButton) {
SelectionListener listener = new SelectionAdapter() {
public void widgetSelected(SelectionEvent e) {
if (e.getSource().equals(browseEPOCROOTButton)) {
browseEPOCROOT();
}
}
};
aButton.addSelectionListener(listener);
}
private void browseEPOCROOT(){
DirectoryDialog browseDir = new DirectoryDialog(getShell(), SWT.OPEN);
browseDir.setMessage(Messages.getString("AddSDKDialog.Choose_location_for_EPOCROOT")); //$NON-NLS-1$
BrowseDialogUtils.initializeFrom(browseDir, HostOS.IS_WIN32 ? "C:/Symbian/" : null); //$NON-NLS-1$
String dirText = browseDir.open();
if (dirText != null){
epocRootText.setText(dirText);
}
}
private boolean isValidIDName(String sdkID){
boolean isValid = true;
// check for spaces in ID
if (sdkID.contains(" ")){ //$NON-NLS-1$
MessageDialog.openError(getShell(), Messages.getString("AddSDKDialog.Invalid_SDK_ID"), Messages.getString("AddSDKDialog.SDK_ID_No_Spaces")); //$NON-NLS-1$ //$NON-NLS-2$
return false;
}
// check that the ID is unique...
for (ISymbianSDK sdk : SDKCorePlugin.getSDKManager().getSDKList()){
if (sdk.getUniqueId().equalsIgnoreCase(sdkID)){
// id already exists, choose a different one...
MessageDialog.openError(getShell(), Messages.getString("AddSDKDialog.Duplicate_ID"), Messages.getString("AddSDKDialog.Duplicate_ID_Msg")); //$NON-NLS-1$ //$NON-NLS-2$
return false;
}
}
return isValid;
}
}