/**********************************************************************
 * Copyright (c) 2002,2003 Rational Software Corporation and others.
 * All rights reserved.   This program and the accompanying materials
 * are made available under the terms of the Common Public License v0.5
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/cpl-v05.html
 * 
 * Contributors: 
 * IBM Rational Software - Initial API and implementation
 * QNX Software Systems - Move to Make plugin
***********************************************************************/
package org.eclipse.cdt.make.ui.dialogs;

import java.util.ArrayList;
import java.util.StringTokenizer;

import org.eclipse.cdt.internal.ui.util.SWTUtil;
import org.eclipse.cdt.make.core.MakeCorePlugin;
import org.eclipse.cdt.make.core.MakeScannerInfo;
import org.eclipse.cdt.make.core.MakeScannerProvider;
import org.eclipse.cdt.make.internal.ui.MakeUIPlugin;
import org.eclipse.cdt.make.ui.IMakeHelpContextIds;
import org.eclipse.cdt.ui.dialogs.AbstractCOptionPage;
import org.eclipse.cdt.utils.ui.controls.ControlFactory;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.core.runtime.Preferences;
import org.eclipse.jface.dialogs.InputDialog;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.MouseAdapter;
import org.eclipse.swt.events.MouseEvent;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.graphics.Font;
import org.eclipse.swt.graphics.FontData;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.List;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.ui.help.WorkbenchHelp;

public class BuildPathInfoBlock extends AbstractCOptionPage {
	private static final int PROJECT_LIST_MULTIPLIER = 10;

	private static final String PREF_SYMBOLS = "ScannerSymbols";
	private static final String PREF_INCLUDES = "ScannerIncludes";
	private static final String PREFIX = "BuildPathInfoBlock"; //$NON-NLS-1$
	private static final String LABEL = PREFIX + ".label"; //$NON-NLS-1$
	private static final String PATHS = PREFIX + ".paths"; //$NON-NLS-1$
	private static final String SYMBOLS = PREFIX + ".symbols"; //$NON-NLS-1$
	private static final String BROWSE = PREFIX + ".browse"; //$NON-NLS-1$
	private static final String PATH_TITLE = BROWSE + ".path"; //$NON-NLS-1$
	private static final String EDIT_PATH_TITLE = BROWSE + ".path.edit"; //$NON-NLS-1$
	private static final String PATH_LABEL = BROWSE + ".path.label"; //$NON-NLS-1$
	private static final String SYMBOL_TITLE = BROWSE + ".symbol"; //$NON-NLS-1$
	private static final String EDIT_SYMBOL_TITLE = BROWSE + ".symbol.edit"; //$NON-NLS-1$
	private static final String SYMBOL_LABEL = BROWSE + ".symbol.label"; //$NON-NLS-1$
	private static final String NEW = "BuildPropertyCommon.label.new"; //$NON-NLS-1$
	private static final String EDIT = "BuildPropertyCommon.label.edit"; //$NON-NLS-1$
	private static final String REMOVE = "BuildPropertyCommon.label.remove"; //$NON-NLS-1$
	private static final String UP = "BuildPropertyCommon.label.up"; //$NON-NLS-1$
	private static final String DOWN = "BuildPropertyCommon.label.down"; //$NON-NLS-1$

	private List pathList;
	private List symbolList;
	private Composite pathButtonComp;
	private Button addPath;
	private Button editPath;
	private Button removePath;
	private Button pathUp;
	private Button pathDown;
	private Composite symbolButtonComp;
	private Button addSymbol;
	private Button editSymbol;
	private Button removeSymbol;
	private Button symbolUp;
	private Button symbolDown;
	private Shell shell;

	public BuildPathInfoBlock() {
		super(MakeUIPlugin.getResourceString(LABEL));
		setDescription("Set the include paths and preprocessor symbols for this project");
	}

