runelite/runelite-client/src/main/java/net/runelite/client/game/ChatboxInputManager.java

/*
 * Copyright (c) 2018 Abex
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package net.runelite.client.game;

import com.google.inject.Inject;
import com.google.inject.Singleton;
import java.util.function.Consumer;
import lombok.Getter;
import net.runelite.api.Client;
import net.runelite.api.ScriptID;
import net.runelite.api.events.ScriptCallbackEvent;
import net.runelite.client.callback.ClientThread;
import net.runelite.client.eventbus.EventBus;
import net.runelite.client.eventbus.Subscribe;

@Singleton
public class ChatboxInputManager
{
	public static final int NO_LIMIT = Integer.MAX_VALUE;
	private final Client client;
	private final ClientThread clientThread;

	private Consumer<String> done;
	private Consumer<String> changed;
	private int characterLimit = NO_LIMIT;

	@Getter
	private boolean open = false;

	@Inject
	public ChatboxInputManager(Client client, ClientThread clientThread, EventBus eventBus)
	{
		this.client = client;
		this.clientThread = clientThread;
		eventBus.register(this);
	}

	/**
	 * Opens a RuneScape-style chatbox input
	 *
	 * @param text   Text to show at the top of the window
	 * @param defaul Default text in the editable field
	 * @param done   Callback when the text box has been exited, called with "" on esc
	 */
	public void openInputWindow(String text, String defaul, Consumer<String> done)
	{
		openInputWindow(text, defaul, NO_LIMIT, done);
	}

	public void openInputWindow(String text, String defaul, int characterLimit, Consumer<String> done)
	{
		openInputWindow(text, defaul, characterLimit, null, done);
	}

	public void openInputWindow(String text, String defaul, int characterLimit, Consumer<String> changed, Consumer<String> done)
	{
		this.done = done;
		this.changed = changed;
		this.characterLimit = characterLimit;
		this.open = true;
		clientThread.invoke(() -> client.runScript(
			ScriptID.RUNELITE_CHATBOX_INPUT_INIT,
			text,
			defaul
		));
	}

	/**
	 * Closes the RuneScape-style chatbox input
	 */
	public void closeInputWindow()
	{
		if (!this.open)
		{
			return;
		}
		this.open = false;
		clientThread.invoke(() -> client.runScript(
			ScriptID.RESET_CHATBOX_INPUT,
			1,
			1
		));
	}

	@Subscribe
	public void onScriptCallbackEvent(ScriptCallbackEvent ev)
	{
		// This replaces script 74 and most of 112
		if ("chatboxInputHandler".equals(ev.getEventName()))
		{
			int intStackSize = client.getIntStackSize();
			int stringStackSize = client.getStringStackSize();
			int typedKey = client.getIntStack()[--intStackSize];
			String str = client.getStringStack()[--stringStackSize];
			boolean isDone = false;

			switch (typedKey)
			{
				case 27: // Escape
					str = "";
					// fallthrough
				case '\n':
					this.open = false;
					isDone = true;
					break;
				case '\b':
					if (!str.isEmpty())
					{
						str = str.substring(0, str.length() - 1);
					}
					break;
				default:
					// If we wanted to do numbers only, we could add a limit here
					if (typedKey >= 32 && (str.length() < characterLimit))
					{
						str += Character.toString((char) typedKey);
					}
			}

			if (changed != null)
			{
				changed.accept(str);
			}

			if (isDone && done != null)
			{
				done.accept(str);
			}

			client.getStringStack()[stringStackSize++] = str;
			client.getIntStack()[intStackSize++] = isDone ? 1 : 0;
			client.setIntStackSize(intStackSize);
			client.setStringStackSize(stringStackSize);
		}
	}
}