]> git.xonotic.org Git - xonotic/darkplaces.git/blob - cmd.c
only lock the server mutex if executing commands
[xonotic/darkplaces.git] / cmd.c
1 /*
2 Copyright (C) 1996-1997 Id Software, Inc.
3
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
12
13 See the GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18
19 */
20 // cmd.c -- Quake script command processing module
21
22 #include "quakedef.h"
23 #include "thread.h"
24
25 typedef struct cmdalias_s
26 {
27         struct cmdalias_s *next;
28         char name[MAX_ALIAS_NAME];
29         char *value;
30         qboolean initstate; // indicates this command existed at init
31         char *initialvalue; // backup copy of value at init
32 } cmdalias_t;
33
34 static cmdalias_t *cmd_alias;
35
36 static qboolean cmd_wait;
37
38 static mempool_t *cmd_mempool;
39
40 static char cmd_tokenizebuffer[CMD_TOKENIZELENGTH];
41 static int cmd_tokenizebufferpos = 0;
42
43 //=============================================================================
44
45 /*
46 ============
47 Cmd_Wait_f
48
49 Causes execution of the remainder of the command buffer to be delayed until
50 next frame.  This allows commands like:
51 bind g "impulse 5 ; +attack ; wait ; -attack ; impulse 2"
52 ============
53 */
54 static void Cmd_Wait_f (void)
55 {
56         cmd_wait = true;
57 }
58
59 typedef struct cmddeferred_s
60 {
61         struct cmddeferred_s *next;
62         char *value;
63         double delay;
64 } cmddeferred_t;
65
66 static cmddeferred_t *cmd_deferred_list = NULL;
67
68 /*
69 ============
70 Cmd_Defer_f
71
72 Cause a command to be executed after a delay.
73 ============
74 */
75 static void Cmd_Defer_f (void)
76 {
77         if(Cmd_Argc() == 1)
78         {
79                 cmddeferred_t *next = cmd_deferred_list;
80                 if(!next)
81                         Con_Printf("No commands are pending.\n");
82                 while(next)
83                 {
84                         Con_Printf("-> In %9.2f: %s\n", next->delay, next->value);
85                         next = next->next;
86                 }
87         } else if(Cmd_Argc() == 2 && !strcasecmp("clear", Cmd_Argv(1)))
88         {
89                 while(cmd_deferred_list)
90                 {
91                         cmddeferred_t *cmd = cmd_deferred_list;
92                         cmd_deferred_list = cmd->next;
93                         Mem_Free(cmd->value);
94                         Mem_Free(cmd);
95                 }
96         } else if(Cmd_Argc() == 3)
97         {
98                 const char *value = Cmd_Argv(2);
99                 cmddeferred_t *defcmd = (cmddeferred_t*)Mem_Alloc(tempmempool, sizeof(*defcmd));
100                 size_t len = strlen(value);
101
102                 defcmd->delay = atof(Cmd_Argv(1));
103                 defcmd->value = (char*)Mem_Alloc(tempmempool, len+1);
104                 memcpy(defcmd->value, value, len+1);
105                 defcmd->next = NULL;
106
107                 if(cmd_deferred_list)
108                 {
109                         cmddeferred_t *next = cmd_deferred_list;
110                         while(next->next)
111                                 next = next->next;
112                         next->next = defcmd;
113                 } else
114                         cmd_deferred_list = defcmd;
115                 /* Stupid me... this changes the order... so commands with the same delay go blub :S
116                   defcmd->next = cmd_deferred_list;
117                   cmd_deferred_list = defcmd;*/
118         } else {
119                 Con_Printf("usage: defer <seconds> <command>\n"
120                            "       defer clear\n");
121                 return;
122         }
123 }
124
125 /*
126 ============
127 Cmd_Centerprint_f
128
129 Print something to the center of the screen using SCR_Centerprint
130 ============
131 */
132 static void Cmd_Centerprint_f (void)
133 {
134         char msg[MAX_INPUTLINE];
135         unsigned int i, c, p;
136         c = Cmd_Argc();
137         if(c >= 2)
138         {
139                 strlcpy(msg, Cmd_Argv(1), sizeof(msg));
140                 for(i = 2; i < c; ++i)
141                 {
142                         strlcat(msg, " ", sizeof(msg));
143                         strlcat(msg, Cmd_Argv(i), sizeof(msg));
144                 }
145                 c = strlen(msg);
146                 for(p = 0, i = 0; i < c; ++i)
147                 {
148                         if(msg[i] == '\\')
149                         {
150                                 if(msg[i+1] == 'n')
151                                         msg[p++] = '\n';
152                                 else if(msg[i+1] == '\\')
153                                         msg[p++] = '\\';
154                                 else {
155                                         msg[p++] = '\\';
156                                         msg[p++] = msg[i+1];
157                                 }
158                                 ++i;
159                         } else {
160                                 msg[p++] = msg[i];
161                         }
162                 }
163                 msg[p] = '\0';
164                 SCR_CenterPrint(msg);
165         }
166 }
167
168 /*
169 =============================================================================
170
171                                                 COMMAND BUFFER
172
173 =============================================================================
174 */
175
176 static sizebuf_t        cmd_text;
177 static unsigned char            cmd_text_buf[CMDBUFSIZE];
178 void *cmd_text_mutex = NULL;
179
180 #define Cbuf_LockThreadMutex() (cmd_text_mutex ? Thread_LockMutex(cmd_text_mutex),1 : 0)
181 #define Cbuf_UnlockThreadMutex() (cmd_text_mutex ? Thread_UnlockMutex(cmd_text_mutex),1 : 0)
182
183 /*
184 ============
185 Cbuf_AddText
186
187 Adds command text at the end of the buffer
188 ============
189 */
190 void Cbuf_AddText (const char *text)
191 {
192         int             l;
193
194         l = (int)strlen(text);
195
196         Cbuf_LockThreadMutex();
197         if (cmd_text.cursize + l >= cmd_text.maxsize)
198                 Con_Print("Cbuf_AddText: overflow\n");
199         else
200                 SZ_Write(&cmd_text, (const unsigned char *)text, l);
201         Cbuf_UnlockThreadMutex();
202 }
203
204
205 /*
206 ============
207 Cbuf_InsertText
208
209 Adds command text immediately after the current command
210 Adds a \n to the text
211 FIXME: actually change the command buffer to do less copying
212 ============
213 */
214 void Cbuf_InsertText (const char *text)
215 {
216         size_t l = strlen(text);
217         Cbuf_LockThreadMutex();
218         // we need to memmove the existing text and stuff this in before it...
219         if (cmd_text.cursize + l >= (size_t)cmd_text.maxsize)
220                 Con_Print("Cbuf_InsertText: overflow\n");
221         else
222         {
223                 // we don't have a SZ_Prepend, so...
224                 memmove(cmd_text.data + l, cmd_text.data, cmd_text.cursize);
225                 cmd_text.cursize += l;
226                 memcpy(cmd_text.data, text, l);
227         }
228         Cbuf_UnlockThreadMutex();
229 }
230
231 /*
232 ============
233 Cbuf_Execute_Deferred --blub
234 ============
235 */
236 static void Cbuf_Execute_Deferred (void)
237 {
238         static double oldrealtime = 0;
239         cmddeferred_t *cmd, *prev;
240         double eat;
241         if (realtime - oldrealtime < 0 || realtime - oldrealtime > 1800) oldrealtime = realtime;
242         eat = realtime - oldrealtime;
243         if (eat < (1.0 / 120.0))
244                 return;
245         oldrealtime = realtime;
246         prev = NULL;
247         cmd = cmd_deferred_list;
248         while(cmd)
249         {
250                 cmd->delay -= eat;
251                 if(cmd->delay <= 0)
252                 {
253                         Cbuf_AddText(cmd->value);
254                         Cbuf_AddText(";\n");
255                         Mem_Free(cmd->value);
256
257                         if(prev) {
258                                 prev->next = cmd->next;
259                                 Mem_Free(cmd);
260                                 cmd = prev->next;
261                         } else {
262                                 cmd_deferred_list = cmd->next;
263                                 Mem_Free(cmd);
264                                 cmd = cmd_deferred_list;
265                         }
266                         continue;
267                 }
268                 prev = cmd;
269                 cmd = cmd->next;
270         }
271 }
272
273 /*
274 ============
275 Cbuf_Execute
276 ============
277 */
278 static void Cmd_PreprocessString( const char *intext, char *outtext, unsigned maxoutlen, cmdalias_t *alias );
279 void Cbuf_Execute (void)
280 {
281         int i;
282         char *text;
283         char line[MAX_INPUTLINE];
284         char preprocessed[MAX_INPUTLINE];
285         char *firstchar;
286         qboolean quotes;
287         char *comment;
288
289         // LordHavoc: making sure the tokenizebuffer doesn't get filled up by repeated crashes
290         cmd_tokenizebufferpos = 0;
291
292         while (cmd_text.cursize)
293         {
294 // find a \n or ; line break
295                 text = (char *)cmd_text.data;
296
297                 quotes = false;
298                 comment = NULL;
299                 for (i=0 ; i < cmd_text.cursize ; i++)
300                 {
301                         if(!comment)
302                         {
303                                 if (text[i] == '"')
304                                         quotes = !quotes;
305
306                                 if(quotes)
307                                 {
308                                         // make sure i doesn't get > cursize which causes a negative
309                                         // size in memmove, which is fatal --blub
310                                         if (i < (cmd_text.cursize-1) && (text[i] == '\\' && (text[i+1] == '"' || text[i+1] == '\\')))
311                                                 i++;
312                                 }
313                                 else
314                                 {
315                                         if(text[i] == '/' && text[i + 1] == '/' && (i == 0 || ISWHITESPACE(text[i-1])))
316                                                 comment = &text[i];
317                                         if(text[i] == ';')
318                                                 break;  // don't break if inside a quoted string or comment
319                                 }
320                         }
321
322                         if (text[i] == '\r' || text[i] == '\n')
323                                 break;
324                 }
325
326                 // better than CRASHING on overlong input lines that may SOMEHOW enter the buffer
327                 if(i >= MAX_INPUTLINE)
328                 {
329                         Con_Printf("Warning: console input buffer had an overlong line. Ignored.\n");
330                         line[0] = 0;
331                 }
332                 else
333                 {
334                         memcpy (line, text, comment ? (comment - text) : i);
335                         line[comment ? (comment - text) : i] = 0;
336                 }
337
338 // delete the text from the command buffer and move remaining commands down
339 // this is necessary because commands (exec, alias) can insert data at the
340 // beginning of the text buffer
341
342                 if (i == cmd_text.cursize)
343                         cmd_text.cursize = 0;
344                 else
345                 {
346                         i++;
347                         cmd_text.cursize -= i;
348                         memmove (cmd_text.data, text+i, cmd_text.cursize);
349                 }
350
351 // execute the command line
352                 firstchar = line;
353                 while(*firstchar && ISWHITESPACE(*firstchar))
354                         ++firstchar;
355                 if(
356                         (strncmp(firstchar, "alias", 5) || !ISWHITESPACE(firstchar[5]))
357                         &&
358                         (strncmp(firstchar, "bind", 4) || !ISWHITESPACE(firstchar[4]))
359                         &&
360                         (strncmp(firstchar, "in_bind", 7) || !ISWHITESPACE(firstchar[7]))
361                 )
362                 {
363                         Cmd_PreprocessString( line, preprocessed, sizeof(preprocessed), NULL );
364                         Cmd_ExecuteString (preprocessed, src_command, false);
365                 }
366                 else
367                 {
368                         Cmd_ExecuteString (line, src_command, false);
369                 }
370
371                 if (cmd_wait)
372                 {       // skip out while text still remains in buffer, leaving it
373                         // for next frame
374                         cmd_wait = false;
375                         break;
376                 }
377         }
378 }
379
380 void Cbuf_Frame(void)
381 {
382         Cbuf_Execute_Deferred();
383         if (cmd_text.cursize)
384         {
385                 SV_LockThreadMutex();
386                 Cbuf_Execute();
387                 SV_UnlockThreadMutex();
388         }
389 }
390
391 /*
392 ==============================================================================
393
394                                                 SCRIPT COMMANDS
395
396 ==============================================================================
397 */
398
399 /*
400 ===============
401 Cmd_StuffCmds_f
402
403 Adds command line parameters as script statements
404 Commands lead with a +, and continue until a - or another +
405 quake +prog jctest.qp +cmd amlev1
406 quake -nosound +cmd amlev1
407 ===============
408 */
409 qboolean host_stuffcmdsrun = false;
410 static void Cmd_StuffCmds_f (void)
411 {
412         int             i, j, l;
413         // this is for all commandline options combined (and is bounds checked)
414         char    build[MAX_INPUTLINE];
415
416         if (Cmd_Argc () != 1)
417         {
418                 Con_Print("stuffcmds : execute command line parameters\n");
419                 return;
420         }
421
422         // no reason to run the commandline arguments twice
423         if (host_stuffcmdsrun)
424                 return;
425
426         host_stuffcmdsrun = true;
427         build[0] = 0;
428         l = 0;
429         for (i = 0;i < com_argc;i++)
430         {
431                 if (com_argv[i] && com_argv[i][0] == '+' && (com_argv[i][1] < '0' || com_argv[i][1] > '9') && l + strlen(com_argv[i]) - 1 <= sizeof(build) - 1)
432                 {
433                         j = 1;
434                         while (com_argv[i][j])
435                                 build[l++] = com_argv[i][j++];
436                         i++;
437                         for (;i < com_argc;i++)
438                         {
439                                 if (!com_argv[i])
440                                         continue;
441                                 if ((com_argv[i][0] == '+' || com_argv[i][0] == '-') && (com_argv[i][1] < '0' || com_argv[i][1] > '9'))
442                                         break;
443                                 if (l + strlen(com_argv[i]) + 4 > sizeof(build) - 1)
444                                         break;
445                                 build[l++] = ' ';
446                                 if (strchr(com_argv[i], ' '))
447                                         build[l++] = '\"';
448                                 for (j = 0;com_argv[i][j];j++)
449                                         build[l++] = com_argv[i][j];
450                                 if (strchr(com_argv[i], ' '))
451                                         build[l++] = '\"';
452                         }
453                         build[l++] = '\n';
454                         i--;
455                 }
456         }
457         // now terminate the combined string and prepend it to the command buffer
458         // we already reserved space for the terminator
459         build[l++] = 0;
460         Cbuf_InsertText (build);
461 }
462
463 static void Cmd_Exec(const char *filename)
464 {
465         char *f;
466         qboolean isdefaultcfg = strlen(filename) >= 11 && !strcmp(filename + strlen(filename) - 11, "default.cfg");
467
468         if (!strcmp(filename, "config.cfg"))
469         {
470                 filename = CONFIGFILENAME;
471                 if (COM_CheckParm("-noconfig"))
472                         return; // don't execute config.cfg
473         }
474
475         f = (char *)FS_LoadFile (filename, tempmempool, false, NULL);
476         if (!f)
477         {
478                 Con_Printf("couldn't exec %s\n",filename);
479                 return;
480         }
481         Con_Printf("execing %s\n",filename);
482
483         // if executing default.cfg for the first time, lock the cvar defaults
484         // it may seem backwards to insert this text BEFORE the default.cfg
485         // but Cbuf_InsertText inserts before, so this actually ends up after it.
486         if (isdefaultcfg)
487                 Cbuf_InsertText("\ncvar_lockdefaults\n");
488
489         // insert newline after the text to make sure the last line is terminated (some text editors omit the trailing newline)
490         // (note: insertion order here is backwards from execution order, so this adds it after the text, by calling it before...)
491         Cbuf_InsertText ("\n");
492         Cbuf_InsertText (f);
493         Mem_Free(f);
494
495         if (isdefaultcfg)
496         {
497                 // special defaults for specific games go here, these execute before default.cfg
498                 // Nehahra pushable crates malfunction in some levels if this is on
499                 // Nehahra NPC AI is confused by blowupfallenzombies
500                 if (gamemode == GAME_NEHAHRA)
501                         Cbuf_InsertText("\nsv_gameplayfix_upwardvelocityclearsongroundflag 0\nsv_gameplayfix_blowupfallenzombies 0\n\n");
502                 // hipnotic mission pack has issues in their 'friendly monster' ai, which seem to attempt to attack themselves for some reason when findradius() returns non-solid entities.
503                 // hipnotic mission pack has issues with bobbing water entities 'jittering' between different heights on alternate frames at the default 0.0138889 ticrate, 0.02 avoids this issue
504                 // hipnotic mission pack has issues in their proximity mine sticking code, which causes them to bounce off.
505                 if (gamemode == GAME_HIPNOTIC)
506                         Cbuf_InsertText("\nsv_gameplayfix_blowupfallenzombies 0\nsys_ticrate 0.02\nsv_gameplayfix_slidemoveprojectiles 0\n\n");
507                 // rogue mission pack has a guardian boss that does not wake up if findradius returns one of the entities around its spawn area
508                 if (gamemode == GAME_ROGUE)
509                         Cbuf_InsertText("\nsv_gameplayfix_findradiusdistancetobox 0\n\n");
510                 if (gamemode == GAME_NEXUIZ)
511                         Cbuf_InsertText("\nsv_gameplayfix_q2airaccelerate 1\nsv_gameplayfix_stepmultipletimes 1\n\n");
512                 if (gamemode == GAME_TENEBRAE)
513                         Cbuf_InsertText("\nr_shadow_gloss 2\nr_shadow_bumpscale_basetexture 4\n\n");
514                 // Steel Storm: Burning Retribution csqc misinterprets CSQC_InputEvent if type is a value other than 0 or 1
515                 if (gamemode == GAME_STEELSTORM)
516                         Cbuf_InsertText("\ncl_csqc_generatemousemoveevents 0\n\n");
517         }
518 }
519
520 /*
521 ===============
522 Cmd_Exec_f
523 ===============
524 */
525 static void Cmd_Exec_f (void)
526 {
527         fssearch_t *s;
528         int i;
529
530         if (Cmd_Argc () != 2)
531         {
532                 Con_Print("exec <filename> : execute a script file\n");
533                 return;
534         }
535
536         s = FS_Search(Cmd_Argv(1), true, true);
537         if(!s || !s->numfilenames)
538         {
539                 Con_Printf("couldn't exec %s\n",Cmd_Argv(1));
540                 return;
541         }
542
543         for(i = 0; i < s->numfilenames; ++i)
544                 Cmd_Exec(s->filenames[i]);
545
546         FS_FreeSearch(s);
547 }
548
549
550 /*
551 ===============
552 Cmd_Echo_f
553
554 Just prints the rest of the line to the console
555 ===============
556 */
557 static void Cmd_Echo_f (void)
558 {
559         int             i;
560
561         for (i=1 ; i<Cmd_Argc() ; i++)
562                 Con_Printf("%s ",Cmd_Argv(i));
563         Con_Print("\n");
564 }
565
566 // DRESK - 5/14/06
567 // Support Doom3-style Toggle Console Command
568 /*
569 ===============
570 Cmd_Toggle_f
571
572 Toggles a specified console variable amongst the values specified (default is 0 and 1)
573 ===============
574 */
575 static void Cmd_Toggle_f(void)
576 {
577         // Acquire Number of Arguments
578         int nNumArgs = Cmd_Argc();
579
580         if(nNumArgs == 1)
581                 // No Arguments Specified; Print Usage
582                 Con_Print("Toggle Console Variable - Usage\n  toggle <variable> - toggles between 0 and 1\n  toggle <variable> <value> - toggles between 0 and <value>\n  toggle <variable> [string 1] [string 2]...[string n] - cycles through all strings\n");
583         else
584         { // Correct Arguments Specified
585                 // Acquire Potential CVar
586                 cvar_t* cvCVar = Cvar_FindVar( Cmd_Argv(1) );
587
588                 if(cvCVar != NULL)
589                 { // Valid CVar
590                         if(nNumArgs == 2)
591                         { // Default Usage
592                                 if(cvCVar->integer)
593                                         Cvar_SetValueQuick(cvCVar, 0);
594                                 else
595                                         Cvar_SetValueQuick(cvCVar, 1);
596                         }
597                         else
598                         if(nNumArgs == 3)
599                         { // 0 and Specified Usage
600                                 if(cvCVar->integer == atoi(Cmd_Argv(2) ) )
601                                         // CVar is Specified Value; // Reset to 0
602                                         Cvar_SetValueQuick(cvCVar, 0);
603                                 else
604                                 if(cvCVar->integer == 0)
605                                         // CVar is 0; Specify Value
606                                         Cvar_SetQuick(cvCVar, Cmd_Argv(2) );
607                                 else
608                                         // CVar does not match; Reset to 0
609                                         Cvar_SetValueQuick(cvCVar, 0);
610                         }
611                         else
612                         { // Variable Values Specified
613                                 int nCnt;
614                                 int bFound = 0;
615
616                                 for(nCnt = 2; nCnt < nNumArgs; nCnt++)
617                                 { // Cycle through Values
618                                         if( strcmp(cvCVar->string, Cmd_Argv(nCnt) ) == 0)
619                                         { // Current Value Located; Increment to Next
620                                                 if( (nCnt + 1) == nNumArgs)
621                                                         // Max Value Reached; Reset
622                                                         Cvar_SetQuick(cvCVar, Cmd_Argv(2) );
623                                                 else
624                                                         // Next Value
625                                                         Cvar_SetQuick(cvCVar, Cmd_Argv(nCnt + 1) );
626
627                                                 // End Loop
628                                                 nCnt = nNumArgs;
629                                                 // Assign Found
630                                                 bFound = 1;
631                                         }
632                                 }
633                                 if(!bFound)
634                                         // Value not Found; Reset to Original
635                                         Cvar_SetQuick(cvCVar, Cmd_Argv(2) );
636                         }
637
638                 }
639                 else
640                 { // Invalid CVar
641                         Con_Printf("ERROR : CVar '%s' not found\n", Cmd_Argv(1) );
642                 }
643         }
644 }
645
646 /*
647 ===============
648 Cmd_Alias_f
649
650 Creates a new command that executes a command string (possibly ; seperated)
651 ===============
652 */
653 static void Cmd_Alias_f (void)
654 {
655         cmdalias_t      *a;
656         char            cmd[MAX_INPUTLINE];
657         int                     i, c;
658         const char              *s;
659         size_t          alloclen;
660
661         if (Cmd_Argc() == 1)
662         {
663                 Con_Print("Current alias commands:\n");
664                 for (a = cmd_alias ; a ; a=a->next)
665                         Con_Printf("%s : %s", a->name, a->value);
666                 return;
667         }
668
669         s = Cmd_Argv(1);
670         if (strlen(s) >= MAX_ALIAS_NAME)
671         {
672                 Con_Print("Alias name is too long\n");
673                 return;
674         }
675
676         // if the alias already exists, reuse it
677         for (a = cmd_alias ; a ; a=a->next)
678         {
679                 if (!strcmp(s, a->name))
680                 {
681                         Z_Free (a->value);
682                         break;
683                 }
684         }
685
686         if (!a)
687         {
688                 cmdalias_t *prev, *current;
689
690                 a = (cmdalias_t *)Z_Malloc (sizeof(cmdalias_t));
691                 strlcpy (a->name, s, sizeof (a->name));
692                 // insert it at the right alphanumeric position
693                 for( prev = NULL, current = cmd_alias ; current && strcmp( current->name, a->name ) < 0 ; prev = current, current = current->next )
694                         ;
695                 if( prev ) {
696                         prev->next = a;
697                 } else {
698                         cmd_alias = a;
699                 }
700                 a->next = current;
701         }
702
703
704 // copy the rest of the command line
705         cmd[0] = 0;             // start out with a null string
706         c = Cmd_Argc();
707         for (i=2 ; i < c ; i++)
708         {
709                 if (i != 2)
710                         strlcat (cmd, " ", sizeof (cmd));
711                 strlcat (cmd, Cmd_Argv(i), sizeof (cmd));
712         }
713         strlcat (cmd, "\n", sizeof (cmd));
714
715         alloclen = strlen (cmd) + 1;
716         if(alloclen >= 2)
717                 cmd[alloclen - 2] = '\n'; // to make sure a newline is appended even if too long
718         a->value = (char *)Z_Malloc (alloclen);
719         memcpy (a->value, cmd, alloclen);
720 }
721
722 /*
723 ===============
724 Cmd_UnAlias_f
725
726 Remove existing aliases.
727 ===============
728 */
729 static void Cmd_UnAlias_f (void)
730 {
731         cmdalias_t      *a, *p;
732         int i;
733         const char *s;
734
735         if(Cmd_Argc() == 1)
736         {
737                 Con_Print("unalias: Usage: unalias alias1 [alias2 ...]\n");
738                 return;
739         }
740
741         for(i = 1; i < Cmd_Argc(); ++i)
742         {
743                 s = Cmd_Argv(i);
744                 p = NULL;
745                 for(a = cmd_alias; a; p = a, a = a->next)
746                 {
747                         if(!strcmp(s, a->name))
748                         {
749                                 if (a->initstate) // we can not remove init aliases
750                                         continue;
751                                 if(a == cmd_alias)
752                                         cmd_alias = a->next;
753                                 if(p)
754                                         p->next = a->next;
755                                 Z_Free(a->value);
756                                 Z_Free(a);
757                                 break;
758                         }
759                 }
760                 if(!a)
761                         Con_Printf("unalias: %s alias not found\n", s);
762         }
763 }
764
765 /*
766 =============================================================================
767
768                                         COMMAND EXECUTION
769
770 =============================================================================
771 */
772
773 typedef struct cmd_function_s
774 {
775         struct cmd_function_s *next;
776         const char *name;
777         const char *description;
778         xcommand_t consolefunction;
779         xcommand_t clientfunction;
780         qboolean csqcfunc;
781         qboolean initstate; // indicates this command existed at init
782 } cmd_function_t;
783
784 static int cmd_argc;
785 static const char *cmd_argv[MAX_ARGS];
786 static const char *cmd_null_string = "";
787 static const char *cmd_args;
788 cmd_source_t cmd_source;
789
790
791 static cmd_function_t *cmd_functions;           // possible commands to execute
792
793 static const char *Cmd_GetDirectCvarValue(const char *varname, cmdalias_t *alias, qboolean *is_multiple)
794 {
795         cvar_t *cvar;
796         long argno;
797         char *endptr;
798         char vabuf[1024];
799
800         if(is_multiple)
801                 *is_multiple = false;
802
803         if(!varname || !*varname)
804                 return NULL;
805
806         if(alias)
807         {
808                 if(!strcmp(varname, "*"))
809                 {
810                         if(is_multiple)
811                                 *is_multiple = true;
812                         return Cmd_Args();
813                 }
814                 else if(!strcmp(varname, "#"))
815                 {
816                         return va(vabuf, sizeof(vabuf), "%d", Cmd_Argc());
817                 }
818                 else if(varname[strlen(varname) - 1] == '-')
819                 {
820                         argno = strtol(varname, &endptr, 10);
821                         if(endptr == varname + strlen(varname) - 1)
822                         {
823                                 // whole string is a number, apart from the -
824                                 const char *p = Cmd_Args();
825                                 for(; argno > 1; --argno)
826                                         if(!COM_ParseToken_Console(&p))
827                                                 break;
828                                 if(p)
829                                 {
830                                         if(is_multiple)
831                                                 *is_multiple = true;
832
833                                         // kill pre-argument whitespace
834                                         for (;*p && ISWHITESPACE(*p);p++)
835                                                 ;
836
837                                         return p;
838                                 }
839                         }
840                 }
841                 else
842                 {
843                         argno = strtol(varname, &endptr, 10);
844                         if(*endptr == 0)
845                         {
846                                 // whole string is a number
847                                 // NOTE: we already made sure we don't have an empty cvar name!
848                                 if(argno >= 0 && argno < Cmd_Argc())
849                                         return Cmd_Argv(argno);
850                         }
851                 }
852         }
853
854         if((cvar = Cvar_FindVar(varname)) && !(cvar->flags & CVAR_PRIVATE))
855                 return cvar->string;
856
857         return NULL;
858 }
859
860 qboolean Cmd_QuoteString(char *out, size_t outlen, const char *in, const char *quoteset, qboolean putquotes)
861 {
862         qboolean quote_quot = !!strchr(quoteset, '"');
863         qboolean quote_backslash = !!strchr(quoteset, '\\');
864         qboolean quote_dollar = !!strchr(quoteset, '$');
865
866         if(putquotes)
867         {
868                 if(outlen <= 2)
869                 {
870                         *out++ = 0;
871                         return false;
872                 }
873                 *out++ = '"'; --outlen;
874                 --outlen;
875         }
876
877         while(*in)
878         {
879                 if(*in == '"' && quote_quot)
880                 {
881                         if(outlen <= 2)
882                                 goto fail;
883                         *out++ = '\\'; --outlen;
884                         *out++ = '"'; --outlen;
885                 }
886                 else if(*in == '\\' && quote_backslash)
887                 {
888                         if(outlen <= 2)
889                                 goto fail;
890                         *out++ = '\\'; --outlen;
891                         *out++ = '\\'; --outlen;
892                 }
893                 else if(*in == '$' && quote_dollar)
894                 {
895                         if(outlen <= 2)
896                                 goto fail;
897                         *out++ = '$'; --outlen;
898                         *out++ = '$'; --outlen;
899                 }
900                 else
901                 {
902                         if(outlen <= 1)
903                                 goto fail;
904                         *out++ = *in; --outlen;
905                 }
906                 ++in;
907         }
908         if(putquotes)
909                 *out++ = '"';
910         *out++ = 0;
911         return true;
912 fail:
913         if(putquotes)
914                 *out++ = '"';
915         *out++ = 0;
916         return false;
917 }
918
919 static const char *Cmd_GetCvarValue(const char *var, size_t varlen, cmdalias_t *alias)
920 {
921         static char varname[MAX_INPUTLINE]; // cmd_mutex
922         static char varval[MAX_INPUTLINE]; // cmd_mutex
923         const char *varstr;
924         char *varfunc;
925 static char asis[] = "asis"; // just to suppress const char warnings
926
927         if(varlen >= MAX_INPUTLINE)
928                 varlen = MAX_INPUTLINE - 1;
929         memcpy(varname, var, varlen);
930         varname[varlen] = 0;
931         varfunc = strchr(varname, ' ');
932
933         if(varfunc)
934         {
935                 *varfunc = 0;
936                 ++varfunc;
937         }
938
939         if(*var == 0)
940         {
941                 // empty cvar name?
942                 return NULL;
943         }
944
945         varstr = NULL;
946
947         if(varname[0] == '$')
948                 varstr = Cmd_GetDirectCvarValue(Cmd_GetDirectCvarValue(varname + 1, alias, NULL), alias, NULL);
949         else
950         {
951                 qboolean is_multiple = false;
952                 // Exception: $* and $n- don't use the quoted form by default
953                 varstr = Cmd_GetDirectCvarValue(varname, alias, &is_multiple);
954                 if(is_multiple)
955                         if(!varfunc)
956                                 varfunc = asis;
957         }
958
959         if(!varstr)
960         {
961                 if(alias)
962                         Con_Printf("Warning: Could not expand $%s in alias %s\n", varname, alias->name);
963                 else
964                         Con_Printf("Warning: Could not expand $%s\n", varname);
965                 return NULL;
966         }
967
968         if(!varfunc || !strcmp(varfunc, "q")) // note: quoted form is default, use "asis" to override!
969         {
970                 // quote it so it can be used inside double quotes
971                 // we just need to replace " by \", and of course, double backslashes
972                 Cmd_QuoteString(varval, sizeof(varval), varstr, "\"\\", false);
973                 return varval;
974         }
975         else if(!strcmp(varfunc, "asis"))
976         {
977                 return varstr;
978         }
979         else
980                 Con_Printf("Unknown variable function %s\n", varfunc);
981
982         return varstr;
983 }
984
985 /*
986 Cmd_PreprocessString
987
988 Preprocesses strings and replaces $*, $param#, $cvar accordingly. Also strips comments.
989 */
990 static void Cmd_PreprocessString( const char *intext, char *outtext, unsigned maxoutlen, cmdalias_t *alias ) {
991         const char *in;
992         size_t eat, varlen;
993         unsigned outlen;
994         const char *val;
995
996         // don't crash if there's no room in the outtext buffer
997         if( maxoutlen == 0 ) {
998                 return;
999         }
1000         maxoutlen--; // because of \0
1001
1002         in = intext;
1003         outlen = 0;
1004
1005         while( *in && outlen < maxoutlen ) {
1006                 if( *in == '$' ) {
1007                         // this is some kind of expansion, see what comes after the $
1008                         in++;
1009
1010                         // The console does the following preprocessing:
1011                         //
1012                         // - $$ is transformed to a single dollar sign.
1013                         // - $var or ${var} are expanded to the contents of the named cvar,
1014                         //   with quotation marks and backslashes quoted so it can safely
1015                         //   be used inside quotation marks (and it should always be used
1016                         //   that way)
1017                         // - ${var asis} inserts the cvar value as is, without doing this
1018                         //   quoting
1019                         // - prefix the cvar name with a dollar sign to do indirection;
1020                         //   for example, if $x has the value timelimit, ${$x} will return
1021                         //   the value of $timelimit
1022                         // - when expanding an alias, the special variable name $* refers
1023                         //   to all alias parameters, and a number refers to that numbered
1024                         //   alias parameter, where the name of the alias is $0, the first
1025                         //   parameter is $1 and so on; as a special case, $* inserts all
1026                         //   parameters, without extra quoting, so one can use $* to just
1027                         //   pass all parameters around. All parameters starting from $n
1028                         //   can be referred to as $n- (so $* is equivalent to $1-).
1029                         //
1030                         // Note: when expanding an alias, cvar expansion is done in the SAME step
1031                         // as alias expansion so that alias parameters or cvar values containing
1032                         // dollar signs have no unwanted bad side effects. However, this needs to
1033                         // be accounted for when writing complex aliases. For example,
1034                         //   alias foo "set x NEW; echo $x"
1035                         // actually expands to
1036                         //   "set x NEW; echo OLD"
1037                         // and will print OLD! To work around this, use a second alias:
1038                         //   alias foo "set x NEW; foo2"
1039                         //   alias foo2 "echo $x"
1040                         //
1041                         // Also note: lines starting with alias are exempt from cvar expansion.
1042                         // If you want cvar expansion, write "alias" instead:
1043                         //
1044                         //   set x 1
1045                         //   alias foo "echo $x"
1046                         //   "alias" bar "echo $x"
1047                         //   set x 2
1048                         //
1049                         // foo will print 2, because the variable $x will be expanded when the alias
1050                         // gets expanded. bar will print 1, because the variable $x was expanded
1051                         // at definition time. foo can be equivalently defined as
1052                         //
1053                         //   "alias" foo "echo $$x"
1054                         //
1055                         // because at definition time, $$ will get replaced to a single $.
1056
1057                         if( *in == '$' ) {
1058                                 val = "$";
1059                                 eat = 1;
1060                         } else if(*in == '{') {
1061                                 varlen = strcspn(in + 1, "}");
1062                                 if(in[varlen + 1] == '}')
1063                                 {
1064                                         val = Cmd_GetCvarValue(in + 1, varlen, alias);
1065                                         eat = varlen + 2;
1066                                 }
1067                                 else
1068                                 {
1069                                         // ran out of data?
1070                                         val = NULL;
1071                                         eat = varlen + 1;
1072                                 }
1073                         } else {
1074                                 varlen = strspn(in, "#*0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ_-");
1075                                 val = Cmd_GetCvarValue(in, varlen, alias);
1076                                 eat = varlen;
1077                         }
1078                         if(val)
1079                         {
1080                                 // insert the cvar value
1081                                 while(*val && outlen < maxoutlen)
1082                                         outtext[outlen++] = *val++;
1083                                 in += eat;
1084                         }
1085                         else
1086                         {
1087                                 // copy the unexpanded text
1088                                 outtext[outlen++] = '$';
1089                                 while(eat && outlen < maxoutlen)
1090                                 {
1091                                         outtext[outlen++] = *in++;
1092                                         --eat;
1093                                 }
1094                         }
1095                 }
1096                 else 
1097                         outtext[outlen++] = *in++;
1098         }
1099         outtext[outlen] = 0;
1100 }
1101
1102 /*
1103 ============
1104 Cmd_ExecuteAlias
1105
1106 Called for aliases and fills in the alias into the cbuffer
1107 ============
1108 */
1109 static void Cmd_ExecuteAlias (cmdalias_t *alias)
1110 {
1111         static char buffer[ MAX_INPUTLINE ]; // cmd_mutex
1112         static char buffer2[ MAX_INPUTLINE ]; // cmd_mutex
1113         Cmd_PreprocessString( alias->value, buffer, sizeof(buffer) - 2, alias );
1114         // insert at start of command buffer, so that aliases execute in order
1115         // (fixes bug introduced by Black on 20050705)
1116
1117         // Note: Cbuf_PreprocessString will be called on this string AGAIN! So we
1118         // have to make sure that no second variable expansion takes place, otherwise
1119         // alias parameters containing dollar signs can have bad effects.
1120         Cmd_QuoteString(buffer2, sizeof(buffer2), buffer, "$", false);
1121         Cbuf_InsertText( buffer2 );
1122 }
1123
1124 /*
1125 ========
1126 Cmd_List
1127
1128         CmdList Added by EvilTypeGuy eviltypeguy@qeradiant.com
1129         Thanks to Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
1130
1131 ========
1132 */
1133 static void Cmd_List_f (void)
1134 {
1135         cmd_function_t *cmd;
1136         const char *partial;
1137         size_t len;
1138         int count;
1139         qboolean ispattern;
1140
1141         if (Cmd_Argc() > 1)
1142         {
1143                 partial = Cmd_Argv (1);
1144                 len = strlen(partial);
1145         }
1146         else
1147         {
1148                 partial = NULL;
1149                 len = 0;
1150         }
1151
1152         ispattern = partial && (strchr(partial, '*') || strchr(partial, '?'));
1153
1154         count = 0;
1155         for (cmd = cmd_functions; cmd; cmd = cmd->next)
1156         {
1157                 if (partial && (ispattern ? !matchpattern_with_separator(cmd->name, partial, false, "", false) : strncmp(partial, cmd->name, len)))
1158                         continue;
1159                 Con_Printf("%s : %s\n", cmd->name, cmd->description);
1160                 count++;
1161         }
1162
1163         if (len)
1164         {
1165                 if(ispattern)
1166                         Con_Printf("%i Command%s matching \"%s\"\n\n", count, (count > 1) ? "s" : "", partial);
1167                 else
1168                         Con_Printf("%i Command%s beginning with \"%s\"\n\n", count, (count > 1) ? "s" : "", partial);
1169         }
1170         else
1171                 Con_Printf("%i Command%s\n\n", count, (count > 1) ? "s" : "");
1172 }
1173
1174 static void Cmd_Apropos_f(void)
1175 {
1176         cmd_function_t *cmd;
1177         cvar_t *cvar;
1178         cmdalias_t *alias;
1179         const char *partial;
1180         int count;
1181         qboolean ispattern;
1182         char vabuf[1024];
1183
1184         if (Cmd_Argc() > 1)
1185                 partial = Cmd_Args();
1186         else
1187         {
1188                 Con_Printf("usage: apropos <string>\n");
1189                 return;
1190         }
1191
1192         ispattern = partial && (strchr(partial, '*') || strchr(partial, '?'));
1193         if(!ispattern)
1194                 partial = va(vabuf, sizeof(vabuf), "*%s*", partial);
1195
1196         count = 0;
1197         for (cvar = cvar_vars; cvar; cvar = cvar->next)
1198         {
1199                 if (!matchpattern_with_separator(cvar->name, partial, true, "", false))
1200                 if (!matchpattern_with_separator(cvar->description, partial, true, "", false))
1201                         continue;
1202                 Con_Printf ("cvar ^3%s^7 is \"%s\" [\"%s\"] %s\n", cvar->name, cvar->string, cvar->defstring, cvar->description);
1203                 count++;
1204         }
1205         for (cmd = cmd_functions; cmd; cmd = cmd->next)
1206         {
1207                 if (!matchpattern_with_separator(cmd->name, partial, true, "", false))
1208                 if (!matchpattern_with_separator(cmd->description, partial, true, "", false))
1209                         continue;
1210                 Con_Printf("command ^2%s^7: %s\n", cmd->name, cmd->description);
1211                 count++;
1212         }
1213         for (alias = cmd_alias; alias; alias = alias->next)
1214         {
1215                 // procede here a bit differently as an alias value always got a final \n
1216                 if (!matchpattern_with_separator(alias->name, partial, true, "", false))
1217                 if (!matchpattern_with_separator(alias->value, partial, true, "\n", false)) // when \n is as separator wildcards don't match it
1218                         continue;
1219                 Con_Printf("alias ^5%s^7: %s", alias->name, alias->value); // do not print an extra \n
1220                 count++;
1221         }
1222         Con_Printf("%i result%s\n\n", count, (count > 1) ? "s" : "");
1223 }
1224
1225 /*
1226 ============
1227 Cmd_Init
1228 ============
1229 */
1230 void Cmd_Init (void)
1231 {
1232         cmd_mempool = Mem_AllocPool("commands", 0, NULL);
1233         // space for commands and script files
1234         cmd_text.data = cmd_text_buf;
1235         cmd_text.maxsize = sizeof(cmd_text_buf);
1236         cmd_text.cursize = 0;
1237
1238         if (Thread_HasThreads())
1239                 cmd_text_mutex = Thread_CreateMutex();
1240 }
1241
1242 void Cmd_Init_Commands (void)
1243 {
1244 //
1245 // register our commands
1246 //
1247         Cmd_AddCommand ("stuffcmds",Cmd_StuffCmds_f, "execute commandline parameters (must be present in quake.rc script)");
1248         Cmd_AddCommand ("exec",Cmd_Exec_f, "execute a script file");
1249         Cmd_AddCommand ("echo",Cmd_Echo_f, "print a message to the console (useful in scripts)");
1250         Cmd_AddCommand ("alias",Cmd_Alias_f, "create a script function (parameters are passed in as $X (being X a number), $* for all parameters, $X- for all parameters starting from $X). Without arguments show the list of all alias");
1251         Cmd_AddCommand ("unalias",Cmd_UnAlias_f, "remove an alias");
1252         Cmd_AddCommand ("cmd", Cmd_ForwardToServer, "send a console commandline to the server (used by some mods)");
1253         Cmd_AddCommand ("wait", Cmd_Wait_f, "make script execution wait for next rendered frame");
1254         Cmd_AddCommand ("set", Cvar_Set_f, "create or change the value of a console variable");
1255         Cmd_AddCommand ("seta", Cvar_SetA_f, "create or change the value of a console variable that will be saved to config.cfg");
1256         Cmd_AddCommand ("unset", Cvar_Del_f, "delete a cvar (does not work for static ones like _cl_name, or read-only ones)");
1257 #ifdef FILLALLCVARSWITHRUBBISH
1258         Cmd_AddCommand ("fillallcvarswithrubbish", Cvar_FillAll_f, "fill all cvars with a specified number of characters to provoke buffer overruns");
1259 #endif /* FILLALLCVARSWITHRUBBISH */
1260
1261         // 2000-01-09 CmdList, CvarList commands By Matthias "Maddes" Buecher
1262         // Added/Modified by EvilTypeGuy eviltypeguy@qeradiant.com
1263         Cmd_AddCommand ("cmdlist", Cmd_List_f, "lists all console commands beginning with the specified prefix or matching the specified wildcard pattern");
1264         Cmd_AddCommand ("cvarlist", Cvar_List_f, "lists all console variables beginning with the specified prefix or matching the specified wildcard pattern");
1265         Cmd_AddCommand ("apropos", Cmd_Apropos_f, "lists all console variables/commands/aliases containing the specified string in the name or description");
1266
1267         Cmd_AddCommand ("cvar_lockdefaults", Cvar_LockDefaults_f, "stores the current values of all cvars into their default values, only used once during startup after parsing default.cfg");
1268         Cmd_AddCommand ("cvar_resettodefaults_all", Cvar_ResetToDefaults_All_f, "sets all cvars to their locked default values");
1269         Cmd_AddCommand ("cvar_resettodefaults_nosaveonly", Cvar_ResetToDefaults_NoSaveOnly_f, "sets all non-saved cvars to their locked default values (variables that will not be saved to config.cfg)");
1270         Cmd_AddCommand ("cvar_resettodefaults_saveonly", Cvar_ResetToDefaults_SaveOnly_f, "sets all saved cvars to their locked default values (variables that will be saved to config.cfg)");
1271
1272         Cmd_AddCommand ("cprint", Cmd_Centerprint_f, "print something at the screen center");
1273         Cmd_AddCommand ("defer", Cmd_Defer_f, "execute a command in the future");
1274
1275         // DRESK - 5/14/06
1276         // Support Doom3-style Toggle Command
1277         Cmd_AddCommand( "toggle", Cmd_Toggle_f, "toggles a console variable's values (use for more info)");
1278 }
1279
1280 /*
1281 ============
1282 Cmd_Shutdown
1283 ============
1284 */
1285 void Cmd_Shutdown(void)
1286 {
1287         if (cmd_text_mutex)
1288         {
1289                 // we usually have this locked when we get here from Host_Quit_f
1290                 Cbuf_UnlockThreadMutex();
1291                 Thread_DestroyMutex(cmd_text_mutex);
1292         }
1293         cmd_text_mutex = NULL;
1294
1295         Mem_FreePool(&cmd_mempool);
1296 }
1297
1298 /*
1299 ============
1300 Cmd_Argc
1301 ============
1302 */
1303 int             Cmd_Argc (void)
1304 {
1305         return cmd_argc;
1306 }
1307
1308 /*
1309 ============
1310 Cmd_Argv
1311 ============
1312 */
1313 const char *Cmd_Argv (int arg)
1314 {
1315         if (arg >= cmd_argc )
1316                 return cmd_null_string;
1317         return cmd_argv[arg];
1318 }
1319
1320 /*
1321 ============
1322 Cmd_Args
1323 ============
1324 */
1325 const char *Cmd_Args (void)
1326 {
1327         return cmd_args;
1328 }
1329
1330
1331 /*
1332 ============
1333 Cmd_TokenizeString
1334
1335 Parses the given string into command line tokens.
1336 ============
1337 */
1338 // AK: This function should only be called from ExcuteString because the current design is a bit of an hack
1339 static void Cmd_TokenizeString (const char *text)
1340 {
1341         int l;
1342
1343         cmd_argc = 0;
1344         cmd_args = NULL;
1345
1346         while (1)
1347         {
1348                 // skip whitespace up to a /n
1349                 while (*text && ISWHITESPACE(*text) && *text != '\r' && *text != '\n')
1350                         text++;
1351
1352                 // line endings:
1353                 // UNIX: \n
1354                 // Mac: \r
1355                 // Windows: \r\n
1356                 if (*text == '\n' || *text == '\r')
1357                 {
1358                         // a newline separates commands in the buffer
1359                         if (*text == '\r' && text[1] == '\n')
1360                                 text++;
1361                         text++;
1362                         break;
1363                 }
1364
1365                 if (!*text)
1366                         return;
1367
1368                 if (cmd_argc == 1)
1369                         cmd_args = text;
1370
1371                 if (!COM_ParseToken_Console(&text))
1372                         return;
1373
1374                 if (cmd_argc < MAX_ARGS)
1375                 {
1376                         l = (int)strlen(com_token) + 1;
1377                         if (cmd_tokenizebufferpos + l > CMD_TOKENIZELENGTH)
1378                         {
1379                                 Con_Printf("Cmd_TokenizeString: ran out of %i character buffer space for command arguements\n", CMD_TOKENIZELENGTH);
1380                                 break;
1381                         }
1382                         memcpy (cmd_tokenizebuffer + cmd_tokenizebufferpos, com_token, l);
1383                         cmd_argv[cmd_argc] = cmd_tokenizebuffer + cmd_tokenizebufferpos;
1384                         cmd_tokenizebufferpos += l;
1385                         cmd_argc++;
1386                 }
1387         }
1388 }
1389
1390
1391 /*
1392 ============
1393 Cmd_AddCommand
1394 ============
1395 */
1396 void Cmd_AddCommand_WithClientCommand (const char *cmd_name, xcommand_t consolefunction, xcommand_t clientfunction, const char *description)
1397 {
1398         cmd_function_t *cmd;
1399         cmd_function_t *prev, *current;
1400
1401 // fail if the command is a variable name
1402         if (Cvar_FindVar( cmd_name ))
1403         {
1404                 Con_Printf("Cmd_AddCommand: %s already defined as a var\n", cmd_name);
1405                 return;
1406         }
1407
1408 // fail if the command already exists
1409         for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
1410         {
1411                 if (!strcmp (cmd_name, cmd->name))
1412                 {
1413                         if (consolefunction || clientfunction)
1414                         {
1415                                 Con_Printf("Cmd_AddCommand: %s already defined\n", cmd_name);
1416                                 return;
1417                         }
1418                         else    //[515]: csqc
1419                         {
1420                                 cmd->csqcfunc = true;
1421                                 return;
1422                         }
1423                 }
1424         }
1425
1426         cmd = (cmd_function_t *)Mem_Alloc(cmd_mempool, sizeof(cmd_function_t));
1427         cmd->name = cmd_name;
1428         cmd->consolefunction = consolefunction;
1429         cmd->clientfunction = clientfunction;
1430         cmd->description = description;
1431         if(!consolefunction && !clientfunction)                 //[515]: csqc
1432                 cmd->csqcfunc = true;
1433         cmd->next = cmd_functions;
1434
1435 // insert it at the right alphanumeric position
1436         for( prev = NULL, current = cmd_functions ; current && strcmp( current->name, cmd->name ) < 0 ; prev = current, current = current->next )
1437                 ;
1438         if( prev ) {
1439                 prev->next = cmd;
1440         } else {
1441                 cmd_functions = cmd;
1442         }
1443         cmd->next = current;
1444 }
1445
1446 void Cmd_AddCommand (const char *cmd_name, xcommand_t function, const char *description)
1447 {
1448         Cmd_AddCommand_WithClientCommand (cmd_name, function, NULL, description);
1449 }
1450
1451 /*
1452 ============
1453 Cmd_Exists
1454 ============
1455 */
1456 qboolean Cmd_Exists (const char *cmd_name)
1457 {
1458         cmd_function_t  *cmd;
1459
1460         for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
1461                 if (!strcmp (cmd_name,cmd->name))
1462                         return true;
1463
1464         return false;
1465 }
1466
1467
1468 /*
1469 ============
1470 Cmd_CompleteCommand
1471 ============
1472 */
1473 const char *Cmd_CompleteCommand (const char *partial)
1474 {
1475         cmd_function_t *cmd;
1476         size_t len;
1477
1478         len = strlen(partial);
1479
1480         if (!len)
1481                 return NULL;
1482
1483 // check functions
1484         for (cmd = cmd_functions; cmd; cmd = cmd->next)
1485                 if (!strncasecmp(partial, cmd->name, len))
1486                         return cmd->name;
1487
1488         return NULL;
1489 }
1490
1491 /*
1492         Cmd_CompleteCountPossible
1493
1494         New function for tab-completion system
1495         Added by EvilTypeGuy
1496         Thanks to Fett erich@heintz.com
1497         Thanks to taniwha
1498
1499 */
1500 int Cmd_CompleteCountPossible (const char *partial)
1501 {
1502         cmd_function_t *cmd;
1503         size_t len;
1504         int h;
1505
1506         h = 0;
1507         len = strlen(partial);
1508
1509         if (!len)
1510                 return 0;
1511
1512         // Loop through the command list and count all partial matches
1513         for (cmd = cmd_functions; cmd; cmd = cmd->next)
1514                 if (!strncasecmp(partial, cmd->name, len))
1515                         h++;
1516
1517         return h;
1518 }
1519
1520 /*
1521         Cmd_CompleteBuildList
1522
1523         New function for tab-completion system
1524         Added by EvilTypeGuy
1525         Thanks to Fett erich@heintz.com
1526         Thanks to taniwha
1527
1528 */
1529 const char **Cmd_CompleteBuildList (const char *partial)
1530 {
1531         cmd_function_t *cmd;
1532         size_t len = 0;
1533         size_t bpos = 0;
1534         size_t sizeofbuf = (Cmd_CompleteCountPossible (partial) + 1) * sizeof (const char *);
1535         const char **buf;
1536
1537         len = strlen(partial);
1538         buf = (const char **)Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
1539         // Loop through the alias list and print all matches
1540         for (cmd = cmd_functions; cmd; cmd = cmd->next)
1541                 if (!strncasecmp(partial, cmd->name, len))
1542                         buf[bpos++] = cmd->name;
1543
1544         buf[bpos] = NULL;
1545         return buf;
1546 }
1547
1548 // written by LordHavoc
1549 void Cmd_CompleteCommandPrint (const char *partial)
1550 {
1551         cmd_function_t *cmd;
1552         size_t len = strlen(partial);
1553         // Loop through the command list and print all matches
1554         for (cmd = cmd_functions; cmd; cmd = cmd->next)
1555                 if (!strncasecmp(partial, cmd->name, len))
1556                         Con_Printf("^2%s^7: %s\n", cmd->name, cmd->description);
1557 }
1558
1559 /*
1560         Cmd_CompleteAlias
1561
1562         New function for tab-completion system
1563         Added by EvilTypeGuy
1564         Thanks to Fett erich@heintz.com
1565         Thanks to taniwha
1566
1567 */
1568 const char *Cmd_CompleteAlias (const char *partial)
1569 {
1570         cmdalias_t *alias;
1571         size_t len;
1572
1573         len = strlen(partial);
1574
1575         if (!len)
1576                 return NULL;
1577
1578         // Check functions
1579         for (alias = cmd_alias; alias; alias = alias->next)
1580                 if (!strncasecmp(partial, alias->name, len))
1581                         return alias->name;
1582
1583         return NULL;
1584 }
1585
1586 // written by LordHavoc
1587 void Cmd_CompleteAliasPrint (const char *partial)
1588 {
1589         cmdalias_t *alias;
1590         size_t len = strlen(partial);
1591         // Loop through the alias list and print all matches
1592         for (alias = cmd_alias; alias; alias = alias->next)
1593                 if (!strncasecmp(partial, alias->name, len))
1594                         Con_Printf("^5%s^7: %s", alias->name, alias->value);
1595 }
1596
1597
1598 /*
1599         Cmd_CompleteAliasCountPossible
1600
1601         New function for tab-completion system
1602         Added by EvilTypeGuy
1603         Thanks to Fett erich@heintz.com
1604         Thanks to taniwha
1605
1606 */
1607 int Cmd_CompleteAliasCountPossible (const char *partial)
1608 {
1609         cmdalias_t      *alias;
1610         size_t          len;
1611         int                     h;
1612
1613         h = 0;
1614
1615         len = strlen(partial);
1616
1617         if (!len)
1618                 return 0;
1619
1620         // Loop through the command list and count all partial matches
1621         for (alias = cmd_alias; alias; alias = alias->next)
1622                 if (!strncasecmp(partial, alias->name, len))
1623                         h++;
1624
1625         return h;
1626 }
1627
1628 /*
1629         Cmd_CompleteAliasBuildList
1630
1631         New function for tab-completion system
1632         Added by EvilTypeGuy
1633         Thanks to Fett erich@heintz.com
1634         Thanks to taniwha
1635
1636 */
1637 const char **Cmd_CompleteAliasBuildList (const char *partial)
1638 {
1639         cmdalias_t *alias;
1640         size_t len = 0;
1641         size_t bpos = 0;
1642         size_t sizeofbuf = (Cmd_CompleteAliasCountPossible (partial) + 1) * sizeof (const char *);
1643         const char **buf;
1644
1645         len = strlen(partial);
1646         buf = (const char **)Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
1647         // Loop through the alias list and print all matches
1648         for (alias = cmd_alias; alias; alias = alias->next)
1649                 if (!strncasecmp(partial, alias->name, len))
1650                         buf[bpos++] = alias->name;
1651
1652         buf[bpos] = NULL;
1653         return buf;
1654 }
1655
1656 void Cmd_ClearCsqcFuncs (void)
1657 {
1658         cmd_function_t *cmd;
1659         for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
1660                 cmd->csqcfunc = false;
1661 }
1662
1663 /*
1664 ============
1665 Cmd_ExecuteString
1666
1667 A complete command line has been parsed, so try to execute it
1668 FIXME: lookupnoadd the token to speed search?
1669 ============
1670 */
1671 void Cmd_ExecuteString (const char *text, cmd_source_t src, qboolean lockmutex)
1672 {
1673         int oldpos;
1674         int found;
1675         cmd_function_t *cmd;
1676         cmdalias_t *a;
1677
1678         oldpos = cmd_tokenizebufferpos;
1679         cmd_source = src;
1680         found = false;
1681
1682         Cmd_TokenizeString (text);
1683
1684 // execute the command line
1685         if (!Cmd_Argc())
1686                 goto done; // no tokens
1687
1688 // check functions
1689         for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
1690         {
1691                 if (!strcasecmp (cmd_argv[0],cmd->name))
1692                 {
1693                         if (cmd->csqcfunc && CL_VM_ConsoleCommand (text))       //[515]: csqc
1694                                 goto done;
1695                         switch (src)
1696                         {
1697                         case src_command:
1698                                 if (cmd->consolefunction)
1699                                         cmd->consolefunction ();
1700                                 else if (cmd->clientfunction)
1701                                 {
1702                                         if (cls.state == ca_connected)
1703                                         {
1704                                                 // forward remote commands to the server for execution
1705                                                 Cmd_ForwardToServer();
1706                                         }
1707                                         else
1708                                                 Con_Printf("Can not send command \"%s\", not connected.\n", Cmd_Argv(0));
1709                                 }
1710                                 else
1711                                         Con_Printf("Command \"%s\" can not be executed\n", Cmd_Argv(0));
1712                                 found = true;
1713                                 goto command_found;
1714                         case src_client:
1715                                 if (cmd->clientfunction)
1716                                 {
1717                                         cmd->clientfunction ();
1718                                         goto done;
1719                                 }
1720                                 break;
1721                         }
1722                         break;
1723                 }
1724         }
1725 command_found:
1726
1727         // if it's a client command and no command was found, say so.
1728         if (cmd_source == src_client)
1729         {
1730                 Con_Printf("player \"%s\" tried to %s\n", host_client->name, text);
1731                 goto done;
1732         }
1733
1734 // check alias
1735         for (a=cmd_alias ; a ; a=a->next)
1736         {
1737                 if (!strcasecmp (cmd_argv[0], a->name))
1738                 {
1739                         Cmd_ExecuteAlias(a);
1740                         goto done;
1741                 }
1742         }
1743
1744         if(found) // if the command was hooked and found, all is good
1745                 goto done;
1746
1747 // check cvars
1748         if (!Cvar_Command () && host_framecount > 0)
1749                 Con_Printf("Unknown command \"%s\"\n", Cmd_Argv(0));
1750
1751 done:
1752         cmd_tokenizebufferpos = oldpos;
1753 }
1754
1755
1756 /*
1757 ===================
1758 Cmd_ForwardStringToServer
1759
1760 Sends an entire command string over to the server, unprocessed
1761 ===================
1762 */
1763 void Cmd_ForwardStringToServer (const char *s)
1764 {
1765         char temp[128];
1766         if (cls.state != ca_connected)
1767         {
1768                 Con_Printf("Can't \"%s\", not connected\n", s);
1769                 return;
1770         }
1771
1772         if (!cls.netcon)
1773                 return;
1774
1775         // LordHavoc: thanks to Fuh for bringing the pure evil of SZ_Print to my
1776         // attention, it has been eradicated from here, its only (former) use in
1777         // all of darkplaces.
1778         if (cls.protocol == PROTOCOL_QUAKEWORLD)
1779                 MSG_WriteByte(&cls.netcon->message, qw_clc_stringcmd);
1780         else
1781                 MSG_WriteByte(&cls.netcon->message, clc_stringcmd);
1782         if ((!strncmp(s, "say ", 4) || !strncmp(s, "say_team ", 9)) && cl_locs_enable.integer)
1783         {
1784                 // say/say_team commands can replace % character codes with status info
1785                 while (*s)
1786                 {
1787                         if (*s == '%' && s[1])
1788                         {
1789                                 // handle proquake message macros
1790                                 temp[0] = 0;
1791                                 switch (s[1])
1792                                 {
1793                                 case 'l': // current location
1794                                         CL_Locs_FindLocationName(temp, sizeof(temp), cl.movement_origin);
1795                                         break;
1796                                 case 'h': // current health
1797                                         dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_HEALTH]);
1798                                         break;
1799                                 case 'a': // current armor
1800                                         dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_ARMOR]);
1801                                         break;
1802                                 case 'x': // current rockets
1803                                         dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_ROCKETS]);
1804                                         break;
1805                                 case 'c': // current cells
1806                                         dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_CELLS]);
1807                                         break;
1808                                 // silly proquake macros
1809                                 case 'd': // loc at last death
1810                                         CL_Locs_FindLocationName(temp, sizeof(temp), cl.lastdeathorigin);
1811                                         break;
1812                                 case 't': // current time
1813                                         dpsnprintf(temp, sizeof(temp), "%.0f:%.0f", floor(cl.time / 60), cl.time - floor(cl.time / 60) * 60);
1814                                         break;
1815                                 case 'r': // rocket launcher status ("I have RL", "I need rockets", "I need RL")
1816                                         if (!(cl.stats[STAT_ITEMS] & IT_ROCKET_LAUNCHER))
1817                                                 dpsnprintf(temp, sizeof(temp), "I need RL");
1818                                         else if (!cl.stats[STAT_ROCKETS])
1819                                                 dpsnprintf(temp, sizeof(temp), "I need rockets");
1820                                         else
1821                                                 dpsnprintf(temp, sizeof(temp), "I have RL");
1822                                         break;
1823                                 case 'p': // powerup status (outputs "quad" "pent" and "eyes" according to status)
1824                                         if (cl.stats[STAT_ITEMS] & IT_QUAD)
1825                                         {
1826                                                 if (temp[0])
1827                                                         strlcat(temp, " ", sizeof(temp));
1828                                                 strlcat(temp, "quad", sizeof(temp));
1829                                         }
1830                                         if (cl.stats[STAT_ITEMS] & IT_INVULNERABILITY)
1831                                         {
1832                                                 if (temp[0])
1833                                                         strlcat(temp, " ", sizeof(temp));
1834                                                 strlcat(temp, "pent", sizeof(temp));
1835                                         }
1836                                         if (cl.stats[STAT_ITEMS] & IT_INVISIBILITY)
1837                                         {
1838                                                 if (temp[0])
1839                                                         strlcat(temp, " ", sizeof(temp));
1840                                                 strlcat(temp, "eyes", sizeof(temp));
1841                                         }
1842                                         break;
1843                                 case 'w': // weapon status (outputs "SSG:NG:SNG:GL:RL:LG" with the text between : characters omitted if you lack the weapon)
1844                                         if (cl.stats[STAT_ITEMS] & IT_SUPER_SHOTGUN)
1845                                                 strlcat(temp, "SSG", sizeof(temp));
1846                                         strlcat(temp, ":", sizeof(temp));
1847                                         if (cl.stats[STAT_ITEMS] & IT_NAILGUN)
1848                                                 strlcat(temp, "NG", sizeof(temp));
1849                                         strlcat(temp, ":", sizeof(temp));
1850                                         if (cl.stats[STAT_ITEMS] & IT_SUPER_NAILGUN)
1851                                                 strlcat(temp, "SNG", sizeof(temp));
1852                                         strlcat(temp, ":", sizeof(temp));
1853                                         if (cl.stats[STAT_ITEMS] & IT_GRENADE_LAUNCHER)
1854                                                 strlcat(temp, "GL", sizeof(temp));
1855                                         strlcat(temp, ":", sizeof(temp));
1856                                         if (cl.stats[STAT_ITEMS] & IT_ROCKET_LAUNCHER)
1857                                                 strlcat(temp, "RL", sizeof(temp));
1858                                         strlcat(temp, ":", sizeof(temp));
1859                                         if (cl.stats[STAT_ITEMS] & IT_LIGHTNING)
1860                                                 strlcat(temp, "LG", sizeof(temp));
1861                                         break;
1862                                 default:
1863                                         // not a recognized macro, print it as-is...
1864                                         temp[0] = s[0];
1865                                         temp[1] = s[1];
1866                                         temp[2] = 0;
1867                                         break;
1868                                 }
1869                                 // write the resulting text
1870                                 SZ_Write(&cls.netcon->message, (unsigned char *)temp, strlen(temp));
1871                                 s += 2;
1872                                 continue;
1873                         }
1874                         MSG_WriteByte(&cls.netcon->message, *s);
1875                         s++;
1876                 }
1877                 MSG_WriteByte(&cls.netcon->message, 0);
1878         }
1879         else // any other command is passed on as-is
1880                 SZ_Write(&cls.netcon->message, (const unsigned char *)s, (int)strlen(s) + 1);
1881 }
1882
1883 /*
1884 ===================
1885 Cmd_ForwardToServer
1886
1887 Sends the entire command line over to the server
1888 ===================
1889 */
1890 void Cmd_ForwardToServer (void)
1891 {
1892         const char *s;
1893         char vabuf[1024];
1894         if (!strcasecmp(Cmd_Argv(0), "cmd"))
1895         {
1896                 // we want to strip off "cmd", so just send the args
1897                 s = Cmd_Argc() > 1 ? Cmd_Args() : "";
1898         }
1899         else
1900         {
1901                 // we need to keep the command name, so send Cmd_Argv(0), a space and then Cmd_Args()
1902                 s = va(vabuf, sizeof(vabuf), "%s %s", Cmd_Argv(0), Cmd_Argc() > 1 ? Cmd_Args() : "");
1903         }
1904         // don't send an empty forward message if the user tries "cmd" by itself
1905         if (!s || !*s)
1906                 return;
1907         Cmd_ForwardStringToServer(s);
1908 }
1909
1910
1911 /*
1912 ================
1913 Cmd_CheckParm
1914
1915 Returns the position (1 to argc-1) in the command's argument list
1916 where the given parameter apears, or 0 if not present
1917 ================
1918 */
1919
1920 int Cmd_CheckParm (const char *parm)
1921 {
1922         int i;
1923
1924         if (!parm)
1925         {
1926                 Con_Printf ("Cmd_CheckParm: NULL");
1927                 return 0;
1928         }
1929
1930         for (i = 1; i < Cmd_Argc (); i++)
1931                 if (!strcasecmp (parm, Cmd_Argv (i)))
1932                         return i;
1933
1934         return 0;
1935 }
1936
1937
1938
1939 void Cmd_SaveInitState(void)
1940 {
1941         cmd_function_t *f;
1942         cmdalias_t *a;
1943         for (f = cmd_functions;f;f = f->next)
1944                 f->initstate = true;
1945         for (a = cmd_alias;a;a = a->next)
1946         {
1947                 a->initstate = true;
1948                 a->initialvalue = Mem_strdup(zonemempool, a->value);
1949         }
1950         Cvar_SaveInitState();
1951 }
1952
1953 void Cmd_RestoreInitState(void)
1954 {
1955         cmd_function_t *f, **fp;
1956         cmdalias_t *a, **ap;
1957         for (fp = &cmd_functions;(f = *fp);)
1958         {
1959                 if (f->initstate)
1960                         fp = &f->next;
1961                 else
1962                 {
1963                         // destroy this command, it didn't exist at init
1964                         Con_DPrintf("Cmd_RestoreInitState: Destroying command %s\n", f->name);
1965                         *fp = f->next;
1966                         Z_Free(f);
1967                 }
1968         }
1969         for (ap = &cmd_alias;(a = *ap);)
1970         {
1971                 if (a->initstate)
1972                 {
1973                         // restore this alias, it existed at init
1974                         if (strcmp(a->value ? a->value : "", a->initialvalue ? a->initialvalue : ""))
1975                         {
1976                                 Con_DPrintf("Cmd_RestoreInitState: Restoring alias %s\n", a->name);
1977                                 if (a->value)
1978                                         Z_Free(a->value);
1979                                 a->value = Mem_strdup(zonemempool, a->initialvalue);
1980                         }
1981                         ap = &a->next;
1982                 }
1983                 else
1984                 {
1985                         // free this alias, it didn't exist at init...
1986                         Con_DPrintf("Cmd_RestoreInitState: Destroying alias %s\n", a->name);
1987                         *ap = a->next;
1988                         if (a->value)
1989                                 Z_Free(a->value);
1990                         Z_Free(a);
1991                 }
1992         }
1993         Cvar_RestoreInitState();
1994 }