	private void createPathListButtons(Composite parent) {
		// Create a composite for the buttons
		pathButtonComp = ControlFactory.createComposite(parent, 1);
		pathButtonComp.setFont(parent.getFont());

		// Add the buttons
		addPath = ControlFactory.createPushButton(pathButtonComp, MakeUIPlugin.getResourceString(NEW));
		addPath.addSelectionListener(new SelectionAdapter() {
			public void widgetSelected(SelectionEvent e) {
				handleAddPath();
			}
		});
		addPath.setEnabled(true);
		addPath.setFont(parent.getFont());
		addPath.setLayoutData(new GridData());
		SWTUtil.setButtonDimensionHint(addPath);

		editPath = ControlFactory.createPushButton(pathButtonComp, MakeUIPlugin.getResourceString(EDIT));
		editPath.addSelectionListener(new SelectionAdapter() {
			public void widgetSelected(SelectionEvent e) {
				editPathListItem();
			}
		});
		editPath.setEnabled(true);
		editPath.setFont(parent.getFont());
		editPath.setLayoutData(new GridData());
		SWTUtil.setButtonDimensionHint(editPath);

		removePath = ControlFactory.createPushButton(pathButtonComp, MakeUIPlugin.getResourceString(REMOVE));
		removePath.addSelectionListener(new SelectionAdapter() {
			public void widgetSelected(SelectionEvent e) {
				handleRemovePath();
			}
		});
		removePath.setFont(parent.getFont());
		removePath.setLayoutData(new GridData());
		SWTUtil.setButtonDimensionHint(removePath);

		pathUp = ControlFactory.createPushButton(pathButtonComp, MakeUIPlugin.getResourceString(UP));
		pathUp.addSelectionListener(new SelectionAdapter() {
			public void widgetSelected(SelectionEvent e) {
				handlePathUp();
			}
		});
		pathUp.setFont(parent.getFont());
		pathUp.setLayoutData(new GridData());
		SWTUtil.setButtonDimensionHint(pathUp);

		pathDown = ControlFactory.createPushButton(pathButtonComp, MakeUIPlugin.getResourceString(DOWN));
		pathDown.addSelectionListener(new SelectionAdapter() {
			public void widgetSelected(SelectionEvent e) {
				handlePathDown();
			}
		});
		pathDown.setFont(parent.getFont());
		pathDown.setLayoutData(new GridData());
		SWTUtil.setButtonDimensionHint(pathDown);

	}

	private void createPathListControl(Composite parent, int numColumns) {
		// Create the list
		pathList = new List(parent, SWT.BORDER | SWT.SINGLE | SWT.H_SCROLL | SWT.V_SCROLL);
		pathList.addSelectionListener(new SelectionAdapter() {
			public void widgetSelected(SelectionEvent e) {
				enablePathButtons();
			}
		});
		pathList.addMouseListener(new MouseAdapter() {
			public void mouseDoubleClick(MouseEvent e) {
				editPathListItem();
			}
		});

		// Make it occupy the first 2 columns
		GridData gd = new GridData(GridData.FILL_BOTH);
		gd.grabExcessHorizontalSpace = true;
		gd.horizontalSpan = numColumns - 1;
		gd.heightHint = getDefaultFontHeight(pathList, PROJECT_LIST_MULTIPLIER);
		pathList.setLayoutData(gd);
		pathList.setFont(parent.getFont());

	}

	/**
	 * Get the defualt widget height for the supplied control.
	 * @return int
	 * @param control - the control being queried about fonts
	 * @param lines - the number of lines to be shown on the table.
	 */
	private static int getDefaultFontHeight(Control control, int lines) {
		FontData[] viewerFontData = control.getFont().getFontData();
		int fontHeight = 10;

		//If we have no font data use our guess
		if (viewerFontData.length > 0)
			fontHeight = viewerFontData[0].getHeight();
		return lines * fontHeight;
	}

