Skip to content
Snippets Groups Projects
Interpreter.java 10.2 KiB
Newer Older
/* Copyright or (C) or Copr. GET / ENST, Telecom-Paris, Ludovic Apvrille
 * 
 * ludovic.apvrille AT enst.fr
 * 
 * This software is a computer program whose purpose is to allow the
 * edition of TURTLE analysis, design and deployment diagrams, to
 * allow the generation of RT-LOTOS or Java code from this diagram,
 * and at last to allow the analysis of formal validation traces
 * obtained from external tools, e.g. RTL from LAAS-CNRS and CADP
 * from INRIA Rhone-Alpes.
 * 
 * This software is governed by the CeCILL  license under French law and
 * abiding by the rules of distribution of free software.  You can  use,
 * modify and/ or redistribute the software under the terms of the CeCILL
 * license as circulated by CEA, CNRS and INRIA at the following URL
 * "http://www.cecill.info".
 * 
 * As a counterpart to the access to the source code and  rights to copy,
 * modify and redistribute granted by the license, users are provided only
 * with a limited warranty  and the software's author,  the holder of the
 * economic rights,  and the successive licensors  have only  limited
 * liability.
 * 
 * In this respect, the user's attention is drawn to the risks associated
 * with loading,  using,  modifying and/or developing or reproducing the
 * software by the user in light of its specific status of free software,
 * that may mean  that it is complicated to manipulate,  and  that  also
 * therefore means  that it is reserved for developers  and  experienced
 * professionals having in-depth computer knowledge. Users are therefore
 * encouraged to load and test the software's suitability as regards their
 * requirements in conditions enabling the security of their systems and/or
 * data to be ensured and,  more generally, to use and operate it in the
 * same conditions as regards security.
 * 
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL license and that you accept its terms.
 */


package cli;

Ludovic Apvrille's avatar
Ludovic Apvrille committed
import common.ConfigurationTTool;
import common.SpecConfigTTool;
import launcher.RTLLauncher;
import myutil.Conversion;
Ludovic Apvrille's avatar
Ludovic Apvrille committed
import myutil.PluginManager;
Ludovic Apvrille's avatar
Ludovic Apvrille committed
import myutil.TraceManager;
import ui.*;
Ludovic Apvrille's avatar
Ludovic Apvrille committed
import ui.util.IconManager;
Ludovic Apvrille's avatar
Ludovic Apvrille committed
import java.io.*;
Ludovic Apvrille's avatar
Ludovic Apvrille committed
import myutil.*;

import java.util.*;

/**
 * Class Interpreter
 * Creation: 05/10/2018
 * Version 2.0 05/10/2018
 *
 * @author Ludovic APVRILLE
 */
public class Interpreter implements Runnable, TerminalProviderInterface  {
Ludovic Apvrille's avatar
Ludovic Apvrille committed
    public final static Command[] commands = {new Help(), new Quit(), new Action(),
            new Set(), new Wait(), new Print(), new History(), new TestSpecific()};
Ludovic Apvrille's avatar
Ludovic Apvrille committed
    // Errors
Ludovic Apvrille's avatar
Ludovic Apvrille committed
    public final static String UNKNOWN = "Unknown command";
    public final static String BAD = "Badly formatted expression";
    public final static String BAD_WAIT_VALUE = "Must provide a int value > 0";
    public final static String BAD_VAR_VALUE ="Unvalid value for variable";
    public final static String BAD_VAR_NAME ="Unvalid variable name";
apvrille's avatar
apvrille committed
    public final static String UNKNOWN_NEXT_COMMAND ="Invalid action: ";
Ludovic Apvrille's avatar
Ludovic Apvrille committed
    public final static String TTOOL_NOT_STARTED ="TTool is not yet started. Cannot execute command.";
    public final static String TTOOL_ALREADY_STARTED ="TTool is already started. Cannot execute command.";
Ludovic Apvrille's avatar
Ludovic Apvrille committed
    public final static String BAD_COMMAND_NAME ="The provided command is invalid";
    private String script;
Ludovic Apvrille's avatar
Ludovic Apvrille committed
    private InterpreterOutputInterface printInterface;
    private boolean show;
Ludovic Apvrille's avatar
Ludovic Apvrille committed
    // State management
    private HashMap<String, String> variables;
    private String error;
    private boolean ttoolStarted = false;
Ludovic Apvrille's avatar
Ludovic Apvrille committed
    public MainGUI mgui;
Ludovic Apvrille's avatar
Ludovic Apvrille committed
    private Vector<String> formerCommands;
    private Terminal term;
Ludovic Apvrille's avatar
Ludovic Apvrille committed
    public Interpreter(String script, InterpreterOutputInterface printInterface, boolean show) {
        this.script = script;
        this.printInterface = printInterface;
        variables = new HashMap<>();
Ludovic Apvrille's avatar
Ludovic Apvrille committed
        this.show = show;
Ludovic Apvrille's avatar
Ludovic Apvrille committed
        formerCommands = new Vector<>();
        term = new Terminal();
        term.setTerminalProvider(this);
Ludovic Apvrille's avatar
Ludovic Apvrille committed
    }

