/*

 * Copyright (c) 2015, 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 jdk.jshell.spi.ExecutionControl;

import java.io.ByteArrayInputStream;

import java.io.InputStream;

import java.io.PrintStream;

import java.text.MessageFormat;

import java.util.ArrayList;

import java.util.Arrays;

import java.util.Collections;

import java.util.HashMap;

import java.util.List;

import java.util.Map;

import java.util.MissingResourceException;

import java.util.Objects;

import java.util.ResourceBundle;

import java.util.function.BiFunction;

import java.util.function.Consumer;

import java.util.function.Supplier;

import java.util.stream.Stream;

import jdk.internal.jshell.debug.InternalDebugControl;

import jdk.jshell.Snippet.Status;

import jdk.jshell.execution.JDIDefaultExecutionControl;

import jdk.jshell.spi.ExecutionControl.EngineTerminationException;

import jdk.jshell.spi.ExecutionControl.ExecutionControlException;

import jdk.jshell.spi.ExecutionEnv;

import static jdk.jshell.execution.Util.failOverExecutionControlGenerator;

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

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

import static jdk.jshell.Util.expunge;

/**

 * The JShell evaluation state engine.  This is the central class in the JShell

 * API.  A {@code JShell} instance holds the evolving compilation and

 * execution state.  The state is changed with the instance methods

 * {@link jdk.jshell.JShell#eval(java.lang.String) eval(String)},

 * {@link jdk.jshell.JShell#drop(jdk.jshell.PersistentSnippet) drop(PersistentSnippet)} and

 * {@link jdk.jshell.JShell#addToClasspath(java.lang.String) addToClasspath(String)}.

 * The majority of methods query the state.

 * A {@code JShell} instance also allows registering for events with

 * {@link jdk.jshell.JShell#onSnippetEvent(java.util.function.Consumer) onSnippetEvent(Consumer)}

 * and {@link jdk.jshell.JShell#onShutdown(java.util.function.Consumer) onShutdown(Consumer)}, which

 * are unregistered with

 * {@link jdk.jshell.JShell#unsubscribe(jdk.jshell.JShell.Subscription) unsubscribe(Subscription)}.

 * Access to the source analysis utilities is via

 * {@link jdk.jshell.JShell#sourceCodeAnalysis()}.

 * When complete the instance should be closed to free resources --

 * {@link jdk.jshell.JShell#close()}.

 * <p>

 * An instance of {@code JShell} is created with

 * {@code JShell.create()}.

 * <p>

 * This class is not thread safe, except as noted, all access should be through

 * a single thread.

 * @author Robert Field

 */

public class JShell implements AutoCloseable {

    final SnippetMaps maps;

    final KeyMap keyMap;

    final OuterWrapMap outerMap;

    final TaskFactory taskFactory;

    final InputStream in;

    final PrintStream out;

    final PrintStream err;

    final Supplier<String> tempVariableNameGenerator;

    final BiFunction<Snippet, Integer, String> idGenerator;

    final List<String> extraRemoteVMOptions;

    final List<String> extraCompilerOptions;

    final ExecutionControl.Generator executionControlGenerator;

    private int nextKeyIndex = 1;

    final Eval eval;

    final ClassTracker classTracker;

    private final Map<Subscription, Consumer<JShell>> shutdownListeners = new HashMap<>();

    private final Map<Subscription, Consumer<SnippetEvent>> keyStatusListeners = new HashMap<>();

    private boolean closed = false;

    private ExecutionControl executionControl = null;

    private SourceCodeAnalysisImpl sourceCodeAnalysis = null;

    private static final String L10N_RB_NAME    = "jdk.jshell.resources.l10n";

    private static ResourceBundle outputRB  = null;

    JShell(Builder b) {

        this.in = b.in;

        this.out = b.out;

        this.err = b.err;

        this.tempVariableNameGenerator = b.tempVariableNameGenerator;

        this.idGenerator = b.idGenerator;

        this.extraRemoteVMOptions = b.extraRemoteVMOptions;

        this.extraCompilerOptions = b.extraCompilerOptions;

        this.executionControlGenerator = b.executionControlGenerator==null

                ? failOverExecutionControlGenerator(

                        JDIDefaultExecutionControl.launch(),

                        JDIDefaultExecutionControl.listen())

                : b.executionControlGenerator;

        this.maps = new SnippetMaps(this);

        this.keyMap = new KeyMap(this);

        this.outerMap = new OuterWrapMap(this);

        this.taskFactory = new TaskFactory(this);

        this.eval = new Eval(this);

        this.classTracker = new ClassTracker();

    }