	private void createSymbolListButtons(Composite parent) {
		// Create a composite for the buttons
		symbolButtonComp = ControlFactory.createComposite(parent, 1);
		symbolButtonComp.setFont(parent.getFont());

		// Add the buttons
		addSymbol = ControlFactory.createPushButton(symbolButtonComp, MakeUIPlugin.getResourceString(NEW));
		addSymbol.addSelectionListener(new SelectionAdapter() {
			public void widgetSelected(SelectionEvent e) {
				handleAddSymbol();
			}
		});
		addSymbol.setEnabled(true);
		addSymbol.setFont(parent.getFont());
		addSymbol.setLayoutData(new GridData());
		SWTUtil.setButtonDimensionHint(addSymbol);

		editSymbol = ControlFactory.createPushButton(symbolButtonComp, MakeUIPlugin.getResourceString(EDIT));
		editSymbol.addSelectionListener(new SelectionAdapter() {
			public void widgetSelected(SelectionEvent e) {
				editSymbolListItem();
			}
		});
		editSymbol.setEnabled(true);
		editSymbol.setFont(parent.getFont());
		editSymbol.setLayoutData(new GridData());
		SWTUtil.setButtonDimensionHint(editSymbol);

		removeSymbol = ControlFactory.createPushButton(symbolButtonComp, MakeUIPlugin.getResourceString(REMOVE));
		removeSymbol.addSelectionListener(new SelectionAdapter() {
			public void widgetSelected(SelectionEvent e) {
				handleRemoveSymbol();
			}
		});
		removeSymbol.setFont(parent.getFont());
		removeSymbol.setLayoutData(new GridData());
		SWTUtil.setButtonDimensionHint(removeSymbol);

		symbolUp = ControlFactory.createPushButton(symbolButtonComp, MakeUIPlugin.getResourceString(UP));
		symbolUp.addSelectionListener(new SelectionAdapter() {
			public void widgetSelected(SelectionEvent e) {
				handleSymbolUp();
			}
		});
		symbolUp.setFont(parent.getFont());
		symbolUp.setLayoutData(new GridData());
		SWTUtil.setButtonDimensionHint(symbolUp);

		symbolDown = ControlFactory.createPushButton(symbolButtonComp, MakeUIPlugin.getResourceString(DOWN));
		symbolDown.addSelectionListener(new SelectionAdapter() {
			public void widgetSelected(SelectionEvent e) {
				handleSymbolDown();
			}
		});
		symbolDown.setFont(parent.getFont());
		symbolDown.setLayoutData(new GridData());
		SWTUtil.setButtonDimensionHint(symbolDown);
	}

	private void createSymbolListControl(Composite parent, int numColumns) {
		// Create the list
		symbolList = new List(parent, SWT.BORDER | SWT.SINGLE | SWT.H_SCROLL | SWT.V_SCROLL);
		symbolList.addSelectionListener(new SelectionAdapter() {
			public void widgetSelected(SelectionEvent e) {
				enableSymbolButtons();
			}
		});
		symbolList.addMouseListener(new MouseAdapter() {
			public void mouseDoubleClick(MouseEvent e) {
				editSymbolListItem();
			}
		});

		// Make it occupy the first n-1 columns
		GridData gd = new GridData(GridData.FILL_BOTH);
		gd.horizontalSpan = numColumns - 1;
		gd.grabExcessHorizontalSpace = true;
		gd.heightHint = getDefaultFontHeight(pathList, PROJECT_LIST_MULTIPLIER);
		symbolList.setLayoutData(gd);
		symbolList.setFont(parent.getFont());

	}

