cvar.qh File Reference

#include "nil.qh"
#include "progname.qh"
#include "static.qh"

Include dependency graph for cvar.qh:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	__AUTOCVAR(file, archive, var, type, desc, default)
#define	_AUTOCVAR(...)
#define	AUTOCVAR(...)
#define	AUTOCVAR_5(file, archive, var, type, desc)
#define	AUTOCVAR_6(file, archive, var, type, default, desc)
#define	AUTOCVAR_SAVE(...)
#define	BINOP(op, len, expr)
#define	EVAL__AUTOCVAR(...)
#define	repr_cvar_bool(x)
#define	repr_cvar_float(x)
#define	repr_cvar_int(x)
#define	repr_cvar_string(x)
#define	repr_cvar_vector(x)
#define	X(expr)

Functions
ERASEABLE bool	cvar_value_issafe (string s)
ERASEABLE bool	expr_evaluate (string s)
	Evaluate an expression of the form: [+ | -]?
ERASEABLE string	MakeConsoleSafe (string input)
	Escape the string to make it safe for consoles.
ERASEABLE void	RegisterCvars (void(string name, string def, string desc, bool archive, string file) f)
ERASEABLE void	RegisterCvars_Save (string name, string def, string desc, bool archive, string file)
ERASEABLE void	RegisterCvars_Set (string name, string def, string desc, bool archive, string file)
	STATIC_INIT_LATE (Cvars)

Variables
const noref bool	default_bool = false
const noref float	default_float = 0
const noref int	default_int = 0
const noref string	default_string = ""
const noref vector	default_vector = '0 0 0'
int	RegisterCvars_Save_fd

Macro Definition Documentation

__AUTOCVAR

#define __AUTOCVAR	(		file,
			archive,
			var,
			type,
			desc,
			default )

Value:

ACCUMULATE void RegisterCvars(void(string, string, string, bool, string) f) \
{ \
    f( #var, repr_cvar_##type(default), desc, archive, file); \
} \
type autocvar_##var = default

Definition at line 151 of file cvar.qh.

#define __AUTOCVAR(file, archive, var, type, desc, default) \
    ACCUMULATE void RegisterCvars(void(string, string, string, bool, string) f) \
    { \
        f( #var, repr_cvar_##type(default), desc, archive, file); \
    } \
    type autocvar_##var = default

_AUTOCVAR

#define _AUTOCVAR

(

...

)

Value:

EVAL__AUTOCVAR(OVERLOAD(AUTOCVAR, __FILE__, __VA_ARGS__))

Definition at line 161 of file cvar.qh.

AUTOCVAR

#define AUTOCVAR

(

...

)

Value:

_AUTOCVAR(false, __VA_ARGS__)

Definition at line 164 of file cvar.qh.

AUTOCVAR_5

#define AUTOCVAR_5	(		file,
			archive,
			var,
			type,
			desc )

Value:

__AUTOCVAR(file, archive, var, type, desc, default_##type)

Definition at line 157 of file cvar.qh.

#define AUTOCVAR_5(file, archive, var, type, desc) \
    __AUTOCVAR(file, archive, var, type, desc, default_##type)

AUTOCVAR_6

#define AUTOCVAR_6	(		file,
			archive,
			var,
			type,
			default,
			desc )

Value:

__AUTOCVAR(file, archive, var, type, desc, default)

Definition at line 159 of file cvar.qh.

#define AUTOCVAR_6(file, archive, var, type, default, desc) \
    __AUTOCVAR(file, archive, var, type, desc, default)

AUTOCVAR_SAVE

#define AUTOCVAR_SAVE

(

...

)

Value:

_AUTOCVAR(true, __VA_ARGS__)

Definition at line 163 of file cvar.qh.

BINOP

#define BINOP	(		op,
			len,
			expr )

Value:

if ((o = strstrofs(s, op, 0)) >= 0) \
{ \
    k = substring(s, 0, o); \
    v = substring(s, o + len, -1); \
    X(expr); \
}

Referenced by expr_evaluate().

EVAL__AUTOCVAR

#define EVAL__AUTOCVAR

(

...

)

Value:

__VA_ARGS__

Definition at line 162 of file cvar.qh.

repr_cvar_bool

#define repr_cvar_bool

(

x

)

Value:

((x) ? "1" : "0")

Definition at line 139 of file cvar.qh.

repr_cvar_float

#define repr_cvar_float

(

x

)

Value:

(ftos(x))

Definition at line 141 of file cvar.qh.

repr_cvar_int

#define repr_cvar_int

(

x

)

Value:

(itos(x))

Definition at line 140 of file cvar.qh.

repr_cvar_string

#define repr_cvar_string

(

x

)

Value:

(x)

Definition at line 142 of file cvar.qh.

repr_cvar_vector

#define repr_cvar_vector

(

x

)

Value:

(sprintf("%v", x))

Definition at line 143 of file cvar.qh.

X

#define X

(

expr

)

Value:

if (expr) \
    continue; \
expr_fail = true; \
break

Referenced by expr_evaluate().

Function Documentation

cvar_value_issafe()

ERASEABLE bool cvar_value_issafe

(

string

s

)

Definition at line 11 of file cvar.qh.

{
    if (strstrofs(s, "\"", 0) >= 0)  return false;
    if (strstrofs(s, "\\", 0) >= 0)  return false;
    if (strstrofs(s, ";",  0) >= 0)  return false;
    if (strstrofs(s, "$",  0) >= 0)  return false;
    if (strstrofs(s, "\r", 0) >= 0)  return false;
    if (strstrofs(s, "\n", 0) >= 0)  return false;
    return true;
}

References strstrofs.

Referenced by _MapInfo_Parse_Settemp(), InitGameplayMode(), MapInfo_Get_ByName_NoFallbacks(), and spawnfunc().

expr_evaluate()

ERASEABLE bool expr_evaluate

(

string

s

)

Evaluate an expression of the form: [+ | -]?

[var[op]val | [op]var | val | var] ... +: all must match. this is the default -: one must NOT match

var>x var<x var>=x var<=x var==x var!=x var===x var!==x

Definition at line 48 of file cvar.qh.

{
    bool ret = false;
    if (str2chr(s, 0) == '+')
        s = substring(s, 1, -1);
    else if (str2chr(s, 0) == '-')
    {
        ret = true;
        s = substring(s, 1, -1);
    }
    bool expr_fail = false;
    for (int i = 0, n = tokenize_console(s); i < n; ++i)
    {
        int o;
        string k, v;
        s = argv(i);
        #define X(expr) \
            if (expr) \
                continue; \
            expr_fail = true; \
            break
 
        #define BINOP(op, len, expr) \
            if ((o = strstrofs(s, op, 0)) >= 0) \
            { \
                k = substring(s, 0, o); \
                v = substring(s, o + len, -1); \
                X(expr); \
            }
        BINOP(">=",  2, cvar(k) >= stof(v))
        BINOP("<=",  2, cvar(k) <= stof(v))
        BINOP(">",   1, cvar(k) >  stof(v))
        BINOP("<",   1, cvar(k) <  stof(v))
        BINOP("==",  2, cvar(k) == stof(v))
        BINOP("!=",  2, cvar(k) != stof(v))
        BINOP("===", 3, cvar_string(k) == v)
        BINOP("!==", 3, cvar_string(k) != v)
        {
            k = s;
            bool b = true;
            if (str2chr(k, 0) == '!')
            {
                k = substring(s, 1, -1);
                b = false;
            }
            float f = stof(k);
            X(boolean((ftos(f) == k) ? f : cvar(k)) == b);
        }
        #undef BINOP
        #undef X
    }
    if (!expr_fail)
        ret = !ret;
    // now ret is true if we want to keep the item, and false if we want to get rid of it
    return ret;
}

References argv(), BINOP, cvar(), cvar_string(), ftos(), stof(), str2chr, substring(), tokenize_console, and X.

Referenced by SV_OnEntityPreSpawnFunction().

MakeConsoleSafe()

ERASEABLE string MakeConsoleSafe

(

string

input

)

Escape the string to make it safe for consoles.

Definition at line 24 of file cvar.qh.

{
    input = strreplace("\n", "", input);
    input = strreplace("\\", "\\\\", input);
    input = strreplace("$", "$$", input);
    input = strreplace("\"", "\\\"", input);
    return input;
}

Referenced by GameCommand_adminmsg(), Local_Notification(), Local_Notification_centerprint_Add(), Local_Notification_HUD_Notify_Push(), Local_Notification_sprintf(), net_handle_ServerWelcome(), RegisterCvars_Set(), Send_Notification(), Send_Notification_Core(), and Welcome_Message_Show_Try().

RegisterCvars()

ERASEABLE void RegisterCvars

(

void(string name, string def, string desc, bool archive, string file)

f

)

Definition at line 8 of file cvar.qh.

{}

References name.

Referenced by STATIC_INIT_LATE().

RegisterCvars_Save()

ERASEABLE void RegisterCvars_Save	(	string	name,
		string	def,
		string	desc,
		bool	archive,
		string	file )

Definition at line 115 of file cvar.qh.

{
    if (!archive)
        return;
    fputs(RegisterCvars_Save_fd, sprintf("seta %s \"%s\"\n", name, def));
}

References fputs(), name, and RegisterCvars_Save_fd.

Referenced by STATIC_INIT_LATE().

RegisterCvars_Set()

ERASEABLE void RegisterCvars_Set	(	string	name,
		string	def,
		string	desc,
		bool	archive,
		string	file )

Definition at line 106 of file cvar.qh.

{
    localcmd(sprintf("\nset %1$s \"$%1$s\" \"%2$s\"\n", name, MakeConsoleSafe(desc)));
    if (archive)
        localcmd(sprintf("\nseta %1$s \"$%1$s\"\n", name));
}

References localcmd(), MakeConsoleSafe(), and name.

Referenced by STATIC_INIT_LATE().

STATIC_INIT_LATE()

STATIC_INIT_LATE

(

Cvars

)

Definition at line 122 of file cvar.qh.

{
    RegisterCvars(RegisterCvars_Set);
    RegisterCvars_Save_fd = fopen(sprintf("default%s.cfg", PROGNAME), FILE_WRITE);
    if (RegisterCvars_Save_fd >= 0)
    {
        RegisterCvars(RegisterCvars_Save);
        fclose(RegisterCvars_Save_fd);
    }
}

References fclose(), FILE_WRITE, fopen(), PROGNAME, RegisterCvars(), RegisterCvars_Save(), RegisterCvars_Save_fd, and RegisterCvars_Set().

Variable Documentation

default_bool

const noref bool default_bool = false

Definition at line 133 of file cvar.qh.

default_float

const noref float default_float = 0

Definition at line 135 of file cvar.qh.

default_int

const noref int default_int = 0

Definition at line 134 of file cvar.qh.

default_string

const noref string default_string = ""

Definition at line 136 of file cvar.qh.

default_vector

const noref vector default_vector = '0 0 0'

Definition at line 137 of file cvar.qh.

RegisterCvars_Save_fd

int RegisterCvars_Save_fd

Definition at line 113 of file cvar.qh.

Referenced by RegisterCvars_Save(), and STATIC_INIT_LATE().