/*

 * Copyright (c) 2014, 2016, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package jdk.jshell;

import java.util.ArrayList;

import java.util.Collection;

import java.util.Collections;

import java.util.List;

import java.util.Locale;

import java.util.regex.Matcher;

import java.util.regex.Pattern;

import java.util.stream.Collectors;

import javax.lang.model.element.Modifier;

import com.sun.source.tree.ArrayTypeTree;

import com.sun.source.tree.AssignmentTree;

import com.sun.source.tree.ClassTree;

import com.sun.source.tree.ExpressionTree;

import com.sun.source.tree.IdentifierTree;

import com.sun.source.tree.MethodTree;

import com.sun.source.tree.ModifiersTree;

import com.sun.source.tree.Tree;

import com.sun.source.tree.VariableTree;

import com.sun.tools.javac.tree.JCTree;

import com.sun.tools.javac.tree.Pretty;

import java.io.IOException;

import java.io.StringWriter;

import java.io.Writer;

import java.util.LinkedHashSet;

import java.util.Set;

import jdk.jshell.Key.ErroneousKey;

import jdk.jshell.Key.MethodKey;

import jdk.jshell.Key.TypeDeclKey;

import jdk.jshell.Snippet.Kind;

import jdk.jshell.Snippet.SubKind;

import jdk.jshell.TaskFactory.AnalyzeTask;

import jdk.jshell.TaskFactory.BaseTask;

import jdk.jshell.TaskFactory.CompileTask;

import jdk.jshell.TaskFactory.ParseTask;

import jdk.jshell.TreeDissector.ExpressionInfo;

import jdk.jshell.Wrap.Range;

import jdk.jshell.Snippet.Status;

import jdk.jshell.spi.ExecutionControl.ClassBytecodes;

import jdk.jshell.spi.ExecutionControl.ClassInstallException;

import jdk.jshell.spi.ExecutionControl.EngineTerminationException;

import jdk.jshell.spi.ExecutionControl.InternalException;

import jdk.jshell.spi.ExecutionControl.NotImplementedException;

import jdk.jshell.spi.ExecutionControl.ResolutionException;

import jdk.jshell.spi.ExecutionControl.RunException;

import jdk.jshell.spi.ExecutionControl.UserException;

import static java.util.stream.Collectors.toList;

import static java.util.stream.Collectors.toSet;

import static java.util.Collections.singletonList;

import static jdk.internal.jshell.debug.InternalDebugControl.DBG_GEN;

import static jdk.jshell.Util.DOIT_METHOD_NAME;

import static jdk.jshell.Util.PREFIX_PATTERN;

import static jdk.jshell.Util.expunge;

import static jdk.jshell.Snippet.SubKind.SINGLE_TYPE_IMPORT_SUBKIND;

import static jdk.jshell.Snippet.SubKind.SINGLE_STATIC_IMPORT_SUBKIND;

import static jdk.jshell.Snippet.SubKind.TYPE_IMPORT_ON_DEMAND_SUBKIND;

import static jdk.jshell.Snippet.SubKind.STATIC_IMPORT_ON_DEMAND_SUBKIND;

/**

 * The Evaluation Engine. Source internal analysis, wrapping control,

 * compilation, declaration. redefinition, replacement, and execution.

 *

 * @author Robert Field

 */

class Eval {

    private static final Pattern IMPORT_PATTERN = Pattern.compile("import\\p{javaWhitespace}+(?<static>static\\p{javaWhitespace}+)?(?<fullname>[\\p{L}\\p{N}_\\$\\.]+\\.(?<name>[\\p{L}\\p{N}_\\$]+|\\*))");

    private int varNumber = 0;

    private final JShell state;

    Eval(JShell state) {

        this.state = state;

    }

    /**

     * Evaluates a snippet of source.

     *

     * @param userSource the source of the snippet

     * @return the list of primary and update events

     * @throws IllegalStateException

     */