	/* (non-Javadoc)
	 * @see org.eclipse.cdt.ui.wizards.IWizardTab#doRun(org.eclipse.core.resources.IProject, org.eclipse.core.runtime.IProgressMonitor)
	 */
	public void performApply(IProgressMonitor monitor) throws CoreException {
		if (monitor == null) {
			monitor = new NullProgressMonitor();
		}
		if (getContainer().getProject() != null) {
			// Store the paths and symbols 
			monitor.beginTask("Setting Scanner Info", 3);
			MakeScannerInfo info = MakeScannerProvider.getDefault().getMakeScannerInfo(getContainer().getProject(), false);
			info.setIncludePaths(getPathListContents());
			monitor.worked(1);
			info.setPreprocessorSymbols(getSymbolListContents());
			monitor.worked(1);
			info.update();
			monitor.done();
		} else {
			setIncludes(MakeCorePlugin.getDefault().getPluginPreferences());
			setSymbols(MakeCorePlugin.getDefault().getPluginPreferences());
		}
	}

	public void performDefaults() {
		pathList.removeAll();
		symbolList.removeAll();
		if (getContainer().getProject() != null) {
			pathList.setItems(getIncludes(MakeCorePlugin.getDefault().getPluginPreferences()));
			symbolList.setItems(getSymbols(MakeCorePlugin.getDefault().getPluginPreferences()));
		}
		getContainer().updateContainer();
	}

	private void setSymbols(Preferences prefs) {
		prefs.setValue(PREF_SYMBOLS, stringArrayToString(getSymbolListContents()));
	}

	private void setIncludes(Preferences prefs) {
		prefs.setValue(PREF_INCLUDES, stringArrayToString(getPathListContents()));
	}

	private String stringArrayToString(String[] strings) {
		StringBuffer buf = new StringBuffer();
		for (int i = 0; i < strings.length; i++) {
			buf.append(strings[i]).append(';');
		}
		return buf.toString();
	}

	private String[] getSymbols(Preferences prefs) {
		String syms = prefs.getString(PREF_SYMBOLS);
		return parseStringToList(syms);
	}

	private String[] getIncludes(Preferences prefs) {
		String syms = prefs.getString(PREF_INCLUDES);
		return parseStringToList(syms);
	}

	private String[] parseStringToList(String syms) {
		if (syms != null && syms.length() > 0) {
			StringTokenizer tok = new StringTokenizer(syms, ";");
			ArrayList list = new ArrayList(tok.countTokens());
			while (tok.hasMoreElements()) {
				list.add(tok.nextToken());
			}
			return (String[]) list.toArray(new String[list.size()]);
		}
		return new String[0];
	}

	/*
	 * Double-click handler to allow edit of path information
	 */
	protected void editPathListItem() {
		// Edit the selection index
		int index = pathList.getSelectionIndex();
		if (index != -1) {
			String selItem = pathList.getItem(index);
			if (selItem != null) {
				InputDialog dialog =
					new InputDialog(
						shell,
						MakeUIPlugin.getResourceString(EDIT_PATH_TITLE),
						MakeUIPlugin.getResourceString(PATH_LABEL),
						selItem,
						null);
				String newItem = null;
				if (dialog.open() == InputDialog.OK) {
					newItem = dialog.getValue();
					if (newItem != null && !newItem.equals(selItem)) {
						pathList.setItem(index, newItem);
					}
				}
			}
		}
	}

	/*
	 * Double-click handler to allow edit of symbol information
	 */
	protected void editSymbolListItem() {
		// Edit the selection index
		int index = symbolList.getSelectionIndex();
		if (index != -1) {
			String selItem = symbolList.getItem(index);
			if (selItem != null) {
				InputDialog dialog =
					new InputDialog(
						shell,
						MakeUIPlugin.getResourceString(EDIT_SYMBOL_TITLE),
						MakeUIPlugin.getResourceString(SYMBOL_LABEL),
						selItem,
						null);
				String newItem = null;
				if (dialog.open() == InputDialog.OK) {
					newItem = dialog.getValue();
					if (newItem != null && !newItem.equals(selItem)) {
						symbolList.setItem(index, newItem);
					}
				}
			}
		}
	}

