path: root/base/src/main/java/bjc/utils/cli/objects/BlockReaderCLI.java

package bjc.utils.cli.objects;

import java.io.InputStreamReader;
import java.io.Reader;

import java.util.HashMap;
import java.util.Map;
import java.util.Scanner;
import java.util.function.Predicate;
import java.util.logging.Logger;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;

import bjc.utils.ioutils.blocks.*;

import static bjc.utils.cli.objects.Command.CommandStatus;
import static bjc.utils.cli.objects.Command.CommandStatus.*;

/**
 * Command-line interface for configuring block readers.
 *
 * @author Ben Culkin
 */
public class BlockReaderCLI {
	/**
	 * The state of the block reader.
	 *
	 * @author Ben Culkin
	 */
	public static final class BlockReaderState {
		/**
		 * All of the configured block readers.
		 */
		public final Map<String, BlockReader> readers;
		/**
		 * All of the configured I/O sources.
		 */
		public final Map<String, Reader> sources;

		/**
		 * Create a new set of state for the block reader.
		 *
		 * @param readers
		 *                The set of configured block readers.
		 *
		 * @param sources
		 *                The set of configured I/O sources.
		 */
		public BlockReaderState(Map<String, BlockReader> readers, Map<String, Reader> sources) {
			this.readers = readers;
			this.sources = sources;
		}

		/**
		 * Create a new set of state for the block reader.
		 *
		 * @param sources
		 *                The set of configured I/O sources.
		 */
		public BlockReaderState(Map<String, Reader> sources) {
			this.readers = new HashMap<>();
			this.sources = sources;
		}
	}

	/* Logger. */
	private final Logger LOGGER = Logger.getLogger(BlockReaderCLI.class.getName());

	/* Our state. */
	private BlockReaderState stat;

	/**
	 * Create a new CLI for configuring BlockReaders.
	 *
	 * @param srcs
	 *                The container of initial I/O sources.
	 */
	public BlockReaderCLI(Map<String, Reader> srcs) {
		stat = new BlockReaderState(srcs);
	}

	/**
	 * Create a new CLI for configuring BlockReaders.
	 *
	 * @param state
	 *                The state object to use.
	 */
	public BlockReaderCLI(BlockReaderState state) {
		stat = state;
	}

	/* :CLIArgsParsing */
	/**
	 * Run the command line interface
	 *
	 * @param args
	 *                Ignored CLI args.
	 */
	public static void main(String[] args) {
		/* Create/configure I/O sources. */
		Map<String, Reader> sources = new HashMap<>();
		BlockReaderCLI reader = new BlockReaderCLI(sources);

		sources.put("stdio", new InputStreamReader(System.in));

		Scanner input = new Scanner(System.in);
		reader.run(input, "console", true);
		input.close();
	}

	/**
	 * Run the CLI on an input source.
	 *
	 * @param input
	 *                The place to read input from.
	 *
	 * @param srcName
	 *                The name of the place to read input from.
	 *
	 * @param interactive
	 *                Whether or not the source is interactive
	 */
	public void run(Scanner input, String srcName, boolean interactive) {
		int lno = 0;

		do {
			/* Print a prompt. */
			if (interactive) {
				System.out.printf("reader-conf(%d)>", lno);
			}

			/* Read a line. */
			String ln = input.nextLine();
			lno += 1;

			/* Parse the command. */
			Command com = Command.fromString(ln, lno, srcName);
			/* Ignore blank commands. */
			if (com == null) continue;

			/* Handle a command. */
			CommandStatus sts = handleCommand(com, interactive);
			/* Exit if we finished or encountered a fatal error. */
			if (sts == FINISH || sts == ERROR) { return; }
		} while (input.hasNextLine());
	}