    List<SnippetEvent> eval(String userSource) throws IllegalStateException {

        List<SnippetEvent> allEvents = new ArrayList<>();

        for (Snippet snip : sourceToSnippets(userSource)) {

            if (snip.kind() == Kind.ERRONEOUS) {

                state.maps.installSnippet(snip);

                allEvents.add(new SnippetEvent(

                        snip, Status.NONEXISTENT, Status.REJECTED,

                        false, null, null, null));

            } else {

                allEvents.addAll(declare(snip, snip.syntheticDiags()));

            }

        }

        return allEvents;

    }

    /**

     * Converts the user source of a snippet into a Snippet list -- Snippet will

     * have wrappers.

     *

     * @param userSource the source of the snippet

     * @return usually a singleton list of Snippet, but may be empty or multiple

     */

    List<Snippet> sourceToSnippetsWithWrappers(String userSource) {

        List<Snippet> snippets = sourceToSnippets(userSource);

        for (Snippet snip : snippets) {

            if (snip.outerWrap() == null) {

                snip.setOuterWrap(

                        (snip.kind() == Kind.IMPORT)

                                ? state.outerMap.wrapImport(snip.guts(), snip)

                                : state.outerMap.wrapInTrialClass(snip.guts())

                );

            }

        }

        return snippets;

    }

    /**

     * Converts the user source of a snippet into a Snippet object (or list of

     * objects in the case of: int x, y, z;).  Does not install the Snippets

     * or execute them.

     *

     * @param userSource the source of the snippet

     * @return usually a singleton list of Snippet, but may be empty or multiple

     */

    private List<Snippet> sourceToSnippets(String userSource) {

        String compileSource = Util.trimEnd(new MaskCommentsAndModifiers(userSource, false).cleared());

        if (compileSource.length() == 0) {

            return Collections.emptyList();

        }

        ParseTask pt = state.taskFactory.new ParseTask(compileSource);

        List<? extends Tree> units = pt.units();

        if (units.isEmpty()) {

            return compileFailResult(pt, userSource, Kind.ERRONEOUS);

        }

        Tree unitTree = units.get(0);

        if (pt.getDiagnostics().hasOtherThanNotStatementErrors()) {

            return compileFailResult(pt, userSource, kindOfTree(unitTree));

        }

        // Erase illegal/ignored modifiers

        compileSource = new MaskCommentsAndModifiers(compileSource, true).cleared();

        state.debug(DBG_GEN, "Kind: %s -- %s\n", unitTree.getKind(), unitTree);

        switch (unitTree.getKind()) {

            case IMPORT:

                return processImport(userSource, compileSource);

            case VARIABLE:

                return processVariables(userSource, units, compileSource, pt);

            case EXPRESSION_STATEMENT:

                return processExpression(userSource, compileSource);

            case CLASS:

                return processClass(userSource, unitTree, compileSource, SubKind.CLASS_SUBKIND, pt);

            case ENUM:

                return processClass(userSource, unitTree, compileSource, SubKind.ENUM_SUBKIND, pt);

            case ANNOTATION_TYPE:

                return processClass(userSource, unitTree, compileSource, SubKind.ANNOTATION_TYPE_SUBKIND, pt);

            case INTERFACE:

                return processClass(userSource, unitTree, compileSource, SubKind.INTERFACE_SUBKIND, pt);

            case METHOD:

                return processMethod(userSource, unitTree, compileSource, pt);

            default:

                return processStatement(userSource, compileSource);

        }

    }

    private List<Snippet> processImport(String userSource, String compileSource) {

        Wrap guts = Wrap.simpleWrap(compileSource);

        Matcher mat = IMPORT_PATTERN.matcher(compileSource);

        String fullname;

        String name;

        boolean isStatic;

        if (mat.find()) {

            isStatic = mat.group("static") != null;

            name = mat.group("name");

            fullname = mat.group("fullname");

        } else {

            // bad import -- fake it

            isStatic = compileSource.contains("static");

            name = fullname = compileSource;

        }

        String fullkey = (isStatic ? "static-" : "") + fullname;

        boolean isStar = name.equals("*");

        String keyName = isStar

                ? fullname

                : name;

        SubKind snippetKind = isStar

                ? (isStatic ? STATIC_IMPORT_ON_DEMAND_SUBKIND : TYPE_IMPORT_ON_DEMAND_SUBKIND)

                : (isStatic ? SINGLE_STATIC_IMPORT_SUBKIND : SINGLE_TYPE_IMPORT_SUBKIND);

        Snippet snip = new ImportSnippet(state.keyMap.keyForImport(keyName, snippetKind),

                userSource, guts, fullname, name, snippetKind, fullkey, isStatic, isStar);

        return singletonList(snip);

    }

