/*

* Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies). 

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "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.s60tools.ui.wizards;

import java.io.File;

import org.eclipse.swt.widgets.DirectoryDialog;

import org.eclipse.swt.SWT;

import org.eclipse.swt.dnd.DND;

import org.eclipse.swt.dnd.DropTarget;

import org.eclipse.swt.dnd.DropTargetEvent;

import org.eclipse.swt.dnd.DropTargetListener;

import org.eclipse.swt.dnd.FileTransfer;

import org.eclipse.swt.dnd.Transfer;

import org.eclipse.swt.events.ModifyEvent;

import org.eclipse.swt.events.ModifyListener;

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.List;

import org.eclipse.swt.widgets.Combo;

import org.eclipse.swt.widgets.Composite;

import org.eclipse.swt.widgets.FileDialog;

import org.eclipse.swt.widgets.Group;

import org.eclipse.swt.widgets.Label;

import org.eclipse.swt.widgets.Text;

import org.eclipse.ui.PlatformUI;

import org.eclipse.jface.dialogs.IDialogSettings;

import com.nokia.s60tools.ui.internal.resources.Messages;

import java.util.*;

/**

 * Wizard page for querying user for: Symbol, map and image files.

 * 

 * This page can also be used to query selge.ini location, but this

 * functionality is hidden from the user at the moment. It might 

 * be restored in the future.

 *

 */