	/**
	 * Handle a command.
	 *
	 * @param com
	 *                The command to handle
	 *
	 * @param interactive
	 *                Whether the current input source is interactive or
	 *                not.
	 * @return The status of the executed command.
	 */
	public CommandStatus handleCommand(Command com, boolean interactive) {
		/* Handle each command. */
		switch (com.name) {
		case "def-filtered":
			return defFiltered(com);
		case "def-layered":
			return defLayered(com);
		case "def-pushback":
			return defPushback(com);
		case "def-simple":
			return defSimple(com);
		case "def-serial":
			return defSerial(com);
		case "def-toggled":
			return defToggled(com);
		case "}":
		case "end":
		case "exit":
		case "quit":
			if (interactive)
				System.out.printf("Exiting reader-conf, %d readers configured in %d commands\n",
						stat.readers.size(), com.lno);
			return FINISH;
		default:
			LOGGER.severe(com.error("Unknown command '%s'\n", com.name));
			return FAIL;
		}
	}

	private CommandStatus defFiltered(Command com) {
		/*
		 * Get the block name.
		 */

		String blockName = com.trimTo(' ');
		if (blockName == null) {
			LOGGER.severe(com.error("No name argument for def-filtered.\n"));
			return FAIL;
		}

		/*
		 * Check there isn't a reader already bound to this name.
		 */
		if (stat.readers.containsKey(blockName)) {
			LOGGER.warning(com.warn("Shadowing existing reader named %s\n", blockName));
		}

		/*
		 * Get the reader name.
		 */

		String readerName = com.trimTo(' ');
		if (readerName == null) {
			LOGGER.severe(com.error("No reader-name argument for def-filtered.\n"));
			return FAIL;
		}

		/*
		 * Check there is a reader bound to that name.
		 */
		if (!stat.readers.containsKey(readerName)) {
			LOGGER.severe(com.error("No source named %s\n", readerName));
			return FAIL;
		}

		/*
		 * Get the pattern.
		 */
		if (com.remn.equals("")) {
			LOGGER.severe(com.error("No filter argument for def-filtered\n"));
			return FAIL;
		}

		String filter = com.remn;

		try {
			Pattern pat = Pattern.compile(filter);

			Predicate<Block> pred = (block) -> {
				Matcher mat = pat.matcher(block.contents);

				return mat.matches();
			};

			BlockReader reader = new FilteredBlockReader(stat.readers.get(readerName), pred);

			stat.readers.put(blockName, reader);
		} catch (PatternSyntaxException psex) {
			LOGGER.severe(com.error("Invalid regular expression '%s' for filter. (%s)\n", filter,
					psex.getMessage()));
			return FAIL;
		}

		return SUCCESS;
	}

	private CommandStatus defPushback(Command com) {
		String[] parts = com.remn.split(" ");

		if (parts.length != 2) {
			LOGGER.severe(com.error(
					"Incorrect number of arguments to def-pushback. Requires a block name and a reader name\n"));
			return FAIL;
		}

		String blockName = parts[0];
		if (stat.readers.containsKey(blockName)) {
			LOGGER.warning(com.warn("Shadowing existing reader %s\n", blockName));
			return FAIL;
		}

		String readerName = parts[1];
		if (!stat.readers.containsKey(readerName)) {
			LOGGER.severe(com.error("No reader named %s\n", readerName));
			return FAIL;
		}

		BlockReader reader = new PushbackBlockReader(stat.readers.get(readerName));
		stat.readers.put(blockName, reader);

		return SUCCESS;
	}

	private CommandStatus defToggled(Command com) {
		String[] parts = com.remn.split(" ");

		if (parts.length != 3) {
			LOGGER.severe(com.error(
					"Incorrect number of arguments to def-toggled. Requires a block name and two reader names\n"));
			return FAIL;
		}

		/*
		 * Get the block name.
		 */
		String blockName = parts[0];
		if (stat.readers.containsKey(blockName)) {
			LOGGER.warning(com.warn("Shadowing existing reader named %s\n", blockName));
		}

		/*
		 * Make sure the component readers exist.
		 */
		if (!stat.readers.containsKey(parts[1])) {
			LOGGER.severe(com.error("No reader named %s\n", parts[1]));
			return FAIL;
		}

		if (!stat.readers.containsKey(parts[2])) {
			LOGGER.severe(com.error("No reader named %s\n", parts[2]));
			return FAIL;
		}

		BlockReader reader = new ToggledBlockReader(stat.readers.get(parts[1]), stat.readers.get(parts[2]));
		stat.readers.put(blockName, reader);

		return SUCCESS;
	}

