execution/org.eclipse.efm.execution.configuration.common.ui/src/org/eclipse/efm/execution/configuration/common/ui/page/supervisor/SupervisorConfigurationPage.java

/*******************************************************************************
 * Copyright (c) 2017 CEA LIST.
 *
 * 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:
 *  Alain Faivre (CEA LIST) alain.faivre@cea.fr - Initial Implementation (tab-based, inserted in Run Configurations dialog)
 *  Erwan Mahe (CEA LIST) erwan.mahe@cea.fr - New API (free-composite-based, no type assumptions on parent)
 *******************************************************************************/

package org.eclipse.efm.execution.configuration.common.ui.page.supervisor;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.debug.core.ILaunchConfiguration;
import org.eclipse.debug.core.ILaunchConfigurationWorkingCopy;
import org.eclipse.efm.execution.configuration.common.ui.api.AbstractConfigurationPage;
import org.eclipse.efm.execution.configuration.common.ui.api.ILaunchConfigurationGUIelement;
import org.eclipse.efm.execution.configuration.common.ui.api.IWidgetToolkit;
import org.eclipse.efm.execution.configuration.common.ui.editors.BooleanFieldEditor;
import org.eclipse.efm.execution.configuration.common.ui.editors.IntegerFieldEditor;
import org.eclipse.efm.execution.core.workflow.common.GraphExplorationStrategyKind;
import org.eclipse.swt.events.ModifyEvent;
import org.eclipse.swt.events.ModifyListener;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Group;

public class SupervisorConfigurationPage extends AbstractConfigurationPage {

	//	public static final String ATTR_BEHAVIOR_ANALYSIS_TRANSITION_NAME =
	//	Activator.PLUGIN_ID + ".ATTR_BEHAVIOR_ANALYSIS_TRANSITION_NAME"; //$NON-NLS-1$

	private IntegerFieldEditor fNodeIntegerField;
	private IntegerFieldEditor fWidthIntegerField;
	private IntegerFieldEditor fHeightIntegerField;
	private IntegerFieldEditor fStepsIntegerField;
	private IntegerFieldEditor fTimeoutIntegerField;
	//private StringFieldEditor fTransitionNameStringField;
	private BooleanFieldEditor fInclusionCriterionBooleanField;

	private Button fBFSButton = null;
	private Button fDFSButton = null;
	private Button fRFSButton = null;

	private GraphExplorationStrategyKind fAnalyzeStrategy =
		GraphExplorationStrategyKind.BREADTH_FIRST_SEARCH;

	private Group groupAnalyzeStrategy;
	//private Group groupBehaviorCharacterization;
	private Group groupInclusionCriterion;

	public SupervisorConfigurationPage(ILaunchConfigurationGUIelement masterGUIelement) {
		super(masterGUIelement);
	}


	private final class TabListener extends SelectionAdapter implements ModifyListener {

		/* (non-Javadoc)
		 * @see org.eclipse.swt.events.ModifyListener#modifyText(org.eclipse.swt.events.ModifyEvent)
		 */
		@Override
		public void modifyText(ModifyEvent e) {
			propagateGUIupdate();
		}

		/* (non-Javadoc)
		 * @see org.eclipse.swt.events.SelectionListener#widgetSelected(org.eclipse.swt.events.SelectionEvent)
		 */
		@Override
		public void widgetSelected(SelectionEvent e) {
			Object source= e.getSource();
		//	if (source == fViewer.getTable() || source == fViewer) {
		//		setParametersButtonsEnableState();
		//	} else if (source == fParametersAddButton) {
		//		handleParametersAddButtonSelected();
		//	} else if (source == fParametersEditButton) {
		//		handleParametersEditButtonSelected();
		//	} else if (source == fParametersRemoveButton) {
		//		handleParametersRemoveButtonSelected();
		//	}

			// Use case Analysis
			if (source == fBFSButton) {
				handleBFSButtonSelected();
			}
			else if (source == fDFSButton) {
				handleDFSButtonSelected();
			}
			else if (source == fRFSButton) {
				handleRFSButtonSelected();
			}
		}
	}

	private TabListener fListener= new TabListener();


	// ======================================================================================
	//                              Buttons handling
	// ======================================================================================

	public void handleBFSButtonSelected() {
		if( fBFSButton.getSelection() ) {
			fAnalyzeStrategy = GraphExplorationStrategyKind.BREADTH_FIRST_SEARCH;
		}
		propagateGUIupdate();
	}

	public void handleDFSButtonSelected() {
		if( fDFSButton.getSelection() ) {
			fAnalyzeStrategy = GraphExplorationStrategyKind.DEPTH_FIRST_SEARCH;
		}
		propagateGUIupdate();
	}

