/*

 * 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.internal.jshell.tool;

import java.io.BufferedWriter;

import java.io.File;

import java.io.FileNotFoundException;

import java.io.FileReader;

import java.io.IOException;

import java.io.InputStream;

import java.io.PrintStream;

import java.io.Reader;

import java.io.StringReader;

import java.nio.charset.Charset;

import java.nio.file.AccessDeniedException;

import java.nio.file.FileSystems;

import java.nio.file.Files;

import java.nio.file.NoSuchFileException;

import java.nio.file.Path;

import java.nio.file.Paths;

import java.text.MessageFormat;

import java.util.ArrayList;

import java.util.Arrays;

import java.util.Collections;

import java.util.HashSet;

import java.util.Iterator;

import java.util.LinkedHashMap;

import java.util.LinkedHashSet;

import java.util.List;

import java.util.Locale;

import java.util.Map;

import java.util.Map.Entry;

import java.util.Scanner;

import java.util.Set;

import java.util.function.Consumer;

import java.util.function.Predicate;

import java.util.prefs.Preferences;

import java.util.regex.Matcher;

import java.util.regex.Pattern;

import java.util.stream.Collectors;

import java.util.stream.Stream;

import java.util.stream.StreamSupport;

import jdk.internal.jshell.debug.InternalDebugControl;

import jdk.internal.jshell.tool.IOContext.InputInterruptedException;

import jdk.jshell.DeclarationSnippet;

import jdk.jshell.Diag;

import jdk.jshell.EvalException;

import jdk.jshell.ExpressionSnippet;

import jdk.jshell.ImportSnippet;

import jdk.jshell.JShell;

import jdk.jshell.JShell.Subscription;

import jdk.jshell.MethodSnippet;

import jdk.jshell.Snippet;

import jdk.jshell.Snippet.Status;

import jdk.jshell.SnippetEvent;

import jdk.jshell.SourceCodeAnalysis;

import jdk.jshell.SourceCodeAnalysis.CompletionInfo;

import jdk.jshell.SourceCodeAnalysis.Suggestion;

import jdk.jshell.TypeDeclSnippet;

import jdk.jshell.UnresolvedReferenceException;

import jdk.jshell.VarSnippet;

import static java.nio.file.StandardOpenOption.CREATE;

import static java.nio.file.StandardOpenOption.TRUNCATE_EXISTING;

import static java.nio.file.StandardOpenOption.WRITE;

import java.util.MissingResourceException;

import java.util.Optional;

import java.util.ResourceBundle;

import java.util.ServiceLoader;

import java.util.Spliterators;

import java.util.function.Function;

import java.util.function.Supplier;

import jdk.internal.joptsimple.*;

import jdk.internal.jshell.tool.Feedback.FormatAction;

import jdk.internal.jshell.tool.Feedback.FormatCase;

import jdk.internal.jshell.tool.Feedback.FormatErrors;

import jdk.internal.jshell.tool.Feedback.FormatResolve;

import jdk.internal.jshell.tool.Feedback.FormatUnresolved;

import jdk.internal.jshell.tool.Feedback.FormatWhen;

import jdk.internal.editor.spi.BuildInEditorProvider;

import jdk.internal.editor.external.ExternalEditor;

import static java.util.Arrays.asList;

import static java.util.Arrays.stream;

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

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

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

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

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

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

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

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

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

import static jdk.internal.jshell.tool.ContinuousCompletionProvider.STARTSWITH_MATCHER;

/**

 * Command line REPL tool for Java using the JShell API.

 * @author Robert Field

 */

public class JShellTool implements MessageHandler {

    private static final String LINE_SEP = System.getProperty("line.separator");

    private static final Pattern LINEBREAK = Pattern.compile("\\R");

    private static final String RECORD_SEPARATOR = "\u241E";

    private static final String RB_NAME_PREFIX  = "jdk.internal.jshell.tool.resources";

    private static final String VERSION_RB_NAME = RB_NAME_PREFIX + ".version";

    private static final String L10N_RB_NAME    = RB_NAME_PREFIX + ".l10n";

    final InputStream cmdin;

    final PrintStream cmdout;

    final PrintStream cmderr;

    final PrintStream console;

    final InputStream userin;

    final PrintStream userout;

    final PrintStream usererr;

    final Preferences prefs;

    final Map<String, String> envvars;

    final Locale locale;

    final Feedback feedback = new Feedback();

    /**

     * Simple constructor for the tool used by main.

     * @param in command line input

     * @param out command line output, feedback including errors, user System.out

     * @param err start-up errors and debugging info, user System.err

     */