	/*
	 * Enables the buttons on the path control if the right conditions are met
	 */
	void enablePathButtons() {
		// Enable the remove button if there is at least 1 item in the list
		int items = pathList.getItemCount();
		if (items > 0) {
			editPath.setEnabled(true);
			removePath.setEnabled(true);
			// Enable the up/down buttons depending on what item is selected
			int index = pathList.getSelectionIndex();
			pathUp.setEnabled(items > 1 && index > 0);
			pathDown.setEnabled(items > 1 && index < (items - 1));
		} else {
			editPath.setEnabled(false);
			removePath.setEnabled(false);
			pathUp.setEnabled(false);
			pathDown.setEnabled(false);
		}
	}

	void enableSymbolButtons() {
		// Enable the remove button if there is at least 1 item in the list
		int items = symbolList.getItemCount();
		if (items > 0) {
			editSymbol.setEnabled(true);
			removeSymbol.setEnabled(true);
			// Enable the up/down buttons depending on what item is selected
			int index = symbolList.getSelectionIndex();
			symbolUp.setEnabled(items > 1 && index > 0);
			symbolDown.setEnabled(items > 1 && index < (items - 1));
		} else {
			editSymbol.setEnabled(false);
			removeSymbol.setEnabled(false);
			symbolUp.setEnabled(false);
			symbolDown.setEnabled(false);
		}
	}

	/* (non-Javadoc)
	 * @see org.eclipse.cdt.ui.wizards.IWizardTab#getControl(org.eclipse.swt.widgets.Composite)
	 */
	public void createControl(Composite parent) {
		// Create the composite control for the tab
		int tabColumns = 3;
		Font font = parent.getFont();
		Composite composite = ControlFactory.createComposite(parent, tabColumns);
		composite.setFont(font);
		GridData gd;
		setControl(composite);

		WorkbenchHelp.setHelp(getControl(), IMakeHelpContextIds.MAKE_PATH_SYMBOL_SETTINGS);

		// Create a label for the include paths control
		Label paths = ControlFactory.createLabel(composite, MakeUIPlugin.getResourceString(PATHS));
		gd = new GridData(GridData.FILL_HORIZONTAL);
		gd.horizontalSpan = tabColumns;
		paths.setLayoutData(gd);
		paths.setFont(font);

		//Create the list and button controls
		createPathListControl(composite, tabColumns);
		createPathListButtons(composite);
		enablePathButtons();

		// Create a label for the symbols control
		Label symbols = ControlFactory.createLabel(composite, MakeUIPlugin.getResourceString(SYMBOLS));
		gd = new GridData(GridData.FILL_HORIZONTAL);
		gd.horizontalSpan = tabColumns;
		symbols.setLayoutData(gd);
		symbols.setFont(font);

		// Create list and button controls for symbols
		createSymbolListControl(composite, tabColumns);
		createSymbolListButtons(composite);
		enableSymbolButtons();

		setListContents();
		pathList.select(0);
		enablePathButtons();
		symbolList.select(0);
		enableSymbolButtons();
	}

	private String[] getPathListContents() {
		return pathList.getItems();
	}

	private String[] getSymbolListContents() {
		return symbolList.getItems();
	}

	protected void handleAddPath() {
		// Popup an entry dialog
		InputDialog dialog = new InputDialog(shell, MakeUIPlugin.getResourceString(PATH_TITLE), MakeUIPlugin.getResourceString(PATH_LABEL), "", null); //$NON-NLS-1$
		String path = null;
		if (dialog.open() == InputDialog.OK) {
			path = dialog.getValue();
		}
		if (path != null && path.length() > 0) {
			pathList.add(path);
			pathList.select(pathList.getItemCount() - 1);
			enablePathButtons();
		}
	}