	public void handleRFSButtonSelected() {
		if( fRFSButton.getSelection() ) {
			fAnalyzeStrategy = GraphExplorationStrategyKind.RANDOM_FIRST_SEARCH;
		}
		propagateGUIupdate();
	}

	// ======================================================================================
	//                              Graphical Components Creation Methods
	// ======================================================================================

	@Override
	protected void createContent(Composite parent, IWidgetToolkit widgetToolkit)
	{
		createControlNodesHeightWidth(parent, widgetToolkit);
		createControlEvaluationLimits(parent, widgetToolkit);
		createAnalyzeStrategy(parent, widgetToolkit);
		createControlInclusionCriterion(parent, widgetToolkit);
//		createBehaviorCharacterization(parent, widgetToolkit);
	}

	private void createControlNodesHeightWidth(Composite parent, IWidgetToolkit widgetToolkit) {
        Group group = widgetToolkit.createGroup(parent,
        		"Graph size limits", 5, 2, GridData.FILL_HORIZONTAL);

        Composite comp = widgetToolkit.createComposite(group, 1, 1, GridData.FILL_HORIZONTAL);

		fNodeIntegerField = new IntegerFieldEditor(this,
				ATTR_SPECIFICATION_STOP_CRITERIA_NODE, "&Nodes:", comp, -1);
		fNodeIntegerField.setToolTipText("Maximal number of nodes "
				+ "(-1 <=> no-limit) of the symbolic execution tree");

		fWidthIntegerField = new IntegerFieldEditor(this,
				ATTR_SPECIFICATION_STOP_CRITERIA_WIDTH, "W&idth:", comp, -1);
		fWidthIntegerField.setToolTipText(
				"Maximal width (-1 <=> no-limit) of the symbolic execution tree");

		fHeightIntegerField = new IntegerFieldEditor(this,
				ATTR_SPECIFICATION_STOP_CRITERIA_HEIGHT, "&Height:", comp, 100);
		fHeightIntegerField.setToolTipText(
				"Maximal height (-1 <=> no-limit) of the symbolic execution tree");
	}

	private void createControlEvaluationLimits(Composite parent, IWidgetToolkit widgetToolkit) {
        Group group = widgetToolkit.createGroup(parent,
        		"Evaluation limits", 5, 2, GridData.FILL_HORIZONTAL);

        Composite comp = widgetToolkit.createComposite(
        		group, 1, 1, GridData.FILL_HORIZONTAL);

		fStepsIntegerField = new IntegerFieldEditor(this,
				ATTR_SPECIFICATION_STOP_CRITERIA_STEPS,
				"&Evaluation Steps:", comp, 1000);
		fStepsIntegerField.setToolTipText("Maximal steps of calculus "
				+ "(-1 <=> no-limit) during the symbolic execution");

		fTimeoutIntegerField = new IntegerFieldEditor(this,
				ATTR_SPECIFICATION_STOP_CRITERIA_TIMEOUT,
				"&Timeout (seconds):", comp, -1);
		fTimeoutIntegerField.setToolTipText("Maximal duration "
				+ "(-1 <=> no-limit) of the symbolic execution");
	}

	private void createControlInclusionCriterion(Composite parent, IWidgetToolkit widgetToolkit) {
        groupInclusionCriterion = widgetToolkit.createGroup(parent,
        		"Inclusion Criterion", 5, 2, GridData.FILL_HORIZONTAL);

        Composite comp = widgetToolkit.createComposite(
        		groupInclusionCriterion, 1, 1, GridData.FILL_HORIZONTAL);

        fInclusionCriterionBooleanField = new BooleanFieldEditor(this,
        		ATTR_ENABLED_INCLUSION_CRITERION,
        		"&Apply Inclusion", comp, false);
	}