    private static class EvalPretty extends Pretty {

        private final Writer out;

        public EvalPretty(Writer writer, boolean bln) {

            super(writer, bln);

            this.out = writer;

        }

        /**

         * Print string, DO NOT replacing all non-ascii character with unicode

         * escapes.

         */

        @Override

        public void print(Object o) throws IOException {

            out.write(o.toString());

        }

        static String prettyExpr(JCTree tree, boolean bln) {

            StringWriter out = new StringWriter();

            try {

                new EvalPretty(out, bln).printExpr(tree);

            } catch (IOException e) {

                throw new AssertionError(e);

            }

            return out.toString();

        }

    }

    private List<Snippet> processVariables(String userSource, List<? extends Tree> units, String compileSource, ParseTask pt) {

        List<Snippet> snippets = new ArrayList<>();

        TreeDissector dis = TreeDissector.createByFirstClass(pt);

        for (Tree unitTree : units) {

            VariableTree vt = (VariableTree) unitTree;

            String name = vt.getName().toString();

            String typeName = EvalPretty.prettyExpr((JCTree) vt.getType(), false);

            Tree baseType = vt.getType();

            TreeDependencyScanner tds = new TreeDependencyScanner();

            tds.scan(baseType); // Not dependent on initializer

            StringBuilder sbBrackets = new StringBuilder();

            while (baseType instanceof ArrayTypeTree) {

                //TODO handle annotations too

                baseType = ((ArrayTypeTree) baseType).getType();

                sbBrackets.append("[]");

            }

            Range rtype = dis.treeToRange(baseType);

            Range runit = dis.treeToRange(vt);

            runit = new Range(runit.begin, runit.end - 1);

            ExpressionTree it = vt.getInitializer();

            Range rinit = null;

            int nameMax = runit.end - 1;

            SubKind subkind;

            if (it != null) {

                subkind = SubKind.VAR_DECLARATION_WITH_INITIALIZER_SUBKIND;

                rinit = dis.treeToRange(it);

                nameMax = rinit.begin - 1;

            } else {

                subkind = SubKind.VAR_DECLARATION_SUBKIND;

            }

            int nameStart = compileSource.lastIndexOf(name, nameMax);

            if (nameStart < 0) {

                throw new AssertionError("Name '" + name + "' not found");

            }

            int nameEnd = nameStart + name.length();

            Range rname = new Range(nameStart, nameEnd);

            Wrap guts = Wrap.varWrap(compileSource, rtype, sbBrackets.toString(), rname, rinit);

            DiagList modDiag = modifierDiagnostics(vt.getModifiers(), dis, true);

            Snippet snip = new VarSnippet(state.keyMap.keyForVariable(name), userSource, guts,

                    name, subkind, typeName,

                    tds.declareReferences(), modDiag);

            snippets.add(snip);

        }

        return snippets;

    }

