e385ff1c3b
std::ranges::find_if permits use of a sentinel instead of a full iterator, and supports std::ranges::find as an alternative to certain simple uses of std::find_if. Where possible, use the form that takes a range, rather than the form that takes two iterators. Add a declared, but not defined, default constructor for self_return_iterator to satisfy the standard library's concept `semiregular`, which insists that sentinels be default-constructible, even for those functions that never need to do so. Add a defined, but unused, operator++(postfix) for zip_iterator to satisfy a standard library concept for `forward_iterator`.
487 lines
12 KiB
C++
487 lines
12 KiB
C++
/*
|
|
* This file is part of the DXX-Rebirth project <https://www.dxx-rebirth.com/>.
|
|
* It is copyright by its individual contributors, as recorded in the
|
|
* project's Git history. See COPYING.txt at the top level for license
|
|
* terms and a link to the Git history.
|
|
*/
|
|
/*
|
|
*
|
|
* Game console
|
|
*
|
|
*/
|
|
|
|
#include <algorithm>
|
|
#include <stdio.h>
|
|
#include <stdlib.h>
|
|
#include <stdarg.h>
|
|
#include <string.h>
|
|
#include <sys/time.h>
|
|
#include <SDL.h>
|
|
#include "window.h"
|
|
#include "event.h"
|
|
#include "console.h"
|
|
#include "args.h"
|
|
#include "gr.h"
|
|
#include "physfsx.h"
|
|
#include "gamefont.h"
|
|
#include "game.h"
|
|
#include "key.h"
|
|
#include "vers_id.h"
|
|
#include "timer.h"
|
|
#include "cli.h"
|
|
#include "cmd.h"
|
|
#include "cvar.h"
|
|
|
|
#include "dxxsconf.h"
|
|
#include <array>
|
|
|
|
#ifdef _WIN32
|
|
#include <windows.h>
|
|
#endif
|
|
|
|
namespace dcx {
|
|
|
|
namespace {
|
|
|
|
#ifndef DXX_CONSOLE_TIME_SHOW_YMD
|
|
#define DXX_CONSOLE_TIME_SHOW_YMD 0
|
|
#endif
|
|
|
|
#ifndef DXX_CONSOLE_TIME_SHOW_MSEC
|
|
#define DXX_CONSOLE_TIME_SHOW_MSEC 1
|
|
#endif
|
|
|
|
#ifndef DXX_CONSOLE_SHOW_TIME_STDOUT
|
|
#define DXX_CONSOLE_SHOW_TIME_STDOUT 0
|
|
#endif
|
|
|
|
constexpr unsigned CON_LINES_ONSCREEN = 18;
|
|
constexpr auto CON_SCROLL_OFFSET = CON_LINES_ONSCREEN - 3;
|
|
constexpr unsigned CON_LINES_MAX = 128;
|
|
|
|
enum con_state {
|
|
CON_STATE_CLOSING = -1,
|
|
CON_STATE_CLOSED = 0,
|
|
CON_STATE_OPENING = 1,
|
|
CON_STATE_OPEN = 2
|
|
};
|
|
|
|
struct console_window : window
|
|
{
|
|
using window::window;
|
|
virtual window_event_result event_handler(const d_event &) override;
|
|
};
|
|
|
|
static RAIIPHYSFS_File gamelog_fp;
|
|
static std::array<console_buffer, CON_LINES_MAX> con_buffer;
|
|
static con_state con_state;
|
|
static int con_scroll_offset, con_size;
|
|
static void con_force_puts(con_priority priority, std::span<char> buffer);
|
|
|
|
static void con_add_buffer_line(const con_priority priority, const std::span<const char> buffer)
|
|
{
|
|
/* shift con_buffer for one line */
|
|
std::move(std::next(con_buffer.begin()), con_buffer.end(), con_buffer.begin());
|
|
console_buffer &c = con_buffer.back();
|
|
c.priority=priority;
|
|
|
|
const std::size_t copy = std::min(buffer.size(), std::size(c.line) - 1);
|
|
c.line[copy] = 0;
|
|
memcpy(&c.line, buffer.data(), copy);
|
|
}
|
|
|
|
}
|
|
|
|
void (con_printf)(const con_priority_wrapper priority, const char *const fmt, ...)
|
|
{
|
|
va_list arglist;
|
|
|
|
if (priority <= CGameArg.DbgVerbose)
|
|
{
|
|
va_start (arglist, fmt);
|
|
std::array<char, CON_LINE_LENGTH> buffer;
|
|
auto &&[written, leader] = priority.insert_location_leader(buffer);
|
|
const std::size_t len = std::max(vsnprintf(leader.data(), leader.size(), fmt, arglist), 0);
|
|
va_end (arglist);
|
|
con_force_puts(priority, std::span(buffer).first(len + written));
|
|
}
|
|
}
|
|
|
|
namespace {
|
|
|
|
static void con_scrub_markup(const std::span<char> buffer)
|
|
{
|
|
const auto b = buffer.begin();
|
|
const auto e = buffer.end();
|
|
const auto &&i = std::ranges::find_if(b, e, [](const char c) { return c == CC_COLOR || c == CC_LSPACING || c == CC_UNDERLINE; });
|
|
if (i == e)
|
|
return;
|
|
auto p1 = i;
|
|
auto p2 = p1;
|
|
for (;; ++p1)
|
|
{
|
|
switch (auto c = *p1)
|
|
{
|
|
case CC_COLOR:
|
|
case CC_LSPACING:
|
|
c = *++p1;
|
|
if (c)
|
|
/* If a character follows the control code, drop that
|
|
* character.
|
|
*
|
|
* If a null byte follows the control code, fall through
|
|
* and store that null byte to terminate the scrubbed
|
|
* string.
|
|
*/
|
|
break;
|
|
[[fallthrough]];
|
|
default:
|
|
*p2 = c;
|
|
if (!c)
|
|
return;
|
|
++p2;
|
|
case CC_UNDERLINE:
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
static void con_print_file(const char *const buffer)
|
|
{
|
|
char buf[1024];
|
|
#if !DXX_CONSOLE_SHOW_TIME_STDOUT
|
|
#ifndef _WIN32
|
|
/* Print output to stdout */
|
|
puts(buffer);
|
|
#endif
|
|
|
|
/* Print output to gamelog.txt */
|
|
if (const auto fp = gamelog_fp.get())
|
|
#endif
|
|
{
|
|
#if DXX_CONSOLE_TIME_SHOW_YMD
|
|
#define DXX_CONSOLE_TIME_FORMAT_YMD "%04i-%02i-%02i "
|
|
#define DXX_CONSOLE_TIME_ARG_YMD tm_year, tm_month, tm_day,
|
|
#else
|
|
#define DXX_CONSOLE_TIME_FORMAT_YMD ""
|
|
#define DXX_CONSOLE_TIME_ARG_YMD
|
|
#endif
|
|
#if DXX_CONSOLE_TIME_SHOW_MSEC
|
|
#ifdef _WIN32
|
|
#define DXX_CONSOLE_TIME_FORMAT_MSEC ".%03i"
|
|
#else
|
|
#define DXX_CONSOLE_TIME_FORMAT_MSEC ".%06i"
|
|
#endif
|
|
#define DXX_CONSOLE_TIME_ARG_MSEC tm_msec,
|
|
#else
|
|
#define DXX_CONSOLE_TIME_FORMAT_MSEC ""
|
|
#define DXX_CONSOLE_TIME_ARG_MSEC
|
|
#endif
|
|
int
|
|
DXX_CONSOLE_TIME_ARG_YMD
|
|
DXX_CONSOLE_TIME_ARG_MSEC
|
|
tm_hour, tm_min, tm_sec;
|
|
#ifdef _WIN32
|
|
#define DXX_LF "\r\n"
|
|
SYSTEMTIME st = {};
|
|
GetLocalTime(&st);
|
|
#if DXX_CONSOLE_TIME_SHOW_YMD
|
|
tm_year = st.wYear;
|
|
tm_month = st.wMonth;
|
|
tm_day = st.wDay;
|
|
#endif
|
|
tm_hour = st.wHour;
|
|
tm_min = st.wMinute;
|
|
tm_sec = st.wSecond;
|
|
#if DXX_CONSOLE_TIME_SHOW_MSEC
|
|
tm_msec = st.wMilliseconds;
|
|
#endif
|
|
#else
|
|
#define DXX_LF "\n"
|
|
struct timeval tv;
|
|
if (gettimeofday(&tv, nullptr))
|
|
tv = {};
|
|
if (const auto lt = localtime(&tv.tv_sec))
|
|
{
|
|
#if DXX_CONSOLE_TIME_SHOW_YMD
|
|
tm_year = lt->tm_year;
|
|
tm_month = lt->tm_mon;
|
|
tm_day = lt->tm_mday;
|
|
#endif
|
|
tm_hour = lt->tm_hour;
|
|
tm_min = lt->tm_min;
|
|
tm_sec = lt->tm_sec;
|
|
#if DXX_CONSOLE_TIME_SHOW_MSEC
|
|
tm_msec = tv.tv_usec;
|
|
#endif
|
|
}
|
|
else
|
|
{
|
|
#if DXX_CONSOLE_TIME_SHOW_YMD
|
|
tm_year = tm_month = tm_day =
|
|
#endif
|
|
#if DXX_CONSOLE_TIME_SHOW_MSEC
|
|
tm_msec =
|
|
#endif
|
|
tm_hour = tm_min = tm_sec = -1;
|
|
}
|
|
#endif
|
|
const size_t len = snprintf(buf, sizeof(buf), DXX_CONSOLE_TIME_FORMAT_YMD "%02i:%02i:%02i" DXX_CONSOLE_TIME_FORMAT_MSEC " %s" DXX_LF, DXX_CONSOLE_TIME_ARG_YMD tm_hour, tm_min, tm_sec, DXX_CONSOLE_TIME_ARG_MSEC buffer);
|
|
#if DXX_CONSOLE_SHOW_TIME_STDOUT
|
|
#ifndef _WIN32
|
|
fputs(buf, stdout);
|
|
#endif
|
|
if (const auto fp = gamelog_fp.get())
|
|
#endif
|
|
{
|
|
PHYSFS_write(fp, buf, 1, len);
|
|
}
|
|
#undef DXX_LF
|
|
#undef DXX_CONSOLE_TIME_ARG_MSEC
|
|
#undef DXX_CONSOLE_TIME_FORMAT_MSEC
|
|
#undef DXX_CONSOLE_TIME_ARG_YMD
|
|
#undef DXX_CONSOLE_TIME_FORMAT_YMD
|
|
}
|
|
}
|
|
|
|
/*
|
|
* The caller is assumed to have checked that the priority allows this
|
|
* entry to be logged.
|
|
*/
|
|
static void con_force_puts(const con_priority priority, const std::span<char> buffer)
|
|
{
|
|
con_add_buffer_line(priority, buffer);
|
|
con_scrub_markup(buffer);
|
|
/* Produce a sanitised version and send it to the console */
|
|
con_print_file(buffer.data());
|
|
}
|
|
|
|
}
|
|
|
|
void con_puts(const con_priority_wrapper priority, char *const buffer, const size_t len)
|
|
{
|
|
if (priority <= CGameArg.DbgVerbose)
|
|
{
|
|
typename con_priority_wrapper::scratch_buffer<CON_LINE_LENGTH> scratch_buffer;
|
|
auto &&b = priority.prepare_buffer(scratch_buffer, std::span<char>{buffer, len});
|
|
con_force_puts(priority, b);
|
|
}
|
|
}
|
|
|
|
void con_puts(const con_priority_wrapper priority, const char *const buffer, const size_t len)
|
|
{
|
|
if (priority <= CGameArg.DbgVerbose)
|
|
{
|
|
typename con_priority_wrapper::scratch_buffer<CON_LINE_LENGTH> scratch_buffer;
|
|
auto &&b = priority.prepare_buffer(scratch_buffer, std::span<const char>{buffer, len});
|
|
/* add given string to con_buffer */
|
|
con_add_buffer_line(priority, b);
|
|
con_print_file(b.data());
|
|
}
|
|
}
|
|
|
|
namespace {
|
|
|
|
static color_palette_index get_console_color_by_priority(const int priority)
|
|
{
|
|
int r, g, b;
|
|
switch (priority)
|
|
{
|
|
case CON_CRITICAL:
|
|
r = 28 * 2, g = 0 * 2, b = 0 * 2;
|
|
break;
|
|
case CON_URGENT:
|
|
r = 54 * 2, g = 54 * 2, b = 0 * 2;
|
|
break;
|
|
case CON_DEBUG:
|
|
case CON_VERBOSE:
|
|
r = 14 * 2, g = 14 * 2, b = 14 * 2;
|
|
break;
|
|
case CON_HUD:
|
|
r = 0 * 2, g = 28 * 2, b = 0 * 2;
|
|
break;
|
|
default:
|
|
r = 255 * 2, g = 255 * 2, b = 255 * 2;
|
|
break;
|
|
}
|
|
return gr_find_closest_color(r, g, b);
|
|
}
|
|
|
|
static void con_draw(grs_canvas &canvas)
|
|
{
|
|
int i = 0, y = 0;
|
|
|
|
if (con_size <= 0)
|
|
return;
|
|
|
|
auto &game_font = *GAME_FONT;
|
|
gr_set_curfont(canvas, game_font);
|
|
const uint8_t color = BM_XRGB(0, 0, 0);
|
|
gr_settransblend(canvas, gr_fade_level{7}, gr_blend::normal);
|
|
const auto &&fspacy1 = FSPACY(1);
|
|
const auto &&line_spacing = LINE_SPACING(*canvas.cv_font, *GAME_FONT);
|
|
y = fspacy1 + (line_spacing * con_size);
|
|
gr_rect(canvas, 0, 0, SWIDTH, y, color);
|
|
gr_settransblend(canvas, GR_FADE_OFF, gr_blend::normal);
|
|
i+=con_scroll_offset;
|
|
|
|
gr_set_fontcolor(canvas, BM_XRGB(255, 255, 255), -1);
|
|
y = cli_draw(y, line_spacing);
|
|
|
|
const auto &&fspacx = FSPACX();
|
|
const auto &&fspacx1 = fspacx(1);
|
|
for (;;)
|
|
{
|
|
auto &b = con_buffer[CON_LINES_MAX - 1 - i];
|
|
gr_set_fontcolor(canvas, get_console_color_by_priority(b.priority), -1);
|
|
const auto &&[w, h] = gr_get_string_size(game_font, b.line.data());
|
|
y -= h + fspacy1;
|
|
gr_string(canvas, game_font, fspacx1, y, b.line.data(), w, h);
|
|
i++;
|
|
|
|
if (y<=0 || CON_LINES_MAX-1-i <= 0 || i < 0)
|
|
break;
|
|
}
|
|
gr_rect(canvas, 0, 0, SWIDTH, line_spacing, color);
|
|
gr_set_fontcolor(canvas, BM_XRGB(255, 255, 255),-1);
|
|
gr_printf(canvas, game_font, fspacx1, fspacy1, "%s LOG", DESCENT_VERSION);
|
|
gr_string(canvas, game_font, SWIDTH - fspacx(110), fspacy1, "PAGE-UP/DOWN TO SCROLL");
|
|
}
|
|
|
|
window_event_result console_window::event_handler(const d_event &event)
|
|
{
|
|
int key;
|
|
static fix64 last_scroll_time = 0;
|
|
|
|
switch (event.type)
|
|
{
|
|
case EVENT_WINDOW_ACTIVATED:
|
|
key_toggle_repeat(1);
|
|
break;
|
|
|
|
case EVENT_WINDOW_DEACTIVATED:
|
|
key_toggle_repeat(0);
|
|
con_size = 0;
|
|
con_state = CON_STATE_CLOSED;
|
|
break;
|
|
|
|
case EVENT_KEY_COMMAND:
|
|
key = event_key_get(event);
|
|
switch (key)
|
|
{
|
|
case KEY_SHIFTED + KEY_ESC:
|
|
switch (con_state)
|
|
{
|
|
case CON_STATE_OPEN:
|
|
case CON_STATE_OPENING:
|
|
con_state = CON_STATE_CLOSING;
|
|
break;
|
|
case CON_STATE_CLOSED:
|
|
case CON_STATE_CLOSING:
|
|
con_state = CON_STATE_OPENING;
|
|
default:
|
|
break;
|
|
}
|
|
break;
|
|
case KEY_PAGEUP:
|
|
con_scroll_offset+=CON_SCROLL_OFFSET;
|
|
if (con_scroll_offset >= CON_LINES_MAX-1)
|
|
con_scroll_offset = CON_LINES_MAX-1;
|
|
while (con_buffer[CON_LINES_MAX-1-con_scroll_offset].line[0]=='\0')
|
|
con_scroll_offset--;
|
|
break;
|
|
case KEY_PAGEDOWN:
|
|
con_scroll_offset-=CON_SCROLL_OFFSET;
|
|
if (con_scroll_offset<0)
|
|
con_scroll_offset=0;
|
|
break;
|
|
case KEY_CTRLED + KEY_A:
|
|
case KEY_HOME: cli_cursor_home(); break;
|
|
case KEY_END:
|
|
case KEY_CTRLED + KEY_E: cli_cursor_end(); break;
|
|
case KEY_CTRLED + KEY_C: cli_clear(); break;
|
|
case KEY_LEFT: cli_cursor_left(); break;
|
|
case KEY_RIGHT: cli_cursor_right(); break;
|
|
case KEY_BACKSP: cli_cursor_backspace(); break;
|
|
case KEY_CTRLED + KEY_D:
|
|
case KEY_DELETE: cli_cursor_del(); break;
|
|
case KEY_UP: cli_history_prev(); break;
|
|
case KEY_DOWN: cli_history_next(); break;
|
|
case KEY_TAB: cli_autocomplete(); break;
|
|
case KEY_ENTER: cli_execute(); break;
|
|
case KEY_INSERT:
|
|
cli_toggle_overwrite_mode();
|
|
break;
|
|
default:
|
|
int character = key_ascii();
|
|
if (character == 255)
|
|
break;
|
|
cli_add_character(character);
|
|
break;
|
|
}
|
|
return window_event_result::handled;
|
|
|
|
case EVENT_WINDOW_DRAW:
|
|
timer_delay2(50);
|
|
if (con_state == CON_STATE_OPENING)
|
|
{
|
|
if (con_size < CON_LINES_ONSCREEN && timer_query() >= last_scroll_time+(F1_0/30))
|
|
{
|
|
last_scroll_time = timer_query();
|
|
if (++ con_size >= CON_LINES_ONSCREEN)
|
|
con_state = CON_STATE_OPEN;
|
|
}
|
|
}
|
|
else if (con_state == CON_STATE_CLOSING)
|
|
{
|
|
if (con_size > 0 && timer_query() >= last_scroll_time+(F1_0/30))
|
|
{
|
|
last_scroll_time = timer_query();
|
|
if (! -- con_size)
|
|
con_state = CON_STATE_CLOSED;
|
|
}
|
|
}
|
|
con_draw(grd_curscreen->sc_canvas);
|
|
if (con_state == CON_STATE_CLOSED)
|
|
{
|
|
return window_event_result::close;
|
|
}
|
|
break;
|
|
case EVENT_WINDOW_CLOSE:
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
|
|
return window_event_result::ignored;
|
|
}
|
|
|
|
}
|
|
|
|
void con_init(void)
|
|
{
|
|
con_buffer = {};
|
|
if (CGameArg.DbgSafelog)
|
|
gamelog_fp.reset(PHYSFS_openWrite("gamelog.txt"));
|
|
else
|
|
gamelog_fp = PHYSFSX_openWriteBuffered("gamelog.txt").first;
|
|
|
|
cli_init();
|
|
cmd_init();
|
|
cvar_init();
|
|
}
|
|
|
|
}
|
|
|
|
namespace dsx {
|
|
|
|
void con_showup(control_info &Controls)
|
|
{
|
|
game_flush_inputs(Controls);
|
|
con_state = CON_STATE_OPENING;
|
|
auto wind = window_create<console_window>(grd_curscreen->sc_canvas, 0, 0, SWIDTH, SHEIGHT);
|
|
(void)wind;
|
|
}
|
|
|
|
}
|