/*
Copyright (C) 1996-1997 Id Software, Inc.
+Copyright (C) 2006-2021 DarkPlaces contributors
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
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.
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.
#ifndef CVAR_H
#define CVAR_H
-// cvar flags
-#define CVAR_SAVE 1
-#define CVAR_NOTIFY 2
-
-/*
-// type of a cvar for menu purposes
-#define CVARMENUTYPE_FLOAT 1
-#define CVARMENUTYPE_INTEGER 2
-#define CVARMENUTYPE_SLIDER 3
-#define CVARMENUTYPE_BOOL 4
-#define CVARMENUTYPE_STRING 5
-#define CVARMENUTYPE_OPTION 6
-
-// which menu to put a cvar in
-#define CVARMENU_GRAPHICS 1
-#define CVARMENU_SOUND 2
-#define CVARMENU_INPUT 3
-#define CVARMENU_NETWORK 4
-#define CVARMENU_SERVER 5
-
-#define MAX_CVAROPTIONS 16
-
-typedef struct
-{
- int value;
- const char *name;
-}
-cvaroption_t;
-
-typedef struct
-{
- int type;
- float valuemin, valuemax, valuestep;
- int numoptions;
- cvaroption_t optionlist[MAX_CVAROPTIONS];
-}
-menucvar_t;
-*/
+#include "qtypes.h"
+#include "qdefs.h"
+struct cmd_state_s;
+struct qfile_s;
typedef struct cvar_s
{
int flags;
- char *name;
- char *string;
+
+ const char *name;
+
+ const char *string;
+ const char *description;
int integer;
float value;
float vector[3];
- //menucvar_t menuinfo;
+
+ const char *defstring;
+
+ void (*callback)(struct cvar_s *var);
+
+ char **aliases;
+ int aliasindex;
+
+ struct cvar_s *initstate; // snapshot of cvar during init
+
+ int globaldefindex[3];
+ int globaldefindex_stringno[3];
+
struct cvar_s *next;
} cvar_t;
-/*
-void Cvar_MenuSlider(cvar_t *variable, int menu, float slider_min, float slider_max, float slider_step);
-void Cvar_MenuBool(cvar_t *variable, int menu, const char *name_false, const char *name_true);
-void Cvar_MenuFloat(cvar_t *variable, int menu, float range_min, float range_max);
-void Cvar_MenuInteger(cvar_t *variable, int menu, int range_min, int range_max);
-void Cvar_MenuString(cvar_t *variable, int menu);
-void Cvar_MenuOption(cvar_t *variable, int menu, int value[16], const char *name[16]);
-*/
+typedef struct cvar_hash_s
+{
+ cvar_t *cvar;
+ struct cvar_hash_s *next;
+} cvar_hash_t;
+
+typedef struct cvar_state_s
+{
+ cvar_t *vars;
+ cvar_hash_t *hashtable[CVAR_HASHSIZE];
+}
+cvar_state_t;
+
+extern cvar_state_t cvars_all;
+extern cvar_state_t cvars_null; // used by cmd_serverfromclient which intentionally has no cvars available
+
+void Cvar_RegisterAlias(cvar_t *variable, const char *alias );
+
+void Cvar_RegisterCallback(cvar_t *variable, void (*callback)(cvar_t *));
+
+/// registers a cvar that already has the name, string, and optionally the
+/// archive elements set.
+void Cvar_RegisterVariable(cvar_t *variable);
-void Cvar_RegisterVariable (cvar_t *variable);
-// registers a cvar that already has the name, string, and optionally the
-// archive elements set.
+qbool Cvar_Readonly (cvar_t *var, const char *cmd_name);
-void Cvar_Set (const char *var_name, const char *value);
-// equivelant to "<name> <variable>" typed at the console
+void Cvar_Callback(cvar_t *var);
-void Cvar_SetValue (const char *var_name, float value);
-// expands value to a string and calls Cvar_Set
+/// equivelant to "<name> <variable>" typed at the console
+void Cvar_Set (cvar_state_t *cvars, const char *var_name, const char *value);
+
+/// expands value to a string and calls Cvar_Set
+void Cvar_SetValue (cvar_state_t *cvars, const char *var_name, float value);
void Cvar_SetQuick (cvar_t *var, const char *value);
void Cvar_SetValueQuick (cvar_t *var, float value);
-float Cvar_VariableValue (const char *var_name);
+float Cvar_VariableValueOr (cvar_state_t *cvars, const char *var_name, float def, int neededflags);
+// returns def if not defined
+
+float Cvar_VariableValue (cvar_state_t *cvars, const char *var_name, int neededflags);
// returns 0 if not defined or non numeric
-const char *Cvar_VariableString (const char *var_name);
+const char *Cvar_VariableStringOr (cvar_state_t *cvars, const char *var_name, const char *def, int neededflags);
+// returns def if not defined
+
+const char *Cvar_VariableString (cvar_state_t *cvars, const char *var_name, int neededflags);
+// returns an empty string if not defined
+
+const char *Cvar_VariableDefString (cvar_state_t *cvars, const char *var_name, int neededflags);
// returns an empty string if not defined
-const char *Cvar_CompleteVariable (const char *partial);
+const char *Cvar_VariableDescription (cvar_state_t *cvars, const char *var_name, int neededflags);
+// returns an empty string if not defined
+
+const char *Cvar_CompleteVariable (cvar_state_t *cvars, const char *partial, int neededflags);
// attempts to match a partial variable name for command line completion
// returns NULL if nothing fits
-qboolean Cvar_Command (void);
-// called by Cmd_ExecuteString when Cmd_Argv(0) doesn't match a known
+void Cvar_PrintHelp(cvar_t *cvar, const char *name, qbool full);
+
+void Cvar_CompleteCvarPrint (cvar_state_t *cvars, const char *partial, int neededflags);
+
+qbool Cvar_Command (struct cmd_state_s *cmd);
+// called by Cmd_ExecuteString when Cmd_Argv(cmd, 0) doesn't match a known
// command. Returns true if the command was a variable reference that
// was handled. (print or change)
-void Cvar_WriteVariables (QFile *f);
+void Cvar_SaveInitState(cvar_state_t *cvars);
+void Cvar_RestoreInitState(cvar_state_t *cvars);
+
+void Cvar_UnlockDefaults(struct cmd_state_s *cmd);
+void Cvar_LockDefaults_f(struct cmd_state_s *cmd);
+void Cvar_ResetToDefaults_All_f(struct cmd_state_s *cmd);
+void Cvar_ResetToDefaults_NoSaveOnly_f(struct cmd_state_s *cmd);
+void Cvar_ResetToDefaults_SaveOnly_f(struct cmd_state_s *cmd);
+
+void Cvar_WriteVariables (cvar_state_t *cvars, struct qfile_s *f);
// Writes lines containing "set variable value" for all variables
// with the archive flag set to true.
-cvar_t *Cvar_FindVar (const char *var_name);
-cvar_t *Cvar_FindVarAfter (const char *prev_var_name, int neededflags);
+cvar_t *Cvar_FindVar(cvar_state_t *cvars, const char *var_name, int neededflags);
+cvar_t *Cvar_FindVarAfter(cvar_state_t *cvars, const char *prev_var_name, int neededflags);
-int Cvar_CompleteCountPossible (const char *partial);
-const char **Cvar_CompleteBuildList (const char *partial);
+int Cvar_CompleteCountPossible(cvar_state_t *cvars, const char *partial, int neededflags);
+const char **Cvar_CompleteBuildList(cvar_state_t *cvars, const char *partial, int neededflags);
// Added by EvilTypeGuy - functions for tab completion system
// Thanks to Fett erich@heintz.com
// Thanks to taniwha
-void Cvar_List_f (void);
-// Prints a list of Cvars including a count of them to the user console
-// Referenced in cmd.c in Cmd_Init hence it's inclusion here
-// Added by EvilTypeGuy eviltypeguy@qeradiant.com
-// Thanks to Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
+/// Prints a list of Cvars including a count of them to the user console
+/// Referenced in cmd.c in Cmd_Init hence it's inclusion here.
+/// Added by EvilTypeGuy eviltypeguy@qeradiant.com
+/// Thanks to Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
+void Cvar_List_f(struct cmd_state_s *cmd);
+
+void Cvar_Set_f(struct cmd_state_s *cmd);
+void Cvar_SetA_f(struct cmd_state_s *cmd);
+void Cvar_Del_f(struct cmd_state_s *cmd);
+// commands to create new cvars (or set existing ones)
+// seta creates an archived cvar (saved to config)
+
+/// allocates a cvar by name and returns its address,
+/// or merely sets its value if it already exists.
+cvar_t *Cvar_Get(cvar_state_t *cvars, const char *name, const char *value, int flags, const char *newdescription);
+
+extern const char *cvar_dummy_description; // ALWAYS the same pointer
+
+void Cvar_UpdateAllAutoCvars(cvar_state_t *cvars); // updates ALL autocvars of the active prog to the cvar values (savegame loading)
+
+#ifdef FILLALLCVARSWITHRUBBISH
+void Cvar_FillAll_f(cmd_state_t *cmd);
+#endif /* FILLALLCVARSWITHRUBBISH */
#endif
projects / xonotic / darkplaces.git / blobdiff