	private CommandStatus defLayered(Command com) {
		String[] parts = com.remn.split(" ");

		if (parts.length != 3) {
			LOGGER.severe(com.error(
					"Incorrect number of arguments to def-layered. Requires a block name and two reader names\n"));
			return FAIL;
		}

		/*
		 * Get the block name.
		 */
		String blockName = parts[0];
		if (stat.readers.containsKey(blockName)) {
			LOGGER.warning(com.warn("Shadowing existing reader named %s\n", blockName));
		}

		/*
		 * Make sure the component readers exist.
		 */
		if (!stat.readers.containsKey(parts[1])) {
			LOGGER.severe(com.error("No reader named %s\n", parts[1]));
			return FAIL;
		}

		if (!stat.readers.containsKey(parts[2])) {
			LOGGER.severe(com.error("No reader named %s\n", parts[2]));
			return FAIL;
		}

		BlockReader reader = new LayeredBlockReader(stat.readers.get(parts[1]), stat.readers.get(parts[2]));
		stat.readers.put(blockName, reader);

		return SUCCESS;
	}

	private CommandStatus defSerial(Command com) {
		String[] parts = com.remn.split(" ");

		if (parts.length < 2) {
			LOGGER.severe(com.error(
					"Not enough arguments to def-serial. Requires at least a block name and at least one reader name\n"));
			return FAIL;
		}

		/*
		 * Get the name for this BlockReader.
		 */
		String blockName = parts[0];
		/*
		 * Check there isn't a reader already bound to this name.
		 */
		if (stat.readers.containsKey(blockName)) {
			LOGGER.warning(com.warn("Shadowing existing reader named %s\n", blockName));
		}

		/*
		 * Get all of the component readers.
		 */
		BlockReader[] readerArr = new BlockReader[parts.length - 1];
		for (int i = 1; i < parts.length; i++) {
			String readerName = parts[i];

			/*
			 * Check there is a reader bound to that name.
			 */
			if (!stat.readers.containsKey(readerName)) {
				LOGGER.severe(com.error("No reader named %s\n", readerName));
				return FAIL;
			}

			readerArr[i] = stat.readers.get(readerName);
		}

		BlockReader reader = new SerialBlockReader(readerArr);

		stat.readers.put(blockName, reader);

		return SUCCESS;
	}

	private CommandStatus defSimple(Command com) {
		String remn = com.remn;

		/*
		 * Get the block name.
		 */
		/* :StringHandling */
		int idx = remn.indexOf(' ');
		if (idx == -1) {
			LOGGER.severe(com.error("No name argument for def-simple.\n"));
			return FAIL;
		}
		String blockName = remn.substring(0, idx).trim();
		remn = remn.substring(idx).trim();

		/*
		 * Check there isn't a reader already bound to this name.
		 */
		if (stat.readers.containsKey(blockName)) {
			LOGGER.warning(com.warn("Shadowing existing reader named %s\n", blockName));
		}

		/*
		 * Get the source name.
		 */
		/* :StringHandling */
		idx = remn.indexOf(' ');
		if (idx == -1) {
			LOGGER.severe(com.error("No source-name argument for def-simple.\n"));
			return FAIL;
		}
		String sourceName = remn.substring(0, idx).trim();
		remn = remn.substring(idx).trim();

		/*
		 * Check there is a source bound to that name.
		 */
		if (!stat.sources.containsKey(sourceName)) {
			LOGGER.severe(com.error("No source named %s\n", sourceName));
			return FAIL;
		}

		/*
		 * Get the pattern.
		 */
		if (remn.equals("")) {
			LOGGER.severe(com.error("No delimiter argument for def-simple\n"));
			return FAIL;
		}

		String delim = remn;

		/* Get the delimiter, and create the reader. */
		try {
			BlockReader reader = new SimpleBlockReader(delim, stat.sources.get(sourceName));

			stat.readers.put(blockName, reader);
		} catch (PatternSyntaxException psex) {
			LOGGER.severe(com.error("Invalid regular expression '%s' for delimiter. (%s)\n", delim,
					psex.getMessage()));
			return FAIL;
		}

		return SUCCESS;
	}
}