quakeforge/libs/util/qargs.c
Bill Currie 12c84046f3 [cvar] Make cvars properly typed
This is an extremely extensive patch as it hits every cvar, and every
usage of the cvars. Cvars no longer store the value they control,
instead, they use a cexpr value object to reference the value and
specify the value's type (currently, a null type is used for strings).
Non-string cvars are passed through cexpr, allowing expressions in the
cvars' settings. Also, cvars have returned to an enhanced version of the
original (id quake) registration scheme.

As a minor benefit, relevant code having direct access to the
cvar-controlled variables is probably a slight optimization as it
removed a pointer dereference, and the variables can be located for data
locality.

The static cvar descriptors are made private as an additional safety
layer, though there's nothing stopping external modification via
Cvar_FindVar (which is needed for adding listeners).

While not used yet (partly due to working out the design), cvars can
have a validation function.

Registering a cvar allows a primary listener (and its data) to be
specified: it will always be called first when the cvar is modified. The
combination of proper listeners and direct access to the controlled
variable greatly simplifies the more complex cvar interactions as much
less null checking is required, and there's no need for one cvar's
callback to call another's.

nq-x11 is known to work at least well enough for the demos. More testing
will come.
2022-04-24 19:15:22 +09:00

244 lines
5.7 KiB
C

/*
qargs.c
command line argument processing routines
Copyright (C) 1996-1997 Id Software, Inc.
Copyright (C) 1999,2000 contributors of the QuakeForge project
Please see the file "AUTHORS" for a list of contributors
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
#ifdef HAVE_STRING_H
# include <string.h>
#endif
#ifdef HAVE_STRINGS_H
# include <strings.h>
#endif
#include <ctype.h>
#include <stdlib.h>
#include <assert.h>
#include "QF/cmd.h"
#include "QF/crc.h"
#include "QF/cvar.h"
#include "QF/idparse.h"
#include "QF/qargs.h"
#include "QF/quakefs.h"
#include "QF/qtypes.h"
#include "QF/sys.h"
#include "QF/va.h"
char *fs_globalcfg;
static cvar_t fs_globalcfg_cvar = {
.name = "fs_globalcfg",
.description =
"global configuration file",
.default_value = FS_GLOBALCFG,
.flags = CVAR_ROM,
.value = { .type = 0, .value = &fs_globalcfg },
};
char *fs_usercfg;
static cvar_t fs_usercfg_cvar = {
.name = "fs_usercfg",
.description =
"user configuration file",
.default_value = FS_USERCFG,
.flags = CVAR_ROM,
.value = { .type = 0, .value = &fs_usercfg },
};
static const char **largv;
static const char *argvdummy = " ";
static const char *safeargvs[] =
{ "-stdvid", "-nolan", "-nosound", "-nocdaudio", "-nojoy", "-nomouse",
"-dibonly" };
#define NUM_SAFE_ARGVS ((int) (sizeof(safeargvs)/sizeof(safeargvs[0])))
VISIBLE int com_argc;
VISIBLE const char **com_argv;
const char *com_cmdline;
VISIBLE qboolean nouse = false; // 1999-10-29 +USE fix by Maddes
/*
COM_CheckParm
Returns the position (1 to argc-1) in the program's argument list
where the given parameter apears, or 0 if not present
*/
VISIBLE int
COM_CheckParm (const char *parm)
{
int i;
for (i = 1; i < com_argc; i++) {
if (!com_argv[i])
continue; // NEXTSTEP sometimes clears appkit
// vars.
if (!strcmp (parm, com_argv[i]))
return i;
}
return 0;
}
VISIBLE void
COM_InitArgv (int argc, const char **argv)
{
qboolean safe;
int i, len;
char *cmdline;
safe = false;
largv = (const char **) calloc (1, (argc + NUM_SAFE_ARGVS + 1) *
sizeof (const char *));
for (com_argc = 0, len = 0; com_argc < argc; com_argc++) {
largv[com_argc] = argv[com_argc];
if ((argv[com_argc]) && !strcmp ("-safe", argv[com_argc]))
safe = true;
if (argv[com_argc])
len += strlen (argv[com_argc]) + 1;
}
cmdline = (char *) calloc (1, len + 1); // need strlen(cmdline)+2
cmdline[0] = 0;
if (len) {
for (i = 1; i < argc; i++) {
strncat (cmdline, argv[i], len - strlen (cmdline));
assert (len - strlen (cmdline) > 0);
strncat (cmdline, " ", len - strlen (cmdline));
}
cmdline[len - 1] = '\0';
}
com_cmdline = cmdline;
if (safe) {
// force all the safe-mode switches. Note that we reserved extra space
// in case we need to add these, so we don't need an overflow check
for (i = 0; i < NUM_SAFE_ARGVS; i++) {
largv[com_argc] = safeargvs[i];
com_argc++;
}
}
largv[com_argc] = argvdummy;
com_argv = largv;
if (COM_CheckParm ("-nouse")) {
nouse = true;
}
}
/*
COM_AddParm
Adds the given string at the end of the current argument list
*/
void
COM_AddParm (const char *parm)
{
largv[com_argc++] = parm;
}
void
COM_ParseConfig (cbuf_t *cbuf)
{
// execute +set as early as possible
Cmd_StuffCmds (cbuf);
Cbuf_Execute_Sets (cbuf);
// execute set commands in the global configuration file if it exists
Cvar_Register (&fs_globalcfg_cvar, 0, 0);
Cmd_Exec_File (cbuf, fs_globalcfg, 0);
Cbuf_Execute_Sets (cbuf);
// execute +set again to override the config file
Cmd_StuffCmds (cbuf);
Cbuf_Execute_Sets (cbuf);
// execute set commands in the user configuration file if it exists
Cvar_Register (&fs_usercfg_cvar, 0, 0);
Cmd_Exec_File (cbuf, fs_usercfg, 0);
Cbuf_Execute_Sets (cbuf);
// execute +set again to override the config file
Cmd_StuffCmds (cbuf);
Cbuf_Execute_Sets (cbuf);
}
int
COM_Check_quakerc (const char *cmd, cbuf_t *cbuf)
{
const char *l, *p;
int ret = 0;
QFile *f;
f = QFS_FOpenFile ("quake.rc");
while (f && (l = Qgetline (f))) {
if ((p = strstr (l, cmd))) {
if (p == l) {
if (cbuf) {
Cbuf_AddText (cbuf, l);
}
ret = 1;
break;
}
}
}
Qclose (f);
return ret;
}
void
COM_ExecConfig (cbuf_t *cbuf, int skip_quakerc)
{
// quakeforge.cfg overrides quake.rc as it contains quakeforge-specific
// commands. If it doesn't exist, then this is the first time quakeforge
// has been used in this installation, thus any existing legacy config
// should be used to set up defaults on the assumption that the user has
// things set up to work with another (hopefully compatible) client
if (Cmd_Exec_File (cbuf, "quakeforge.cfg", 1)) {
Cmd_Exec_File (cbuf, fs_usercfg, 0);
Cmd_StuffCmds (cbuf);
COM_Check_quakerc ("startdemos", cbuf);
} else {
if (!skip_quakerc) {
Cbuf_InsertText (cbuf, "exec quake.rc\n");
}
Cmd_Exec_File (cbuf, fs_usercfg, 0);
// Reparse the command line for + commands.
// (sets still done, but it doesn't matter)
// (Note, no non-base commands exist yet)
if (skip_quakerc || !COM_Check_quakerc ("stuffcmds", 0)) {
Cmd_StuffCmds (cbuf);
}
}
}