quakeforge/libs/console/bi_inputline.c
Bill Currie 973ae0ad54 [gamecode] Add PR_Shutdown for tearing down a VM
This is meant for a "permanent" tear-down before freeing the memory
holding the VM state or at program shutdown. As a consequence, builtin
sub-systems registering resources are now required to pass a "destroy"
function pointer that will be called just before the memory holding
those resources is freed by the VM resource manager (ie, the manager
owns the resource memory block, but each subsystem is responsible for
cleaning up any resources held within that block).

This even enhances thread-safety in rua_obj (there are some problems
with cmd, cvar, and gib).
2022-05-12 19:58:18 +09:00

358 lines
8.4 KiB
C

/*
bi_inputline.c
CSQC inputline builtins
Copyright (C) 1996-1997 Id Software, Inc.
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to:
Free Software Foundation, Inc.
59 Temple Place - Suite 330
Boston, MA 02111-1307, USA
*/
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
#include <stdlib.h>
#ifdef HAVE_STRING_H
# include <string.h>
#endif
#ifdef HAVE_STRINGS_H
# include <strings.h>
#endif
#include "QF/csqc.h"
#include "QF/draw.h"
#include "QF/progs.h"
#include "QF/sys.h"
#include "QF/zone.h"
#include "QF/ui/inputline.h"
typedef struct il_data_s {
struct il_data_s *next;
struct il_data_s **prev;
inputline_t *line;
progs_t *pr;
pr_func_t enter; // enter key callback
pr_ptr_t data[2]; // allow two data params for the callback
int method; // true if method rather than function
} il_data_t;
typedef struct {
PR_RESMAP (il_data_t) line_map;
il_data_t *lines;
void (*draw)(inputline_t *il);
} il_resources_t;
static il_data_t *
il_data_new (il_resources_t *res)
{
return PR_RESNEW (res->line_map);
}
static void
il_data_free (il_resources_t *res, il_data_t *line)
{
PR_RESFREE (res->line_map, line);
}
static void
il_data_reset (il_resources_t *res)
{
PR_RESRESET (res->line_map);
}
static inline il_data_t *
il_data_get (il_resources_t *res, unsigned index)
{
return PR_RESGET (res->line_map, index);
}
static inline int __attribute__((pure))
il_data_index (il_resources_t *res, il_data_t *line)
{
return PR_RESINDEX (res->line_map, line);
}
static void
bi_il_clear (progs_t *pr, void *_res)
{
il_resources_t *res = (il_resources_t *)_res;
il_data_t *line;
for (line = res->lines; line; line = line->next)
Con_DestroyInputLine (line->line);
res->lines = 0;
il_data_reset (res);
}
static void
bi_il_destroy (progs_t *pr, void *_res)
{
}
static il_data_t * __attribute__((pure))
get_inputline (progs_t *pr, il_resources_t *res, int arg, const char *func)
{
il_data_t *line = il_data_get (res, arg);
// line->prev will be null if the handle is unallocated
if (!line || !line->prev)
PR_RunError (pr, "invalid inputline: passed to %s", func);
return line;
}
static void
bi_inputline_enter (inputline_t *il)
{
il_data_t *data = (il_data_t *) il->user_data;
progs_t *pr = data->pr;
const char *line = il->line;
if (!data->enter)
return; // no callback defined
PR_PushFrame (pr);
PR_RESET_PARAMS (pr);
if (data->method) {
P_POINTER (pr, 0) = data->data[0];
P_POINTER (pr, 1) = data->data[1];
P_STRING (pr, 2) = PR_SetTempString (pr, line);
pr->pr_argc = 3;
} else {
P_STRING (pr, 0) = PR_SetTempString (pr, line);
P_POINTER (pr, 1) = data->data[0];
pr->pr_argc = 2;
}
PR_ExecuteProgram (pr, data->enter);
PR_PopFrame (pr);
}
static void
bi_InputLine_Create (progs_t *pr, void *_res)
{
il_resources_t *res = _res;
il_data_t *data;
inputline_t *line;
int lines = P_INT (pr, 0);
int size = P_INT (pr, 1);
int prompt = P_INT (pr, 2);
line = Con_CreateInputLine (lines, size, prompt);
if (!line) {
Sys_Printf ("failed to create inputline\n");
R_INT (pr) = 0;
return;
}
data = il_data_new (res);
if (!data) {
Con_DestroyInputLine (line);
Sys_Printf ("out of resources\n");
R_INT (pr) = 0;
return;
}
data->next = res->lines;
data->prev = &res->lines;
if (res->lines)
res->lines->prev = &data->next;
res->lines = data;
data->line = line;
data->pr = pr;
line->draw = res->draw;
line->enter = bi_inputline_enter;
line->user_data = data;
R_INT (pr) = il_data_index (res, data);
}
static void
bi_InputLine_SetPos (progs_t *pr, void *_res)
{
il_resources_t *res = _res;
il_data_t *line = get_inputline (pr, res, P_INT (pr, 0),
"InputLine_SetPos");
line->line->x = P_INT (pr, 1);
line->line->y = P_INT (pr, 2);
}
static void
bi_InputLine_SetCursor (progs_t *pr, void *_res)
{
il_resources_t *res = _res;
il_data_t *line = get_inputline (pr, res, P_INT (pr, 0),
"InputLine_SetCursor");
line->line->cursor = P_INT (pr, 1);
}
static void
bi_InputLine_SetEnter (progs_t *pr, void *_res)
{
il_resources_t *res = _res;
il_data_t *line = get_inputline (pr, res, P_INT (pr, 0),
"InputLine_SetEnter");
line->data[1] = 0;
//FIXME look up implementation here?
if (pr->pr_argc == 4) {
line->enter = P_FUNCTION (pr, 1); // implementation
line->data[0] = P_POINTER (pr, 2); // object
line->data[1] = P_POINTER (pr, 3); // selector
line->method = 1;
} else {
line->enter = P_FUNCTION (pr, 1); // function
line->data[0] = P_POINTER (pr, 2); // data
line->data[1] = 0;
line->method = 0;
}
}
static void
bi_InputLine_SetWidth (progs_t *pr, void *_res)
{
il_resources_t *res = _res;
il_data_t *line = get_inputline (pr, res, P_INT (pr, 0),
"InputLine_SetWidth");
int width = P_INT (pr, 1);
line->line->width = width;
}
static void
bi_InputLine_Destroy (progs_t *pr, void *_res)
{
il_resources_t *res = _res;
il_data_t *line = get_inputline (pr, res, P_INT (pr, 0),
"InputLine_Destroy");
Con_DestroyInputLine (line->line);
*line->prev = line->next;
if (line->next)
line->next->prev = line->prev;
il_data_free (res, line);
}
static void
bi_InputLine_Clear (progs_t *pr, void *_res)
{
il_resources_t *res = _res;
il_data_t *line = get_inputline (pr, res, P_INT (pr, 0),
"InputLine_Clear");
int save = P_INT (pr, 1);
Con_ClearTyping (line->line, save);
}
static void
bi_InputLine_Process (progs_t *pr, void *_res)
{
il_resources_t *res = _res;
il_data_t *line = get_inputline (pr, res, P_INT (pr, 0),
"InputLine_Process");
int ch = P_INT (pr, 1);
Con_ProcessInputLine (line->line, ch);
}
/*
bi_InputLine_SetText
Sets the inputline to a specified text
*/
static void
bi_InputLine_SetText (progs_t *pr, void *_res)
{
il_resources_t *res = _res;
il_data_t *line = get_inputline (pr, res, P_INT (pr, 0),
"InputLine_SetText");
const char *str = P_GSTRING (pr, 1);
inputline_t *il = line->line;
/* this was segfault trap:
il->lines[il->edit_line][0] is promt character
*/
strncpy(il->lines[il->edit_line] + 1,str,il->line_size - 1);
il->lines[il->edit_line][il->line_size-1] = '\0';
}
/*
bi_InputLine_GetText
Gets the text from a inputline
*/
static void
bi_InputLine_GetText (progs_t *pr, void *_res)
{
il_resources_t *res = _res;
il_data_t *line = get_inputline (pr, res, P_INT (pr, 0),
"InputLine_GetText");
inputline_t *il = line->line;
RETURN_STRING(pr, il->lines[il->edit_line]+1);
}
static void
bi_InputLine_Draw (progs_t *pr, void *_res)
{
il_resources_t *res = _res;
il_data_t *line = get_inputline (pr, res, P_INT (pr, 0),
"InputLine_Draw");
line->line->draw (line->line);
}
#define bi(x,np,params...) {#x, bi_##x, -1, np, {params}}
#define p(type) PR_PARAM(type)
static builtin_t builtins[] = {
bi(InputLine_Create, 3, p(int), p(int), p(int)),
bi(InputLine_SetPos, 3, p(ptr), p(int), p(int)),
bi(InputLine_SetCursor, 2, p(ptr), p(int)),
{"InputLine_SetEnter|^{tag _inputline_t=}(v*^v)^v",
bi_InputLine_SetEnter, -1, 3, {p(ptr), p(func), p(ptr)}},
{"InputLine_SetEnter|^{tag _inputline_t=}(@@:.)@:",
bi_InputLine_SetEnter, -1, 4, {p(ptr), p(func), p(ptr), p(ptr)}},
bi(InputLine_SetWidth, 2, p(ptr), p(int)),
bi(InputLine_SetText, 2, p(ptr), p(string)),
bi(InputLine_GetText, 1, p(ptr)),
bi(InputLine_Destroy, 1, p(ptr)),
bi(InputLine_Clear, 2, p(ptr), p(int)),
bi(InputLine_Process, 2, p(ptr), p(int)),
bi(InputLine_Draw, 1, p(ptr)),
{0}
};
VISIBLE void
InputLine_Progs_Init (progs_t *pr)
{
il_resources_t *res = calloc (1, sizeof (il_resources_t));
PR_Resources_Register (pr, "InputLine", res, bi_il_clear, bi_il_destroy);
PR_RegisterBuiltins (pr, builtins, res);
}
VISIBLE void
InputLine_Progs_SetDraw (progs_t *pr, void (*draw)(inputline_t *))
{
il_resources_t *res = PR_Resources_Find (pr, "InputLine");
res->draw = draw;
}