    /**

     * Builder for {@code JShell} instances.

     * Create custom instances of {@code JShell} by using the setter

     * methods on this class.  After zero or more of these, use the

     * {@link #build()} method to create a {@code JShell} instance.

     * These can all be chained. For example, setting the remote output and

     * error streams:

     * <pre>

     * {@code

     *     JShell myShell =

     *       JShell.builder()

     *         .out(myOutStream)

     *         .err(myErrStream)

     *         .build(); } </pre>

     * If no special set-up is needed, just use

     * {@code JShell.builder().build()} or the short-cut equivalent

     * {@code JShell.create()}.

     */

    public static class Builder {

        InputStream in = new ByteArrayInputStream(new byte[0]);

        PrintStream out = System.out;

        PrintStream err = System.err;

        Supplier<String> tempVariableNameGenerator = null;

        BiFunction<Snippet, Integer, String> idGenerator = null;

        List<String> extraRemoteVMOptions = new ArrayList<>();

        List<String> extraCompilerOptions = new ArrayList<>();

        ExecutionControl.Generator executionControlGenerator;

        Builder() { }

        /**

         * Sets the input for the running evaluation (it's {@code System.in}). Note:

         * applications that use {@code System.in} for snippet or other

         * user input cannot use {@code System.in} as the input stream for

         * the remote process.

         * <p>

         * The default, if this is not set, is to provide an empty input stream

         * -- {@code new ByteArrayInputStream(new byte[0])}.

         *

         * @param in the {@code InputStream} to be channelled to

         * {@code System.in} in the remote execution process

         * @return the {@code Builder} instance (for use in chained

         * initialization)

         */

        public Builder in(InputStream in) {

            this.in = in;

            return this;

        }

        /**

         * Sets the output for the running evaluation (it's {@code System.out}).

         * The controlling process and

         * the remote process can share {@code System.out}.

         * <p>

         * The default, if this is not set, is {@code System.out}.

         *

         * @param out the {@code PrintStream} to be channelled to

         * {@code System.out} in the remote execution process

         * @return the {@code Builder} instance (for use in chained

         * initialization)

         */

        public Builder out(PrintStream out) {

            this.out = out;

            return this;

        }

        /**

         * Sets the error output for the running evaluation (it's

         * {@code System.err}). The controlling process and the remote

         * process can share {@code System.err}.

         * <p>

         * The default, if this is not set, is {@code System.err}.

         *

         * @param err the {@code PrintStream} to be channelled to

         * {@code System.err} in the remote execution process

         * @return the {@code Builder} instance (for use in chained

         * initialization)

         */

        public Builder err(PrintStream err) {

            this.err = err;

            return this;

        }

        /**

         * Sets a generator of temp variable names for

         * {@link jdk.jshell.VarSnippet} of

         * {@link jdk.jshell.Snippet.SubKind#TEMP_VAR_EXPRESSION_SUBKIND}.

         * <p>

         * Do not use this method unless you have explicit need for it.

         * <p>

         * The generator will be used for newly created VarSnippet

         * instances. The name of a variable is queried with

         * {@link jdk.jshell.VarSnippet#name()}.

         * <p>

         * The callback is sent during the processing of the snippet, the

         * JShell state is not stable. No calls whatsoever on the

         * {@code JShell} instance may be made from the callback.

         * <p>

         * The generated name must be unique within active snippets.

         * <p>

         * The default behavior (if this is not set or {@code generator}

         * is null) is to generate the name as a sequential number with a

         * prefixing dollar sign ("$").

         *

         * @param generator the {@code Supplier} to generate the temporary

         * variable name string or {@code null}

         * @return the {@code Builder} instance (for use in chained

         * initialization)

         */

        public Builder tempVariableNameGenerator(Supplier<String> generator) {

            this.tempVariableNameGenerator = generator;

            return this;

        }