    @Override
    public void run() {
        interact();
    }


    public void interact() {
        Terminal term = new Terminal();
        term.setTerminalProvider(this);

        String line;
        int cptLine = 0;
        while ((line = term.getNextCommand()) != null) {
            executeLine(line, cptLine, false);
            cptLine ++;
        }
    }

    public void interactIntegratedTerminal() {
Ludovic Apvrille's avatar
Ludovic Apvrille committed
        /*if (RawConsoleInput.isWindows) {
            print("In Windows");
        } else  {
            print("In Unix");
        }*/

        Scanner scanner = new Scanner(System.in);
        int cptLine = 0;
        printPrompt(cptLine);
        while (scanner.hasNextLine()) {
            String line = scanner.nextLine();
            executeLine(line, cptLine, false);
            cptLine ++;
            printPrompt(cptLine);
        }
    }

    private void printPrompt(int lineNb) {
        System.out.print("" + lineNb + " -> ");
        System.out.flush();
    }

    public void interpret() {
        Scanner scanner = new Scanner(script);
Ludovic Apvrille's avatar
Ludovic Apvrille committed
        int cptLine = 0;
        while (scanner.hasNextLine()) {
            String line = scanner.nextLine();
Ludovic Apvrille's avatar
Ludovic Apvrille committed
            cptLine ++;
Ludovic Apvrille's avatar
Ludovic Apvrille committed
            executeLine(line, cptLine, true);
Ludovic Apvrille's avatar
Ludovic Apvrille committed
        }
        scanner.close();
        printInterface.print("All done. See you soon.");
        printInterface.exit(1);
Ludovic Apvrille's avatar
Ludovic Apvrille committed
    }
Ludovic Apvrille's avatar
Ludovic Apvrille committed
    private void executeLine(String line, int cptLine, boolean exitOnError) {
        // Comment
        //TraceManager.addDev("Executing line:" + line);
apvrille's avatar
apvrille committed

Ludovic Apvrille's avatar
Ludovic Apvrille committed
        line = line.trim();
        if (line.length() == 0) {
            return;
        }
apvrille's avatar
apvrille committed

Ludovic Apvrille's avatar
Ludovic Apvrille committed
        if (line.startsWith("#")) {
Ludovic Apvrille's avatar
Ludovic Apvrille committed
        } else {

            formerCommands.add(line);

            // Replace all double space by one unique space
            line = Conversion.replaceAllString(line, "  ", " ").trim();

            //TraceManager.addDev("Handling line: " + line);
            // Replace variable value in the current line
            String lineWithNoVariable = removeVariablesIn(line).trim();

            String begOfLine = lineWithNoVariable;
            int index = lineWithNoVariable.indexOf(' ');
            if (index > -1) {
                begOfLine = begOfLine.substring(0, index).trim();
            }

            //TraceManager.addDev("Handling line: " + lineWithNoVariable);
            String [] commandInfo = lineWithNoVariable.split(" ");

            if ((commandInfo == null) || (commandInfo.length < 1)){
                System.out.println("Empty command");
                if (exitOnError) {
                    System.exit(-1);
                }
            }


Ludovic Apvrille's avatar
Ludovic Apvrille committed

            // Analyze current line
            error = "";
            for(Command c: commands) {
                if (commandInfo[0].compareTo(c.getCommand()) == 0) {
Ludovic Apvrille's avatar
Ludovic Apvrille committed
                    error = c.executeCommand( lineWithNoVariable.substring(c.getCommand().length(),
                            lineWithNoVariable.length()).trim(), this);
                    TraceManager.addDev("Command executed");
Ludovic Apvrille's avatar
Ludovic Apvrille committed
                    break;
                }
                if (commandInfo[0].compareTo(c.getShortCommand()) == 0) {
Ludovic Apvrille's avatar
Ludovic Apvrille committed
                    error = c.executeCommand( lineWithNoVariable.substring(c.getShortCommand().length(),
                            lineWithNoVariable.length()).trim(), this);
                    TraceManager.addDev("Short Command executed");
Ludovic Apvrille's avatar
Ludovic Apvrille committed
                    break;
            if ((error != null) && (error.length() > 0)) {
Ludovic Apvrille's avatar
Ludovic Apvrille committed
                System.out.println("Error in line " + cptLine + " : " + error);
                if (exitOnError) {
                    System.exit(-1);
                }
            } else if ((error != null) && (error.length() == 0)) {
                System.out.println("Unknown command in line " + cptLine + " : " + commandInfo[0]);
Ludovic Apvrille's avatar
Ludovic Apvrille committed
            }
apvrille's avatar
apvrille committed
    public void addVariable(String name, String value) {
        variables.put(name, value);
    private String removeVariablesIn(String input) {
        String ret = "";
        String initialLine = input;

        int index;
        while((index = input.indexOf("$")) > -1) {
            ret = ret + input.substring(0, index);
            input = input.substring(index+1, input.length());
            int indexSpace = input.indexOf(" ");
            String varName;
            if (indexSpace == -1) {
                varName = input;
                input = "";
            } else {
                varName = input.substring(0, indexSpace);
                input = input.substring(indexSpace+1, input.length());
            }

            // Identifying variable
            String value = variables.get(varName);
            if (value == null) {
                printInterface.printError("Unknown variable name:" + varName + " in " + initialLine);
                printInterface.exit(-1);
            }
Ludovic Apvrille's avatar
Ludovic Apvrille committed
            ret = ret + value;
        }

        ret = ret + input;
        return ret;
    }

    public boolean exitCLI() {
        System.exit(-1);
        return true;
    }

Ludovic Apvrille's avatar
Ludovic Apvrille committed
    public boolean isTToolStarted() {
        return ttoolStarted;
    }

    public void setTToolStarted(boolean b) {
        ttoolStarted = b;
    }

Ludovic Apvrille's avatar
Ludovic Apvrille committed
    public void setMGUI(MainGUI mgui) {
        this.mgui = mgui;
    }

Ludovic Apvrille's avatar
Ludovic Apvrille committed
    public boolean showWindow() {
        return show;
    }
Ludovic Apvrille's avatar
Ludovic Apvrille committed
    public Command getCommandByName(String cmd) {
        for (Command c: commands) {
            if ((c.getShortCommand().compareTo(cmd) == 0) || (c.getCommand().compareTo(cmd) == 0)) {
                return c;
            }
        }
        return null;
    }

    public String getHelp() {
        StringBuffer buf = new StringBuffer("");
        for(Command c:commands) {
            buf.append(c.getHelp(0) + "\n");
        }
        return buf.toString();
    }

Ludovic Apvrille's avatar
Ludovic Apvrille committed
    public void print(String s) {
        printInterface.print(s);
    }

    public String printAllFormerCommands() {
        StringBuffer sb = new StringBuffer("");
        for(int i=0; i<formerCommands.size(); i++) {
            sb.append("" + i + "\t" + formerCommands.get(i) + "\n");
        }
        print(sb.toString());
        return null;
    }

    // Terminal provider interface
    public String getMidPrompt() {
        return "> ";
    }

    public void tabAction(String buffer) {

    }