    private List<Snippet> processExpression(String userSource, String compileSource) {

        String name = null;

        ExpressionInfo ei = typeOfExpression(compileSource);

        ExpressionTree assignVar;

        Wrap guts;

        Snippet snip;

        if (ei != null && ei.isNonVoid) {

            String typeName = ei.typeName;

            SubKind subkind;

            if (ei.tree instanceof IdentifierTree) {

                IdentifierTree id = (IdentifierTree) ei.tree;

                name = id.getName().toString();

                subkind = SubKind.VAR_VALUE_SUBKIND;

            } else if (ei.tree instanceof AssignmentTree

                    && (assignVar = ((AssignmentTree) ei.tree).getVariable()) instanceof IdentifierTree) {

                name = assignVar.toString();

                subkind = SubKind.ASSIGNMENT_SUBKIND;

            } else {

                subkind = SubKind.OTHER_EXPRESSION_SUBKIND;

            }

            if (shouldGenTempVar(subkind)) {

                if (state.tempVariableNameGenerator != null) {

                    name = state.tempVariableNameGenerator.get();

                }

                while (name == null || state.keyMap.doesVariableNameExist(name)) {

                    name = "$" + ++varNumber;

                }

                guts = Wrap.tempVarWrap(compileSource, typeName, name);

                Collection<String> declareReferences = null; //TODO

                snip = new VarSnippet(state.keyMap.keyForVariable(name), userSource, guts,

                        name, SubKind.TEMP_VAR_EXPRESSION_SUBKIND, typeName, declareReferences, null);

            } else {

                guts = Wrap.methodReturnWrap(compileSource);

                snip = new ExpressionSnippet(state.keyMap.keyForExpression(name, typeName), userSource, guts,

                        name, subkind);

            }

        } else {

            guts = Wrap.methodWrap(compileSource);

            if (ei == null) {

                // We got no type info, check for not a statement by trying

                AnalyzeTask at = trialCompile(guts);

                if (at.getDiagnostics().hasNotStatement()) {

                    guts = Wrap.methodReturnWrap(compileSource);

                    at = trialCompile(guts);

                }

                if (at.hasErrors()) {

                    return compileFailResult(at, userSource, Kind.EXPRESSION);

                }

            }

            snip = new StatementSnippet(state.keyMap.keyForStatement(), userSource, guts);

        }

        return singletonList(snip);

    }

    private List<Snippet> processClass(String userSource, Tree unitTree, String compileSource, SubKind snippetKind, ParseTask pt) {

        TreeDependencyScanner tds = new TreeDependencyScanner();

        tds.scan(unitTree);

        TreeDissector dis = TreeDissector.createByFirstClass(pt);

        ClassTree klassTree = (ClassTree) unitTree;

        String name = klassTree.getSimpleName().toString();

        DiagList modDiag = modifierDiagnostics(klassTree.getModifiers(), dis, false);

        TypeDeclKey key = state.keyMap.keyForClass(name);

        // Corralling mutates.  Must be last use of pt, unitTree, klassTree

        Wrap corralled = new Corraller(key.index(), pt.getContext()).corralType(klassTree);

        Wrap guts = Wrap.classMemberWrap(compileSource);

        Snippet snip = new TypeDeclSnippet(key, userSource, guts,

                name, snippetKind,

                corralled, tds.declareReferences(), tds.bodyReferences(), modDiag);

        return singletonList(snip);

    }

    private List<Snippet> processStatement(String userSource, String compileSource) {

        Wrap guts = Wrap.methodWrap(compileSource);

        // Check for unreachable by trying

        AnalyzeTask at = trialCompile(guts);

        if (at.hasErrors()) {

            if (at.getDiagnostics().hasUnreachableError()) {

                guts = Wrap.methodUnreachableSemiWrap(compileSource);

                at = trialCompile(guts);

                if (at.hasErrors()) {

                    if (at.getDiagnostics().hasUnreachableError()) {

                        // Without ending semicolon

                        guts = Wrap.methodUnreachableWrap(compileSource);

                        at = trialCompile(guts);

                    }

                    if (at.hasErrors()) {

                        return compileFailResult(at, userSource, Kind.STATEMENT);

                    }

                }

            } else {

                return compileFailResult(at, userSource, Kind.STATEMENT);

            }

        }

        Snippet snip = new StatementSnippet(state.keyMap.keyForStatement(), userSource, guts);

        return singletonList(snip);

    }

    private AnalyzeTask trialCompile(Wrap guts) {

        OuterWrap outer = state.outerMap.wrapInTrialClass(guts);

        return state.taskFactory.new AnalyzeTask(outer);

    }

