cvarlist, buf_cvarlist: support wildcards if present (if not present, it's treated...
[xonotic/darkplaces.git] / cvar.c
diff --git a/cvar.c b/cvar.c
index b77fee3..47a5735 100644 (file)
--- a/cvar.c
+++ b/cvar.c
@@ -21,7 +21,10 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 #include "quakedef.h"
 
+char *cvar_dummy_description = "custom cvar";
+
 cvar_t *cvar_vars = NULL;
+cvar_t *cvar_hashtable[65536];
 char *cvar_null_string = "";
 
 /*
@@ -31,10 +34,13 @@ Cvar_FindVar
 */
 cvar_t *Cvar_FindVar (const char *var_name)
 {
+       int hashindex;
        cvar_t *var;
 
-       for (var = cvar_vars;var;var = var->next)
-               if (!strcasecmp (var_name, var->name))
+       // use hash lookup to minimize search time
+       hashindex = CRC_Block((const unsigned char *)var_name, strlen(var_name));
+       for (var = cvar_hashtable[hashindex];var;var = var->nextonhashchain)
+               if (!strcmp (var_name, var->name))
                        return var;
 
        return NULL;
@@ -95,6 +101,36 @@ const char *Cvar_VariableString (const char *var_name)
        return var->string;
 }
 
+/*
+============
+Cvar_VariableDefString
+============
+*/
+const char *Cvar_VariableDefString (const char *var_name)
+{
+       cvar_t *var;
+
+       var = Cvar_FindVar (var_name);
+       if (!var)
+               return cvar_null_string;
+       return var->defstring;
+}
+
+/*
+============
+Cvar_VariableDescription
+============
+*/
+const char *Cvar_VariableDescription (const char *var_name)
+{
+       cvar_t *var;
+
+       var = Cvar_FindVar (var_name);
+       if (!var)
+               return cvar_null_string;
+       return var->description;
+}
+
 
 /*
 ============
@@ -104,7 +140,7 @@ Cvar_CompleteVariable
 const char *Cvar_CompleteVariable (const char *partial)
 {
        cvar_t          *cvar;
-       int                     len;
+       size_t          len;
 
        len = strlen(partial);
 
@@ -131,7 +167,7 @@ const char *Cvar_CompleteVariable (const char *partial)
 int Cvar_CompleteCountPossible (const char *partial)
 {
        cvar_t  *cvar;
-       int             len;
+       size_t  len;
        int             h;
 
        h = 0;
@@ -160,13 +196,13 @@ int Cvar_CompleteCountPossible (const char *partial)
 const char **Cvar_CompleteBuildList (const char *partial)
 {
        const cvar_t *cvar;
-       int len = 0;
-       int bpos = 0;
-       int sizeofbuf = (Cvar_CompleteCountPossible (partial) + 1) * sizeof (const char *);
+       size_t len = 0;
+       size_t bpos = 0;
+       size_t sizeofbuf = (Cvar_CompleteCountPossible (partial) + 1) * sizeof (const char *);
        const char **buf;
 
        len = strlen(partial);
-       buf = Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
+       buf = (const char **)Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
        // Loop through the alias list and print all matches
        for (cvar = cvar_vars; cvar; cvar = cvar->next)
                if (!strncasecmp(partial, cvar->name, len))
@@ -176,6 +212,18 @@ const char **Cvar_CompleteBuildList (const char *partial)
        return buf;
 }
 
+// written by LordHavoc
+void Cvar_CompleteCvarPrint (const char *partial)
+{
+       cvar_t *cvar;
+       size_t len = strlen(partial);
+       // Loop through the command list and print all matches
+       for (cvar = cvar_vars; cvar; cvar = cvar->next)
+               if (!strncasecmp(partial, cvar->name, len))
+                       Con_Printf ("%c3%s%s : \"%s\" (\"%s\") : %s\n", STRING_COLOR_TAG, cvar->name, STRING_COLOR_DEFAULT_STR, cvar->string, cvar->defstring, cvar->description);
+}
+
+
 /*
 ============
 Cvar_Set
@@ -184,6 +232,7 @@ Cvar_Set
 void Cvar_SetQuick_Internal (cvar_t *var, const char *value)
 {
        qboolean changed;
+       size_t valuelen;
 
        changed = strcmp(var->string, value);
        // LordHavoc: don't reallocate when there is no change
@@ -191,17 +240,61 @@ void Cvar_SetQuick_Internal (cvar_t *var, const char *value)
                return;
 
        // LordHavoc: don't reallocate when the buffer is the same size
-       if (!var->string || strlen(var->string) != strlen(value))
+       valuelen = strlen(value);
+       if (!var->string || strlen(var->string) != valuelen)
        {
                Z_Free (var->string);   // free the old value string
 
-               var->string = Z_Malloc (strlen(value)+1);
+               var->string = (char *)Z_Malloc (valuelen + 1);
        }
-       strcpy (var->string, value);
+       memcpy (var->string, value, valuelen + 1);
        var->value = atof (var->string);
        var->integer = (int) var->value;
        if ((var->flags & CVAR_NOTIFY) && changed && sv.active)
                SV_BroadcastPrintf("\"%s\" changed to \"%s\"\n", var->name, var->string);
+#if 0
+       // TODO: add infostring support to the server?
+       if ((var->flags & CVAR_SERVERINFO) && changed && sv.active)
+       {
+               InfoString_SetValue(svs.serverinfo, sizeof(svs.serverinfo), var->name, var->string);
+               if (sv.active)
+               {
+                       MSG_WriteByte (&sv.reliable_datagram, svc_serverinfostring);
+                       MSG_WriteString (&sv.reliable_datagram, var->name);
+                       MSG_WriteString (&sv.reliable_datagram, var->string);
+               }
+       }
+#endif
+       if ((var->flags & CVAR_USERINFO) && cls.state != ca_dedicated)
+               CL_SetInfo(var->name, var->string, true, false, false, false);
+       else if ((var->flags & CVAR_NQUSERINFOHACK) && cls.state != ca_dedicated)
+       {
+               // update the cls.userinfo to have proper values for the
+               // silly nq config variables.
+               //
+               // this is done when these variables are changed rather than at
+               // connect time because if the user or code checks the userinfo and it
+               // holds weird values it may cause confusion...
+               if (!strcmp(var->name, "_cl_color"))
+               {
+                       int top = (var->integer >> 4) & 15, bottom = var->integer & 15;
+                       CL_SetInfo("topcolor", va("%i", top), true, false, false, false);
+                       CL_SetInfo("bottomcolor", va("%i", bottom), true, false, false, false);
+                       if (cls.protocol != PROTOCOL_QUAKEWORLD && cls.netcon)
+                       {
+                               MSG_WriteByte(&cls.netcon->message, clc_stringcmd);
+                               MSG_WriteString(&cls.netcon->message, va("color %i %i", top, bottom));
+                       }
+               }
+               else if (!strcmp(var->name, "_cl_rate"))
+                       CL_SetInfo("rate", va("%i", var->integer), true, false, false, false);
+               else if (!strcmp(var->name, "_cl_playerskin"))
+                       CL_SetInfo("playerskin", var->string, true, false, false, false);
+               else if (!strcmp(var->name, "_cl_playermodel"))
+                       CL_SetInfo("playermodel", var->string, true, false, false, false);
+               else if (!strcmp(var->name, "_cl_name"))
+                       CL_SetInfo("name", var->string, true, false, false, false);
+       }
 }
 
 void Cvar_SetQuick (cvar_t *var, const char *value)
@@ -212,8 +305,8 @@ void Cvar_SetQuick (cvar_t *var, const char *value)
                return;
        }
 
-       if (developer.integer)
-               Con_Printf("Cvar_SetQuick({\"%s\", \"%s\", %i}, \"%s\");\n", var->name, var->string, var->flags, value);
+       if (developer.integer >= 100)
+               Con_Printf("Cvar_SetQuick({\"%s\", \"%s\", %i, \"%s\"}, \"%s\");\n", var->name, var->string, var->flags, var->defstring, value);
 
        Cvar_SetQuick_Internal(var, value);
 }
@@ -237,23 +330,23 @@ Cvar_SetValue
 */
 void Cvar_SetValueQuick(cvar_t *var, float value)
 {
-       char val[256];
+       char val[MAX_INPUTLINE];
 
        if ((float)((int)value) == value)
-               sprintf(val, "%i", (int)value);
+               dpsnprintf(val, sizeof(val), "%i", (int)value);
        else
-               sprintf(val, "%f", value);
+               dpsnprintf(val, sizeof(val), "%f", value);
        Cvar_SetQuick(var, val);
 }
 
 void Cvar_SetValue(const char *var_name, float value)
 {
-       char val[256];
+       char val[MAX_INPUTLINE];
 
        if ((float)((int)value) == value)
-               sprintf(val, "%i", (int)value);
+               dpsnprintf(val, sizeof(val), "%i", (int)value);
        else
-               sprintf(val, "%f", value);
+               dpsnprintf(val, sizeof(val), "%f", value);
        Cvar_Set(var_name, val);
 }
 
@@ -266,10 +359,12 @@ Adds a freestanding variable to the variable list.
 */
 void Cvar_RegisterVariable (cvar_t *variable)
 {
-       cvar_t *cvar, *cvar2;
+       int hashindex;
+       cvar_t *current, *next, *cvar;
        char *oldstr;
+       size_t alloclen;
 
-       if (developer.integer)
+       if (developer.integer >= 100)
                Con_Printf("Cvar_RegisterVariable({\"%s\", \"%s\", %i});\n", variable->name, variable->string, variable->flags);
 
 // first check to see if it has already been defined
@@ -278,8 +373,8 @@ void Cvar_RegisterVariable (cvar_t *variable)
        {
                if (cvar->flags & CVAR_ALLOCATED)
                {
-                       if (developer.integer)
-                               Con_Printf("...  replacing existing allocated cvar {\"%s\", \"%s\", %i}", cvar->name, cvar->string, cvar->flags);
+                       if (developer.integer >= 100)
+                               Con_Printf("...  replacing existing allocated cvar {\"%s\", \"%s\", %i}\n", cvar->name, cvar->string, cvar->flags);
                        // fixed variables replace allocated ones
                        // (because the engine directly accesses fixed variables)
                        // NOTE: this isn't actually used currently
@@ -287,6 +382,7 @@ void Cvar_RegisterVariable (cvar_t *variable)
                        variable->flags |= (cvar->flags & ~CVAR_ALLOCATED);
                        // cvar->string is now owned by variable instead
                        variable->string = cvar->string;
+                       variable->defstring = cvar->defstring;
                        variable->value = atof (variable->string);
                        variable->integer = (int) variable->value;
                        // replace cvar with this one...
@@ -299,13 +395,13 @@ void Cvar_RegisterVariable (cvar_t *variable)
                        else
                        {
                                // otherwise find it somewhere in the list
-                               for (cvar2 = cvar_vars;cvar2->next != cvar;cvar2 = cvar2->next);
-                               if (cvar2->next == cvar)
-                                       cvar2->next = variable;
+                               for (current = cvar_vars;current->next != cvar;current = current->next)
+                                       ;
+                               current->next = variable;
                        }
 
                        // get rid of old allocated cvar
-                       // (but not the cvar->string, because we kept that)
+                       // (but not cvar->string and cvar->defstring, because we kept those)
                        Z_Free(cvar->name);
                        Z_Free(cvar);
                }
@@ -323,21 +419,29 @@ void Cvar_RegisterVariable (cvar_t *variable)
 
 // copy the value off, because future sets will Z_Free it
        oldstr = variable->string;
-       variable->string = Z_Malloc (strlen(variable->string)+1);
-       strcpy (variable->string, oldstr);
+       alloclen = strlen(variable->string) + 1;
+       variable->string = (char *)Z_Malloc (alloclen);
+       memcpy (variable->string, oldstr, alloclen);
+       variable->defstring = (char *)Z_Malloc (alloclen);
+       memcpy (variable->defstring, oldstr, alloclen);
        variable->value = atof (variable->string);
        variable->integer = (int) variable->value;
 
 // link the variable in
 // alphanumerical order
-       for( cvar = NULL, cvar2 = cvar_vars ; cvar2 && strcmp( cvar2->name, variable->name ) < 0 ; cvar = cvar2, cvar2 = cvar->next )
+       for( current = NULL, next = cvar_vars ; next && strcmp( next->name, variable->name ) < 0 ; current = next, next = next->next )
                ;
-       if( cvar ) {
-               cvar->next = variable;
+       if( current ) {
+               current->next = variable;
        } else {
                cvar_vars = variable;
        }
-       variable->next = cvar2;
+       variable->next = next;
+
+       // link to head of list in this hash table index
+       hashindex = CRC_Block((const unsigned char *)variable->name, strlen(variable->name));
+       variable->nextonhashchain = cvar_hashtable[hashindex];
+       cvar_hashtable[hashindex] = variable;
 }
 
 /*
@@ -347,11 +451,13 @@ Cvar_Get
 Adds a newly allocated variable to the variable list or sets its value.
 ============
 */
-cvar_t *Cvar_Get (const char *name, const char *value, int flags)
+cvar_t *Cvar_Get (const char *name, const char *value, int flags, const char *newdescription)
 {
-       cvar_t *cvar;
+       int hashindex;
+       cvar_t *current, *next, *cvar;
+       size_t alloclen;
 
-       if (developer.integer)
+       if (developer.integer >= 100)
                Con_Printf("Cvar_Get(\"%s\", \"%s\", %i);\n", name, value, flags);
 
 // first check to see if it has already been defined
@@ -360,6 +466,20 @@ cvar_t *Cvar_Get (const char *name, const char *value, int flags)
        {
                cvar->flags |= flags;
                Cvar_SetQuick_Internal (cvar, value);
+               if(newdescription && (cvar->flags & CVAR_ALLOCATED))
+               {
+                       if(cvar->description != cvar_dummy_description)
+                               Z_Free(cvar->description);
+
+                       if(*newdescription)
+                       {
+                               alloclen = strlen(newdescription) + 1;
+                               cvar->description = (char *)Z_Malloc(alloclen);
+                               memcpy(cvar->description, newdescription, alloclen);
+                       }
+                       else
+                               cvar->description = cvar_dummy_description;
+               }
                return cvar;
        }
 
@@ -371,19 +491,45 @@ cvar_t *Cvar_Get (const char *name, const char *value, int flags)
        }
 
 // allocate a new cvar, cvar name, and cvar string
+// TODO: factorize the following code with the one at the end of Cvar_RegisterVariable()
 // FIXME: these never get Z_Free'd
-       cvar = Z_Malloc(sizeof(cvar_t));
+       cvar = (cvar_t *)Z_Malloc(sizeof(cvar_t));
        cvar->flags = flags | CVAR_ALLOCATED;
-       cvar->name = Z_Malloc(strlen(name)+1);
-       strcpy(cvar->name, name);
-       cvar->string = Z_Malloc(strlen(value)+1);
-       strcpy(cvar->string, value);
+       alloclen = strlen(name) + 1;
+       cvar->name = (char *)Z_Malloc(alloclen);
+       memcpy(cvar->name, name, alloclen);
+       alloclen = strlen(value) + 1;
+       cvar->string = (char *)Z_Malloc(alloclen);
+       memcpy(cvar->string, value, alloclen);
+       cvar->defstring = (char *)Z_Malloc(alloclen);
+       memcpy(cvar->defstring, value, alloclen);
        cvar->value = atof (cvar->string);
        cvar->integer = (int) cvar->value;
 
+       if(newdescription && *newdescription)
+       {
+               alloclen = strlen(newdescription) + 1;
+               cvar->description = (char *)Z_Malloc(alloclen);
+               memcpy(cvar->description, newdescription, alloclen);
+       }
+       else
+               cvar->description = cvar_dummy_description; // actually checked by VM_cvar_type
+
 // link the variable in
-       cvar->next = cvar_vars;
-       cvar_vars = cvar;
+// alphanumerical order
+       for( current = NULL, next = cvar_vars ; next && strcmp( next->name, cvar->name ) < 0 ; current = next, next = next->next )
+               ;
+       if( current )
+               current->next = cvar;
+       else
+               cvar_vars = cvar;
+       cvar->next = next;
+
+       // link to head of list in this hash table index
+       hashindex = CRC_Block((const unsigned char *)cvar->name, strlen(cvar->name));
+       cvar->nextonhashchain = cvar_hashtable[hashindex];
+       cvar_hashtable[hashindex] = cvar;
+
        return cvar;
 }
 
@@ -407,12 +553,12 @@ qboolean  Cvar_Command (void)
 // perform a variable print or set
        if (Cmd_Argc() == 1)
        {
-               Con_Printf("\"%s\" is \"%s\"\n", v->name, v->string);
+               Con_Printf("\"%s\" is \"%s\" [\"%s\"]\n", v->name, v->string, v->defstring);
                return true;
        }
 
-       if (developer.integer)
-               Con_Print("Cvar_Command: ");
+       if (developer.integer >= 100)
+               Con_DPrint("Cvar_Command: ");
 
        if (v->flags & CVAR_READONLY)
        {
@@ -420,10 +566,71 @@ qboolean  Cvar_Command (void)
                return true;
        }
        Cvar_Set (v->name, Cmd_Argv(1));
+       if (developer.integer >= 100)
+               Con_DPrint("\n");
        return true;
 }
 
 
+void Cvar_UnlockDefaults (void)
+{
+       cvar_t *var;
+       // unlock the default values of all cvars
+       for (var = cvar_vars ; var ; var = var->next)
+               var->flags &= ~CVAR_DEFAULTSET;
+}
+
+
+void Cvar_LockDefaults_f (void)
+{
+       cvar_t *var;
+       // lock in the default values of all cvars
+       for (var = cvar_vars ; var ; var = var->next)
+       {
+               if (!(var->flags & CVAR_DEFAULTSET))
+               {
+                       size_t alloclen;
+
+                       //Con_Printf("locking cvar %s (%s -> %s)\n", var->name, var->string, var->defstring);
+                       var->flags |= CVAR_DEFAULTSET;
+                       Z_Free(var->defstring);
+                       alloclen = strlen(var->string) + 1;
+                       var->defstring = (char *)Z_Malloc(alloclen);
+                       memcpy(var->defstring, var->string, alloclen);
+               }
+       }
+}
+
+
+void Cvar_ResetToDefaults_All_f (void)
+{
+       cvar_t *var;
+       // restore the default values of all cvars
+       for (var = cvar_vars ; var ; var = var->next)
+               Cvar_SetQuick(var, var->defstring);
+}
+
+
+void Cvar_ResetToDefaults_NoSaveOnly_f (void)
+{
+       cvar_t *var;
+       // restore the default values of all cvars
+       for (var = cvar_vars ; var ; var = var->next)
+               if (!(var->flags & CVAR_SAVE))
+                       Cvar_SetQuick(var, var->defstring);
+}
+
+
+void Cvar_ResetToDefaults_SaveOnly_f (void)
+{
+       cvar_t *var;
+       // restore the default values of all cvars
+       for (var = cvar_vars ; var ; var = var->next)
+               if (var->flags & CVAR_SAVE)
+                       Cvar_SetQuick(var, var->defstring);
+}
+
+
 /*
 ============
 Cvar_WriteVariables
@@ -436,8 +643,9 @@ void Cvar_WriteVariables (qfile_t *f)
 {
        cvar_t  *var;
 
+       // don't save cvars that match their default value
        for (var = cvar_vars ; var ; var = var->next)
-               if (var->flags & CVAR_SAVE)
+               if ((var->flags & CVAR_SAVE) && (strcmp(var->string, var->defstring) || (var->flags & CVAR_ALLOCATED)))
                        FS_Printf(f, "%s%s \"%s\"\n", var->flags & CVAR_ALLOCATED ? "seta " : "", var->name, var->string);
 }
 
@@ -453,7 +661,9 @@ void Cvar_List_f (void)
 {
        cvar_t *cvar;
        const char *partial;
-       int len, count;
+       size_t len;
+       int count;
+       qboolean ispattern;
 
        if (Cmd_Argc() > 1)
        {
@@ -466,20 +676,27 @@ void Cvar_List_f (void)
                len = 0;
        }
 
+       ispattern = partial && (strchr(partial, '*') || strchr(partial, '?'));
+
        count = 0;
        for (cvar = cvar_vars; cvar; cvar = cvar->next)
        {
-               if (partial && strncasecmp (partial,cvar->name,len))
+               if (len && (ispattern ? !matchpattern_with_separator(cvar->name, partial, false, "", false) : strncmp (partial,cvar->name,len)))
                        continue;
 
-               Con_Printf("%s is \"%s\"\n", cvar->name, cvar->string);
+               Con_Printf("%s is \"%s\" [\"%s\"] %s\n", cvar->name, cvar->string, cvar->defstring, cvar->description);
                count++;
        }
 
-       Con_Printf("%i cvar(s)", count);
-       if (partial)
-               Con_Printf(" beginning with \"%s\"", partial);
-       Con_Print("\n");
+       if (len)
+       {
+               if(ispattern)
+                       Con_Printf("%i cvar(s) matching \"%s\"\n", count, partial);
+               else
+                       Con_Printf("%i cvar(s) beginning with \"%s\"\n", count, partial);
+       }
+       else
+               Con_Printf("%i cvar(s)\n", count);
 }
 // 2000-01-09 CvarList command by Maddes
 
@@ -490,7 +707,7 @@ void Cvar_Set_f (void)
        // make sure it's the right number of parameters
        if (Cmd_Argc() < 3)
        {
-               Con_Printf("Set: wrong number of parameters, usage: set <variablename> <value>\n");
+               Con_Printf("Set: wrong number of parameters, usage: set <variablename> <value> [<description>]\n");
                return;
        }
 
@@ -502,11 +719,11 @@ void Cvar_Set_f (void)
                return;
        }
 
-       if (developer.integer)
-               Con_Print("Set: ");
+       if (developer.integer >= 100)
+               Con_DPrint("Set: ");
 
        // all looks ok, create/modify the cvar
-       Cvar_Get(Cmd_Argv(1), Cmd_Argv(2), 0);
+       Cvar_Get(Cmd_Argv(1), Cmd_Argv(2), 0, Cmd_Argc() > 3 ? Cmd_Argv(3) : NULL);
 }
 
 void Cvar_SetA_f (void)
@@ -516,7 +733,7 @@ void Cvar_SetA_f (void)
        // make sure it's the right number of parameters
        if (Cmd_Argc() < 3)
        {
-               Con_Printf("SetA: wrong number of parameters, usage: seta <variablename> <value>\n");
+               Con_Printf("SetA: wrong number of parameters, usage: seta <variablename> <value> [<description>]\n");
                return;
        }
 
@@ -528,11 +745,11 @@ void Cvar_SetA_f (void)
                return;
        }
 
-       if (developer.integer)
-               Con_Print("SetA: ");
+       if (developer.integer >= 100)
+               Con_DPrint("SetA: ");
 
        // all looks ok, create/modify the cvar
-       Cvar_Get(Cmd_Argv(1), Cmd_Argv(2), CVAR_SAVE);
+       Cvar_Get(Cmd_Argv(1), Cmd_Argv(2), CVAR_SAVE, Cmd_Argc() > 3 ? Cmd_Argv(3) : NULL);
 }