cvar.h

Go to the documentation of this file.

/*
Copyright (C) 1997-2001 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 the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

*/

#pragma once

#include "../shared/shared.h"
#include "../common/scripts_lua.h"

#define CVAR_ARCHIVE    1       
#define CVAR_USERINFO   2       
#define CVAR_SERVERINFO 4       
#define CVAR_NOSET      8       
#define CVAR_LATCH      16      
#define CVAR_DEVELOPER  32      
#define CVAR_CHEAT      64      
#define CVAR_R_IMAGES   128     
#define CVAR_R_CONTEXT  256     
#define CVAR_R_PROGRAMS 512     
#define CVAR_R_MASK (CVAR_R_IMAGES | CVAR_R_CONTEXT | CVAR_R_PROGRAMS)

typedef void (*cvarChangeListenerFunc_t) (const char* cvarName, const char* oldValue, const char* newValue, void* data);

typedef struct cvarChangeListener_s {
    cvarChangeListenerFunc_t exec;
    struct cvarChangeListener_s* next;
    void* data;
} cvarChangeListener_t;

typedef struct cvar_s {
    char* name;             
    char* string;           
    char* latchedString;    
    char* defaultString;    
    char* oldString;        
    char* description;      
    int flags;              
    bool modified;          
    float value;            
    int integer;            
    bool (*check) (struct cvar_s* cvar);    
    cvarChangeListener_t* changeListener;
    struct cvar_s* next;
    struct cvar_s* prev;
    struct cvar_s* hash_next;
} cvar_t;

typedef struct cvarList_s {
    const char* name;
    const char* value;
} cvarList_t;

class CvarListener {
public:
    virtual ~CvarListener() {}
    virtual void onCreate (const struct cvar_s* cvar) = 0;
    virtual void onDelete (const struct cvar_s* cvar) = 0;
};

typedef SharedPtr<CvarListener> CvarListenerPtr;

cvar_t* Cvar_GetFirst(void);

cvar_t* Cvar_Get(const char* varName, const char* value = "", int flags = 0, const char* desc = nullptr);

cvar_t* Cvar_Set(const char* varName, const char* value, ...) __attribute__((format(__printf__, 2, 3)));

cvar_t* Cvar_ForceSet(const char* varName, const char* value);

cvar_t* Cvar_FullSet(const char* varName, const char* value, int flags);

void Cvar_SetValue(const char* varName, float value);

int Cvar_GetInteger(const char* varName);

float Cvar_GetValue(const char* varName);

const char* Cvar_GetString(const char* varName);

const char* Cvar_VariableStringOld(const char* varName);

int Cvar_CompleteVariable(const char* partial, const char** match);

void Cvar_UpdateLatchedVars(void);

bool Cvar_Command(void);

void Cvar_Init(void);
void Cvar_Shutdown(void);

const char* Cvar_Userinfo(char* info, size_t infoSize);

const char* Cvar_Serverinfo(char* info, size_t infoSize);

bool Cvar_AssertValue(cvar_t* cvar, float minVal, float maxVal, bool shouldBeIntegral);

bool Cvar_SetCheckFunction(const char* varName, bool (*check) (cvar_t* cvar));

cvarChangeListener_t* Cvar_RegisterChangeListener(const char* varName, cvarChangeListenerFunc_t listenerFunc);

void Cvar_UnRegisterChangeListener(const char* varName, cvarChangeListenerFunc_t listenerFunc);

void Cvar_RegisterCvarListener(CvarListenerPtr listener);

void Cvar_UnRegisterCvarListener(CvarListenerPtr listener);

void Cvar_FixCheatVars(void);

bool Cvar_Delete(const char* varName);

cvar_t* Cvar_FindVar(const char* varName);

bool Cvar_PendingCvars(int flags);

void Com_SetUserinfoModified(bool modified);

bool Com_IsUserinfoModified(void);

void Com_SetRenderModified(bool modified);

bool Com_IsRenderModified(void);

void Cvar_ClearVars(int flags);

void Cvar_Reset(cvar_t* cvar);

#ifdef DEBUG
void Cvar_PrintDebugCvars(void);
#endif