	protected void createAnalyzeStrategy(Composite parent, IWidgetToolkit widgetToolkit) {
		groupAnalyzeStrategy = widgetToolkit.createGroup(
				parent, "&Analyze Strategy", 3, 1, GridData.FILL_HORIZONTAL);

		fBFSButton = widgetToolkit.createRadioButton(groupAnalyzeStrategy, "&BFS");
		fBFSButton.addSelectionListener(fListener);
		fBFSButton.setToolTipText("Breadth First Search");

		fDFSButton = widgetToolkit.createRadioButton(groupAnalyzeStrategy, "&DFS");
		fDFSButton.addSelectionListener(fListener);
		fDFSButton.setToolTipText("Depth First Search");

		fRFSButton = widgetToolkit.createRadioButton(groupAnalyzeStrategy, "&RFS");
		fRFSButton.addSelectionListener(fListener);
		fRFSButton.setToolTipText("Random First Search");

		fBFSButton.setSelection(false);
		fDFSButton.setSelection(false);
		fRFSButton.setSelection(false);
	}

//	public void createBehaviorCharacterization(Composite parent, IWidgetToolkit widgetToolkit) {
//        groupBehaviorCharacterization = widgetToolkit.createGroup(
//        		parent, "Behavior Characterization",
//        		5, 2, GridData.FILL_HORIZONTAL);
//
//        Composite comp = widgetToolkit.createComposite(
//        		groupBehaviorCharacterization, 1, 1, GridData.FILL_HORIZONTAL);
//
//		fTransitionNameStringField = new StringFieldEditor(this,
//				ATTR_BEHAVIOR_ANALYSIS_TRANSITION_NAME,
//				"&Transition Name List:", comp,
//				"Select a transition name list");
//	}


	// ======================================================================================
	//                              Fields Values Management
	// ======================================================================================

	@Override
	public void setDefaultFieldValues(ILaunchConfigurationWorkingCopy configuration) {
//		fNodeIntegerField.setDefaults(configuration);
		configuration.setAttribute(
				ATTR_SPECIFICATION_STOP_CRITERIA_NODE, -1);

//		fWidthIntegerField.setDefaults(configuration);
		configuration.setAttribute(
				ATTR_SPECIFICATION_STOP_CRITERIA_WIDTH, -1);

//		fHeightIntegerField.setDefaults(configuration);
		configuration.setAttribute(
				ATTR_SPECIFICATION_STOP_CRITERIA_HEIGHT, -1);

//		fStepsIntegerField.setDefaults(configuration);
    	String fModelAnalysis;
		try {
			fModelAnalysis = configuration.getAttribute(
					ATTR_SPECIFICATION_MODEL_ANALYSIS_PROFILE, "");

			if ( fModelAnalysis.equals(
					ANALYSIS_PROFILE_MODEL_COVERAGE_TRANSITION) )
			{
				configuration.setAttribute(
						ATTR_SPECIFICATION_STOP_CRITERIA_STEPS, -1);
			}
			else {
				configuration.setAttribute(
						ATTR_SPECIFICATION_STOP_CRITERIA_STEPS, 1000);
			}
		}
		catch (CoreException e) {
			e.printStackTrace();
		}

//		fTimeoutIntegerField.setDefaults(configuration);
		configuration.setAttribute(
				ATTR_SPECIFICATION_STOP_CRITERIA_TIMEOUT, -1);

//		fInclusionCriterionBooleanField.setDefaults(configuration);
		configuration.setAttribute(
				ATTR_ENABLED_INCLUSION_CRITERION, false);

		configuration.setAttribute(
				ATTR_SPECIFICATION_ANALYZE_STRATEGY, "BFS");
	}

	@Override
	public void initializeFieldValuesFrom(ILaunchConfiguration configuration) {
		fNodeIntegerField.initializeFrom(configuration);
		fWidthIntegerField.initializeFrom(configuration);
		fHeightIntegerField.initializeFrom(configuration);
		
		fStepsIntegerField.initializeFrom(configuration);
		fTimeoutIntegerField.initializeFrom(configuration);

		fInclusionCriterionBooleanField.initializeFrom(configuration);

		// Timeout grisé tant que pas de solution pour le prendre en compte
		//
		// fTimeoutIntegerField.setEnabled(false);

		// Cas fAnalyzeStrategy
		//
		try {
			fAnalyzeStrategy = GraphExplorationStrategyKind.get(
					configuration.getAttribute(
							ATTR_SPECIFICATION_ANALYZE_STRATEGY,
							GraphExplorationStrategyKind.
									BREADTH_FIRST_SEARCH.getLiteral()) );
		} catch (CoreException e) {
			e.printStackTrace();
		}
		finally {
			if( fAnalyzeStrategy == null ) {
				fAnalyzeStrategy = GraphExplorationStrategyKind.BREADTH_FIRST_SEARCH;
			}
		}

		initializeAnalyzeStrategy(configuration);

//		// Cas fTransitionNameStringField
//		//
//		fTransitionNameStringField.initializeFrom(configuration);
//		initializeBehaviorCharacterization(configuration);
	}