	protected void handleAddSymbol() {
		// Popup an entry dialog
		InputDialog dialog = new InputDialog(shell, MakeUIPlugin.getResourceString(SYMBOL_TITLE), MakeUIPlugin.getResourceString(SYMBOL_LABEL), "", null); //$NON-NLS-1$
		String symbol = null;
		if (dialog.open() == InputDialog.OK) {
			symbol = dialog.getValue();
		}
		if (symbol != null && symbol.length() > 0) {
			symbolList.add(symbol);
			symbolList.select(symbolList.getItemCount() - 1);
			enableSymbolButtons();
		}
	}

	protected void handlePathDown() {
		// Get the selection index
		int index = pathList.getSelectionIndex();
		int items = pathList.getItemCount();
		if (index == -1 || index == items - 1) {
			return;
		}
		// Swap the items in the list
		String selItem = pathList.getItem(index);
		pathList.remove(index);
		if (index + 1 == items) {
			pathList.add(selItem);
		} else {
			pathList.add(selItem, ++index);
		}

		// Keep the swapped item selected
		pathList.select(index);
		enablePathButtons();
	}

	protected void handlePathUp() {
		// Get the selection index
		int index = pathList.getSelectionIndex();
		if (index == -1 || index == 0) {
			return;
		}
		// Swap the items in the list
		String selItem = pathList.getItem(index);
		pathList.remove(index);
		pathList.add(selItem, --index);

		// Keep the index selected
		pathList.select(index);
		enablePathButtons();
	}

	protected void handleRemovePath() {
		// Get the selection index
		int index = pathList.getSelectionIndex();
		if (index == -1) {
			return;
		}

		// Remove the element at that index
		pathList.remove(index);
		index = index - 1 < 0 ? 0 : index - 1;
		pathList.select(index);

		// Check if the buttons should still be enabled
		enablePathButtons();
	}

	protected void handleRemoveSymbol() {
		// Get the selection index
		int index = symbolList.getSelectionIndex();
		if (index == -1) {
			return;
		}
		// Remove the item at that index
		symbolList.remove(index);
		index = index - 1 < 0 ? 0 : index - 1;
		symbolList.select(index);
		// Check if the button state should be toggled
		enableSymbolButtons();
	}

	protected void handleSymbolDown() {
		// Get the selection index
		int index = symbolList.getSelectionIndex();
		int items = symbolList.getItemCount();
		if (index == -1 || index == items - 1) {
			return;
		}
		// Swap the items in the list
		String selItem = symbolList.getItem(index);
		symbolList.remove(index);
		if (index + 1 == items) {
			symbolList.add(selItem);
		} else {
			symbolList.add(selItem, ++index);
		}

		// Keep the swapped item selected
		symbolList.select(index);
		enableSymbolButtons();
	}

	protected void handleSymbolUp() {
		// Get the selection index
		int index = symbolList.getSelectionIndex();
		if (index == -1 || index == 0) {
			return;
		}
		// Swap the items in the list
		String selItem = symbolList.getItem(index);
		symbolList.remove(index);
		symbolList.add(selItem, --index);

		// Keep the index selected
		symbolList.select(index);
		enableSymbolButtons();
	}

	/* (non-Javadoc)
	 * @see org.eclipse.cdt.ui.wizards.IWizardTab#isValid()
	 */
	public boolean isValid() {
		// Info on this page is not critical
		return true;
	}

	private void setListContents() {
		if (getContainer().getProject() != null) {
			MakeScannerInfo info;
			try {
				info = MakeScannerProvider.getDefault().getMakeScannerInfo(getContainer().getProject(), false);
				pathList.setItems(info.getIncludePaths());
				symbolList.setItems(info.getPreprocessorSymbols());
			} catch (CoreException e) {
			}
		} else {
			pathList.setItems(getIncludes(MakeCorePlugin.getDefault().getPluginPreferences()));
			symbolList.setItems(getSymbols(MakeCorePlugin.getDefault().getPluginPreferences()));
		}
	}
}