    public JShellTool(InputStream in, PrintStream out, PrintStream err) {

        this(in, out, err, out, null, out, err,

                Preferences.userRoot().node("tool/JShell"),

                System.getenv(),

                Locale.getDefault());

    }

    /**

     * The complete constructor for the tool (used by test harnesses).

     * @param cmdin command line input -- snippets and commands

     * @param cmdout command line output, feedback including errors

     * @param cmderr start-up errors and debugging info

     * @param console console control interaction

     * @param userin code execution input, or null to use IOContext

     * @param userout code execution output  -- System.out.printf("hi")

     * @param usererr code execution error stream  -- System.err.printf("Oops")

     * @param prefs preferences to use

     * @param envvars environment variable mapping to use

     * @param locale locale to use

     */

    public JShellTool(InputStream cmdin, PrintStream cmdout, PrintStream cmderr,

            PrintStream console,

            InputStream userin, PrintStream userout, PrintStream usererr,

            Preferences prefs, Map<String, String> envvars, Locale locale) {

        this.cmdin = cmdin;

        this.cmdout = cmdout;

        this.cmderr = cmderr;

        this.console = console;

        this.userin = userin != null ? userin : new InputStream() {

            @Override

            public int read() throws IOException {

                return input.readUserInput();

            }

        };

        this.userout = userout;

        this.usererr = usererr;

        this.prefs = prefs;

        this.envvars = envvars;

        this.locale = locale;

    }

    private ResourceBundle versionRB = null;

    private ResourceBundle outputRB  = null;

    private IOContext input = null;

    private boolean regenerateOnDeath = true;

    private boolean live = false;

    private boolean feedbackInitialized = false;

    private String commandLineFeedbackMode = null;

    private List<String> remoteVMOptions = new ArrayList<>();

    private List<String> compilerOptions = new ArrayList<>();

    SourceCodeAnalysis analysis;

    JShell state = null;

    Subscription shutdownSubscription = null;

    static final EditorSetting BUILT_IN_EDITOR = new EditorSetting(null, false);

    private boolean debug = false;

    public boolean testPrompt = false;

    private String cmdlineClasspath = null;

    private String startup = null;

    private EditorSetting editor = BUILT_IN_EDITOR;

    private static final String[] EDITOR_ENV_VARS = new String[] {

        "JSHELLEDITOR", "VISUAL", "EDITOR"};

    // Commands and snippets which should be replayed

    private List<String> replayableHistory;

    private List<String> replayableHistoryPrevious;

    static final String STARTUP_KEY  = "STARTUP";

    static final String EDITOR_KEY   = "EDITOR";

    static final String FEEDBACK_KEY = "FEEDBACK";

    static final String MODE_KEY     = "MODE";

    static final String REPLAY_RESTORE_KEY = "REPLAY_RESTORE";

    static final String DEFAULT_STARTUP =

            "\n" +

            "import java.util.*;\n" +

            "import java.io.*;\n" +

            "import java.math.*;\n" +

            "import java.net.*;\n" +

            "import java.util.concurrent.*;\n" +

            "import java.util.prefs.*;\n" +

            "import java.util.regex.*;\n" +

            "void printf(String format, Object... args) { System.out.printf(format, args); }\n";

    // Tool id (tid) mapping: the three name spaces

    NameSpace mainNamespace;

    NameSpace startNamespace;

    NameSpace errorNamespace;

    // Tool id (tid) mapping: the current name spaces

    NameSpace currentNameSpace;

    Map<Snippet,SnippetInfo> mapSnippet;

    /**

     * Is the input/output currently interactive

     *

     * @return true if console

     */

    boolean interactive() {

        return input != null && input.interactiveOutput();

    }

    void debug(String format, Object... args) {

        if (debug) {

            cmderr.printf(format + "\n", args);

        }

    }

    /**

     * Base output for command output -- no pre- or post-fix

     *

     * @param printf format

     * @param printf args

     */

    void rawout(String format, Object... args) {

        cmdout.printf(format, args);

    }

    /**

     * Must show command output

     *

     * @param format printf format

     * @param args printf args

     */

    @Override

    public void hard(String format, Object... args) {

        rawout(prefix(format), args);

    }

    /**

     * Error command output

     *

     * @param format printf format

     * @param args printf args

     */

    void error(String format, Object... args) {

        rawout(prefixError(format), args);

    }

    /**

     * Should optional informative be displayed?

     * @return true if they should be displayed

     */

    @Override

    public boolean showFluff() {

        return feedback.shouldDisplayCommandFluff() && interactive();

    }

    /**

     * Optional output

     *

     * @param format printf format

     * @param args printf args

     */

    @Override