	private void initializeAnalyzeStrategy(ILaunchConfiguration configuration) {
		try {
			String modelAnalysisProfile = configuration.getAttribute(
					ATTR_SPECIFICATION_MODEL_ANALYSIS_PROFILE, "");


			if ( ! modelAnalysisProfile.equals(ANALYSIS_PROFILE_MODEL_EXPLORATION) ) {
				propagateVisibility(groupAnalyzeStrategy,false);
				propagateVisibility(groupInclusionCriterion,false);
			}
			else {
				propagateVisibility(groupAnalyzeStrategy,true);
				propagateVisibility(groupInclusionCriterion,true);

				switch( fAnalyzeStrategy ) {
				case BREADTH_FIRST_SEARCH:
					fBFSButton.setSelection(true);
					break;
				case DEPTH_FIRST_SEARCH:
					fDFSButton.setSelection(true);
					break;
				case RANDOM_FIRST_SEARCH:
					fRFSButton.setSelection(true);
					break;
				default:
					fBFSButton.setSelection(true);
					fAnalyzeStrategy =
							GraphExplorationStrategyKind.BREADTH_FIRST_SEARCH;
					break;
				}
			}

		} catch (CoreException e) {
			e.printStackTrace();
		}
	}

//	private void initializeBehaviorCharacterization(ILaunchConfiguration configuration) {
//    	String fAnalysisProfile;
//    	String fModelAnalysis;
//		try {
//			fAnalysisProfile = configuration.getAttribute(
//					MainTab.ATTR_SPECIFICATION_ANALYSIS_PROFILE, "");
//			fModelAnalysis = configuration.getAttribute(
//					MainTab.ATTR_SPECIFICATION_MODEL_ANALYSIS, "");
//
//			if ( fAnalysisProfile.equals(ANALYSIS_PROFILE_MODEL) &&
//					fModelAnalysis.equals(ANALYSIS_PROFILE_MODEL_COVERAGE_BEHAVIOR)	) {
////				fTransitionNameStringField.setEnabled(true);
//
////				groupBehaviorCharacterization.setVisible(true);
//				visibleAndExclude(groupBehaviorCharacterization,true);
//			}
//			else {
////				fTransitionNameStringField.setEnabled(false);
//
////				groupBehaviorCharacterization.setVisible(false);
//				visibleAndExclude(groupBehaviorCharacterization,false);
//			}
//
//		} catch (CoreException e) {
//			e.printStackTrace();
//		}
//	}

	@Override
	public void applyUpdatesOnFieldValuesFrom(ILaunchConfigurationWorkingCopy configuration) {
		fNodeIntegerField.performApply(configuration);
		fWidthIntegerField.performApply(configuration);
		fHeightIntegerField.performApply(configuration);
		fStepsIntegerField.performApply(configuration);
		fTimeoutIntegerField.performApply(configuration);
//		fTransitionNameStringField.performApply(configuration);

		fInclusionCriterionBooleanField.performApply(configuration);

		configuration.setAttribute(
				ATTR_SPECIFICATION_ANALYZE_STRATEGY,
				fAnalyzeStrategy.getLiteral());
	}

	// ======================================================================================
	//                              Fields Validation
	// ======================================================================================

	@Override
	public FieldValidationReturn areFieldsValid(ILaunchConfiguration launchConfig) {
		if( ! fNodeIntegerField.isValid() ) {
			return new FieldValidationReturn(false, "Node is not a valid integer");
		}
		if( ! fWidthIntegerField.isValid() ) {
			return new FieldValidationReturn(false, "Width is not a valid integer");
		}
		if( ! fHeightIntegerField.isValid() ) {
			return new FieldValidationReturn(false, "Height is not a valid integer");
		}
		if( ! fStepsIntegerField.isValid() ) {
			return new FieldValidationReturn(false, "Evaluation Steps is not a valid integer");
		}
		if( ! fTimeoutIntegerField.isValid() ) {
			return new FieldValidationReturn(false, "Timeout is not a valid integer");
		}
//		if( ! fTransitionNameStringField.isValid() ) {
//			return new FieldValidationReturn(false, "Transition Name is not a valid string");
//		}
		return new FieldValidationReturn(true, null);
	}


	///////////////////////////////////////////////////////////////////////////
	// Model Analysis Profile changed
	//
	@Override
	public void handleModelAnalysisProfileSelectionChanged(String analysisProfile) {
		switch ( analysisProfile ) {
		case ANALYSIS_PROFILE_MODEL_COVERAGE_TRANSITION:
		case ANALYSIS_PROFILE_MODEL_COVERAGE_BEHAVIOR:
		case ANALYSIS_PROFILE_MODEL_TEST_OFFLINE:
			propagateVisibility(groupAnalyzeStrategy   , false);
			propagateVisibility(groupInclusionCriterion, false);
			
			break;
			
		case ANALYSIS_PROFILE_MODEL_EXPLORATION:
		default:
			propagateVisibility(groupAnalyzeStrategy   , true);
			propagateVisibility(groupInclusionCriterion, true);
			break;
		}
	}

}