public abstract class DebugMetadataWizardPage extends S60ToolsWizardPage implements

		SelectionListener, ModifyListener, DropTargetListener {

	// defines for map file radio buttons

	final int NO_MAP_FILES_RADIO = 0;

	final int SDK_MAP_FILES_FOLDER_RADIO = 1;

	final int MAP_FILES_ZIP_RADIO = 2;

	final int MAP_FILES_FOLDER_RADIO = 3;

	// width hint for all buttons in the page

	final int BUTTON_WIDTH = 60;

	// height hint for all lists in the page

	final int LIST_HEIGHT = 50;

	// filters for file selection dialogs

	static final String SELGE_INI_FILTER = "selge.ini";

	static final String SYMBOL_FILTER = "*.symbol";

	static final String ZIP_FILTER = "*.zip";

	static final String[] IMAGE_FILTER = {"*.fpsx", "*.img", "*.v??", ".c??", "*.*"};

	// wizard saves last entered values to these tags in dialog_settings.xml

	static final String LAST_USED_SELGE_INI_FILES = "SelgeIniFiles"; //$NON-NLS-1$

	static final String LAST_USED_SYMBOL_FILES = "SymbolFiles"; //$NON-NLS-1$

	static final String LAST_USED_DECODING_STYLE = "SymbolFileWasUsedLast"; //$NON-NLS-1$

	static final String LAST_USED_MAPFILES_FOLDER = "MapFilesFolder"; //$NON-NLS-1$

	static final String LAST_USED_MAPZIP_FILES = "MapZipFiles"; //$NON-NLS-1$

	static final String LAST_USED_IMAGE_FILES = "ImageFiles"; //$NON-NLS-1$

	static final String LAST_USED_MAPFILE_TYPE = "LastUsedMapFileType"; //$NON-NLS-1$

	static final String LAST_USED_SDK = "LastUsedSdk"; //$NON-NLS-1$

	// top level containers

	protected Composite composite;

	protected Group groupSelge; // selge group is hidden at all times. Might be restored in the future

	// selge.ini page items. Page cannot be show at the moment. Might be restored in the future.

	protected Button buttonSelgeRadio;

	protected Button buttonSelgeBrowse;

	protected Button buttonShowSelgeDetails;

	protected Text textSelgeDetails;

	protected Combo comboSelge;

	protected Label labelSelge;

	// symbol page items

	protected Button buttonSymbolRadio = null;

	protected Button buttonMapFolderBrowse;

	protected Button buttonZipBrowse;

	protected Button buttonMapFilesZipRadio;

	protected Button buttonMapFilesFolderRadio;

	protected Button buttonSdkFolderRadio;

	protected Button buttonNoMapFilesRadio;

	protected Button buttonAddSymbol;

	protected Button buttonRemoveSymbol;

	protected Button buttonAddImageFile;

	protected Button buttonRemoveImageFile;

	protected Combo comboMapFilesFolder;

	protected Combo comboMapFilesZip;

	protected Combo comboSdkFolder;

	protected Group groupSymbolFiles;

	protected Group groupMapFiles;

	protected Group groupImageFiles;

	protected Group groupSelgeSymbolRadios;

	protected Label labelMapFilesFolder;

	protected Label labelZip;

	protected Label labelSdkFolder;

	protected Label labelNoMapFiles;

	protected List listSymbols;

	protected List listImageFiles;

	// owner can pass in ROM IDs so that we can check that correct symbol is selected

	protected String[] romIds = null;

	// holds SDK names and their folders

	protected HashMap<String, String> sdkFolders = null;

	// default location of selge.ini. 

	protected String defaultSelgeIniFile = "\\\\Vagrp014\\groups4\\Builds\\S60RnD\\S60_5_0\\SelgeIniFile\\selge.ini"; //$NON-NLS-1$

	// defines whether image files selection should be visible in the page

	boolean showImageFilesGroup = false;

	// section where this wizard pages data is saved

	IDialogSettings previousValuesSection;

	// defines how many previous user entered values are saved

	final int MAX_SAVED_VALUES;

	/**

	 * Constructor.

	 * 

	 * @param pageName name of the page

	 * @param title page title

	 * @param imageFilesGroup if true, image files are queried from user. If false, image file are not queried

	 * @param section section where wizard reads/saves previously entered values

	 * @param maxSavedValues how many previously entered values are saved

	 */

	public DebugMetadataWizardPage(String pageName, 

									String title, 

									boolean imageFilesGroup,

									IDialogSettings section,

									int maxSavedValues){

		super(pageName);

		MAX_SAVED_VALUES = maxSavedValues;

		showImageFilesGroup = imageFilesGroup;

		previousValuesSection = section;

		setTitle(title);

		setDescription(Messages.getString("DebugMetadataWizardPage.SelgeIniDescription")); //$NON-NLS-1$

		setPageComplete(true);

	 }

	public abstract String getHelpContext();

	public abstract boolean canFinish();

	public abstract HashMap<String, String> getSdkMapFolders(); 

	public abstract boolean folderContainsMapFiles(String folder);

	public abstract boolean zipContainsMapFiles(String path);

	@Override

	public void recalculateButtonStates() {

	}

	@Override

	public void setInitialFocus() {

		if (buttonSelgeRadio.getSelection())

			comboSelge.setFocus();

		else

			listSymbols.setFocus();

	}

	/**

	 * @see org.eclipse.jface.wizard.WizardPage

	 */

	public void createControl(Composite parent) {

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

		GridLayout gl = new GridLayout();

		gl.numColumns = 1;

		composite.setLayout(gl);

		groupSelgeSymbolRadios = new Group(composite, SWT.NONE);

		groupSelgeSymbolRadios.setLayout(gl);

		groupSelgeSymbolRadios.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));

		// Selge.ini radio button

		buttonSelgeRadio = new Button(groupSelgeSymbolRadios, SWT.RADIO);

		buttonSelgeRadio.setText(Messages.getString("DebugMetadataWizardPage.UseSelgeIni")); //$NON-NLS-1$

		buttonSelgeRadio.setSelection(!symbolFileWasUsedPreviously());

		buttonSelgeRadio.addSelectionListener(this);

		// symbol & map files radio button

		buttonSymbolRadio = new Button(groupSelgeSymbolRadios, SWT.RADIO);

		buttonSymbolRadio.setText(Messages.getString("DebugMetadataWizardPage.DefinePathsManually")); //$NON-NLS-1$

		buttonSymbolRadio.setSelection(symbolFileWasUsedPreviously());

		createSelgeGroup();

		createSymbolGroup();

		setHelps();

		setInitialFocus();

		// selge.ini is not used at the moment, but it might be restored later

		hideSelgeIniSelection();

		Transfer[] types = new Transfer[] { FileTransfer.getInstance() };

	    DropTarget dropTarget = new DropTarget(composite, DND.DROP_COPY);

	    dropTarget.setTransfer(types);

	    dropTarget.addDropListener(this);		

		setControl(composite);

	}

	/**

	 * Creates UI controls for selge.ini usage

	 *

	 */

	void createSelgeGroup() {

		// Selge.ini group

		groupSelge = new Group(composite, SWT.NONE);

		GridLayout gl = new GridLayout();

		GridData selgeGd = new GridData(GridData.FILL_BOTH);

		gl.numColumns = 2;

		groupSelge.setLayout(gl);

		// show selge group if user used selge.ini last time, hide if symbol & map files was used

		groupSelge.setVisible(!symbolFileWasUsedPreviously()); 

		selgeGd.exclude = symbolFileWasUsedPreviously();

		groupSelge.setLayoutData(selgeGd);

		// Selge.ini label

		labelSelge = new Label(groupSelge, SWT.LEFT);

		GridData gd = new GridData(GridData.FILL_HORIZONTAL);

		gd.horizontalSpan = 2;

		labelSelge.setLayoutData(gd);

		labelSelge.setText(Messages.getString("DebugMetadataWizardPage.SelgeIniFile")); //$NON-NLS-1$

		// Selge.ini combo

		comboSelge = new Combo(groupSelge, SWT.BORDER);

		gd = new GridData(GridData.FILL_HORIZONTAL | GridData.VERTICAL_ALIGN_BEGINNING);

		comboSelge.setLayoutData(gd);

		comboSelge.addModifyListener(this);

		String[] lastUsed = getPreviousPaths(LAST_USED_SELGE_INI_FILES);

		// set the previous selge.ini file as default

		if (lastUsed != null) {

			comboSelge.setItems(lastUsed);

			comboSelge.select(0);

		// user has not defined selge.ini previously, show default location

		} else {

			comboSelge.setText(defaultSelgeIniFile);

		}

		// Selge.ini browse button

		buttonSelgeBrowse = new Button(groupSelge, SWT.PUSH);

		buttonSelgeBrowse.setText(Messages.getString("DebugMetadataWizardPage.Browse")); //$NON-NLS-1$

		buttonSelgeBrowse.addSelectionListener(this);

		// Show selge.ini details button is not yet used i.e. shown to user

		GridData gdDetailsButton = new GridData();

		gdDetailsButton.horizontalSpan = 2;

		buttonShowSelgeDetails = new Button(groupSelge, SWT.PUSH);

		buttonShowSelgeDetails.setText(Messages.getString("DebugMetadataWizardPage.ShowDetails")); //$NON-NLS-1$

		buttonShowSelgeDetails.setLayoutData(gdDetailsButton);

		buttonShowSelgeDetails.addSelectionListener(this);

		buttonShowSelgeDetails.setVisible(false);

		// textbox for selge.ini details. Not yet used.

		textSelgeDetails = new Text(groupSelge, SWT.READ_ONLY | SWT.MULTI | SWT.WRAP);

		textSelgeDetails.setLayoutData(new GridData(GridData.FILL_BOTH));

	}

	/**

	 * Creates UI controls for symbol & map & image files usage.

	 *

	 */

	void createSymbolGroup() {

		// Symbol group

		GridLayout gl = new GridLayout();

		gl.numColumns = 2;

		GridData gd = new GridData(GridData.FILL_BOTH);

		boolean visible = symbolFileWasUsedPreviously();

		// show symbol group if user used symbol & map files last time, hide if selge.ini was used

		gd.exclude = !visible;

		if (visible)

			setDescription(Messages.getString("DebugMetadataWizardPage.SymbolDescription")); //$NON-NLS-1$

		// Symbol files group

		groupSymbolFiles = new Group(composite, SWT.LEFT);

		groupSymbolFiles.setLayout(gl);

		groupSymbolFiles.setLayoutData(new GridData(GridData.FILL_BOTH));

		GridData gdTwoSpan = new GridData(GridData.FILL_HORIZONTAL);

		gdTwoSpan.horizontalSpan = 2;

		groupSymbolFiles.setText(Messages.getString("DebugMetadataWizardPage.SymbolFiles")); //$NON-NLS-1$

		// Symbol file list

		listSymbols = new List(groupSymbolFiles, SWT.BORDER | SWT.V_SCROLL | SWT.H_SCROLL | SWT.MULTI);

		GridData gdHorizontalTop = new GridData(GridData.FILL_HORIZONTAL | GridData.VERTICAL_ALIGN_BEGINNING);

		gdHorizontalTop.verticalSpan = 2;

		gdHorizontalTop.heightHint = LIST_HEIGHT;

		listSymbols.setLayoutData(gdHorizontalTop);

		// read last used symbol files to combo

		String[] lastUsed = getPreviousPaths(LAST_USED_SYMBOL_FILES);

		if (lastUsed != null) {

			listSymbols.setItems(lastUsed);

		}				

		GridData gdButtons = new GridData();

		gdButtons.widthHint =  BUTTON_WIDTH;

		// Add Symbol file button

		buttonAddSymbol = new Button(groupSymbolFiles, SWT.PUSH);

		buttonAddSymbol.setText(Messages.getString("DebugMetadataWizardPage.Add")); //$NON-NLS-1$

		buttonAddSymbol.setLayoutData(gdButtons);

		buttonAddSymbol.addSelectionListener(this);

		// Remove Symbol file button

		buttonRemoveSymbol = new Button(groupSymbolFiles, SWT.PUSH);

		buttonRemoveSymbol.setText(Messages.getString("DebugMetadataWizardPage.Remove")); //$NON-NLS-1$

		buttonRemoveSymbol.setLayoutData(gdButtons);

		buttonRemoveSymbol.addSelectionListener(this);

		createMapFilesGroup(composite);

		// if image files UI is wanted, create it

		if (showImageFilesGroup)

			createImageFilesGroup(composite);

	}

	/**

	 * Creates UI controls for map files usage.

	 *

	 */

	void createMapFilesGroup(Composite parent) {

		// Map Files group

		groupMapFiles = new Group(parent, SWT.NONE);

		GridData gd = new GridData(GridData.FILL_BOTH);

		gd.horizontalSpan = 2;

		gd.verticalIndent = 10;

		GridLayout gl = new GridLayout();

		gl.numColumns = 3;

		groupMapFiles.setLayout(gl);

		groupMapFiles.setText(Messages.getString("DebugMetadataWizardPage.MapFiles")); //$NON-NLS-1$

		groupMapFiles.setLayoutData(gd);		

		// empty label to make layout correct

		new Label(groupMapFiles, SWT.LEFT);

		// Map files folder label

		labelMapFilesFolder = new Label(groupMapFiles, SWT.LEFT);

		GridData gdTwoSpanWithIndent = new GridData(GridData.FILL_HORIZONTAL);

		gdTwoSpanWithIndent.horizontalSpan = 2;

		gdTwoSpanWithIndent.verticalIndent = 10;

		labelMapFilesFolder.setLayoutData(gdTwoSpanWithIndent);

		labelMapFilesFolder.setText(Messages.getString("DebugMetadataWizardPage.MapFilesFolder")); //$NON-NLS-1$

		// Map files folder radio button

		buttonMapFilesFolderRadio = new Button(groupMapFiles, SWT.RADIO);

		buttonMapFilesFolderRadio.addSelectionListener(this);

		// Map files folder combo

		comboMapFilesFolder = new Combo(groupMapFiles, SWT.BORDER);

		GridData gdHorizontal = new GridData(GridData.FILL_HORIZONTAL);

		comboMapFilesFolder.setLayoutData(gdHorizontal);

		comboMapFilesFolder.addModifyListener(this);

		// read last used map file folders to combo

		String[] lastUsed = getPreviousPaths(LAST_USED_MAPFILES_FOLDER);

		if (lastUsed != null) {

			comboMapFilesFolder.setItems(lastUsed);

			comboMapFilesFolder.select(0);

		}						

		// Map files folder browse button

		buttonMapFolderBrowse = new Button(groupMapFiles, SWT.PUSH);

		buttonMapFolderBrowse.setText(Messages.getString("DebugMetadataWizardPage.Browse")); //$NON-NLS-1$

		buttonMapFolderBrowse.addSelectionListener(this);

		// empty label to make layout correct

		new Label(groupMapFiles, SWT.LEFT);

		// MapFiles.zip label

		labelZip = new Label(groupMapFiles, SWT.LEFT);

		GridData gdTwoSpan = new GridData(GridData.FILL_HORIZONTAL);

		gdTwoSpan.horizontalSpan = 2;

		labelZip.setLayoutData(gdTwoSpan);

		labelZip.setText(Messages.getString("DebugMetadataWizardPage.MapFilesZip")); //$NON-NLS-1$

		// MapFiles.zip radio button

		buttonMapFilesZipRadio = new Button(groupMapFiles, SWT.RADIO);

		buttonMapFilesZipRadio.addSelectionListener(this);

		// MapFiles.zip combo

		comboMapFilesZip = new Combo(groupMapFiles, SWT.BORDER);

		comboMapFilesZip.setLayoutData(gdHorizontal);

		comboMapFilesZip.addModifyListener(this);

		// read last used mapfiles.zip file paths to combo

		lastUsed = getPreviousPaths(LAST_USED_MAPZIP_FILES);

		if (lastUsed != null) {

			comboMapFilesZip.setItems(lastUsed);

			comboMapFilesZip.select(0);

		}						

		// MapFiles.zip browse button

		buttonZipBrowse = new Button(groupMapFiles, SWT.PUSH);

		buttonZipBrowse.setText(Messages.getString("DebugMetadataWizardPage.Browse")); //$NON-NLS-1$

		buttonZipBrowse.addSelectionListener(this);

		// empty label to make layout correct

		new Label(groupMapFiles, SWT.LEFT);

		// SDK folder label

		labelSdkFolder = new Label(groupMapFiles, SWT.LEFT);

		labelSdkFolder.setLayoutData(gdTwoSpan);

		labelSdkFolder.setText(Messages.getString("DebugMetadataWizardPage.SdkMapFilesFolder")); //$NON-NLS-1$

		// SDK folder radio button

		buttonSdkFolderRadio = new Button(groupMapFiles, SWT.RADIO);

		buttonSdkFolderRadio.addSelectionListener(this);

		// SDK folder combo

		comboSdkFolder = new Combo(groupMapFiles, SWT.BORDER | SWT.READ_ONLY);

		comboSdkFolder.setLayoutData(gdHorizontal);

		comboSdkFolder.addModifyListener(this);

		comboSdkFolder.setVisibleItemCount(50);

		sdkFolders = getSdkMapFolders();

		// if no SDK folders were found disable SDK combo

		if (sdkFolders == null || sdkFolders.size() < 1) {

			disableSdkSelection();

		// SDK folders were found, fill SDK combo with those values

		} else {

			Set<String> keySet = sdkFolders.keySet();

			String[] keys = keySet.toArray(new String[keySet.size()]);

			Arrays.sort(keys);

			comboSdkFolder.setItems(keys);

		}

		// read which SDK folder was used last, and select it in SDK combo if possible

		lastUsed = getPreviousPaths(LAST_USED_SDK);

		if (lastUsed != null && sdkFolders != null && buttonSdkFolderRadio.getEnabled()) {

			String[] items = comboSdkFolder.getItems();

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

				if (items[i].equalsIgnoreCase(lastUsed[0])) {

					comboSdkFolder.select(i);

					break;

				}

			}

		}										

		// empty label to make layout correct

		new Label(groupMapFiles, SWT.LEFT);

		// No map files radio button

		buttonNoMapFilesRadio = new Button(groupMapFiles, SWT.RADIO);

		buttonNoMapFilesRadio.addSelectionListener(this);

		// No map files label

		labelNoMapFiles = new Label(groupMapFiles, SWT.LEFT);

		labelNoMapFiles.setText(Messages.getString("DebugMetadataWizardPage.NoMapFiles")); //$NON-NLS-1$

		labelNoMapFiles.setLayoutData(gdTwoSpan);

		// read how map files were used last time (i.e. which radio button

		// was selected) and select the same radio button this time.

		int lastUsedMapRadio = lastUsedMapFileType();

		switch (lastUsedMapRadio) {

		case MAP_FILES_FOLDER_RADIO:

			buttonMapFilesFolderRadio.setSelection(true);

			break;

		case MAP_FILES_ZIP_RADIO:

			buttonMapFilesZipRadio.setSelection(true);

			break;

		case SDK_MAP_FILES_FOLDER_RADIO:

			buttonSdkFolderRadio.setSelection(true);

			break;

		default:

			buttonNoMapFilesRadio.setSelection(true);

			break;

		}

		enableMapSelections();

	}

	/**

	 * Creates UI controls for image files usage.

	 *

	 */

	void createImageFilesGroup(Composite parent) {

		// Image files group

		groupImageFiles = new Group(parent, SWT.NONE);

		GridData gd = new GridData(GridData.FILL_BOTH);

		gd.horizontalSpan = 2;

		gd.verticalIndent = 10;

		GridLayout gl = new GridLayout();

		gl.numColumns = 2;

		groupImageFiles.setLayout(gl);

		groupImageFiles.setText(Messages.getString("DebugMetadataWizardPage.ImageFiles")); //$NON-NLS-1$

		groupImageFiles.setLayoutData(gd);		

		// Image file list

		listImageFiles = new List(groupImageFiles, SWT.BORDER | SWT.V_SCROLL | SWT.H_SCROLL | SWT.MULTI);

		GridData gdHorizontalTop = new GridData(GridData.FILL_HORIZONTAL | GridData.VERTICAL_ALIGN_BEGINNING);

		gdHorizontalTop.verticalSpan = 2;