123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684 |
- /*
- * 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.ui.input;
-
- import com.dmdirc.FrameContainer;
- import com.dmdirc.commandparser.CommandArguments;
- import com.dmdirc.commandparser.CommandInfoPair;
- import com.dmdirc.commandparser.commands.ValidatingCommand;
- import com.dmdirc.commandparser.commands.WrappableCommand;
- import com.dmdirc.commandparser.parsers.CommandParser;
- import com.dmdirc.events.ClientUserInputEvent;
- import com.dmdirc.events.FrameClosingEvent;
- import com.dmdirc.interfaces.CommandController;
- import com.dmdirc.interfaces.EventBus;
- import com.dmdirc.interfaces.WindowModel;
- import com.dmdirc.interfaces.config.ConfigChangeListener;
- import com.dmdirc.interfaces.ui.InputField;
- import com.dmdirc.interfaces.ui.InputValidationListener;
- import com.dmdirc.parser.common.CompositionState;
- import com.dmdirc.plugins.ServiceManager;
- import com.dmdirc.ui.input.tabstyles.TabCompletionResult;
- import com.dmdirc.ui.input.tabstyles.TabCompletionStyle;
- import com.dmdirc.ui.messages.IRCControlCodes;
- import com.dmdirc.util.collections.ListenerList;
- import com.dmdirc.util.collections.RollingList;
- import com.dmdirc.util.validators.ValidationResponse;
-
- import com.google.common.util.concurrent.ThreadFactoryBuilder;
-
- import java.awt.Toolkit;
- import java.awt.event.KeyEvent;
- import java.util.ArrayList;
- import java.util.List;
- import java.util.concurrent.Executors;
- import java.util.concurrent.ScheduledExecutorService;
- import java.util.concurrent.ScheduledFuture;
- import java.util.concurrent.TimeUnit;
-
- import org.slf4j.Logger;
- import org.slf4j.LoggerFactory;
-
- import net.engio.mbassy.listener.Handler;
-
- /**
- * Handles events generated by a user typing into a textfield. Allows the user to use shortcut keys
- * for control characters (ctrl+b, etc), to tab complete nicknames/channel names/etc, and to scroll
- * through their previously issued commands.
- */
- public abstract class InputHandler implements ConfigChangeListener {
-
- private static final Logger LOG = LoggerFactory.getLogger(InputHandler.class);
- /**
- * Indicates that the caret should be moved to the start of a selection when a control code has
- * been inserted.
- */
- protected static final int POSITION_START = 2;
- /** Flag to indicate that this input handler should handle tab completion. */
- protected static final int HANDLE_TABCOMPLETION = 1;
- /** Flag to indicate that this input handler should maintain a back buffer. */
- protected static final int HANDLE_BACKBUFFER = 2;
- /** Flag to indicate that this input handler should handle formatting. */
- protected static final int HANDLE_FORMATTING = 4;
- /** Flag to indicate that this input handler should handle returns. */
- protected static final int HANDLE_RETURN = 8;
- /**
- * Time in milliseconds after which we switch from "typing" to"text entered" composing states.
- */
- private static final int TYPING_TIMEOUT = 5000;
- /**
- * Indicates that the caret should be moved to the end of a selection when a control code has
- * been inserted.
- */
- private static final int POSITION_END = 1;
- /** Tab-completer utilities. */
- private final TabCompleterUtils tabCompleterUtils;
- /** The flags for this particular input handler. */
- protected int flags = HANDLE_TABCOMPLETION | HANDLE_BACKBUFFER
- | HANDLE_FORMATTING | HANDLE_RETURN;
- /** The input buffer. */
- protected final RollingList<String> buffer;
- /** The textfield that we're handling input for. */
- protected final InputField target;
- /** The TabCompleter to use for tab completion. */
- protected TabCompleter tabCompleter;
- /** The CommandParser to use for our input. */
- protected final CommandParser commandParser;
- /** The frame that we belong to. */
- protected final WindowModel parentWindow;
- /** The tab completion style. */
- protected TabCompletionStyle style;
- /** Our listener list. */
- private final ListenerList listeners = new ListenerList();
- /** The current composition state. */
- private CompositionState state = CompositionState.IDLE;
- /** Timer used to manage timeouts of composition state. */
- private ScheduledFuture<?> compositionTimer;
- /** Manager to use to look up tab completion services. */
- private final ServiceManager serviceManager;
- /** The controller to use to retrieve command information. */
- private final CommandController commandController;
- /** The event bus to use to dispatch input events. */
- private final EventBus eventBus;
- /** Executor service. */
- private final ScheduledExecutorService executorService;
-
- /**
- * Creates a new instance of InputHandler. Adds listeners to the target that we need to operate.
- *
- * @param serviceManager Manager to use to look up tab completion services.
- * @param target The text field this input handler is dealing with.
- * @param commandController The controller to use to retrieve command information.
- * @param commandParser The command parser to use for this text field.
- * @param parentWindow The window that owns this input handler
- * @param eventBus The event bus to use to dispatch input events.
- */
- public InputHandler(
- final ServiceManager serviceManager,
- final InputField target,
- final CommandController commandController,
- final CommandParser commandParser,
- final WindowModel parentWindow,
- final TabCompleterUtils tabCompleterUtils,
- final EventBus eventBus) {
- buffer = new RollingList<>(parentWindow.getConfigManager()
- .getOptionInt("ui", "inputbuffersize"), "");
-
- this.serviceManager = serviceManager;
- this.target = target;
- this.commandController = commandController;
- this.commandParser = commandParser;
- this.parentWindow = parentWindow;
- this.tabCompleterUtils = tabCompleterUtils;
- this.eventBus = eventBus;
- executorService = Executors.newSingleThreadScheduledExecutor(
- new ThreadFactoryBuilder().setNameFormat("Composition state timer-%d").build());
-
- setStyle();
-
- parentWindow.getConfigManager().addChangeListener(
- "tabcompletion", "style", this);
-
- addUpHandler();
- addDownHandler();
- addTabHandler();
- addKeyHandler();
- addEnterHandler();
-
- eventBus.subscribe(this);
- }
-
- /**
- * Adds an arrow up key handler.
- */
- protected abstract void addUpHandler();
-
- /**
- * Adds an arrow down key handler.
- */
- protected abstract void addDownHandler();
-
- /**
- * Adds an tab key handler.
- */
- protected abstract void addTabHandler();
-
- /**
- * Adds a key handler.
- */
- protected abstract void addKeyHandler();
-
- /**
- * Adds an enter key handler.
- */
- protected abstract void addEnterHandler();
-
- /**
- * Indicates which types of input this handler should handle.
- *
- * @param handleTabCompletion Whether or not to handle tab completion
- * @param handleBackBuffer Whether or not to maintain an input back buffer
- * @param handleFormatting Whether or not to handle formatting
- * @param handleReturn Whether or not to handle returns
- */
- public void setTypes(final boolean handleTabCompletion,
- final boolean handleBackBuffer,
- final boolean handleFormatting, final boolean handleReturn) {
- flags = (handleTabCompletion ? HANDLE_TABCOMPLETION : 0)
- | (handleBackBuffer ? HANDLE_BACKBUFFER : 0)
- | (handleFormatting ? HANDLE_FORMATTING : 0)
- | (handleReturn ? HANDLE_RETURN : 0);
- }
-
- /**
- * Sets this inputhandler's tab completion style.
- */
- private void setStyle() {
- style = (TabCompletionStyle) serviceManager
- .getServiceProvider("tabcompletion", parentWindow
- .getConfigManager().getOption("tabcompletion", "style"))
- .getExportedService("getCompletionStyle").execute(tabCompleter,
- parentWindow);
- }
-
- /**
- * Sets this input handler's tab completer.
- *
- * @param newTabCompleter The new tab completer
- */
- public void setTabCompleter(final TabCompleter newTabCompleter) {
- tabCompleter = newTabCompleter;
- setStyle();
- }
-
- /**
- * Handles the pressing of a key. Inserts control chars as appropriate.
- *
- * @param line Text in the target
- * @param caretPosition Position of the caret after the key was pressed
- * @param keyCode Keycode for the pressed key
- * @param shiftPressed Was shift pressed
- * @param ctrlPressed Was ctrl key pressed
- */
- protected void handleKeyPressed(final String line, final int caretPosition,
- final int keyCode, final boolean shiftPressed,
- final boolean ctrlPressed) {
- target.hideColourPicker();
-
- if (keyCode == KeyEvent.VK_COMMA && caretPosition > 1) {
- // Reshow the colour picker dialog if the user follows a colour
- // or control code with a comma (so they can pick a background)
- final String partialLine = line.substring(0, caretPosition - 1);
-
- if (partialLine.matches("^.*" + IRCControlCodes.COLOUR + "[0-9]{0,2}$")) {
- target.showColourPicker(true, false);
- } else if (partialLine.matches("^.*" + IRCControlCodes.COLOUR_HEX + "[0-9A-Z]{6}?$")) {
- target.showColourPicker(false, true);
- }
- }
-
- if (ctrlPressed && (flags & HANDLE_FORMATTING) != 0) {
- handleControlKey(line, keyCode, shiftPressed);
- }
-
- if (target.getText().isEmpty()) {
- cancelTypingNotification();
- } else {
- updateTypingNotification();
- }
-
- validateText();
- }
-
- /**
- * Validates the text currently entered in the text field.
- */
- protected void validateText() {
- final String text = target.getText();
-
- final CommandArguments args = new CommandArguments(commandController, text);
-
- if (args.isCommand()) {
- final CommandInfoPair command = commandParser.getCommand(args.getCommandName());
-
- if (command != null && command.getCommand() instanceof ValidatingCommand) {
- final ValidationResponse vr = ((ValidatingCommand) command.getCommand())
- .validateArguments(parentWindow, args);
-
- if (vr.isFailure()) {
- fireCommandFailure(vr.getFailureReason());
- } else {
- fireCommandPassed();
- }
- }
-
- if (command != null && command.getCommand() instanceof WrappableCommand) {
- final int count = ((WrappableCommand) command.getCommand())
- .getLineCount(parentWindow, args);
- fireLineWrap(count);
- }
- } else {
- final int lines = parentWindow.getInputModel().get().getNumLines(text);
- fireLineWrap(lines);
- }
- }
-
- /** Resets the composition state to idle and notifies the parent if relevant. */
- private void cancelTypingNotification() {
- if (compositionTimer != null) {
- LOG.debug("Cancelling composition timer");
- compositionTimer.cancel(true);
- }
-
- LOG.debug("Cancelling typing notification");
- setCompositionState(CompositionState.IDLE);
- }
-
- /** Updates the composition state to typing and starts/resets the idle timer. */
- private void updateTypingNotification() {
- if (compositionTimer != null) {
- LOG.debug("Cancelling composition timer");
- compositionTimer.cancel(true);
- }
-
- compositionTimer = executorService.schedule(this::timeoutTypingNotification,
- TYPING_TIMEOUT, TimeUnit.MILLISECONDS);
-
- LOG.debug("Setting composition state to typing. Timer scheduled for {}", TYPING_TIMEOUT);
- setCompositionState(CompositionState.TYPING);
- }
-
- /** Updates the composition state to "entered text". */
- private void timeoutTypingNotification() {
- LOG.debug("Composition state timeout reached");
- setCompositionState(CompositionState.ENTERED_TEXT);
- }
-
- /**
- * Sets the composition state to the specified one. If the state has changed, the parent window
- * is notified of the new state.
- *
- * @param newState The new composition state
- */
- private void setCompositionState(final CompositionState newState) {
- if (state != newState) {
- state = newState;
-
- // TODO: Not sure where this should be exposed...
- ((FrameContainer) parentWindow).setCompositionState(state);
- }
- }
-
- /**
- * Fires the "illegalCommand" method of all validation listeners.
- *
- * @param reason The reason for the command failure
- */
- private void fireCommandFailure(final String reason) {
- for (InputValidationListener listener : listeners.get(InputValidationListener.class)) {
- listener.illegalCommand(reason);
- }
- }
-
- /**
- * Fires the "legalCommand" method of all validation listeners.
- */
- private void fireCommandPassed() {
- listeners.get(InputValidationListener.class).forEach(InputValidationListener::legalCommand);
- }
-
- /**
- * Fires the "wrappedText" method of all validation listeners.
- *
- * @param lines The number of lines that the text will wrap to
- */
- private void fireLineWrap(final int lines) {
- for (InputValidationListener listener : listeners.get(InputValidationListener.class)) {
- listener.wrappedText(lines);
- }
- }
-
- /**
- * Adds an InputValidationListener to this input handler.
- *
- * @param listener The listener to be added
- */
- public void addValidationListener(final InputValidationListener listener) {
- listeners.add(InputValidationListener.class, listener);
- }
-
- /**
- * Handles the pressing of a key while the control key is pressed. Inserts control chars as
- * appropriate.
- *
- * @param line Text in the target
- * @param keyCode Keycode for the pressed key
- * @param shiftPressed Was shift pressed
- */
- protected void handleControlKey(final String line, final int keyCode,
- final boolean shiftPressed) {
- switch (keyCode) {
- case KeyEvent.VK_B:
- addControlCode(IRCControlCodes.BOLD, POSITION_END);
- break;
-
- case KeyEvent.VK_U:
- addControlCode(IRCControlCodes.UNDERLINE, POSITION_END);
- break;
-
- case KeyEvent.VK_O:
- addControlCode(IRCControlCodes.STOP, POSITION_END);
- break;
-
- case KeyEvent.VK_I:
- addControlCode(IRCControlCodes.ITALIC, POSITION_END);
- break;
-
- case KeyEvent.VK_F:
- if (shiftPressed) {
- addControlCode(IRCControlCodes.FIXED, POSITION_END);
- }
- break;
-
- case KeyEvent.VK_K:
- if (shiftPressed) {
- addControlCode(IRCControlCodes.COLOUR_HEX, POSITION_START);
- target.showColourPicker(false, true);
- } else {
- addControlCode(IRCControlCodes.COLOUR, POSITION_START);
- target.showColourPicker(true, false);
- }
- break;
-
- case KeyEvent.VK_ENTER:
- if ((flags & HANDLE_RETURN) != 0 && !line.isEmpty()) {
- commandParser.parseCommandCtrl(parentWindow, line);
- addToBuffer(line);
- }
- break;
-
- default:
- /* Do nothing. */
- break;
- }
- }
-
- /**
- * Calls when the user presses the up key. Handles cycling through the input buffer.
- */
- protected void doBufferUp() {
- if ((flags & HANDLE_BACKBUFFER) != 0) {
- if (buffer.hasPrevious()) {
- target.setText(buffer.getPrevious());
- } else {
- Toolkit.getDefaultToolkit().beep();
- }
- }
- validateText();
- }
-
- /**
- * Called when the user presses the down key. Handles cycling through the input buffer, and
- * storing incomplete lines.
- */
- protected void doBufferDown() {
- if ((flags & HANDLE_BACKBUFFER) != 0) {
- if (buffer.hasNext()) {
- target.setText(buffer.getNext());
- } else if (target.getText().isEmpty()) {
- Toolkit.getDefaultToolkit().beep();
- } else {
- addToBuffer(target.getText());
- target.setText("");
- }
- }
- validateText();
- }
-
- /**
- * Retrieves a list of all known entries in the input backbuffer.
- *
- * @since 0.6
- * @return A copy of the input backbuffer.
- */
- public List<String> getBackBuffer() {
- return new ArrayList<>(buffer.getList());
- }
-
- /**
- * Handles tab completion of a string. Called when the user presses (shift) tab.
- *
- * @param shiftPressed True iff shift is pressed
- *
- * @since 0.6.3
- */
- protected void doTabCompletion(final boolean shiftPressed) {
- if (tabCompleter == null || (flags & HANDLE_TABCOMPLETION) == 0) {
- LOG.debug("Aborting tab completion. Completer: {}, flags: {}",
- new Object[]{tabCompleter, flags});
- return;
- }
-
- final String text = target.getText();
-
- LOG.trace("Text for tab completion: {}", text);
-
- if (text.isEmpty()) {
- doNormalTabCompletion(text, 0, 0, shiftPressed, null);
- return;
- }
-
- final int pos = target.getCaretPosition() - 1;
- int start = pos < 0 ? 0 : pos;
- int end = pos < 0 ? 0 : pos;
-
- // Traverse backwards
- while (start > 0 && text.charAt(start) != ' ') {
- start--;
- }
- if (text.charAt(start) == ' ') {
- start++;
- }
-
- // And forwards
- while (end < text.length() && text.charAt(end) != ' ') {
- end++;
- }
-
- if (start > end) {
- end = start;
- }
-
- LOG.trace("Offsets: start: {}, end: {}", new Object[]{start, end});
-
- if (start > 0 && text.charAt(0) == commandController.getCommandChar()) {
- doCommandTabCompletion(text, start, end, shiftPressed);
- } else {
- doNormalTabCompletion(text, start, end, shiftPressed, null);
- }
- }
-
- /**
- * Handles potentially intelligent tab completion.
- *
- * @param text The text that is being completed
- * @param start The start index of the word we're completing
- * @param end The end index of the word we're completing
- * @param shiftPressed True iff shift is pressed
- */
- private void doCommandTabCompletion(final String text, final int start,
- final int end, final boolean shiftPressed) {
- doNormalTabCompletion(text, start, end, shiftPressed,
- tabCompleterUtils.getIntelligentResults(parentWindow, commandController,
- text.substring(0, start), text.substring(start, end)));
- }
-
- /**
- * Handles normal (non-intelligent-command) tab completion.
- *
- * @param text The text that is being completed
- * @param start The start index of the word we're completing
- * @param end The end index of the word we're completing
- * @param additional A list of additional strings to use
- * @param shiftPressed True iff shift is pressed
- */
- private void doNormalTabCompletion(final String text, final int start,
- final int end, final boolean shiftPressed,
- final AdditionalTabTargets additional) {
- final TabCompletionResult res = style.getResult(text, start, end,
- shiftPressed, additional);
-
- if (res != null) {
- target.setText(res.getText());
- target.setCaretPosition(res.getPosition());
- }
- }
-
- /**
- * Called when the user presses return in the text area. The line they typed is added to the
- * buffer for future use.
- *
- * @param line The event that was fired
- */
- public void enterPressed(final String line) {
- if (!line.isEmpty()) {
- final StringBuffer bufferedLine = new StringBuffer(line);
- eventBus.publishAsync(new ClientUserInputEvent(parentWindow, bufferedLine));
- addToBuffer(bufferedLine.toString());
- commandParser.parseCommand(parentWindow, bufferedLine.toString());
- }
-
- cancelTypingNotification();
- fireLineWrap(0);
- fireCommandPassed();
- }
-
- /**
- * Adds the specified control code to the textarea. If the user has a range of text selected,
- * the characters are added before and after, and the caret is positioned based on the position
- * argument.
- *
- * @param code The control code to add
- * @param position The position of the caret after a selection is altered
- */
- protected void addControlCode(final int code, final int position) {
- final String insert = String.valueOf((char) code);
- final int selectionEnd = target.getSelectionEnd();
- final int selectionStart = target.getSelectionStart();
- if (selectionStart < selectionEnd) {
- final String source = target.getText();
- final String before = source.substring(0, selectionStart);
- final String selected = target.getSelectedText();
- final String after = source.substring(selectionEnd, source.length());
- target.setText(before + insert + selected + insert + after);
- if (position == POSITION_START) {
- target.setCaretPosition(selectionStart + 1);
- } else if (position == POSITION_END) {
- target.setCaretPosition(selectionEnd + 2);
- }
- } else {
- final int offset = target.getCaretPosition();
- final String source = target.getText();
- final String before = target.getText().substring(0, offset);
- final String after = target.getText().substring(offset,
- source.length());
- target.setText(before + insert + after);
- target.setCaretPosition(offset + 1);
- }
- }
-
- /**
- * Adds all items in the string array to the buffer.
- *
- * @param lines lines to add to the buffer
- */
- public void addToBuffer(final String[] lines) {
- for (String line : lines) {
- addToBuffer(line);
- }
- }
-
- /**
- * Adds the specified string to the buffer.
- *
- * @param line The line to be added to the buffer
- */
- public void addToBuffer(final String line) {
- buffer.add(line);
- buffer.seekToEnd();
- }
-
- @Override
- public void configChanged(final String domain, final String key) {
- setStyle();
- }
-
- /**
- * Inserts text to the current inputField.
- *
- * @param text The text to insert into the inputField
- *
- * @since 0.6.4
- */
- public void addToInputField(final String text) {
- target.setText(text);
- }
-
- /**
- * Clears the text from the inputField.
- *
- * @since 0.6.4
- */
- public void clearInputField() {
- target.setText("");
- }
-
- @Handler
- void parentClosing(final FrameClosingEvent event) {
- if (event.getSource().equals(parentWindow)) {
- executorService.shutdown();
- eventBus.unsubscribe(this);
- }
- }
-
- }
|