plugins/org.polarsys.chess.smvExporter/src/org/polarsys/chess/smvExporter/ui/commands/ExportModelToMonolithicSMVCommand.java

/*******************************************************************************
 * Copyright (C) 2018 Fondazione Bruno Kessler.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v2.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v20.html
 * 
 * Contributors:
 *     Luca Cristoforetti - initial API and implementation
 ******************************************************************************/
package org.polarsys.chess.smvExporter.ui.commands;

import java.util.HashMap;
import org.apache.log4j.Logger;
import org.eclipse.core.commands.ExecutionEvent;
import org.eclipse.core.commands.ExecutionException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.ui.handlers.HandlerUtil;
import org.eclipse.uml2.uml.Class;
import org.eclipse.uml2.uml.Package;
import org.polarsys.chess.contracts.profile.chesscontract.util.EntityUtil;
import org.polarsys.chess.service.core.exceptions.NoComponentException;
import org.polarsys.chess.service.core.model.ChessSystemModel;
import org.polarsys.chess.service.core.model.UMLStateMachineModel;
import org.polarsys.chess.service.gui.utils.SelectionUtil;
import org.polarsys.chess.smvExporter.ui.utils.SMVGenerationDialogUtil;

import eu.fbk.eclipse.standardtools.ExecOcraCommands.ui.services.OCRAExecService;
import eu.fbk.eclipse.standardtools.StateMachineTranslatorToSmv.ui.services.SmvExportServiceUI;
import eu.fbk.eclipse.standardtools.nuXmvService.ui.utils.NuXmvDirectoryUtil;
import eu.fbk.eclipse.standardtools.utils.ui.commands.AbstractJobCommand;
import eu.fbk.eclipse.standardtools.utils.ui.dialogs.MessageTimeModelDialog;
import eu.fbk.eclipse.standardtools.utils.ui.utils.DialogUtil;
import eu.fbk.eclipse.standardtools.utils.ui.utils.OCRADirectoryUtil;

/**
 * Command that generates a monolithic SMV file for the active package.
 * @author cristofo
 *
 */
public class ExportModelToMonolithicSMVCommand extends AbstractJobCommand {
	private static final Logger logger = Logger.getLogger(ExportModelToMonolithicSMVCommand.class);
	private SelectionUtil selectionUtil = SelectionUtil.getInstance();
	private DialogUtil dialogUtil = DialogUtil.getInstance();
	private EntityUtil entityUtil = EntityUtil.getInstance();

	public ExportModelToMonolithicSMVCommand() {
		super("Monolithic SMV file generation");
	}
	
	/**
	 * Returns the selected package, if any.
	 * @param event the event
	 * @return the selected package
	 * @throws NoComponentException
	 */
	private Package getPackageFromSelectedObject(ExecutionEvent event) throws NoComponentException {
		
		ISelection selection = HandlerUtil.getActiveWorkbenchWindow(event).getActivePage().getSelection();

		logger.debug("current selection: " + selection);

		Object selectedUmlElement = selectionUtil.getUmlSelectedObject(selection);
		
		logger.debug("selectedUmlElement: "+selectedUmlElement);
		
		if (selectedUmlElement instanceof Package) {
			return (Package) selectedUmlElement;
		}
		
		throw new NoComponentException();	
	}

	@Override
	public void execPreJobOperations(ExecutionEvent event, IProgressMonitor monitor) throws Exception {
		final SmvExportServiceUI smvExportServiceUI = SmvExportServiceUI.getInstance(ChessSystemModel.getInstance(),UMLStateMachineModel.getInstance());
		final NuXmvDirectoryUtil nuXmvDirectoryUtil = NuXmvDirectoryUtil.getInstance();
		final OCRADirectoryUtil ocraDirectoryUtil = OCRADirectoryUtil.getInstance();
		final OCRAExecService ocraExecService = OCRAExecService.getInstance(ChessSystemModel.getInstance());
		Class umlSelectedComponent = null;
		Package pkg = null;
		
		// Try to get the package containing the active element
		try {
			umlSelectedComponent = selectionUtil.getUmlComponentFromSelectedObject(event);
		} catch (NoComponentException e) {
			try {
				pkg = getPackageFromSelectedObject(event);
			} catch (NoComponentException ex) {
				dialogUtil.showMessage_ExceptionError(ex);
				throw new ExecutionException(ex.getMessage());
			}
		}
		if (pkg == null) {
			pkg = umlSelectedComponent.getNearestPackage();
		}
		
		if (!entityUtil.isSystemViewPackage(pkg)) {
			logger.debug("Wrong model package, aborting.");			
			final ExecutionException e = 
					new ExecutionException("Please select a package from <<SystemView>>");
			dialogUtil.showMessage_ExceptionError(e);
			throw e;
		}
		
		// Try to find the system block
		umlSelectedComponent = entityUtil.getSystemComponent(pkg);
		if (umlSelectedComponent == null) {
			logger.debug("System block not found, aborting.");			
			final ExecutionException e = 
					new ExecutionException("The package does not have a <<System>> block or it has more than one. Please check.");
			dialogUtil.showMessage_ExceptionError(e);
			throw e;
		}
		
		// Make the user aware that the time model can be only discrete
		final boolean isDiscreteTime = MessageTimeModelDialog.openQuestion(true);
		
		final String smvFileDirectory = nuXmvDirectoryUtil.getSmvFileDirectory();
		
		// If specified, set the given file name, otherwise compute it
		String monolithicSMVFilePath = event.getParameter("file_name");

		if( monolithicSMVFilePath == null ) {
			monolithicSMVFilePath = nuXmvDirectoryUtil.getMonolithicSMVFilePath(umlSelectedComponent.getName());
		}
		final String smvMapDirPath = nuXmvDirectoryUtil.getSmvFileDirectory();
		final String ossDirPath = ocraDirectoryUtil.getOSSDirPath();
		final Resource umlSelectedResource = umlSelectedComponent.eResource();
		final boolean showPopups = false;
		final boolean usexTextValidation = true;
		final boolean internalExecution = true;

		// Commands cannot be executed in the execJobCommand() method, they need to be synchronous
		logger.debug("exportSmv");
		HashMap<String, String> smvPathComponentNameMap = smvExportServiceUI.exportSmv(umlSelectedComponent,
				showPopups, smvFileDirectory, monitor);

		logger.debug("createMonolithicSMV");
		if (!ocraExecService.createMonolithicSMV(umlSelectedComponent, umlSelectedResource, smvPathComponentNameMap,
				isDiscreteTime, usexTextValidation, showPopups, ossDirPath, smvMapDirPath, 
				monolithicSMVFilePath, internalExecution, monitor)) {
			final ExecutionException e = new ExecutionException("createMonolithicSMV command failed.");
			DialogUtil.getInstance().showMessage_ExceptionError(e);
			throw e;
		}
		
		// If requested, show a message at the end of the file generation
		final String showPopup = event.getParameter("show_popup");
		if (showPopup != null && showPopup.equals("true")) {
			SMVGenerationDialogUtil smvGenerationDialogUtil = SMVGenerationDialogUtil.getInstance(); 
			smvGenerationDialogUtil.showMessage_SmvGenerationDone(monolithicSMVFilePath);
		}
	}

	@Override
	public void execJobCommand(ExecutionEvent event, IProgressMonitor monitor) throws Exception {
	}

	@Override
	public void execPostJobOperations(ExecutionEvent event, NullProgressMonitor nullProgressMonitor) throws Exception {
		// TODO Auto-generated method stub
		
	}
}