        /**

         * Sets the generator of identifying names for Snippets.

         * <p>

         * Do not use this method unless you have explicit need for it.

         * <p>

         * The generator will be used for newly created Snippet instances. The

         * identifying name (id) is accessed with

         * {@link jdk.jshell.Snippet#id()} and can be seen in the

         * {@code StackTraceElement.getFileName()} for a

         * {@link jdk.jshell.EvalException} and

         * {@link jdk.jshell.UnresolvedReferenceException}.

         * <p>

         * The inputs to the generator are the {@link jdk.jshell.Snippet} and an

         * integer. The integer will be the same for two Snippets which would

         * overwrite one-another, but otherwise is unique.

         * <p>

         * The callback is sent during the processing of the snippet and the

         * Snippet and the state as a whole are not stable. No calls to change

         * system state (including Snippet state) should be made. Queries of

         * Snippet may be made except to {@link jdk.jshell.Snippet#id()}. No

         * calls on the {@code JShell} instance may be made from the

         * callback, except to

         * {@link #status(jdk.jshell.Snippet) status(Snippet)}.

         * <p>

         * The default behavior (if this is not set or {@code generator}

         * is null) is to generate the id as the integer converted to a string.

         *

         * @param generator the {@code BiFunction} to generate the id

         * string or {@code null}

         * @return the {@code Builder} instance (for use in chained

         * initialization)

         */

        public Builder idGenerator(BiFunction<Snippet, Integer, String> generator) {

            this.idGenerator = generator;

            return this;

        }

        /**

         * Sets additional VM options for launching the VM.

         *

         * @param options The options for the remote VM

         * @return the {@code Builder} instance (for use in chained

         * initialization)

         */

        public Builder remoteVMOptions(String... options) {

            this.extraRemoteVMOptions.addAll(Arrays.asList(options));

            return this;

        }

        /**

         * Adds compiler options.  These additional options will be used on

         * parsing, analysis, and code generation calls to the compiler.

         * Options which interfere with results are not supported and have

         * undefined effects on JShell's operation.

         *

         * @param options the addition options for compiler invocations

         * @return the {@code Builder} instance (for use in chained

         * initialization)

         */

        public Builder compilerOptions(String... options) {

            this.extraCompilerOptions.addAll(Arrays.asList(options));

            return this;

        }

        /**

         * Sets the custom engine for execution. Snippet execution will be

         * provided by the specified {@link ExecutionControl} instance.

         *

         * @param executionControlGenerator the execution engine generator

         * @return the {@code Builder} instance (for use in chained

         * initialization)

         */

        public Builder executionEngine(ExecutionControl.Generator executionControlGenerator) {

            this.executionControlGenerator = executionControlGenerator;

            return this;

        }

        /**

         * Builds a JShell state engine. This is the entry-point to all JShell

         * functionality. This creates a remote process for execution. It is

         * thus important to close the returned instance.

         *

         * @return the state engine

         */

        public JShell build() {

            return new JShell(this);

        }

    }

    // --- public API ---

    /**

     * Create a new JShell state engine.

     * That is, create an instance of {@code JShell}.

     * <p>

     * Equivalent to {@link JShell#builder() JShell.builder()}{@link JShell.Builder#build() .build()}.

     * @return an instance of {@code JShell}.

     */

    public static JShell create() {

        return builder().build();

    }

    /**

     * Factory method for {@code JShell.Builder} which, in-turn, is used

     * for creating instances of {@code JShell}.

     * Create a default instance of {@code JShell} with

     * {@code JShell.builder().build()}. For more construction options

     * see {@link jdk.jshell.JShell.Builder}.

     * @return an instance of {@code Builder}.

     * @see jdk.jshell.JShell.Builder

     */

    public static Builder builder() {

        return new Builder();

    }

    /**

     * Access to source code analysis functionality.

     * An instance of {@code JShell} will always return the same

     * {@code SourceCodeAnalysis} instance from

     * {@code sourceCodeAnalysis()}.

     * @return an instance of {@link SourceCodeAnalysis SourceCodeAnalysis}

     * which can be used for source analysis such as completion detection and

     * completion suggestions.

     */

    public SourceCodeAnalysis sourceCodeAnalysis() {

        if (sourceCodeAnalysis == null) {

            sourceCodeAnalysis = new SourceCodeAnalysisImpl(this);

        }

        return sourceCodeAnalysis;

    }

