DMDirc-Plugins/debug/src/main/java/com/dmdirc/addons/debug/Debug.java

/*
 * Copyright (c) 2006-2015 DMDirc Developers
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package com.dmdirc.addons.debug;

import com.dmdirc.commandparser.BaseCommandInfo;
import com.dmdirc.commandparser.CommandArguments;
import com.dmdirc.commandparser.CommandInfo;
import com.dmdirc.commandparser.CommandType;
import com.dmdirc.commandparser.commands.Command;
import com.dmdirc.commandparser.commands.IntelligentCommand;
import com.dmdirc.commandparser.commands.context.CommandContext;
import com.dmdirc.interfaces.CommandController;
import com.dmdirc.interfaces.WindowModel;
import com.dmdirc.ui.input.AdditionalTabTargets;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;

import javax.annotation.Nonnull;
import javax.inject.Inject;
import javax.inject.Singleton;

/**
 * Provides various handy ways to test or debug the client.
 */
@Singleton
public class Debug extends Command implements IntelligentCommand {

    /** A command info object for this command. */
    public static final CommandInfo INFO = new BaseCommandInfo("debug",
            "debug <command> [args] - facilitates debugging of DMDirc",
            CommandType.TYPE_GLOBAL);
    /** The command controller to use to lookup command information. */
    private final CommandController controller;
    /** List of registered debug commands. */
    private final Map<String, DebugCommand> commands;

    /**
     * Creates a new debug command.
     *
     * @param controller  The command controller to use to lookup command information.
     * @param subcommands The subcommands to be loaded.
     */
    @Inject
    public Debug(
            final CommandController controller,
            final Set<DebugCommand> subcommands) {
        super(controller);

        this.controller = controller;
        this.commands = new HashMap<>(subcommands.size());

        for (DebugCommand command : subcommands) {
            commands.put(command.getName(), command);
        }
    }

    @Override
    public void execute(@Nonnull final WindowModel origin,
            final CommandArguments args, final CommandContext context) {
        if (args.getArguments().length == 0) {
            showUsage(origin, args.isSilent(), "debug",
                    "<debug command> [options]");
        } else {
            final DebugCommand command = commands.get(args.getArguments()[0]);
            if (command == null) {
                showError(origin, args.isSilent(), "Unknown debug action.");
            } else {
                final CommandArguments newArgs = new CommandArguments(
                        controller,
                        Arrays.asList((controller.getCommandChar()
                                + command.getName() + ' '
                                + args.getArgumentsAsString(1)).split(" ")));
                command.execute(origin, newArgs, context);
            }
        }
    }

    /**
     * Shows output, if appropriate, in the specified target.
     *
     * @param target   The command window to send the line to
     * @param isSilent Whether this command is being silenced or not
     * @param message  The message to be sent
     */
    public void proxyShowOutput(final WindowModel target,
            final boolean isSilent, final String message) {
        showOutput(target, isSilent, message);
    }

    /**
     * Shows an error, if appropriate, in the specified target.
     *
     * @param target   The command window to send the line to
     * @param isSilent Whether this command is being silenced or not
     * @param message  The message to be sent
     */
    public void proxyShowError(final WindowModel target,
            final boolean isSilent, final String message) {
        showError(target, isSilent, message);
    }

    /**
     * Sends a usage line, if appropriate, to the specified target.
     *
     * @param target   The command window to send the line to
     * @param isSilent Whether this command is being silenced or not
     * @param name     The name of the command that's raising the error
     * @param args     The arguments that the command accepts or expects
     */
    public void proxyShowUsage(final WindowModel target,
            final boolean isSilent, final String name, final String args) {
        showUsage(target, isSilent, INFO.getName(), name + ' ' + args);
    }

    /**
     * Formats the specified data into a table suitable for output in the textpane. It is expected
     * that each String[] in data has the same number of elements as the headers array.
     *
     * @param headers The headers of the table.
     * @param data    The contents of the table.
     *
     * @return A string containing an ASCII table
     */
    public String proxyDoTable(final String[] headers, final String[][] data) {
        return doTable(headers, data);
    }

    /**
     * Returns a list of command names.
     *
     * @return List of command names
     */
    public Collection<String> getCommandNames() {
        final Collection<String> names = new ArrayList<>(commands.size());

        names.addAll(commands.values().stream()
                .map(DebugCommand::getName)
                .collect(Collectors.toList()));

        return names;
    }

    @Override
    public AdditionalTabTargets getSuggestions(final int arg,
            final IntelligentCommandContext context) {
        AdditionalTabTargets res = new AdditionalTabTargets();

        res.excludeAll();

        if (arg == 0) {
            res.addAll(getCommandNames());
        } else {
            final DebugCommand command = commands.get(context.getPreviousArgs().get(0));
            if (command instanceof IntelligentCommand) {
                final IntelligentCommandContext newContext = new IntelligentCommandContext(context.
                        getWindow(),
                        context.getPreviousArgs().subList(1,
                                context.getPreviousArgs().size()),
                        context.getPartial());
                res = ((IntelligentCommand) command).getSuggestions(
                        arg, newContext);
            }
        }

        return res;
    }

}