-
Notifications
You must be signed in to change notification settings - Fork 42
/
cvar.c
1159 lines (1004 loc) · 29.7 KB
/
cvar.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
Copyright (C) 1996-1997 Id Software, Inc.
Copyright (C) 2000-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
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.
*/
// cvar.c -- dynamic variable tracking
#include "quakedef.h"
const char *cvar_dummy_description = "custom cvar";
static const char *cvar_null_string = "";
cvar_state_t cvars_all;
cvar_state_t cvars_null;
/*
============
Cvar_FindVar
============
*/
cvar_t *Cvar_FindVar(cvar_state_t *cvars, const char *var_name, unsigned neededflags)
{
unsigned hashindex;
cvar_hash_t *hash;
// use hash lookup to minimize search time
hashindex = CRC_Block((const unsigned char *)var_name, strlen(var_name)) % CVAR_HASHSIZE;
for (hash = cvars->hashtable[hashindex];hash;hash = hash->next)
if (!strcmp (var_name, hash->cvar->name) && (hash->cvar->flags & neededflags))
return hash->cvar;
else
for (char **alias = hash->cvar->aliases; alias && *alias; alias++)
if (!strcmp (var_name, *alias) && (hash->cvar->flags & neededflags))
return hash->cvar;
return NULL;
}
cvar_t *Cvar_FindVarAfter(cvar_state_t *cvars, const char *prev_var_name, unsigned neededflags)
{
cvar_t *var;
if (*prev_var_name)
{
var = Cvar_FindVar(cvars, prev_var_name, neededflags);
if (!var)
return NULL;
var = var->next;
}
else
var = cvars->vars;
// search for the next cvar matching the needed flags
while (var)
{
if (var->flags & neededflags)
break;
var = var->next;
}
return var;
}
/**
* Returns a pointer to the pointer stored in hashtable[] (or the one it links to)
* because we'll need to update that when deleting a cvar as other cvar(s) may share its hashindex.
*/
static cvar_hash_t **Cvar_FindVarLink(cvar_state_t *cvars, const char *var_name, cvar_t **prev_alpha, unsigned neededflags)
{
unsigned hashindex;
cvar_t *cvar;
cvar_hash_t **hashlinkptr;
// use hash lookup to minimize search time
hashindex = CRC_Block((const unsigned char *)var_name, strlen(var_name)) % CVAR_HASHSIZE;
if(prev_alpha) *prev_alpha = NULL;
hashlinkptr = &cvars->hashtable[hashindex];
for (hashlinkptr = &cvars->hashtable[hashindex]; *hashlinkptr; hashlinkptr = &(*hashlinkptr)->next)
{
cvar = (*hashlinkptr)->cvar;
if (!strcmp (var_name, cvar->name) && (cvar->flags & neededflags))
goto match;
else
for (char **alias = cvar->aliases; alias && *alias; alias++)
if (!strcmp (var_name, *alias) && (cvar->flags & neededflags))
goto match;
}
return NULL;
match:
if(!prev_alpha || cvar == cvars->vars)
return hashlinkptr;
*prev_alpha = cvars->vars;
// if prev_alpha happens to become NULL then there has been some inconsistency elsewhere
// already - should I still insert '*prev_alpha &&' in the loop?
while((*prev_alpha)->next != cvar)
*prev_alpha = (*prev_alpha)->next;
return hashlinkptr;
}
/*
============
Cvar_VariableValue
============
*/
float Cvar_VariableValueOr(cvar_state_t *cvars, const char *var_name, float def, unsigned neededflags)
{
cvar_t *var;
var = Cvar_FindVar(cvars, var_name, neededflags);
if (!var)
return def;
return atof (var->string);
}
float Cvar_VariableValue(cvar_state_t *cvars, const char *var_name, unsigned neededflags)
{
return Cvar_VariableValueOr(cvars, var_name, 0, neededflags);
}
/*
============
Cvar_VariableString
============
*/
const char *Cvar_VariableStringOr(cvar_state_t *cvars, const char *var_name, const char *def, unsigned neededflags)
{
cvar_t *var;
var = Cvar_FindVar(cvars, var_name, neededflags);
if (!var)
return def;
return var->string;
}
const char *Cvar_VariableString(cvar_state_t *cvars, const char *var_name, unsigned neededflags)
{
return Cvar_VariableStringOr(cvars, var_name, cvar_null_string, neededflags);
}
/*
============
Cvar_VariableDefString
============
*/
const char *Cvar_VariableDefString(cvar_state_t *cvars, const char *var_name, unsigned neededflags)
{
cvar_t *var;
var = Cvar_FindVar(cvars, var_name, neededflags);
if (!var)
return cvar_null_string;
return var->defstring;
}
/*
============
Cvar_VariableDescription
============
*/
const char *Cvar_VariableDescription(cvar_state_t *cvars, const char *var_name, unsigned neededflags)
{
cvar_t *var;
var = Cvar_FindVar(cvars, var_name, neededflags);
if (!var)
return cvar_null_string;
return var->description;
}
/*
============
Cvar_CompleteVariable
============
*/
const char *Cvar_CompleteVariable(cvar_state_t *cvars, const char *partial, unsigned neededflags)
{
cvar_t *cvar;
size_t len;
len = strlen(partial);
if (!len)
return NULL;
// check functions
for (cvar=cvars->vars ; cvar ; cvar=cvar->next)
if (!strncasecmp (partial,cvar->name, len) && (cvar->flags & neededflags))
return cvar->name;
return NULL;
}
/*
CVar_CompleteCountPossible
New function for tab-completion system
Added by EvilTypeGuy
Thanks to Fett erich@heintz.com
*/
int Cvar_CompleteCountPossible(cvar_state_t *cvars, const char *partial, unsigned neededflags)
{
cvar_t *cvar;
size_t len;
int h;
h = 0;
len = strlen(partial);
if (!len)
return 0;
// Loop through the cvars and count all possible matches
for (cvar = cvars->vars; cvar; cvar = cvar->next)
if (!strncasecmp(partial, cvar->name, len) && (cvar->flags & neededflags))
h++;
else
for (char **alias = cvar->aliases; alias && *alias; alias++)
if (!strncasecmp(partial, *alias, len) && (cvar->flags & neededflags))
h++;
return h;
}
/*
CVar_CompleteBuildList
New function for tab-completion system
Added by EvilTypeGuy
Thanks to Fett erich@heintz.com
Thanks to taniwha
*/
const char **Cvar_CompleteBuildList(cvar_state_t *cvars, const char *partial, unsigned neededflags)
{
const cvar_t *cvar;
size_t len = 0;
size_t bpos = 0;
size_t sizeofbuf = (Cvar_CompleteCountPossible(cvars, partial, neededflags) + 1) * sizeof(const char *);
const char **buf;
len = strlen(partial);
buf = (const char **)Mem_Alloc(tempmempool, sizeofbuf + sizeof(const char *));
// Loop through the alias list and print all matches
for (cvar = cvars->vars; cvar; cvar = cvar->next)
if (!strncasecmp(partial, cvar->name, len) && (cvar->flags & neededflags))
buf[bpos++] = cvar->name;
else
for (char **alias = cvar->aliases; alias && *alias; alias++)
if (!strncasecmp(partial, *alias, len) && (cvar->flags & neededflags))
buf[bpos++] = *alias;
buf[bpos] = NULL;
return buf;
}
void Cvar_PrintHelp(cvar_t *cvar, const char *name, qbool full)
{
// Aliases are purple, cvars are yellow
if (strcmp(cvar->name, name))
Con_Printf("^6%s^7 (alias of ^3%s^7)", name, cvar->name);
else
Con_Printf("^3%s^7", name);
Con_Printf(" is \"%s^7\" [\"%s^7\"]", ((cvar->flags & CF_PRIVATE) ? "********"/*hunter2*/ : cvar->string), cvar->defstring);
if (full)
Con_Printf(" %s", cvar->description);
Con_Print("\n");
}
// written by LadyHavoc
void Cvar_CompleteCvarPrint(cvar_state_t *cvars, const char *partial, unsigned neededflags)
{
cvar_t *cvar;
size_t len = strlen(partial);
// Loop through the command list and print all matches
for (cvar = cvars->vars; cvar; cvar = cvar->next)
if (!strncasecmp(partial, cvar->name, len) && (cvar->flags & neededflags))
Cvar_PrintHelp(cvar, cvar->name, true);
else
for (char **alias = cvar->aliases; alias && *alias; alias++)
if (!strncasecmp (partial, *alias, len) && (cvar->flags & neededflags))
Cvar_PrintHelp(cvar, *alias, true);
}
/// Check if a cvar is held by some progs
/// in which case its name is returned, otherwise NULL.
static const char *Cvar_IsAutoCvar(cvar_t *var)
{
int i;
prvm_prog_t *prog;
for (i = 0;i < PRVM_PROG_MAX;i++)
{
prog = &prvm_prog_list[i];
if (prog->loaded && var->globaldefindex[i] >= 0)
return prog->name;
}
return NULL;
}
/// we assume that prog is already set to the target progs
static void Cvar_UpdateAutoCvar(cvar_t *var)
{
int i;
int j;
const char *s;
vec3_t v;
prvm_prog_t *prog;
for (i = 0;i < PRVM_PROG_MAX;i++)
{
prog = &prvm_prog_list[i];
if (prog->loaded && var->globaldefindex[i] >= 0)
{
// MUST BE SYNCED WITH prvm_edict.c PRVM_Prog_Load
switch(prog->globaldefs[var->globaldefindex[i]].type & ~DEF_SAVEGLOBAL)
{
case ev_float:
PRVM_GLOBALFIELDFLOAT(prog->globaldefs[var->globaldefindex[i]].ofs) = var->value;
break;
case ev_vector:
s = var->string;
VectorClear(v);
for (j = 0;j < 3;j++)
{
while (*s && ISWHITESPACE(*s))
s++;
if (!*s)
break;
v[j] = atof(s);
while (!ISWHITESPACE(*s))
s++;
if (!*s)
break;
}
VectorCopy(v, PRVM_GLOBALFIELDVECTOR(prog->globaldefs[var->globaldefindex[i]].ofs));
break;
case ev_string:
PRVM_ChangeEngineString(prog, var->globaldefindex_stringno[i], var->string);
PRVM_GLOBALFIELDSTRING(prog->globaldefs[var->globaldefindex[i]].ofs) = var->globaldefindex_stringno[i];
break;
}
}
}
}
/// called after loading a savegame
void Cvar_UpdateAllAutoCvars(cvar_state_t *cvars)
{
cvar_t *var;
for (var = cvars->vars ; var ; var = var->next)
Cvar_UpdateAutoCvar(var);
}
void Cvar_Callback(cvar_t *var)
{
if (var == NULL)
{
Con_Print(CON_WARN "Cvar_Callback: var == NULL\n");
return;
}
if(var->callback)
var->callback(var);
}
/*
============
Cvar_Set
============
*/
extern cvar_t sv_disablenotify;
static void Cvar_SetQuick_Internal (cvar_t *var, const char *value)
{
qbool changed;
size_t valuelen;
changed = strcmp(var->string, value) != 0;
// LadyHavoc: don't reallocate when there is no change
if (!changed)
goto cvar_callback;
// LadyHavoc: don't reallocate when the buffer is the same size
valuelen = strlen(value);
if (!var->string || strlen(var->string) != valuelen)
{
Z_Free ((char *)var->string); // free the old value string
var->string = (char *)Z_Malloc (valuelen + 1);
}
memcpy ((char *)var->string, value, valuelen + 1);
var->value = atof (var->string);
var->integer = (int) var->value;
if ((var->flags & CF_NOTIFY) && sv.active && !sv_disablenotify.integer)
SV_BroadcastPrintf("\003^3Server cvar \"%s\" changed to \"%s\"\n", var->name, var->string);
#if 0
// TODO: add infostring support to the server?
if ((var->flags & CF_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 & CF_USERINFO)
CL_SetInfo(var->name, var->string, true, false, false, false);
Cvar_UpdateAutoCvar(var);
cvar_callback:
// Call the function stored in the cvar for bounds checking, cleanup, etc
Cvar_Callback(var);
}
void Cvar_SetQuick (cvar_t *var, const char *value)
{
if (var == NULL)
{
Con_Print(CON_WARN "Cvar_SetQuick: var == NULL\n");
return;
}
if (!(var->flags & CF_REGISTERED) && !(var->flags & CF_ALLOCATED))
{
Con_Printf(CON_WARN "Warning: Cvar_SetQuick() cannot set unregistered cvar \"%s\"\n", var->name);
return; // setting an unregistered engine cvar crashes
}
if (developer_extra.integer)
Con_DPrintf("Cvar_SetQuick({\"%s\", \"%s\", %i, \"%s\"}, \"%s\");\n", var->name, var->string, var->flags, var->defstring, value);
Cvar_SetQuick_Internal(var, value);
}
void Cvar_Set(cvar_state_t *cvars, const char *var_name, const char *value)
{
cvar_t *var;
var = Cvar_FindVar(cvars, var_name, ~0);
if (var == NULL)
{
Con_Printf(CON_WARN "Cvar_Set: variable %s not found\n", var_name);
return;
}
Cvar_SetQuick(var, value);
}
/*
============
Cvar_SetValue
============
*/
void Cvar_SetValueQuick(cvar_t *var, float value)
{
char val[MAX_INPUTLINE];
if ((float)((int)value) == value)
dpsnprintf(val, sizeof(val), "%i", (int)value);
else
dpsnprintf(val, sizeof(val), "%f", value);
Cvar_SetQuick(var, val);
}
void Cvar_SetValue(cvar_state_t *cvars, const char *var_name, float value)
{
char val[MAX_INPUTLINE];
if ((float)((int)value) == value)
dpsnprintf(val, sizeof(val), "%i", (int)value);
else
dpsnprintf(val, sizeof(val), "%f", value);
Cvar_Set(cvars, var_name, val);
}
void Cvar_RegisterCallback(cvar_t *variable, void (*callback)(cvar_t *))
{
if (variable == NULL)
{
Con_Print(CON_WARN "Cvar_RegisterCallback: var == NULL\n");
return;
}
if (!(variable->flags & cmd_local->cvars_flagsmask))
{
if (developer_extra.integer)
Con_DPrintf("^6Cvar_RegisterCallback: rejecting cvar \"%s\"\n", variable->name);
return;
}
variable->callback = callback;
}
void Cvar_RegisterVirtual(cvar_t *variable, const char *name )
{
cvar_state_t *cvars = &cvars_all;
cvar_hash_t *hash;
unsigned hashindex;
if (!(variable->flags & cmd_local->cvars_flagsmask))
{
if (developer_extra.integer)
Con_DPrintf("^6Cvar_RegisterVirtual: rejecting cvar \"%s\" alias \"%s\"\n", variable->name, name);
return;
}
if(!*name)
{
Con_Printf(CON_WARN "Cvar_RegisterVirtual: invalid virtual cvar name\n");
return;
}
// check for overlap with a command
if (Cmd_Exists(cmd_local, name))
{
Con_Printf(CON_WARN "Cvar_RegisterVirtual: %s is a command\n", name);
return;
}
if(Cvar_FindVar(&cvars_all, name, 0))
{
Con_Printf(CON_WARN "Cvar_RegisterVirtual: %s is a cvar\n", name);
return;
}
// Resize the variable->aliases list to have room for another entry and a null terminator.
// This zero-pads when resizing, so we don't need to write the NULL terminator manually here.
// Also if aliases is NULL this allocates fresh for the correct size, so it's fine to just do this.
variable->aliases = (char **)Z_Realloc(variable->aliases, sizeof(char *) * (variable->aliases_size + 2));
// Add the new alias, and increment the number of aliases in the list
variable->aliases[variable->aliases_size++] = Z_strdup(name);
// link to head of list in this hash table index
hash = (cvar_hash_t *)Z_Malloc(sizeof(cvar_hash_t));
hashindex = CRC_Block((const unsigned char *)name, strlen(name)) % CVAR_HASHSIZE;
hash->next = cvars->hashtable[hashindex];
cvars->hashtable[hashindex] = hash;
hash->cvar = variable;
}
/*
============
Cvar_Link
Links a variable to the variable list and hashtable
============
*/
static void Cvar_Link(cvar_t *variable, cvar_state_t *cvars)
{
cvar_t *current, *next;
cvar_hash_t *hash;
unsigned hashindex;
/*
* Link the variable in
* alphanumerical order
*/
for( current = NULL, next = cvars->vars ; next && strcmp( next->name, variable->name ) < 0 ; current = next, next = next->next )
;
if(current)
current->next = variable;
else
cvars->vars = variable;
variable->next = next;
// link to head of list in this hash table index
hash = (cvar_hash_t *)Z_Malloc(sizeof(cvar_hash_t));
hashindex = CRC_Block((const unsigned char *)variable->name, strlen(variable->name)) % CVAR_HASHSIZE;
hash->next = cvars->hashtable[hashindex];
hash->cvar = variable;
cvars->hashtable[hashindex] = hash;
}
/*
============
Cvar_RegisterVariable
Adds a freestanding variable to the variable list.
============
*/
void Cvar_RegisterVariable (cvar_t *variable)
{
cvar_state_t *cvars = &cvars_all;
cvar_t *current, *cvar;
int i;
if (!(variable->flags & cmd_local->cvars_flagsmask))
{
if (developer_extra.integer)
Con_DPrintf("^2Cvar_RegisterVariable: rejecting cvar \"%s\"\n", variable->name);
return;
}
if (developer_extra.integer)
Con_DPrintf("Cvar_RegisterVariable({\"%s\", \"%s\", %i});\n", variable->name, variable->string, variable->flags);
// first check to see if it has already been defined
cvar = Cvar_FindVar(cvars, variable->name, ~0);
if (cvar)
{
if (cvar->flags & CF_ALLOCATED)
{
if (developer_extra.integer)
Con_DPrintf("... 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
// (all cvars are registered before config parsing)
variable->flags &= ~CF_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;
// Preserve autocvar status.
memcpy(variable->globaldefindex, cvar->globaldefindex, sizeof(variable->globaldefindex));
memcpy(variable->globaldefindex_stringno, cvar->globaldefindex_stringno, sizeof(variable->globaldefindex_stringno));
// replace cvar with this one...
variable->next = cvar->next;
if (cvars->vars == cvar)
{
// head of the list is easy to change
cvars->vars = variable;
}
else
{
// otherwise find it somewhere in the list
for (current = cvars->vars;current->next != cvar;current = current->next)
;
current->next = variable;
}
// get rid of old allocated cvar
// (but not cvar->string and cvar->defstring, because we kept those)
Z_Free((char *)cvar->name);
Z_Free(cvar);
}
else
Con_DPrintf("Can't register variable %s, already defined\n", variable->name);
return;
}
// check for overlap with a command
if (Cmd_Exists(cmd_local, variable->name))
{
Con_Printf(CON_WARN "Cvar_RegisterVariable: %s is a command\n", variable->name);
return;
}
// copy the value off, because future sets will Z_Free it
variable->name = Z_strdup(variable->name);
variable->string = Z_strdup(variable->string);
variable->defstring = Z_strdup(variable->string);
variable->value = atof (variable->string);
variable->integer = (int) variable->value;
variable->aliases = NULL;
variable->aliases_size = 0;
variable->initstring = NULL;
// Mark it as not an autocvar.
for (i = 0;i < PRVM_PROG_MAX;i++)
variable->globaldefindex[i] = -1;
// Safe for Cvar_SetQuick()
variable->flags |= CF_REGISTERED;
Cvar_Link(variable, cvars);
}
/*
============
Cvar_Get
Adds a newly allocated variable to the variable list or sets its value.
============
*/
cvar_t *Cvar_Get(cvar_state_t *cvars, const char *name, const char *value, unsigned flags, const char *newdescription)
{
cvar_t *cvar;
int i;
if (developer_extra.integer)
Con_DPrintf("Cvar_Get(\"%s\", \"%s\", %i);\n", name, value, flags);
// first check to see if it has already been defined
cvar = Cvar_FindVar(cvars, name, ~0);
if (cvar)
{
cvar->flags |= flags;
Cvar_SetQuick_Internal (cvar, value);
if(newdescription && (cvar->flags & CF_ALLOCATED))
{
if(cvar->description != cvar_dummy_description)
Z_Free((char *)cvar->description);
if(*newdescription)
cvar->description = Z_strdup(newdescription);
else
cvar->description = cvar_dummy_description;
}
return cvar;
}
// check for pure evil
if (!*name)
{
Con_Printf(CON_WARN "Cvar_Get: invalid variable name\n");
return NULL;
}
// check for overlap with a command
if (Cmd_Exists(cmd_local, name))
{
Con_Printf(CON_WARN "Cvar_Get: %s is a command\n", name);
return NULL;
}
// 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 = (cvar_t *)Z_Malloc(sizeof(cvar_t));
cvar->flags = flags | CF_ALLOCATED;
cvar->name = Z_strdup(name);
cvar->string = Z_strdup(value);
cvar->defstring = Z_strdup(value);
cvar->value = atof (cvar->string);
cvar->integer = (int) cvar->value;
cvar->aliases = NULL;
cvar->aliases_size = 0;
cvar->initstring = NULL;
if(newdescription && *newdescription)
cvar->description = Z_strdup(newdescription);
else
cvar->description = cvar_dummy_description; // actually checked by VM_cvar_type
// Mark it as not an autocvar.
for (i = 0;i < PRVM_PROG_MAX;i++)
cvar->globaldefindex[i] = -1;
Cvar_Link(cvar, cvars);
return cvar;
}
/// For "quiet" mode pass NULL as the callername.
/// Returns true if the cvar was deleted.
static qbool Cvar_Delete(cvar_state_t *cvars, const char *name, const char *callername)
{
cvar_t *cvar, *prev;
cvar_hash_t **hashlinkptr, *oldhashlink;
const char *progname;
hashlinkptr = Cvar_FindVarLink(cvars, name, &prev, ~0);
if(!hashlinkptr)
{
if (callername)
Con_Printf("%s: cvar \"%s\" is not defined.\n", callername, name);
return false;
}
cvar = (*hashlinkptr)->cvar;
if(!(cvar->flags & CF_ALLOCATED))
{
if (callername)
Con_Printf(CON_WARN "%s: engine cvar \"%s\" cannot be deleted!\n", callername, cvar->name);
return false;
}
if ((progname = Cvar_IsAutoCvar(cvar)))
{
if (callername)
Con_Printf(CON_WARN "%s: unable to delete cvar \"%s\", it is an autocvar used by running %s progs!\n", callername, cvar->name, progname);
return false;
}
if(cvar == cvars->vars)
cvars->vars = cvar->next;
else
prev->next = cvar->next;
if(cvar->description != cvar_dummy_description)
Z_Free((char *)cvar->description);
Z_Free((char *)cvar->name);
Z_Free((char *)cvar->string);
Z_Free((char *)cvar->defstring);
Z_Free(cvar);
oldhashlink = *hashlinkptr;
*hashlinkptr = (*hashlinkptr)->next;
Z_Free(oldhashlink);
return true;
}
qbool Cvar_Readonly (cvar_t *var, const char *cmd_name)
{
if (var->flags & CF_READONLY)
{
Con_Print(CON_WARN);
if(cmd_name)
Con_Printf("%s: ",cmd_name);
Con_Printf("%s is read-only\n", var->name);
return true;
}
return false;
}
/*
============
Cvar_Command
Handles variable inspection and changing from the console
============
*/
qbool Cvar_Command (cmd_state_t *cmd)
{
cvar_state_t *cvars = cmd->cvars;
cvar_t *v;
// check variables
v = Cvar_FindVar(cvars, Cmd_Argv(cmd, 0), (cmd->cvars_flagsmask));
if (!v)
return false;
// perform a variable print or set
if (Cmd_Argc(cmd) == 1)
{
Cvar_PrintHelp(v, Cmd_Argv(cmd, 0), true);
return true;
}
if (developer_extra.integer)
Con_DPrint("Cvar_Command: ");
if(Cvar_Readonly(v, NULL))
return true;
Cvar_SetQuick(v, Cmd_Argv(cmd, 1));
if (developer_extra.integer)
Con_DPrint("\n");
return true;
}
void Cvar_UnlockDefaults(cmd_state_t *cmd)
{
cvar_state_t *cvars = cmd->cvars;
cvar_t *var;
// unlock the default values of all cvars
for (var = cvars->vars ; var ; var = var->next)
var->flags &= ~CF_DEFAULTSET;
}
void Cvar_LockDefaults_f(cmd_state_t *cmd)
{
cvar_state_t *cvars = cmd->cvars;
cvar_t *var;
// lock in the default values of all cvars
for (var = cvars->vars ; var ; var = var->next)
{
if (!(var->flags & CF_DEFAULTSET))
{
size_t alloclen;
//Con_Printf("locking cvar %s (%s -> %s)\n", var->name, var->string, var->defstring);
var->flags |= CF_DEFAULTSET;
Z_Free((char *)var->defstring);
alloclen = strlen(var->string) + 1;
var->defstring = (char *)Z_Malloc(alloclen);
memcpy((char *)var->defstring, var->string, alloclen);
}
}
}
void Cvar_SaveInitState(cvar_state_t *cvars)
{
cvar_t *c;
for (c = cvars->vars;c;c = c->next)
if ((c->flags & (CF_PERSISTENT | CF_READONLY)) == 0)
c->initstring = Z_strdup(c->string);
}
void Cvar_RestoreInitState(cvar_state_t *cvars)
{
cvar_t *c, *cp;
for (cp = cvars->vars; (c = cp);)
{
cp = c->next; // get next cvar now in case we delete this cvar
if (c->initstring)
{
// restore this cvar, it existed at init
Con_DPrintf("Cvar_RestoreInitState: Restoring cvar \"%s\"\n", c->name);
/* bones_was_here: intentionally NOT restoring defstring in this function.
* The only callsite, Host_LoadConfig_f, will re-exec quake.rc, default.cfg, etc.
* Defaults are unlocked here, so Cvar_LockDefaults_f will reset the defstring.
* This is more correct than restoring the defstring here
* because a gamedir change could load configs that should change defaults.
*/
Cvar_SetQuick(c, c->initstring);
c->flags &= ~CF_DEFAULTSET;
}
else if (!(c->flags & (CF_PERSISTENT | CF_READONLY))) // cvars with those flags have no initstring AND may not be deleted or reset
{
// remove this cvar, it did not exist at init
Con_DPrintf("Cvar_RestoreInitState: cvar \"%s\"", c->name);
if (Cvar_Delete(cvars, c->name, NULL))
Con_DPrint("deleted.\n");
else
{
// In this case, at least reset it to the default.
Con_DPrint("reset.\n");
Cvar_SetQuick(c, c->defstring);
}
}
}
}
void Cvar_ResetToDefaults_All_f(cmd_state_t *cmd)
{
cvar_state_t *cvars = cmd->cvars;
cvar_t *var;
// restore the default values of all cvars
for (var = cvars->vars ; var ; var = var->next)
{
if((var->flags & (CF_PERSISTENT | CF_READONLY)) == 0)
Cvar_SetQuick(var, var->defstring);
}
}
void Cvar_ResetToDefaults_NoSaveOnly_f(cmd_state_t *cmd)
{
cvar_state_t *cvars = cmd->cvars;
cvar_t *var;
// restore the default values of all cvars
for (var = cvars->vars ; var ; var = var->next)
{
if ((var->flags & (CF_PERSISTENT | CF_READONLY | CF_ARCHIVE)) == 0)
Cvar_SetQuick(var, var->defstring);
}
}
void Cvar_ResetToDefaults_SaveOnly_f(cmd_state_t *cmd)
{
cvar_state_t *cvars = cmd->cvars;
cvar_t *var;
// restore the default values of all cvars
for (var = cvars->vars ; var ; var = var->next)
{
if ((var->flags & (CF_PERSISTENT | CF_READONLY | CF_ARCHIVE)) == CF_ARCHIVE)
Cvar_SetQuick(var, var->defstring);
}
}
/*
============
Cvar_WriteVariables
Writes lines containing "set variable value" for all variables
with the archive flag set to true.
============
*/
void Cvar_WriteVariables (cvar_state_t *cvars, qfile_t *f)
{
cvar_t *var;
char buf1[MAX_INPUTLINE], buf2[MAX_INPUTLINE];
// don't save cvars that match their default value
for (var = cvars->vars ; var ; var = var->next) {
if ((var->flags & CF_ARCHIVE) && (strcmp(var->string, var->defstring) || ((var->flags & CF_ALLOCATED) && !(var->flags & CF_DEFAULTSET))))
{
Cmd_QuoteString(buf1, sizeof(buf1), var->name, "\"\\$", false);
Cmd_QuoteString(buf2, sizeof(buf2), var->string, "\"\\$", false);
FS_Printf(f, "%s\"%s\" \"%s\"\n", var->flags & CF_ALLOCATED ? "seta " : "", buf1, buf2);
}
}
}