    private List<Snippet> processMethod(String userSource, Tree unitTree, String compileSource, ParseTask pt) {

        TreeDependencyScanner tds = new TreeDependencyScanner();

        tds.scan(unitTree);

        TreeDissector dis = TreeDissector.createByFirstClass(pt);

        MethodTree mt = (MethodTree) unitTree;

        String name = mt.getName().toString();

        String parameterTypes

                = mt.getParameters()

                .stream()

                .map(param -> dis.treeToRange(param.getType()).part(compileSource))

                .collect(Collectors.joining(","));

        Tree returnType = mt.getReturnType();

        DiagList modDiag = modifierDiagnostics(mt.getModifiers(), dis, true);

        MethodKey key = state.keyMap.keyForMethod(name, parameterTypes);

        // Corralling mutates.  Must be last use of pt, unitTree, mt

        Wrap corralled = new Corraller(key.index(), pt.getContext()).corralMethod(mt);

        if (modDiag.hasErrors()) {

            return compileFailResult(modDiag, userSource, Kind.METHOD);

        }

        Wrap guts = Wrap.classMemberWrap(compileSource);

        Range typeRange = dis.treeToRange(returnType);

        String signature = "(" + parameterTypes + ")" + typeRange.part(compileSource);

        Snippet snip = new MethodSnippet(key, userSource, guts,

                name, signature,

                corralled, tds.declareReferences(), tds.bodyReferences(), modDiag);

        return singletonList(snip);

    }

    private Kind kindOfTree(Tree tree) {

        switch (tree.getKind()) {

            case IMPORT:

                return Kind.IMPORT;

            case VARIABLE:

                return Kind.VAR;

            case EXPRESSION_STATEMENT:

                return Kind.EXPRESSION;

            case CLASS:

            case ENUM:

            case ANNOTATION_TYPE:

            case INTERFACE:

                return Kind.TYPE_DECL;

            case METHOD:

                return Kind.METHOD;

            default:

                return Kind.STATEMENT;

        }

    }

    /**

     * The snippet has failed, return with the rejected snippet

     *

     * @param xt the task from which to extract the failure diagnostics

     * @param userSource the incoming bad user source

     * @return a rejected snippet

     */

    private List<Snippet> compileFailResult(BaseTask xt, String userSource, Kind probableKind) {

        return compileFailResult(xt.getDiagnostics(), userSource, probableKind);

    }

    /**

     * The snippet has failed, return with the rejected snippet

     *

     * @param diags the failure diagnostics

     * @param userSource the incoming bad user source

     * @return a rejected snippet

     */

    private List<Snippet> compileFailResult(DiagList diags, String userSource, Kind probableKind) {

        ErroneousKey key = state.keyMap.keyForErroneous();

        Snippet snip = new ErroneousSnippet(key, userSource, null,

                probableKind, SubKind.UNKNOWN_SUBKIND);

        snip.setFailed(diags);

        // Install  wrapper for query by SourceCodeAnalysis.wrapper

        String compileSource = Util.trimEnd(new MaskCommentsAndModifiers(userSource, true).cleared());

        OuterWrap outer;

        switch (probableKind) {

            case IMPORT:

                outer = state.outerMap.wrapImport(Wrap.simpleWrap(compileSource), snip);

                break;

            case EXPRESSION:

                outer = state.outerMap.wrapInTrialClass(Wrap.methodReturnWrap(compileSource));

                break;

            case VAR:

            case TYPE_DECL:

            case METHOD:

                outer = state.outerMap.wrapInTrialClass(Wrap.classMemberWrap(compileSource));

                break;

            default:

                outer = state.outerMap.wrapInTrialClass(Wrap.methodWrap(compileSource));

                break;

        }

        snip.setOuterWrap(outer);

        return singletonList(snip);

    }

    private ExpressionInfo typeOfExpression(String expression) {

        Wrap guts = Wrap.methodReturnWrap(expression);

        TaskFactory.AnalyzeTask at = trialCompile(guts);

        if (!at.hasErrors() && at.firstCuTree() != null) {

            return TreeDissector.createByFirstClass(at)

                    .typeOfReturnStatement(at, state);

        }

        return null;

    }