    /**

     * Evaluate the input String, including definition and/or execution, if

     * applicable. The input is checked for errors, unless the errors can be

     * deferred (as is the case with some unresolvedDependencies references),

     * errors will abort evaluation.

     * <p>

     * The input should be

     * exactly one complete snippet of source code, that is, one expression,

     * statement, variable declaration, method declaration, class declaration,

     * or import.

     * To break arbitrary input into individual complete snippets, use

     * {@link SourceCodeAnalysis#analyzeCompletion(String)}.

     * <p>

     * For imports, the import is added.  Classes, interfaces. methods,

     * and variables are defined.  The initializer of variables, statements,

     * and expressions are executed.

     * The modifiers public, protected, private, static, and final are not

     * allowed on op-level declarations and are ignored with a warning.

     * Synchronized, native, abstract, and default top-level methods are not

     * allowed and are errors.

     * If a previous definition of a declaration is overwritten then there will

     * be an event showing its status changed to OVERWRITTEN, this will not

     * occur for dropped, rejected, or already overwritten declarations.

     * <p>

     * If execution environment is out of process, as is the default case, then

     * if the evaluated code

     * causes the execution environment to terminate, this {@code JShell}

     * instance will be closed but the calling process and VM remain valid.

     * @param input The input String to evaluate

     * @return the list of events directly or indirectly caused by this evaluation.

     * @throws IllegalStateException if this {@code JShell} instance is closed.

     * @see SourceCodeAnalysis#analyzeCompletion(String)

     * @see JShell#onShutdown(java.util.function.Consumer)

     */

    public List<SnippetEvent> eval(String input) throws IllegalStateException {

        SourceCodeAnalysisImpl a = sourceCodeAnalysis;

        if (a != null) {

            a.suspendIndexing();

        }

        try {

            checkIfAlive();

            List<SnippetEvent> events = eval.eval(input);

            events.forEach(this::notifyKeyStatusEvent);

            return Collections.unmodifiableList(events);

        } finally {

            if (a != null) {

                a.resumeIndexing();

            }

        }

    }

    /**

     * Remove a declaration from the state.

     * @param snippet The snippet to remove

     * @return The list of events from updating declarations dependent on the

     * dropped snippet.

     * @throws IllegalStateException if this {@code JShell} instance is closed.

     * @throws IllegalArgumentException if the snippet is not associated with

     * this {@code JShell} instance.

     */

    public List<SnippetEvent> drop(PersistentSnippet snippet) throws IllegalStateException {

        checkIfAlive();

        checkValidSnippet(snippet);

        List<SnippetEvent> events = eval.drop(snippet);

        events.forEach(this::notifyKeyStatusEvent);

        return Collections.unmodifiableList(events);

    }

    /**

     * The specified path is added to the end of the classpath used in eval().

     * Note that the unnamed package is not accessible from the package in which

     * {@link JShell#eval(String)} code is placed.

     * @param path the path to add to the classpath.

     */

    public void addToClasspath(String path) {

        // Compiler

        taskFactory.addToClasspath(path);

        // Runtime

        try {

            executionControl().addToClasspath(path);

        } catch (ExecutionControlException ex) {

            debug(ex, "on addToClasspath(" + path + ")");

        }

        if (sourceCodeAnalysis != null) {

            sourceCodeAnalysis.classpathChanged();

        }

    }

    /**

     * Attempt to stop currently running evaluation. When called while

     * the {@link #eval(java.lang.String) } method is running and the

     * user's code being executed, an attempt will be made to stop user's code.

     * Note that typically this method needs to be called from a different thread

     * than the one running the {@code eval} method.

     * <p>

     * If the {@link #eval(java.lang.String) } method is not running, does nothing.

     * <p>

     * The attempt to stop the user's code may fail in some case, which may include

     * when the execution is blocked on an I/O operation, or when the user's code is

     * catching the {@link ThreadDeath} exception.

     */

    public void stop() {

        if (executionControl != null) {

            try {

                executionControl.stop();

            } catch (ExecutionControlException ex) {

                debug(ex, "on stop()");

            }

        }

    }

    /**

     * Close this state engine. Frees resources. Should be called when this

     * state engine is no longer needed.

     */

    @Override

    public void close() {

        if (!closed) {

            closeDown();

            executionControl().close();

        }

    }

    /**

     * Return all snippets.

     * @return the snippets for all current snippets in id order.

     */