    public void fluff(String format, Object... args) {

        if (showFluff()) {

            hard(format, args);

        }

    }

    /**

     * Resource bundle look-up

     *

     * @param key the resource key

     */

    String getResourceString(String key) {

        if (outputRB == null) {

            try {

                outputRB = ResourceBundle.getBundle(L10N_RB_NAME, locale);

            } catch (MissingResourceException mre) {

                error("Cannot find ResourceBundle: %s for locale: %s", L10N_RB_NAME, locale);

                return "";

            }

        }

        String s;

        try {

            s = outputRB.getString(key);

        } catch (MissingResourceException mre) {

            error("Missing resource: %s in %s", key, L10N_RB_NAME);

            return "";

        }

        return s;

    }

    /**

     * Add normal prefixing/postfixing to embedded newlines in a string,

     * bracketing with normal prefix/postfix

     *

     * @param s the string to prefix

     * @return the pre/post-fixed and bracketed string

     */

    String prefix(String s) {

         return prefix(s, feedback.getPre(), feedback.getPost());

    }

    /**

     * Add error prefixing/postfixing to embedded newlines in a string,

     * bracketing with error prefix/postfix

     *

     * @param s the string to prefix

     * @return the pre/post-fixed and bracketed string

     */

    String prefixError(String s) {

         return prefix(s, feedback.getErrorPre(), feedback.getErrorPost());

    }

    /**

     * Add prefixing/postfixing to embedded newlines in a string,

     * bracketing with prefix/postfix

     *

     * @param s the string to prefix

     * @param pre the string to prepend to each line

     * @param post the string to append to each line (replacing newline)

     * @return the pre/post-fixed and bracketed string

     */

    String prefix(String s, String pre, String post) {

        if (s == null) {

            return "";

        }

        String pp = s.replaceAll("\\R", post + pre);

        return pre + pp + post;

    }

    /**

     * Print using resource bundle look-up and adding prefix and postfix

     *

     * @param key the resource key

     */

    void hardrb(String key) {

        hard(getResourceString(key));

    }

    /**

     * Format using resource bundle look-up using MessageFormat

     *

     * @param key the resource key

     * @param args

     */

    String messageFormat(String key, Object... args) {

        String rs = getResourceString(key);

        return MessageFormat.format(rs, args);

    }

    /**

     * Print using resource bundle look-up, MessageFormat, and add prefix and

     * postfix

     *

     * @param key the resource key

     * @param args

     */

    @Override

    public void hardmsg(String key, Object... args) {

        hard(messageFormat(key, args));

    }

    /**

     * Print error using resource bundle look-up, MessageFormat, and add prefix

     * and postfix

     *

     * @param key the resource key

     * @param args

     */

    @Override

    public void errormsg(String key, Object... args) {

        if (isRunningInteractive()) {

            rawout(prefixError(messageFormat(key, args)));

        } else {

            startmsg(key, args);

        }

    }

    /**

     * Print command-line error using resource bundle look-up, MessageFormat

     *

     * @param key the resource key

     * @param args

     */

    void startmsg(String key, Object... args) {

        cmderr.println(messageFormat(key, args));

    }

    /**

     * Print (fluff) using resource bundle look-up, MessageFormat, and add

     * prefix and postfix

     *

     * @param key the resource key

     * @param args

     */

    @Override

    public void fluffmsg(String key, Object... args) {

        if (showFluff()) {

            hardmsg(key, args);

        }

    }

    <T> void hardPairs(Stream<T> stream, Function<T, String> a, Function<T, String> b) {

        Map<String, String> a2b = stream.collect(toMap(a, b,

                (m1, m2) -> m1,

        for (Entry<String, String> e : a2b.entrySet()) {

            hard("%s", e.getKey());

            rawout(prefix(e.getValue(), feedback.getPre() + "\t", feedback.getPost()));

        }

    }

    /**

     * Trim whitespace off end of string

     *

     * @param s

     * @return

     */

    static String trimEnd(String s) {

        int last = s.length() - 1;

        int i = last;

        while (i >= 0 && Character.isWhitespace(s.charAt(i))) {

            --i;

        }

        if (i != last) {

            return s.substring(0, i + 1);

        } else {

            return s;

        }

    }

    /**

     * Normal start entry point

     * @param args

     * @throws Exception

     */

    public static void main(String[] args) throws Exception {

        new JShellTool(System.in, System.out, System.err)

                .start(args);

    }

    public void start(String[] args) throws Exception {

        List<String> loadList = processCommandArgs(args);

        if (loadList == null) {

            // Abort

            return;

        }

        try (IOContext in = new ConsoleIOContext(this, cmdin, console)) {

            start(in, loadList);