TclRemoteTab.java

/*******************************************************************************
 * Copyright (c) 2005, 2017 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
 *
 *******************************************************************************/
package org.eclipse.dltk.tcl.internal.debug.ui.launchConfigurations;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.debug.core.ILaunchConfiguration;
import org.eclipse.debug.core.ILaunchConfigurationWorkingCopy;
import org.eclipse.debug.ui.AbstractLaunchConfigurationTab;
import org.eclipse.dltk.debug.core.DLTKDebugPlugin;
import org.eclipse.dltk.launching.ScriptLaunchConfigurationConstants;
import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Group;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Text;

/**
 * XXX This class is not in use.
 */
public class TclRemoteTab extends AbstractLaunchConfigurationTab {
	private static final int DEFAULT_PORT = 9000;
	private static final String DEFAULT_SESSION_ID = "tcl_debug";

	private Text portText;
	private Text sessionIdText;
	private Text timeoutText;

	private int getPort() {
		return Integer.parseInt(portText.getText());
	}

	private void setPort(int port) {
		portText.setText(Integer.toString(port));
	}

	private String getSessionId() {
		return sessionIdText.getText();
	}

	private void setSessionId(String id) {
		sessionIdText.setText(id);
	}

	private int getTimeout() {
		return Integer.parseInt(timeoutText.getText());
	}

	private void setTimeout(int timeout) {
		timeoutText.setText(Integer.toString(timeout));
	}

	protected void createInstruction(Composite parent, Object data) {
		Label instruction = new Label(parent, SWT.NONE);
		instruction.setLayoutData(data);
		instruction.setText("To start Tcl debugging engine use this command temlate:");
	}

	protected void createPathTemplate(Composite parent, Object data) {
		Text text = new Text(parent, SWT.NONE);
		text.setText(
				"${DEBUGGIN_ENGINE} -host-ide ${HOST} -port-ide ${PORT} -app-shell ${TCL_INTERPRETER} -ide-key ${SESSION_ID} -app-file {TCL_FILE}");
	}

	protected void createConnectionPropertiesGroup(Composite parent, Object data) {
		Group group = new Group(parent, SWT.NONE);
		group.setText("Connection Properties");
		group.setLayoutData(data);

		GridLayout layout = new GridLayout();
		layout.numColumns = 2;
		group.setLayout(layout);

		// Local port
		Label portLabel = new Label(group, SWT.NONE);
		portLabel.setText("Local port:");

		portText = new Text(group, SWT.BORDER);
		portText.addModifyListener(e -> updateLaunchConfigurationDialog());
		portText.setLayoutData(new GridData(GridData.FILL, SWT.NONE, true, false));

		// Id string
		Label idLabel = new Label(group, SWT.NONE);
		idLabel.setText("Connection id:");

		sessionIdText = new Text(group, SWT.BORDER);
		sessionIdText.addModifyListener(e -> updateLaunchConfigurationDialog());

		sessionIdText.setLayoutData(new GridData(GridData.FILL, SWT.NONE, true, false));

		// Timeout
		Label timeoutLabel = new Label(group, SWT.NONE);
		timeoutLabel.setText("Waiting timeout:");

		timeoutText = new Text(group, SWT.BORDER);
		timeoutText.addModifyListener(e -> updateLaunchConfigurationDialog());

		timeoutText.setLayoutData(new GridData(GridData.FILL, SWT.NONE, true, false));
	}

	@Override
	public void createControl(Composite parent) {
		Composite composite = new Composite(parent, SWT.NONE);
		setControl(composite);

		GridLayout layout = new GridLayout();
		layout.numColumns = 1;
		composite.setLayout(layout);

		createConnectionPropertiesGroup(composite, new GridData(GridData.FILL, SWT.NONE, true, false));

		createInstruction(composite, new GridData(GridData.FILL, SWT.NONE, true, false));

		createPathTemplate(composite, new GridData(GridData.FILL, SWT.NONE, true, false));
	}

	@Override
	public String getName() {
		return "Tcl Remote Properties";
	}

	@Override
	public void initializeFrom(ILaunchConfiguration configuration) {
		try {
			// Port
			int port = configuration.getAttribute(ScriptLaunchConfigurationConstants.ATTR_DLTK_DBGP_PORT, -1);

			setPort(port != -1 ? port : DEFAULT_PORT);

			// Session id
			String sessionId = configuration.getAttribute(ScriptLaunchConfigurationConstants.ATTR_DLTK_DBGP_SESSION_ID,
					(String) null);

			setSessionId(sessionId != null ? sessionId : DEFAULT_SESSION_ID);

			// Timeout
			int timeout = configuration.getAttribute(ScriptLaunchConfigurationConstants.ATTR_DLTK_DBGP_WAITING_TIMEOUT,
					DLTKDebugPlugin.getConnectionTimeout());
			setTimeout(timeout);
		} catch (CoreException e) {
			// TODO: Log this
		}
	}

	@Override
	public void performApply(ILaunchConfigurationWorkingCopy configuration) {
		try {
			setErrorMessage(null);

			configuration.setAttribute(ScriptLaunchConfigurationConstants.ATTR_DLTK_DBGP_REMOTE, true);

			configuration.setAttribute(ScriptLaunchConfigurationConstants.ATTR_DLTK_DBGP_PORT, getPort());

			configuration.setAttribute(ScriptLaunchConfigurationConstants.ATTR_DLTK_DBGP_SESSION_ID, getSessionId());

			configuration.setAttribute(ScriptLaunchConfigurationConstants.ATTR_DLTK_DBGP_WAITING_TIMEOUT, getTimeout());
		} catch (NumberFormatException e) {
			setErrorMessage("Should be a number instead of string");
		}
	}

	@Override
	public void setDefaults(ILaunchConfigurationWorkingCopy configuration) {
		configuration.setAttribute(ScriptLaunchConfigurationConstants.ATTR_DLTK_DBGP_PORT, DEFAULT_PORT);

		configuration.setAttribute(ScriptLaunchConfigurationConstants.ATTR_DLTK_DBGP_SESSION_ID, DEFAULT_SESSION_ID);

		configuration.setAttribute(ScriptLaunchConfigurationConstants.ATTR_DLTK_DBGP_WAITING_TIMEOUT,
				DLTKDebugPlugin.getConnectionTimeout());
	}
}