Make stdin / stdout a game console #7266

IntelOrca · 2018-03-11T22:36:25Z

This PR refactors the in game console into three classes:

A base class containing the commands.
An implementation for stdin / stdout (allowing interactive console in headless mode)
An implementation for the in game console (which is now in openrct2-ui)

One small issue is that anytime there is a printf or log in headless mode, it will mess up the current prompt on stdout. Fixing this would require replacing all stdout calls with our own method which overwrites the current prompt and writes a new prompt with the current statement. I am not going to worry about this for now.

I originally wrote the interactive console for the plug-in branch, but it will be a long time before that goes into the game. So for now this should allow more interim console commands to be added and used in headless servers.

For the interactive console, I have used linenoise which comes as a single .hpp that we can include.

AaronVanGeffen · 2018-03-17T23:44:43Z

src/openrct2-ui/interface/InGameConsole.cpp

+{
+    if (_consoleHistoryCount >= CONSOLE_HISTORY_SIZE) {
+        for (sint32 i = 0; i < _consoleHistoryCount - 1; i++)
+            memcpy(_consoleHistory[i], _consoleHistory[i + 1], CONSOLE_INPUT_SIZE);


Happy to see the in-game console move to the UI subproject. However, this seems to be undoing the refactoring from #7064. Specifically, the console has been using a deque for its history since that PR.

I haven't changed anything about the way it works, this is a straight move. This code still exists in that PR.

It appears you're right — sorry. I wonder why these instances of memcpy weren't replaced at the time, then… Others were replaced with deque::push_back and the likes.

Broxzier

Tested with a few commands, and seems to work nicely.

janisozaur · 2018-03-20T08:02:30Z

src/openrct2-ui/interface/InGameConsole.cpp

+    case CONSOLE_INPUT_HISTORY_PREVIOUS:
+        if (_consoleHistoryIndex > 0) {
+            _consoleHistoryIndex--;
+            memcpy(_consoleCurrentLine, _consoleHistory[_consoleHistoryIndex], 256);


256 = CONSOLE_INPUT_SIZE

janisozaur · 2018-03-20T08:02:34Z

src/openrct2-ui/interface/InGameConsole.cpp

+    case CONSOLE_INPUT_HISTORY_NEXT:
+        if (_consoleHistoryIndex < _consoleHistoryCount - 1) {
+            _consoleHistoryIndex++;
+            memcpy(_consoleCurrentLine, _consoleHistory[_consoleHistoryIndex], 256);


256 = CONSOLE_INPUT_SIZE

janisozaur · 2018-03-20T23:14:21Z

Typing hide closes the client.

I fear this is something we won't be able to address unless we move to readline, but the console right now feels very limited: line editing boils down to most basic cursor movement: you can't even do per-word moving of caret. That said it is still very welcome addition over no console whatsoever.

janisozaur · 2018-03-20T23:23:04Z

Opening the cli client without any park specified just loops and doesn't allow for any interaction, even though it displays initial prompt.

IntelOrca · 2018-03-20T23:28:33Z

I fear this is something we won't be able to address unless we move to readline, but the console right now feels very limited: line editing boils down to most basic cursor movement: you can't even do per-word moving of caret. That said it is still very welcome addition over no console whatsoever.

Please improve it if you have time.

Opening the cli client without any park specified just loops and doesn't allow for any interaction, even though it displays initial prompt.

I am aware of the infinite loop, but this is not an issue with this PR. It is getting stuck in peep update.

janisozaur

The code looks mostly good, but there are some issues still:

exiting causes a segfault. ~Context calls network_close -> gfx_invalidate_screen -> context_get_height, but we are in ~Context already.
SIGINT is not handled properly: it should discard current input and possibly produce a message to press it again or do ^D or type exit

janisozaur · 2018-03-22T20:51:20Z

$ ./openrct2-cli host /some/park.sv6
Unable to open 'host'

IntelOrca · 2018-03-22T20:52:01Z

➜  bin git:(feature/interactive-stdinout) ✗ ./openrct2-cli host /data/rct1/Scenarios/sc3.sc4
ERROR[../src/openrct2/network/TcpSocket.cpp:146 (Listen)]: IPV6_V6ONLY failed. 92
Ready for clients...

janisozaur · 2018-03-22T20:53:23Z

Whoops, I had networking disabled 😊

janisozaur · 2018-03-22T22:39:20Z

There's only segfault-at-exit to address now.

janisozaur · 2018-03-23T21:41:48Z

I can't test it now, but if the segfault is gone, I'm happy for this to be merged, as long as CIs are green.

Separate out closing of connection into a new method so only that is called when closing the game which then means gfx_invalidate_screen is not called.

- Feature: [#1417] Allow saving track designs for flat rides. - Feature: [#1675] Auto-rotate shops to face footpaths. - Feature: [#3473] Add button in ride window's maintainance tab to refurbish the ride. - Feature: [#6510] Ability to select edges or a row of tiles by holding down Ctrl using the land tool. - Feature: [#7187] Option for early scenario completion. - Feature: [#7266] Make headless instances use an interactive terminal with access to the in-game console API. - Feature: [#7267] Leverage more historical data in Finances window. - Feature: [#7316] Cheat to allow freezing all staff - Feature: [#7332] Keyboard shortcuts for view path issues and cutaway view. - Feature: [#7348] Add large half loops to the Vertical Drop Roller Coaster. - Feature: [#7459] Allow opening and closing of parks that use no money. - Feature: [#7579] New horizontal +/- spinner widgets to make adjusting values easier. - Fix: [#2053] When clearance checks are disabled, a track piece ghost can remove non-ghost track pieces. - Fix: [#2611] Some objects show (undefined string) instead of a description in Korean. - Fix: [#3596] Saving parks, landscapes and tracks with a period in the filenames don't get their extension. - Fix: [#5210] Default system dialog not accessible from saving landscape window. - Fix: [#6134] Scenarios incorrectly categorised when using Polish version of RCT2. - Fix: [#6141] CSS50.dat is never loaded. - Fix: [#6647] Changelog window causes FPS drop. - Fix: [#6938] Banner do not correctly capitalise non-ASCII characters. - Fix: [#7176] Mechanics sometimes fall down from rides. - Fix: [#7303] Visual glitch with virtual floor near map edges. - Fix: [#7313] Loading an invalid path with openrct2 produces results different than expected. - Fix: [#7327] Abstract scenery and stations don't get fully See-Through when hiding them (original bug). - Fix: [#7331] Invention list in scenario editor crashes upon removing previously-enabled ride/stall entries. - Fix: [#7341] Staff may auto-spawn on guests walking outside of paths. - Fix: [#7354] Cut-away view does not draw tile elements that have been moved down on the list. - Fix: [#7358] Peeps and staff entering rides still have the slope speed penalty set. - Fix: [#7382] Opening the mini-map reverts the size of the land tool to 1x1, regardless of what was selected before. - Fix: [#7402] Edges of neigbouring footpaths stay connected after removing a path that's underneath a ride entrance. - Fix: [#7405] Rides can be covered by placing scenery underneath them. - Fix: [#7418] Staff walk off paths with a connection but no adjacent path. - Fix: [#7434] Diagonal ride segments cannot be deleted if they are isolated. - Fix: [#7436] Only the first 32 vehicles of a train can be painted. - Fix: [#7480] Graphs skip values of 0. - Fix: [#7505] Game crashes when trying to make path over map edge while having clearance checks disabled. - Fix: [#7528] In park entrance pricing tab, switching tabs happens on mouse-down instead of mouse-up - Fix: [#7544] Starting a headless server with no arguments causes the game to freeze. - Fix: [#7571] Hovering a ride design over scenery or tracks will give tons of money. - Improved: [#2989] Multiplayer window now changes title when tab changes. - Improved: [#5339] Change eyedropper icon to actual eyedropper and change cursor to crosshair. - Improved: [#5832] Resize tile inspector automatically when selecting a tile element. - Improved: [#6221] The scenario editor's invention list is now resizeable. - Improved: [#7069] The arbitrary ride type selection dropdown is now sorted orthographically, and has its spinners removed. - Improved: [#7302] Raising land near the map edge makes the affected area smaller instead of showing an 'off edge map' error. - Improved: [#7435] Object indexing now supports multi-threading. - Improved: [#7510] Add horizontal clipping to cut-away view options. - Improved: [#7531] "Save track design" dropdown now stays open. - Improved: [#7548] Ctrl-clicking with the tile inspector open now directly selects an element and its tile. - Improved: [#7555] Allow setting the Twitch API URL, allowing custom API servers. - Improved: [#7567] Improve the performance of loading parks and the title sequence. - Improved: [#7577] Allow fine-tuning the virtual floor style. - Improved: [#7608] The vehicle selection dropdown is now sorted orthographically. - Improved: [#7613] Resizing the staff window now resizes the name and action columns too. - Improved: [#7627] Allow scrolling up and down on spinners to change their values.

AaronVanGeffen added this to the v0.2.0 milestone Mar 11, 2018

Gymnasiast added Xcode Fix Required and removed Xcode Fix Required labels Mar 12, 2018

IntelOrca force-pushed the feature/interactive-stdinout branch 5 times, most recently from 48dfc38 to e9278f5 Compare March 13, 2018 21:47

IntelOrca closed this Mar 16, 2018

IntelOrca deleted the feature/interactive-stdinout branch March 16, 2018 21:56

IntelOrca restored the feature/interactive-stdinout branch March 16, 2018 22:03

IntelOrca reopened this Mar 16, 2018

IntelOrca force-pushed the feature/interactive-stdinout branch from 9b41f20 to 1ae950f Compare March 17, 2018 18:38

AaronVanGeffen reviewed Mar 17, 2018

View reviewed changes

Broxzier approved these changes Mar 19, 2018

View reviewed changes

janisozaur force-pushed the feature/interactive-stdinout branch from 1ae950f to 7518434 Compare March 20, 2018 07:26

janisozaur reviewed Mar 20, 2018

View reviewed changes

IntelOrca force-pushed the feature/interactive-stdinout branch from 1f7426f to e4af39b Compare March 20, 2018 16:49

janisozaur requested changes Mar 22, 2018

View reviewed changes

IntelOrca added 7 commits March 22, 2018 20:16

Add basic interactive console using linenoise

d18f416

Create new in-game console class

65eb908

Separate consoles to different sources

c29efc7

Move in game console variables to class

5188c36

Replace gConsoleOpen with function

ec9e812

Fix console exit for stdin/out

395f124

Move in game console to UI library

dd0573b

IntelOrca and others added 12 commits March 22, 2018 20:16

Only enable interactive console for headless

f7dafa9

Add linenoise.hpp to Xcode project

dbf41a1

Fix for MSVC

6d526d0

Optionally use terminal colour codes

2c627b4

Fix building for mingw

e3eff99

Update Xcode project

0137eaa

Add missing headers

af0967e

Add threading library to CLI

24c2fcb

Update changelog

aba142f

Replace magic numbers with CONSOLE_INPUT_SIZE

ee8d72e

Default in-game console to closed

8624a1d

Do not make hide close the game

4babfa2

IntelOrca force-pushed the feature/interactive-stdinout branch from 901cfb3 to 4babfa2 Compare March 22, 2018 20:29

IntelOrca added 2 commits March 22, 2018 20:35

Fix executed statement not written to in game console

85031f2

Require double CTRL+C to exit

3a34181

Default-initialise _consoleCurrentLine

478b787

Fix segfault when exiting a network game

a6d03b3

Separate out closing of connection into a new method so only that is called when closing the game which then means gfx_invalidate_screen is not called.

IntelOrca force-pushed the feature/interactive-stdinout branch from 39831c5 to a6d03b3 Compare March 23, 2018 21:54

IntelOrca merged commit a913fd2 into OpenRCT2:develop Mar 23, 2018

IntelOrca deleted the feature/interactive-stdinout branch May 13, 2018 11:15

janisozaur mentioned this pull request Jul 8, 2019

Disable warnings around incompatible function pointer cast #9543

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make stdin / stdout a game console #7266

Make stdin / stdout a game console #7266

IntelOrca commented Mar 11, 2018 •

edited

Loading

AaronVanGeffen Mar 17, 2018

IntelOrca Mar 18, 2018 •

edited

Loading

AaronVanGeffen Mar 18, 2018

Broxzier left a comment

janisozaur Mar 20, 2018

janisozaur Mar 20, 2018

janisozaur commented Mar 20, 2018

janisozaur commented Mar 20, 2018

IntelOrca commented Mar 20, 2018

janisozaur left a comment

janisozaur commented Mar 22, 2018

IntelOrca commented Mar 22, 2018

janisozaur commented Mar 22, 2018

janisozaur commented Mar 22, 2018

janisozaur commented Mar 23, 2018

Make stdin / stdout a game console #7266

Make stdin / stdout a game console #7266

Conversation

IntelOrca commented Mar 11, 2018 • edited Loading

AaronVanGeffen Mar 17, 2018

Choose a reason for hiding this comment

IntelOrca Mar 18, 2018 • edited Loading

Choose a reason for hiding this comment

AaronVanGeffen Mar 18, 2018

Choose a reason for hiding this comment

Broxzier left a comment

Choose a reason for hiding this comment

janisozaur Mar 20, 2018

Choose a reason for hiding this comment

janisozaur Mar 20, 2018

Choose a reason for hiding this comment

janisozaur commented Mar 20, 2018

janisozaur commented Mar 20, 2018

IntelOrca commented Mar 20, 2018

janisozaur left a comment

Choose a reason for hiding this comment

janisozaur commented Mar 22, 2018

IntelOrca commented Mar 22, 2018

janisozaur commented Mar 22, 2018

janisozaur commented Mar 22, 2018

janisozaur commented Mar 23, 2018

IntelOrca commented Mar 11, 2018 •

edited

Loading

IntelOrca Mar 18, 2018 •

edited

Loading