-
Notifications
You must be signed in to change notification settings - Fork 44
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update net.minecrell:terminalconsoleappender
update net.minecrell:terminalconsoleappender
- Loading branch information
Showing
6 changed files
with
343 additions
and
151 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
162 changes: 162 additions & 0 deletions
162
src/main/java/net/minecraftforge/server/terminalconsole/SimpleTerminalConsole.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,162 @@ | ||
| package net.minecraftforge.server.terminalconsole; | ||
|
|
||
| import org.apache.logging.log4j.LogManager; | ||
| import org.checkerframework.checker.nullness.qual.Nullable; | ||
| import org.jline.reader.Completer; | ||
| import org.jline.reader.EndOfFileException; | ||
| import org.jline.reader.LineReader; | ||
| import org.jline.reader.LineReaderBuilder; | ||
| import org.jline.reader.UserInterruptException; | ||
| import org.jline.terminal.Terminal; | ||
|
|
||
| import java.io.BufferedReader; | ||
| import java.io.IOException; | ||
| import java.io.InputStream; | ||
| import java.io.InputStreamReader; | ||
|
|
||
| /** | ||
| * A simple, optional base implementation of a basic console input command | ||
| * reader using {@link TerminalConsoleAppender}. Once started, it displays | ||
| * a command prompt ("{@code > }") and reads input commands from the console. | ||
| * | ||
| * <p><strong>Usage:</strong> Extend this class and implement the abstract | ||
| * methods for your application. Consider overriding | ||
| * {@link #buildReader(LineReaderBuilder)} to add further features to the | ||
| * console (e.g. call {@link LineReaderBuilder#completer(Completer)} with | ||
| * a custom completer to provide command completion).</p> | ||
| */ | ||
| public abstract class SimpleTerminalConsole { | ||
|
|
||
| /** | ||
| * Determines if the application is still running and accepting input. | ||
| * | ||
| * @return {@code true} to continue reading input | ||
| */ | ||
| protected abstract boolean isRunning(); | ||
|
|
||
| /** | ||
| * Run a command entered in the console. | ||
| * | ||
| * @param command The command line to run | ||
| */ | ||
| protected abstract void runCommand(String command); | ||
|
|
||
| /** | ||
| * Shutdown the application and perform a clean exit. | ||
| * | ||
| * <p>This is called if the application receives SIGINT while reading input, | ||
| * e.g. when pressing CTRL+C on most terminal implementations.</p> | ||
| */ | ||
| protected abstract void shutdown(); | ||
|
|
||
| /** | ||
| * Process an input line entered through the console. | ||
| * | ||
| * <p>The default implementation trims leading and trailing whitespace | ||
| * from the input and skips execution if the command is empty.</p> | ||
| * | ||
| * @param input The input line | ||
| */ | ||
| protected void processInput(String input) { | ||
| String command = input.trim(); | ||
| if (!command.isEmpty()) { | ||
| runCommand(command); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Configures the {@link LineReaderBuilder} and {@link LineReader} with | ||
| * additional options. | ||
| * | ||
| * <p>Override this method to make further changes, (e.g. call | ||
| * {@link LineReaderBuilder#appName(String)} or | ||
| * {@link LineReaderBuilder#completer(Completer)}).</p> | ||
| * | ||
| * <p>The default implementation sets some opinionated default options, | ||
| * which are considered to be appropriate for most applications:</p> | ||
| * | ||
| * <ul> | ||
| * <li>{@link LineReader.Option#DISABLE_EVENT_EXPANSION}: JLine implements | ||
| * <a href="http://www.gnu.org/software/bash/manual/html_node/Event-Designators.html"> | ||
| * Bash's Event Designators</a> by default. These usually do not | ||
| * behave as expected in a simple command environment, so it's | ||
| * recommended to disable it.</li> | ||
| * <li>{@link LineReader.Option#INSERT_TAB}: By default, JLine inserts | ||
| * a tab character when attempting to tab-complete on empty input. | ||
| * It is more intuitive to show a list of commands instead.</li> | ||
| * </ul> | ||
| * | ||
| * @param builder The builder to configure | ||
| * @return The built line reader | ||
| */ | ||
| protected LineReader buildReader(LineReaderBuilder builder) { | ||
| LineReader reader = builder.build(); | ||
| reader.setOpt(LineReader.Option.DISABLE_EVENT_EXPANSION); | ||
| reader.unsetOpt(LineReader.Option.INSERT_TAB); | ||
| return reader; | ||
| } | ||
|
|
||
| /** | ||
| * Start reading commands from the console. | ||
| * | ||
| * <p>Note that this method won't return until one of the following | ||
| * conditions are met:</p> | ||
| * | ||
| * <ul> | ||
| * <li>{@link #isRunning()} returns {@code false}, indicating that the | ||
| * application is shutting down.</li> | ||
| * <li>{@link #shutdown()} is triggered by the user (e.g. due to | ||
| * pressing CTRL+C)</li> | ||
| * <li>The input stream is closed.</li> | ||
| * </ul> | ||
| */ | ||
| public void start() { | ||
| try { | ||
| final @Nullable Terminal terminal = TerminalConsoleAppender.getTerminal(); | ||
| if (terminal != null) { | ||
| readCommands(terminal); | ||
| } else { | ||
| readCommands(System.in); | ||
| } | ||
| } catch (IOException e) { | ||
| LogManager.getLogger("TerminalConsole").error("Failed to read console input", e); | ||
| } | ||
| } | ||
|
|
||
| private void readCommands(Terminal terminal) { | ||
| LineReader reader = buildReader(LineReaderBuilder.builder().terminal(terminal)); | ||
| TerminalConsoleAppender.setReader(reader); | ||
|
|
||
| try { | ||
| String line; | ||
| while (isRunning()) { | ||
| try { | ||
| line = reader.readLine("> "); | ||
| } catch (EndOfFileException ignored) { | ||
| // Continue reading after EOT | ||
| continue; | ||
| } | ||
|
|
||
| if (line == null) { | ||
| break; | ||
| } | ||
|
|
||
| processInput(line); | ||
| } | ||
| } catch (UserInterruptException e) { | ||
| shutdown(); | ||
| } finally { | ||
| TerminalConsoleAppender.setReader(null); | ||
| } | ||
| } | ||
|
|
||
| private void readCommands(InputStream in) throws IOException { | ||
| try (BufferedReader reader = new BufferedReader(new InputStreamReader(in))) { | ||
| String line; | ||
| while (isRunning() && (line = reader.readLine()) != null) { | ||
| processInput(line); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| } |
40 changes: 40 additions & 0 deletions
40
src/main/java/net/minecraftforge/server/terminalconsole/TCALookup.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| package net.minecraftforge.server.terminalconsole; | ||
|
|
||
| import org.apache.logging.log4j.core.LogEvent; | ||
| import org.apache.logging.log4j.core.config.plugins.Plugin; | ||
| import org.apache.logging.log4j.core.lookup.AbstractLookup; | ||
| import org.apache.logging.log4j.core.lookup.StrLookup; | ||
| import org.checkerframework.checker.nullness.qual.Nullable; | ||
|
|
||
| /** | ||
| * A {@link StrLookup} that returns properties specific to | ||
| * {@link TerminalConsoleAppender}. The following properties are supported: | ||
| * | ||
| * <ul> | ||
| * <li>{@code ${tca:disableAnsi}}: Can be used together with | ||
| * {@code PatternLayout} to disable ANSI colors for patterns like | ||
| * {@code %highlight} or {@code %style} if ANSI colors are unsupported | ||
| * or are disabled for {@link TerminalConsoleAppender}. | ||
| * | ||
| * <p><b>Example usage:</b> | ||
| * {@code <PatternLayout ... disableAnsi="${tca:disableAnsi}">}</p></li> | ||
| * </ul> | ||
| */ | ||
| @Plugin(name = "tca", category = StrLookup.CATEGORY) | ||
| public final class TCALookup extends AbstractLookup { | ||
|
|
||
| /** | ||
| * Lookup key that returns if ANSI colors are unsupported/disabled. | ||
| */ | ||
| public final static String KEY_DISABLE_ANSI = "disableAnsi"; | ||
|
|
||
| @Override | ||
| @Nullable | ||
| public String lookup(LogEvent event, String key) { | ||
| if (KEY_DISABLE_ANSI.equals(key)) { | ||
| return String.valueOf(!TerminalConsoleAppender.isAnsiSupported()); | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.