2 Copyright (C) 1996-1997 Id Software, Inc.
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.
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.
13 See the GNU General Public License for more details.
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.
20 // cmd.c -- Quake script command processing module
25 cmd_state_t cmd_client;
26 cmd_state_t cmd_clientfromserver;
27 cmd_state_t cmd_server;
28 cmd_state_t cmd_serverfromclient;
30 typedef struct cmd_iter_s {
35 static cmd_iter_t cmd_iter_all[] = {
37 {&cmd_clientfromserver},
39 {&cmd_serverfromclient},
44 // we only run the +whatever commandline arguments once
45 qboolean host_stuffcmdsrun = false;
47 //=============================================================================
49 void Cbuf_Lock(cmd_state_t *cmd)
51 Thread_AtomicLock(&cmd->text_lock);
54 void Cbuf_Unlock(cmd_state_t *cmd)
56 Thread_AtomicUnlock(&cmd->text_lock);
64 Causes execution of the remainder of the command buffer to be delayed until
65 next frame. This allows commands like:
66 bind g "impulse 5 ; +attack ; wait ; -attack ; impulse 2"
69 static void Cmd_Wait_f (cmd_state_t *cmd)
78 Cause a command to be executed after a delay.
81 static void Cmd_Defer_f (cmd_state_t *cmd)
83 if(Cmd_Argc(cmd) == 1)
85 cmddeferred_t *next = cmd->deferred_list;
87 Con_Printf("No commands are pending.\n");
90 Con_Printf("-> In %9.2f: %s\n", next->delay, next->value);
93 } else if(Cmd_Argc(cmd) == 2 && !strcasecmp("clear", Cmd_Argv(cmd, 1)))
95 while(cmd->deferred_list)
97 cmddeferred_t *defcmd = cmd->deferred_list;
98 cmd->deferred_list = defcmd->next;
99 Mem_Free(defcmd->value);
102 } else if(Cmd_Argc(cmd) == 3)
104 const char *value = Cmd_Argv(cmd, 2);
105 cmddeferred_t *defcmd = (cmddeferred_t*)Mem_Alloc(tempmempool, sizeof(*defcmd));
106 size_t len = strlen(value);
108 defcmd->delay = atof(Cmd_Argv(cmd, 1));
109 defcmd->value = (char*)Mem_Alloc(tempmempool, len+1);
110 memcpy(defcmd->value, value, len+1);
113 if(cmd->deferred_list)
115 cmddeferred_t *next = cmd->deferred_list;
120 cmd->deferred_list = defcmd;
121 /* Stupid me... this changes the order... so commands with the same delay go blub :S
122 defcmd->next = cmd_deferred_list;
123 cmd_deferred_list = defcmd;*/
125 Con_Printf("usage: defer <seconds> <command>\n"
135 Print something to the center of the screen using SCR_Centerprint
138 static void Cmd_Centerprint_f (cmd_state_t *cmd)
140 char msg[MAX_INPUTLINE];
141 unsigned int i, c, p;
145 strlcpy(msg, Cmd_Argv(cmd,1), sizeof(msg));
146 for(i = 2; i < c; ++i)
148 strlcat(msg, " ", sizeof(msg));
149 strlcat(msg, Cmd_Argv(cmd, i), sizeof(msg));
151 c = (unsigned int)strlen(msg);
152 for(p = 0, i = 0; i < c; ++i)
158 else if(msg[i+1] == '\\')
170 SCR_CenterPrint(msg);
175 =============================================================================
179 =============================================================================
186 Adds command text at the end of the buffer
189 void Cbuf_AddText (cmd_state_t *cmd, const char *text)
193 l = (int)strlen(text);
196 if (cmd->text.cursize + l >= (size_t)cmd->text.maxsize)
197 Con_Print("Cbuf_AddText: overflow\n");
199 SZ_Write(&cmd->text, (const unsigned char *)text, l);
208 Adds command text immediately after the current command
209 Adds a \n to the text
210 FIXME: actually change the command buffer to do less copying
213 void Cbuf_InsertText (cmd_state_t *cmd, const char *text)
215 size_t l = strlen(text);
217 // we need to memmove the existing text and stuff this in before it...
218 if (cmd->text.cursize + l >= (size_t)cmd->text.maxsize)
219 Con_Print("Cbuf_InsertText: overflow\n");
222 // we don't have a SZ_Prepend, so...
223 memmove(cmd->text.data + l, cmd->text.data, cmd->text.cursize);
224 cmd->text.cursize += (int)l;
225 memcpy(cmd->text.data, text, l);
232 Cbuf_Execute_Deferred --blub
235 static void Cbuf_Execute_Deferred (cmd_state_t *cmd)
237 static double oldrealtime = 0;
238 cmddeferred_t *defcmd, *prev;
240 if (realtime - oldrealtime < 0 || realtime - oldrealtime > 1800) oldrealtime = realtime;
241 eat = realtime - oldrealtime;
242 if (eat < (1.0 / 120.0))
244 oldrealtime = realtime;
246 defcmd = cmd->deferred_list;
249 defcmd->delay -= eat;
250 if(defcmd->delay <= 0)
252 Cbuf_AddText(cmd, defcmd->value);
253 Cbuf_AddText(cmd, ";\n");
254 Mem_Free(defcmd->value);
257 prev->next = defcmd->next;
261 cmd->deferred_list = defcmd->next;
263 defcmd = cmd->deferred_list;
268 defcmd = defcmd->next;
277 static qboolean Cmd_PreprocessString(cmd_state_t *cmd, const char *intext, char *outtext, unsigned maxoutlen, cmdalias_t *alias );
278 void Cbuf_Execute (cmd_state_t *cmd)
282 char line[MAX_INPUTLINE];
283 char preprocessed[MAX_INPUTLINE];
288 // LadyHavoc: making sure the tokenizebuffer doesn't get filled up by repeated crashes
289 cmd->tokenizebufferpos = 0;
291 while (cmd->text.cursize)
293 // find a \n or ; line break
294 text = (char *)cmd->text.data;
298 for (i=0 ; i < cmd->text.cursize ; i++)
307 // make sure i doesn't get > cursize which causes a negative
308 // size in memmove, which is fatal --blub
309 if (i < (cmd->text.cursize-1) && (text[i] == '\\' && (text[i+1] == '"' || text[i+1] == '\\')))
314 if(text[i] == '/' && text[i + 1] == '/' && (i == 0 || ISWHITESPACE(text[i-1])))
317 break; // don't break if inside a quoted string or comment
321 if (text[i] == '\r' || text[i] == '\n')
325 // better than CRASHING on overlong input lines that may SOMEHOW enter the buffer
326 if(i >= MAX_INPUTLINE)
328 Con_Printf("Warning: console input buffer had an overlong line. Ignored.\n");
333 memcpy (line, text, comment ? (comment - text) : i);
334 line[comment ? (comment - text) : i] = 0;
337 // delete the text from the command buffer and move remaining commands down
338 // this is necessary because commands (exec, alias) can insert data at the
339 // beginning of the text buffer
341 if (i == cmd->text.cursize)
342 cmd->text.cursize = 0;
346 cmd->text.cursize -= i;
347 memmove (cmd->text.data, text+i, cmd->text.cursize);
350 // execute the command line
352 while(*firstchar && ISWHITESPACE(*firstchar))
355 (strncmp(firstchar, "alias", 5) || !ISWHITESPACE(firstchar[5]))
357 (strncmp(firstchar, "bind", 4) || !ISWHITESPACE(firstchar[4]))
359 (strncmp(firstchar, "in_bind", 7) || !ISWHITESPACE(firstchar[7]))
362 if(Cmd_PreprocessString( cmd, line, preprocessed, sizeof(preprocessed), NULL ))
363 Cmd_ExecuteString (cmd, preprocessed, src_command, false);
367 Cmd_ExecuteString (cmd, line, src_command, false);
371 { // skip out while text still remains in buffer, leaving it
379 void Cbuf_Frame(cmd_state_t *cmd)
381 Cbuf_Execute_Deferred(cmd);
382 if (cmd->text.cursize)
384 SV_LockThreadMutex();
386 SV_UnlockThreadMutex();
391 ==============================================================================
395 ==============================================================================
402 Adds command line parameters as script statements
403 Commands lead with a +, and continue until a - or another +
404 quake +prog jctest.qp +cmd amlev1
405 quake -nosound +cmd amlev1
408 static void Cmd_StuffCmds_f (cmd_state_t *cmd)
411 // this is for all commandline options combined (and is bounds checked)
412 char build[MAX_INPUTLINE];
414 if (Cmd_Argc (cmd) != 1)
416 Con_Print("stuffcmds : execute command line parameters\n");
420 // no reason to run the commandline arguments twice
421 if (host_stuffcmdsrun)
424 host_stuffcmdsrun = true;
427 for (i = 0;i < com_argc;i++)
429 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 while (com_argv[i][j])
433 build[l++] = com_argv[i][j++];
435 for (;i < com_argc;i++)
439 if ((com_argv[i][0] == '+' || com_argv[i][0] == '-') && (com_argv[i][1] < '0' || com_argv[i][1] > '9'))
441 if (l + strlen(com_argv[i]) + 4 > sizeof(build) - 1)
444 if (strchr(com_argv[i], ' '))
446 for (j = 0;com_argv[i][j];j++)
447 build[l++] = com_argv[i][j];
448 if (strchr(com_argv[i], ' '))
455 // now terminate the combined string and prepend it to the command buffer
456 // we already reserved space for the terminator
458 Cbuf_InsertText (cmd, build);
461 static void Cmd_Exec(cmd_state_t *cmd, const char *filename)
464 size_t filenameLen = strlen(filename);
465 qboolean isdefaultcfg =
466 !strcmp(filename, "default.cfg") ||
467 (filenameLen >= 12 && !strcmp(filename + filenameLen - 12, "/default.cfg"));
469 if (!strcmp(filename, "config.cfg"))
471 filename = CONFIGFILENAME;
472 if (COM_CheckParm("-noconfig"))
473 return; // don't execute config.cfg
476 f = (char *)FS_LoadFile (filename, tempmempool, false, NULL);
479 Con_Printf("couldn't exec %s\n",filename);
482 Con_Printf("execing %s\n",filename);
484 // if executing default.cfg for the first time, lock the cvar defaults
485 // it may seem backwards to insert this text BEFORE the default.cfg
486 // but Cbuf_InsertText inserts before, so this actually ends up after it.
488 Cbuf_InsertText(cmd, "\ncvar_lockdefaults\n");
490 // insert newline after the text to make sure the last line is terminated (some text editors omit the trailing newline)
491 // (note: insertion order here is backwards from execution order, so this adds it after the text, by calling it before...)
492 Cbuf_InsertText (cmd, "\n");
493 Cbuf_InsertText (cmd, f);
498 // special defaults for specific games go here, these execute before default.cfg
499 // Nehahra pushable crates malfunction in some levels if this is on
500 // Nehahra NPC AI is confused by blowupfallenzombies
504 Cbuf_InsertText(cmd, "\n"
505 "sv_gameplayfix_blowupfallenzombies 0\n"
506 "sv_gameplayfix_findradiusdistancetobox 0\n"
507 "sv_gameplayfix_grenadebouncedownslopes 0\n"
508 "sv_gameplayfix_slidemoveprojectiles 0\n"
509 "sv_gameplayfix_upwardvelocityclearsongroundflag 0\n"
510 "sv_gameplayfix_setmodelrealbox 0\n"
511 "sv_gameplayfix_droptofloorstartsolid 0\n"
512 "sv_gameplayfix_droptofloorstartsolid_nudgetocorrect 0\n"
513 "sv_gameplayfix_noairborncorpse 0\n"
514 "sv_gameplayfix_noairborncorpse_allowsuspendeditems 0\n"
515 "sv_gameplayfix_easierwaterjump 0\n"
516 "sv_gameplayfix_delayprojectiles 0\n"
517 "sv_gameplayfix_multiplethinksperframe 0\n"
518 "sv_gameplayfix_fixedcheckwatertransition 0\n"
519 "sv_gameplayfix_q1bsptracelinereportstexture 0\n"
520 "sv_gameplayfix_swiminbmodels 0\n"
521 "sv_gameplayfix_downtracesupportsongroundflag 0\n"
522 "sys_ticrate 0.01388889\n"
524 "r_shadow_bumpscale_basetexture 0\n"
528 Cbuf_InsertText(cmd, "\n"
529 "sv_gameplayfix_blowupfallenzombies 0\n"
530 "sv_gameplayfix_findradiusdistancetobox 0\n"
531 "sv_gameplayfix_grenadebouncedownslopes 0\n"
532 "sv_gameplayfix_slidemoveprojectiles 0\n"
533 "sv_gameplayfix_upwardvelocityclearsongroundflag 0\n"
534 "sv_gameplayfix_setmodelrealbox 0\n"
535 "sv_gameplayfix_droptofloorstartsolid 0\n"
536 "sv_gameplayfix_droptofloorstartsolid_nudgetocorrect 0\n"
537 "sv_gameplayfix_noairborncorpse 0\n"
538 "sv_gameplayfix_noairborncorpse_allowsuspendeditems 0\n"
539 "sv_gameplayfix_easierwaterjump 0\n"
540 "sv_gameplayfix_delayprojectiles 0\n"
541 "sv_gameplayfix_multiplethinksperframe 0\n"
542 "sv_gameplayfix_fixedcheckwatertransition 0\n"
543 "sv_gameplayfix_q1bsptracelinereportstexture 0\n"
544 "sv_gameplayfix_swiminbmodels 0\n"
545 "sv_gameplayfix_downtracesupportsongroundflag 0\n"
546 "sys_ticrate 0.01388889\n"
548 "r_shadow_bumpscale_basetexture 0\n"
551 // 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.
552 // 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
553 // hipnotic mission pack has issues in their proximity mine sticking code, which causes them to bounce off.
556 Cbuf_InsertText(cmd, "\n"
557 "sv_gameplayfix_blowupfallenzombies 0\n"
558 "sv_gameplayfix_findradiusdistancetobox 0\n"
559 "sv_gameplayfix_grenadebouncedownslopes 0\n"
560 "sv_gameplayfix_slidemoveprojectiles 0\n"
561 "sv_gameplayfix_upwardvelocityclearsongroundflag 0\n"
562 "sv_gameplayfix_setmodelrealbox 0\n"
563 "sv_gameplayfix_droptofloorstartsolid 0\n"
564 "sv_gameplayfix_droptofloorstartsolid_nudgetocorrect 0\n"
565 "sv_gameplayfix_noairborncorpse 0\n"
566 "sv_gameplayfix_noairborncorpse_allowsuspendeditems 0\n"
567 "sv_gameplayfix_easierwaterjump 0\n"
568 "sv_gameplayfix_delayprojectiles 0\n"
569 "sv_gameplayfix_multiplethinksperframe 0\n"
570 "sv_gameplayfix_fixedcheckwatertransition 0\n"
571 "sv_gameplayfix_q1bsptracelinereportstexture 0\n"
572 "sv_gameplayfix_swiminbmodels 0\n"
573 "sv_gameplayfix_downtracesupportsongroundflag 0\n"
576 "r_shadow_bumpscale_basetexture 0\n"
579 // rogue mission pack has a guardian boss that does not wake up if findradius returns one of the entities around its spawn area
581 Cbuf_InsertText(cmd, "\n"
582 "sv_gameplayfix_blowupfallenzombies 0\n"
583 "sv_gameplayfix_findradiusdistancetobox 0\n"
584 "sv_gameplayfix_grenadebouncedownslopes 0\n"
585 "sv_gameplayfix_slidemoveprojectiles 0\n"
586 "sv_gameplayfix_upwardvelocityclearsongroundflag 0\n"
587 "sv_gameplayfix_setmodelrealbox 0\n"
588 "sv_gameplayfix_droptofloorstartsolid 0\n"
589 "sv_gameplayfix_droptofloorstartsolid_nudgetocorrect 0\n"
590 "sv_gameplayfix_noairborncorpse 0\n"
591 "sv_gameplayfix_noairborncorpse_allowsuspendeditems 0\n"
592 "sv_gameplayfix_easierwaterjump 0\n"
593 "sv_gameplayfix_delayprojectiles 0\n"
594 "sv_gameplayfix_multiplethinksperframe 0\n"
595 "sv_gameplayfix_fixedcheckwatertransition 0\n"
596 "sv_gameplayfix_q1bsptracelinereportstexture 0\n"
597 "sv_gameplayfix_swiminbmodels 0\n"
598 "sv_gameplayfix_downtracesupportsongroundflag 0\n"
599 "sys_ticrate 0.01388889\n"
601 "r_shadow_bumpscale_basetexture 0\n"
605 Cbuf_InsertText(cmd, "\n"
606 "sv_gameplayfix_blowupfallenzombies 0\n"
607 "sv_gameplayfix_findradiusdistancetobox 0\n"
608 "sv_gameplayfix_grenadebouncedownslopes 0\n"
609 "sv_gameplayfix_slidemoveprojectiles 0\n"
610 "sv_gameplayfix_upwardvelocityclearsongroundflag 0\n"
611 "sv_gameplayfix_setmodelrealbox 0\n"
612 "sv_gameplayfix_droptofloorstartsolid 0\n"
613 "sv_gameplayfix_droptofloorstartsolid_nudgetocorrect 0\n"
614 "sv_gameplayfix_noairborncorpse 0\n"
615 "sv_gameplayfix_noairborncorpse_allowsuspendeditems 0\n"
616 "sv_gameplayfix_easierwaterjump 0\n"
617 "sv_gameplayfix_delayprojectiles 0\n"
618 "sv_gameplayfix_multiplethinksperframe 0\n"
619 "sv_gameplayfix_fixedcheckwatertransition 0\n"
620 "sv_gameplayfix_q1bsptracelinereportstexture 0\n"
621 "sv_gameplayfix_swiminbmodels 0\n"
622 "sv_gameplayfix_downtracesupportsongroundflag 0\n"
623 "sys_ticrate 0.01388889\n"
625 "r_shadow_bumpscale_basetexture 4\n"
629 Cbuf_InsertText(cmd, "\n"
630 "sv_gameplayfix_blowupfallenzombies 1\n"
631 "sv_gameplayfix_findradiusdistancetobox 1\n"
632 "sv_gameplayfix_grenadebouncedownslopes 1\n"
633 "sv_gameplayfix_slidemoveprojectiles 1\n"
634 "sv_gameplayfix_upwardvelocityclearsongroundflag 1\n"
635 "sv_gameplayfix_setmodelrealbox 1\n"
636 "sv_gameplayfix_droptofloorstartsolid 1\n"
637 "sv_gameplayfix_droptofloorstartsolid_nudgetocorrect 1\n"
638 "sv_gameplayfix_noairborncorpse 1\n"
639 "sv_gameplayfix_noairborncorpse_allowsuspendeditems 1\n"
640 "sv_gameplayfix_easierwaterjump 1\n"
641 "sv_gameplayfix_delayprojectiles 1\n"
642 "sv_gameplayfix_multiplethinksperframe 1\n"
643 "sv_gameplayfix_fixedcheckwatertransition 1\n"
644 "sv_gameplayfix_q1bsptracelinereportstexture 1\n"
645 "sv_gameplayfix_swiminbmodels 1\n"
646 "sv_gameplayfix_downtracesupportsongroundflag 1\n"
647 "sys_ticrate 0.01388889\n"
648 "sv_gameplayfix_q2airaccelerate 1\n"
649 "sv_gameplayfix_stepmultipletimes 1\n"
652 // Steel Storm: Burning Retribution csqc misinterprets CSQC_InputEvent if type is a value other than 0 or 1
653 case GAME_STEELSTORM:
654 Cbuf_InsertText(cmd, "\n"
655 "sv_gameplayfix_blowupfallenzombies 1\n"
656 "sv_gameplayfix_findradiusdistancetobox 1\n"
657 "sv_gameplayfix_grenadebouncedownslopes 1\n"
658 "sv_gameplayfix_slidemoveprojectiles 1\n"
659 "sv_gameplayfix_upwardvelocityclearsongroundflag 1\n"
660 "sv_gameplayfix_setmodelrealbox 1\n"
661 "sv_gameplayfix_droptofloorstartsolid 1\n"
662 "sv_gameplayfix_droptofloorstartsolid_nudgetocorrect 1\n"
663 "sv_gameplayfix_noairborncorpse 1\n"
664 "sv_gameplayfix_noairborncorpse_allowsuspendeditems 1\n"
665 "sv_gameplayfix_easierwaterjump 1\n"
666 "sv_gameplayfix_delayprojectiles 1\n"
667 "sv_gameplayfix_multiplethinksperframe 1\n"
668 "sv_gameplayfix_fixedcheckwatertransition 1\n"
669 "sv_gameplayfix_q1bsptracelinereportstexture 1\n"
670 "sv_gameplayfix_swiminbmodels 1\n"
671 "sv_gameplayfix_downtracesupportsongroundflag 1\n"
672 "sys_ticrate 0.01388889\n"
673 "cl_csqc_generatemousemoveevents 0\n"
677 Cbuf_InsertText(cmd, "\n"
678 "sv_gameplayfix_blowupfallenzombies 1\n"
679 "sv_gameplayfix_findradiusdistancetobox 1\n"
680 "sv_gameplayfix_grenadebouncedownslopes 1\n"
681 "sv_gameplayfix_slidemoveprojectiles 1\n"
682 "sv_gameplayfix_upwardvelocityclearsongroundflag 1\n"
683 "sv_gameplayfix_setmodelrealbox 1\n"
684 "sv_gameplayfix_droptofloorstartsolid 1\n"
685 "sv_gameplayfix_droptofloorstartsolid_nudgetocorrect 1\n"
686 "sv_gameplayfix_noairborncorpse 1\n"
687 "sv_gameplayfix_noairborncorpse_allowsuspendeditems 1\n"
688 "sv_gameplayfix_easierwaterjump 1\n"
689 "sv_gameplayfix_delayprojectiles 1\n"
690 "sv_gameplayfix_multiplethinksperframe 1\n"
691 "sv_gameplayfix_fixedcheckwatertransition 1\n"
692 "sv_gameplayfix_q1bsptracelinereportstexture 1\n"
693 "sv_gameplayfix_swiminbmodels 1\n"
694 "sv_gameplayfix_downtracesupportsongroundflag 1\n"
695 "sys_ticrate 0.01388889\n"
707 static void Cmd_Exec_f (cmd_state_t *cmd)
712 if (Cmd_Argc(cmd) != 2)
714 Con_Print("exec <filename> : execute a script file\n");
718 s = FS_Search(Cmd_Argv(cmd, 1), true, true);
719 if(!s || !s->numfilenames)
721 Con_Printf("couldn't exec %s\n",Cmd_Argv(cmd, 1));
725 for(i = 0; i < s->numfilenames; ++i)
726 Cmd_Exec(cmd, s->filenames[i]);
736 Just prints the rest of the line to the console
739 static void Cmd_Echo_f (cmd_state_t *cmd)
743 for (i=1 ; i<Cmd_Argc(cmd) ; i++)
744 Con_Printf("%s ",Cmd_Argv(cmd, i));
749 // Support Doom3-style Toggle Console Command
754 Toggles a specified console variable amongst the values specified (default is 0 and 1)
757 static void Cmd_Toggle_f(cmd_state_t *cmd)
759 // Acquire Number of Arguments
760 int nNumArgs = Cmd_Argc(cmd);
763 // No Arguments Specified; Print Usage
764 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");
766 { // Correct Arguments Specified
767 // Acquire Potential CVar
768 cvar_t* cvCVar = Cvar_FindVar(cmd->cvars, Cmd_Argv(cmd, 1), cmd->cvars_flagsmask);
775 Cvar_SetValueQuick(cvCVar, 0);
777 Cvar_SetValueQuick(cvCVar, 1);
781 { // 0 and Specified Usage
782 if(cvCVar->integer == atoi(Cmd_Argv(cmd, 2) ) )
783 // CVar is Specified Value; // Reset to 0
784 Cvar_SetValueQuick(cvCVar, 0);
786 if(cvCVar->integer == 0)
787 // CVar is 0; Specify Value
788 Cvar_SetQuick(cvCVar, Cmd_Argv(cmd, 2) );
790 // CVar does not match; Reset to 0
791 Cvar_SetValueQuick(cvCVar, 0);
794 { // Variable Values Specified
798 for(nCnt = 2; nCnt < nNumArgs; nCnt++)
799 { // Cycle through Values
800 if( strcmp(cvCVar->string, Cmd_Argv(cmd, nCnt) ) == 0)
801 { // Current Value Located; Increment to Next
802 if( (nCnt + 1) == nNumArgs)
803 // Max Value Reached; Reset
804 Cvar_SetQuick(cvCVar, Cmd_Argv(cmd, 2) );
807 Cvar_SetQuick(cvCVar, Cmd_Argv(cmd, nCnt + 1) );
816 // Value not Found; Reset to Original
817 Cvar_SetQuick(cvCVar, Cmd_Argv(cmd, 2) );
823 Con_Printf("ERROR : CVar '%s' not found\n", Cmd_Argv(cmd, 1) );
832 Creates a new command that executes a command string (possibly ; seperated)
835 static void Cmd_Alias_f (cmd_state_t *cmd)
838 char line[MAX_INPUTLINE];
843 if (Cmd_Argc(cmd) == 1)
845 Con_Print("Current alias commands:\n");
846 for (a = cmd->alias ; a ; a=a->next)
847 Con_Printf("%s : %s", a->name, a->value);
851 s = Cmd_Argv(cmd, 1);
852 if (strlen(s) >= MAX_ALIAS_NAME)
854 Con_Print("Alias name is too long\n");
858 // if the alias already exists, reuse it
859 for (a = cmd->alias ; a ; a=a->next)
861 if (!strcmp(s, a->name))
870 cmdalias_t *prev, *current;
872 a = (cmdalias_t *)Z_Malloc (sizeof(cmdalias_t));
873 strlcpy (a->name, s, sizeof (a->name));
874 // insert it at the right alphanumeric position
875 for( prev = NULL, current = cmd->alias ; current && strcmp( current->name, a->name ) < 0 ; prev = current, current = current->next )
886 // copy the rest of the command line
887 line[0] = 0; // start out with a null string
889 for (i=2 ; i < c ; i++)
892 strlcat (line, " ", sizeof (line));
893 strlcat (line, Cmd_Argv(cmd, i), sizeof (line));
895 strlcat (line, "\n", sizeof (line));
897 alloclen = strlen (line) + 1;
899 line[alloclen - 2] = '\n'; // to make sure a newline is appended even if too long
900 a->value = (char *)Z_Malloc (alloclen);
901 memcpy (a->value, line, alloclen);
908 Remove existing aliases.
911 static void Cmd_UnAlias_f (cmd_state_t *cmd)
917 if(Cmd_Argc(cmd) == 1)
919 Con_Print("unalias: Usage: unalias alias1 [alias2 ...]\n");
923 for(i = 1; i < Cmd_Argc(cmd); ++i)
925 s = Cmd_Argv(cmd, i);
927 for(a = cmd->alias; a; p = a, a = a->next)
929 if(!strcmp(s, a->name))
931 if (a->initstate) // we can not remove init aliases
934 cmd->alias = a->next;
943 Con_Printf("unalias: %s alias not found\n", s);
948 =============================================================================
952 =============================================================================
955 static const char *Cmd_GetDirectCvarValue(cmd_state_t *cmd, const char *varname, cmdalias_t *alias, qboolean *is_multiple)
960 static char vabuf[1024]; // cmd_mutex
963 *is_multiple = false;
965 if(!varname || !*varname)
970 if(!strcmp(varname, "*"))
974 return Cmd_Args(cmd);
976 else if(!strcmp(varname, "#"))
978 return va(vabuf, sizeof(vabuf), "%d", Cmd_Argc(cmd));
980 else if(varname[strlen(varname) - 1] == '-')
982 argno = strtol(varname, &endptr, 10);
983 if(endptr == varname + strlen(varname) - 1)
985 // whole string is a number, apart from the -
986 const char *p = Cmd_Args(cmd);
987 for(; argno > 1; --argno)
988 if(!COM_ParseToken_Console(&p))
995 // kill pre-argument whitespace
996 for (;*p && ISWHITESPACE(*p);p++)
1005 argno = strtol(varname, &endptr, 10);
1008 // whole string is a number
1009 // NOTE: we already made sure we don't have an empty cvar name!
1010 if(argno >= 0 && argno < Cmd_Argc(cmd))
1011 return Cmd_Argv(cmd, argno);
1016 if((cvar = Cvar_FindVar(cmd->cvars, varname, cmd->cvars_flagsmask)) && !(cvar->flags & CVAR_PRIVATE))
1017 return cvar->string;
1022 qboolean Cmd_QuoteString(char *out, size_t outlen, const char *in, const char *quoteset, qboolean putquotes)
1024 qboolean quote_quot = !!strchr(quoteset, '"');
1025 qboolean quote_backslash = !!strchr(quoteset, '\\');
1026 qboolean quote_dollar = !!strchr(quoteset, '$');
1035 *out++ = '"'; --outlen;
1041 if(*in == '"' && quote_quot)
1045 *out++ = '\\'; --outlen;
1046 *out++ = '"'; --outlen;
1048 else if(*in == '\\' && quote_backslash)
1052 *out++ = '\\'; --outlen;
1053 *out++ = '\\'; --outlen;
1055 else if(*in == '$' && quote_dollar)
1059 *out++ = '$'; --outlen;
1060 *out++ = '$'; --outlen;
1066 *out++ = *in; --outlen;
1081 static const char *Cmd_GetCvarValue(cmd_state_t *cmd, const char *var, size_t varlen, cmdalias_t *alias)
1083 static char varname[MAX_INPUTLINE]; // cmd_mutex
1084 static char varval[MAX_INPUTLINE]; // cmd_mutex
1085 const char *varstr = NULL;
1087 qboolean required = false;
1088 qboolean optional = false;
1089 static char asis[] = "asis"; // just to suppress const char warnings
1091 if(varlen >= MAX_INPUTLINE)
1092 varlen = MAX_INPUTLINE - 1;
1093 memcpy(varname, var, varlen);
1094 varname[varlen] = 0;
1095 varfunc = strchr(varname, ' ');
1107 Con_Printf("Warning: Could not expand $ in alias %s\n", alias->name);
1109 Con_Printf("Warning: Could not expand $\n");
1117 while((p = strchr(varfunc, '?')))
1120 memmove(p, p+1, strlen(p)); // with final NUL
1123 while((p = strchr(varfunc, '!')))
1126 memmove(p, p+1, strlen(p)); // with final NUL
1129 while((p = strchr(varfunc, ' ')))
1131 memmove(p, p+1, strlen(p)); // with final NUL
1133 // if no function is left, NULL it
1138 if(varname[0] == '$')
1139 varstr = Cmd_GetDirectCvarValue(cmd, Cmd_GetDirectCvarValue(cmd, varname + 1, alias, NULL), alias, NULL);
1142 qboolean is_multiple = false;
1143 // Exception: $* and $n- don't use the quoted form by default
1144 varstr = Cmd_GetDirectCvarValue(cmd, varname, alias, &is_multiple);
1155 Con_Printf("Error: Could not expand $%s in alias %s\n", varname, alias->name);
1157 Con_Printf("Error: Could not expand $%s\n", varname);
1167 Con_Printf("Warning: Could not expand $%s in alias %s\n", varname, alias->name);
1169 Con_Printf("Warning: Could not expand $%s\n", varname);
1170 dpsnprintf(varval, sizeof(varval), "$%s", varname);
1175 if(!varfunc || !strcmp(varfunc, "q")) // note: quoted form is default, use "asis" to override!
1177 // quote it so it can be used inside double quotes
1178 // we just need to replace " by \", and of course, double backslashes
1179 Cmd_QuoteString(varval, sizeof(varval), varstr, "\"\\", false);
1182 else if(!strcmp(varfunc, "asis"))
1187 Con_Printf("Unknown variable function %s\n", varfunc);
1193 Cmd_PreprocessString
1195 Preprocesses strings and replaces $*, $param#, $cvar accordingly. Also strips comments.
1197 static qboolean Cmd_PreprocessString(cmd_state_t *cmd, const char *intext, char *outtext, unsigned maxoutlen, cmdalias_t *alias ) {
1203 // don't crash if there's no room in the outtext buffer
1204 if( maxoutlen == 0 ) {
1207 maxoutlen--; // because of \0
1212 while( *in && outlen < maxoutlen ) {
1214 // this is some kind of expansion, see what comes after the $
1217 // The console does the following preprocessing:
1219 // - $$ is transformed to a single dollar sign.
1220 // - $var or ${var} are expanded to the contents of the named cvar,
1221 // with quotation marks and backslashes quoted so it can safely
1222 // be used inside quotation marks (and it should always be used
1224 // - ${var asis} inserts the cvar value as is, without doing this
1226 // - ${var ?} silently expands to the empty string if
1227 // $var does not exist
1228 // - ${var !} fails expansion and executes nothing if
1229 // $var does not exist
1230 // - prefix the cvar name with a dollar sign to do indirection;
1231 // for example, if $x has the value timelimit, ${$x} will return
1232 // the value of $timelimit
1233 // - when expanding an alias, the special variable name $* refers
1234 // to all alias parameters, and a number refers to that numbered
1235 // alias parameter, where the name of the alias is $0, the first
1236 // parameter is $1 and so on; as a special case, $* inserts all
1237 // parameters, without extra quoting, so one can use $* to just
1238 // pass all parameters around. All parameters starting from $n
1239 // can be referred to as $n- (so $* is equivalent to $1-).
1240 // - ${* q} and ${n- q} force quoting anyway
1242 // Note: when expanding an alias, cvar expansion is done in the SAME step
1243 // as alias expansion so that alias parameters or cvar values containing
1244 // dollar signs have no unwanted bad side effects. However, this needs to
1245 // be accounted for when writing complex aliases. For example,
1246 // alias foo "set x NEW; echo $x"
1247 // actually expands to
1248 // "set x NEW; echo OLD"
1249 // and will print OLD! To work around this, use a second alias:
1250 // alias foo "set x NEW; foo2"
1251 // alias foo2 "echo $x"
1253 // Also note: lines starting with alias are exempt from cvar expansion.
1254 // If you want cvar expansion, write "alias" instead:
1257 // alias foo "echo $x"
1258 // "alias" bar "echo $x"
1261 // foo will print 2, because the variable $x will be expanded when the alias
1262 // gets expanded. bar will print 1, because the variable $x was expanded
1263 // at definition time. foo can be equivalently defined as
1265 // "alias" foo "echo $$x"
1267 // because at definition time, $$ will get replaced to a single $.
1272 } else if(*in == '{') {
1273 varlen = strcspn(in + 1, "}");
1274 if(in[varlen + 1] == '}')
1276 val = Cmd_GetCvarValue(cmd, in + 1, varlen, alias);
1288 varlen = strspn(in, "#*0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ_-");
1289 val = Cmd_GetCvarValue(cmd, in, varlen, alias);
1296 // insert the cvar value
1297 while(*val && outlen < maxoutlen)
1298 outtext[outlen++] = *val++;
1303 // copy the unexpanded text
1304 outtext[outlen++] = '$';
1305 while(eat && outlen < maxoutlen)
1307 outtext[outlen++] = *in++;
1313 outtext[outlen++] = *in++;
1315 outtext[outlen] = 0;
1323 Called for aliases and fills in the alias into the cbuffer
1326 static void Cmd_ExecuteAlias (cmd_state_t *cmd, cmdalias_t *alias)
1328 static char buffer[ MAX_INPUTLINE ]; // cmd_mutex
1329 static char buffer2[ MAX_INPUTLINE ]; // cmd_mutex
1330 qboolean ret = Cmd_PreprocessString( cmd, alias->value, buffer, sizeof(buffer) - 2, alias );
1333 // insert at start of command buffer, so that aliases execute in order
1334 // (fixes bug introduced by Black on 20050705)
1336 // Note: Cbuf_PreprocessString will be called on this string AGAIN! So we
1337 // have to make sure that no second variable expansion takes place, otherwise
1338 // alias parameters containing dollar signs can have bad effects.
1339 Cmd_QuoteString(buffer2, sizeof(buffer2), buffer, "$", false);
1340 Cbuf_InsertText(cmd, buffer2);
1347 CmdList Added by EvilTypeGuy eviltypeguy@qeradiant.com
1348 Thanks to Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
1352 static void Cmd_List_f (cmd_state_t *cmd)
1354 cmd_function_t *func;
1355 const char *partial;
1360 if (Cmd_Argc(cmd) > 1)
1362 partial = Cmd_Argv(cmd, 1);
1363 len = strlen(partial);
1364 ispattern = (strchr(partial, '*') || strchr(partial, '?'));
1374 for (func = cmd->functions; func; func = func->next)
1376 if (partial && (ispattern ? !matchpattern_with_separator(func->name, partial, false, "", false) : strncmp(partial, func->name, len)))
1378 Con_Printf("%s : %s\n", func->name, func->description);
1385 Con_Printf("%i Command%s matching \"%s\"\n\n", count, (count > 1) ? "s" : "", partial);
1387 Con_Printf("%i Command%s beginning with \"%s\"\n\n", count, (count > 1) ? "s" : "", partial);
1390 Con_Printf("%i Command%s\n\n", count, (count > 1) ? "s" : "");
1393 static void Cmd_Apropos_f(cmd_state_t *cmd)
1395 cmd_function_t *func;
1398 const char *partial;
1403 if (Cmd_Argc(cmd) > 1)
1404 partial = Cmd_Args(cmd);
1407 Con_Printf("usage: apropos <string>\n");
1411 ispattern = partial && (strchr(partial, '*') || strchr(partial, '?'));
1413 partial = va(vabuf, sizeof(vabuf), "*%s*", partial);
1416 for (cvar = cmd->cvars->vars; cvar; cvar = cvar->next)
1418 if (!matchpattern_with_separator(cvar->name, partial, true, "", false))
1419 if (!matchpattern_with_separator(cvar->description, partial, true, "", false))
1421 Con_Printf ("cvar ^3%s^7 is \"%s\" [\"%s\"] %s\n", cvar->name, cvar->string, cvar->defstring, cvar->description);
1424 for (func = cmd->functions; func; func = func->next)
1426 if (!matchpattern_with_separator(func->name, partial, true, "", false))
1427 if (!matchpattern_with_separator(func->description, partial, true, "", false))
1429 Con_Printf("command ^2%s^7: %s\n", func->name, func->description);
1432 for (alias = cmd->alias; alias; alias = alias->next)
1434 // procede here a bit differently as an alias value always got a final \n
1435 if (!matchpattern_with_separator(alias->name, partial, true, "", false))
1436 if (!matchpattern_with_separator(alias->value, partial, true, "\n", false)) // when \n is as separator wildcards don't match it
1438 Con_Printf("alias ^5%s^7: %s", alias->name, alias->value); // do not print an extra \n
1441 Con_Printf("%i result%s\n\n", count, (count > 1) ? "s" : "");
1451 cmd_iter_t *cmd_iter;
1452 for (cmd_iter = cmd_iter_all; cmd_iter->cmd; cmd_iter++)
1454 cmd_state_t *cmd = cmd_iter->cmd;
1455 cmd->mempool = Mem_AllocPool("commands", 0, NULL);
1456 // space for commands and script files
1457 cmd->text.data = cmd->text_buf;
1458 cmd->text.maxsize = sizeof(cmd->text_buf);
1459 cmd->text.cursize = 0;
1460 cmd->null_string = "";
1462 // client console can see server cvars because the user may start a server
1463 cmd_client.cvars = &cvars_all;
1464 cmd_client.cvars_flagsmask = CVAR_CLIENT | CVAR_SERVER;
1465 // stuffcmd from server has access to the reasonable client things, but it probably doesn't need to access the client's server-only cvars
1466 cmd_clientfromserver.cvars = &cvars_all;
1467 cmd_clientfromserver.cvars_flagsmask = CVAR_CLIENT;
1468 // dedicated server console can only see server cvars, there is no client
1469 cmd_server.cvars = &cvars_all;
1470 cmd_server.cvars_flagsmask = CVAR_SERVER;
1471 // server commands received from clients have no reason to access cvars, cvar expansion seems perilous.
1472 cmd_serverfromclient.cvars = &cvars_null;
1473 cmd_serverfromclient.cvars_flagsmask = 0;
1476 void Cmd_Init_Commands(qboolean dedicated_server)
1479 // register our commands
1481 // client-only commands
1482 Cmd_AddCommand(&cmd_client, "cmd", Cmd_ForwardToServer_f, "send a console commandline to the server (used by some mods)");
1483 Cmd_AddCommand(&cmd_client, "wait", Cmd_Wait_f, "make script execution wait for next rendered frame");
1484 Cmd_AddCommand(&cmd_client, "cprint", Cmd_Centerprint_f, "print something at the screen center");
1486 // maintenance commands used for upkeep of cvars and saved configs
1487 Cmd_AddCommand(&cmd_client, "stuffcmds", Cmd_StuffCmds_f, "execute commandline parameters (must be present in quake.rc script)");
1488 Cmd_AddCommand(&cmd_client, "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");
1489 Cmd_AddCommand(&cmd_client, "cvar_resettodefaults_all", Cvar_ResetToDefaults_All_f, "sets all cvars to their locked default values");
1490 Cmd_AddCommand(&cmd_client, "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)");
1491 Cmd_AddCommand(&cmd_client, "cvar_resettodefaults_saveonly", Cvar_ResetToDefaults_SaveOnly_f, "sets all saved cvars to their locked default values (variables that will be saved to config.cfg)");
1492 Cmd_AddCommand(&cmd_server, "stuffcmds", Cmd_StuffCmds_f, "execute commandline parameters (must be present in quake.rc script)");
1493 Cmd_AddCommand(&cmd_server, "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");
1494 Cmd_AddCommand(&cmd_server, "cvar_resettodefaults_all", Cvar_ResetToDefaults_All_f, "sets all cvars to their locked default values");
1495 Cmd_AddCommand(&cmd_server, "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)");
1496 Cmd_AddCommand(&cmd_server, "cvar_resettodefaults_saveonly", Cvar_ResetToDefaults_SaveOnly_f, "sets all saved cvars to their locked default values (variables that will be saved to config.cfg)");
1498 // general console commands used in multiple environments
1499 Cmd_AddCommand(&cmd_client, "exec", Cmd_Exec_f, "execute a script file");
1500 Cmd_AddCommand(&cmd_client, "echo",Cmd_Echo_f, "print a message to the console (useful in scripts)");
1501 Cmd_AddCommand(&cmd_client, "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");
1502 Cmd_AddCommand(&cmd_client, "unalias",Cmd_UnAlias_f, "remove an alias");
1503 Cmd_AddCommand(&cmd_client, "set", Cvar_Set_f, "create or change the value of a console variable");
1504 Cmd_AddCommand(&cmd_client, "seta", Cvar_SetA_f, "create or change the value of a console variable that will be saved to config.cfg");
1505 Cmd_AddCommand(&cmd_client, "unset", Cvar_Del_f, "delete a cvar (does not work for static ones like _cl_name, or read-only ones)");
1506 Cmd_AddCommand(&cmd_clientfromserver, "exec", Cmd_Exec_f, "execute a script file");
1507 Cmd_AddCommand(&cmd_clientfromserver, "echo", Cmd_Echo_f, "print a message to the console (useful in scripts)");
1508 Cmd_AddCommand(&cmd_clientfromserver, "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");
1509 Cmd_AddCommand(&cmd_clientfromserver, "unalias", Cmd_UnAlias_f, "remove an alias");
1510 Cmd_AddCommand(&cmd_clientfromserver, "set", Cvar_Set_f, "create or change the value of a console variable");
1511 Cmd_AddCommand(&cmd_clientfromserver, "seta", Cvar_SetA_f, "create or change the value of a console variable that will be saved to config.cfg");
1512 Cmd_AddCommand(&cmd_clientfromserver, "unset", Cvar_Del_f, "delete a cvar (does not work for static ones like _cl_name, or read-only ones)");
1513 Cmd_AddCommand(&cmd_server, "exec", Cmd_Exec_f, "execute a script file");
1514 Cmd_AddCommand(&cmd_server, "echo", Cmd_Echo_f, "print a message to the console (useful in scripts)");
1515 Cmd_AddCommand(&cmd_server, "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");
1516 Cmd_AddCommand(&cmd_server, "unalias", Cmd_UnAlias_f, "remove an alias");
1517 Cmd_AddCommand(&cmd_server, "set", Cvar_Set_f, "create or change the value of a console variable");
1518 Cmd_AddCommand(&cmd_server, "seta", Cvar_SetA_f, "create or change the value of a console variable that will be saved to config.cfg");
1519 Cmd_AddCommand(&cmd_server, "unset", Cvar_Del_f, "delete a cvar (does not work for static ones like _cl_name, or read-only ones)");
1521 #ifdef FILLALLCVARSWITHRUBBISH
1522 Cmd_AddCommand(&cmd_client, "fillallcvarswithrubbish", Cvar_FillAll_f, "fill all cvars with a specified number of characters to provoke buffer overruns");
1523 Cmd_AddCommand(&cmd_server, "fillallcvarswithrubbish", Cvar_FillAll_f, "fill all cvars with a specified number of characters to provoke buffer overruns");
1524 #endif /* FILLALLCVARSWITHRUBBISH */
1526 // 2000-01-09 CmdList, CvarList commands By Matthias "Maddes" Buecher
1527 // Added/Modified by EvilTypeGuy eviltypeguy@qeradiant.com
1528 Cmd_AddCommand(&cmd_client, "cmdlist", Cmd_List_f, "lists all console commands beginning with the specified prefix or matching the specified wildcard pattern");
1529 Cmd_AddCommand(&cmd_client, "cvarlist", Cvar_List_f, "lists all console variables beginning with the specified prefix or matching the specified wildcard pattern");
1530 Cmd_AddCommand(&cmd_client, "apropos", Cmd_Apropos_f, "lists all console variables/commands/aliases containing the specified string in the name or description");
1531 Cmd_AddCommand(&cmd_server, "cmdlist", Cmd_List_f, "lists all console commands beginning with the specified prefix or matching the specified wildcard pattern");
1532 Cmd_AddCommand(&cmd_server, "cvarlist", Cvar_List_f, "lists all console variables beginning with the specified prefix or matching the specified wildcard pattern");
1533 Cmd_AddCommand(&cmd_server, "apropos", Cmd_Apropos_f, "lists all console variables/commands/aliases containing the specified string in the name or description");
1535 Cmd_AddCommand(&cmd_client, "defer", Cmd_Defer_f, "execute a command in the future");
1536 Cmd_AddCommand(&cmd_server, "defer", Cmd_Defer_f, "execute a command in the future");
1539 // Support Doom3-style Toggle Command
1540 Cmd_AddCommand(&cmd_client, "toggle", Cmd_Toggle_f, "toggles a console variable's values (use for more info)");
1541 Cmd_AddCommand(&cmd_server, "toggle", Cmd_Toggle_f, "toggles a console variable's values (use for more info)");
1542 Cmd_AddCommand(&cmd_clientfromserver, "toggle", Cmd_Toggle_f, "toggles a console variable's values (use for more info)");
1550 void Cmd_Shutdown(void)
1552 cmd_iter_t *cmd_iter;
1553 for (cmd_iter = cmd_iter_all; cmd_iter->cmd; cmd_iter++)
1555 cmd_state_t *cmd = cmd_iter->cmd;
1559 // we usually have this locked when we get here from Host_Quit_f
1563 Mem_FreePool(&cmd->mempool);
1572 int Cmd_Argc (cmd_state_t *cmd)
1582 const char *Cmd_Argv(cmd_state_t *cmd, int arg)
1584 if (arg >= cmd->argc )
1585 return cmd->null_string;
1586 return cmd->argv[arg];
1594 const char *Cmd_Args (cmd_state_t *cmd)
1604 Parses the given string into command line tokens.
1607 // AK: This function should only be called from ExcuteString because the current design is a bit of an hack
1608 static void Cmd_TokenizeString (cmd_state_t *cmd, const char *text)
1617 // skip whitespace up to a /n
1618 while (*text && ISWHITESPACE(*text) && *text != '\r' && *text != '\n')
1625 if (*text == '\n' || *text == '\r')
1627 // a newline separates commands in the buffer
1628 if (*text == '\r' && text[1] == '\n')
1640 if (!COM_ParseToken_Console(&text))
1643 if (cmd->argc < MAX_ARGS)
1645 l = (int)strlen(com_token) + 1;
1646 if (cmd->tokenizebufferpos + l > CMD_TOKENIZELENGTH)
1648 Con_Printf("Cmd_TokenizeString: ran out of %i character buffer space for command arguements\n", CMD_TOKENIZELENGTH);
1651 memcpy (cmd->tokenizebuffer + cmd->tokenizebufferpos, com_token, l);
1652 cmd->argv[cmd->argc] = cmd->tokenizebuffer + cmd->tokenizebufferpos;
1653 cmd->tokenizebufferpos += l;
1665 void Cmd_AddCommand(cmd_state_t *cmd, const char *cmd_name, xcommand_t function, const char *description)
1667 cmd_function_t *func;
1668 cmd_function_t *prev, *current;
1670 // fail if the command is a variable name
1671 if (Cvar_FindVar(cmd->cvars, cmd_name, ~0))
1673 Con_Printf("Cmd_AddCommand: %s already defined as a var\n", cmd_name);
1677 // fail if the command already exists in this interpreter
1678 for (func = cmd->functions; func; func = func->next)
1679 if (!strcmp(cmd_name, func->name))
1684 // command already defined...
1686 Con_Printf("Cmd_AddCommand: %s already defined\n", cmd_name);
1688 func->csqcfunc = true;
1692 func = (cmd_function_t *)Mem_Alloc(cmd->mempool, sizeof(cmd_function_t));
1693 func->name = cmd_name;
1694 func->function = function;
1695 func->description = description;
1696 if (!function) //[515]: csqc
1697 func->csqcfunc = true;
1698 func->next = cmd->functions;
1700 // insert it at the right alphanumeric position
1701 for (prev = NULL, current = cmd->functions; current && strcmp(current->name, func->name) < 0; prev = current, current = current->next)
1707 cmd->functions = func;
1709 func->next = current;
1718 qboolean Cmd_Exists (cmd_state_t *cmd, const char *cmd_name)
1720 cmd_function_t *func;
1722 for (func=cmd->functions ; func ; func=func->next)
1723 if (!strcmp (cmd_name,func->name))
1735 const char *Cmd_CompleteCommand (cmd_state_t *cmd, const char *partial)
1737 cmd_function_t *func;
1740 len = strlen(partial);
1746 for (func = cmd->functions; func; func = func->next)
1747 if (!strncasecmp(partial, func->name, len))
1754 Cmd_CompleteCountPossible
1756 New function for tab-completion system
1757 Added by EvilTypeGuy
1758 Thanks to Fett erich@heintz.com
1762 int Cmd_CompleteCountPossible (cmd_state_t *cmd, const char *partial)
1764 cmd_function_t *func;
1769 len = strlen(partial);
1774 // Loop through the command list and count all partial matches
1775 for (func = cmd->functions; func; func = func->next)
1776 if (!strncasecmp(partial, func->name, len))
1783 Cmd_CompleteBuildList
1785 New function for tab-completion system
1786 Added by EvilTypeGuy
1787 Thanks to Fett erich@heintz.com
1791 const char **Cmd_CompleteBuildList (cmd_state_t *cmd, const char *partial)
1793 cmd_function_t *func;
1796 size_t sizeofbuf = (Cmd_CompleteCountPossible (cmd, partial) + 1) * sizeof (const char *);
1799 len = strlen(partial);
1800 buf = (const char **)Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
1801 // Loop through the alias list and print all matches
1802 for (func = cmd->functions; func; func = func->next)
1803 if (!strncasecmp(partial, func->name, len))
1804 buf[bpos++] = func->name;
1810 // written by LadyHavoc
1811 void Cmd_CompleteCommandPrint (cmd_state_t *cmd, const char *partial)
1813 cmd_function_t *func;
1814 size_t len = strlen(partial);
1815 // Loop through the command list and print all matches
1816 for (func = cmd->functions; func; func = func->next)
1817 if (!strncasecmp(partial, func->name, len))
1818 Con_Printf("^2%s^7: %s\n", func->name, func->description);
1824 New function for tab-completion system
1825 Added by EvilTypeGuy
1826 Thanks to Fett erich@heintz.com
1830 const char *Cmd_CompleteAlias (cmd_state_t *cmd, const char *partial)
1835 len = strlen(partial);
1841 for (alias = cmd->alias; alias; alias = alias->next)
1842 if (!strncasecmp(partial, alias->name, len))
1848 // written by LadyHavoc
1849 void Cmd_CompleteAliasPrint (cmd_state_t *cmd, const char *partial)
1852 size_t len = strlen(partial);
1853 // Loop through the alias list and print all matches
1854 for (alias = cmd->alias; alias; alias = alias->next)
1855 if (!strncasecmp(partial, alias->name, len))
1856 Con_Printf("^5%s^7: %s", alias->name, alias->value);
1861 Cmd_CompleteAliasCountPossible
1863 New function for tab-completion system
1864 Added by EvilTypeGuy
1865 Thanks to Fett erich@heintz.com
1869 int Cmd_CompleteAliasCountPossible (cmd_state_t *cmd, const char *partial)
1877 len = strlen(partial);
1882 // Loop through the command list and count all partial matches
1883 for (alias = cmd->alias; alias; alias = alias->next)
1884 if (!strncasecmp(partial, alias->name, len))
1891 Cmd_CompleteAliasBuildList
1893 New function for tab-completion system
1894 Added by EvilTypeGuy
1895 Thanks to Fett erich@heintz.com
1899 const char **Cmd_CompleteAliasBuildList (cmd_state_t *cmd, const char *partial)
1904 size_t sizeofbuf = (Cmd_CompleteAliasCountPossible (cmd, partial) + 1) * sizeof (const char *);
1907 len = strlen(partial);
1908 buf = (const char **)Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
1909 // Loop through the alias list and print all matches
1910 for (alias = cmd->alias; alias; alias = alias->next)
1911 if (!strncasecmp(partial, alias->name, len))
1912 buf[bpos++] = alias->name;
1918 void Cmd_ClearCsqcFuncs (cmd_state_t *cmd)
1920 cmd_function_t *func;
1921 for (func = cmd->functions; func; func = func->next)
1922 func->csqcfunc = false;
1929 A complete command line has been parsed, so try to execute it
1930 FIXME: lookupnoadd the token to speed search?
1933 void Cmd_ExecuteString (cmd_state_t *cmd, const char *text, cmd_source_t src, qboolean lockmutex)
1936 cmd_function_t *func;
1940 oldpos = cmd->tokenizebufferpos;
1943 Cmd_TokenizeString (cmd, text);
1945 // execute the command line
1947 goto done; // no tokens
1950 for (func = cmd->functions; func; func=func->next)
1952 if (!strcasecmp (cmd->argv[0], func->name))
1954 if (func->csqcfunc && CL_VM_ConsoleCommand (text)) //[515]: csqc
1960 func->function(cmd);
1962 Con_Printf("Command \"%s\" can not be executed\n", Cmd_Argv(cmd, 0));
1967 func->function(cmd);
1975 // if it's a client command and no command was found, say so.
1976 if (cmd->source == src_client)
1978 Con_Printf("player \"%s\" tried to %s\n", host_client->name, text);
1983 for (a=cmd->alias ; a ; a=a->next)
1985 if (!strcasecmp (cmd->argv[0], a->name))
1987 Cmd_ExecuteAlias(cmd, a);
1993 if (!Cvar_Command(cmd) && host_framecount > 0)
1994 Con_Printf("Unknown command \"%s\"\n", Cmd_Argv(cmd, 0));
1997 cmd->tokenizebufferpos = oldpos;
2005 Cmd_ForwardStringToServer
2007 Sends an entire command string over to the server, unprocessed
2010 void Cmd_ForwardStringToServer (const char *s)
2013 if (cls.state != ca_connected)
2015 Con_Printf("Can't \"%s\", not connected\n", s);
2022 // LadyHavoc: thanks to Fuh for bringing the pure evil of SZ_Print to my
2023 // attention, it has been eradicated from here, its only (former) use in
2024 // all of darkplaces.
2025 if (cls.protocol == PROTOCOL_QUAKEWORLD)
2026 MSG_WriteByte(&cls.netcon->message, qw_clc_stringcmd);
2028 MSG_WriteByte(&cls.netcon->message, clc_stringcmd);
2029 if ((!strncmp(s, "say ", 4) || !strncmp(s, "say_team ", 9)) && cl_locs_enable.integer)
2031 // say/say_team commands can replace % character codes with status info
2034 if (*s == '%' && s[1])
2036 // handle proquake message macros
2040 case 'l': // current location
2041 CL_Locs_FindLocationName(temp, sizeof(temp), cl.movement_origin);
2043 case 'h': // current health
2044 dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_HEALTH]);
2046 case 'a': // current armor
2047 dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_ARMOR]);
2049 case 'x': // current rockets
2050 dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_ROCKETS]);
2052 case 'c': // current cells
2053 dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_CELLS]);
2055 // silly proquake macros
2056 case 'd': // loc at last death
2057 CL_Locs_FindLocationName(temp, sizeof(temp), cl.lastdeathorigin);
2059 case 't': // current time
2060 dpsnprintf(temp, sizeof(temp), "%.0f:%.0f", floor(cl.time / 60), cl.time - floor(cl.time / 60) * 60);
2062 case 'r': // rocket launcher status ("I have RL", "I need rockets", "I need RL")
2063 if (!(cl.stats[STAT_ITEMS] & IT_ROCKET_LAUNCHER))
2064 dpsnprintf(temp, sizeof(temp), "I need RL");
2065 else if (!cl.stats[STAT_ROCKETS])
2066 dpsnprintf(temp, sizeof(temp), "I need rockets");
2068 dpsnprintf(temp, sizeof(temp), "I have RL");
2070 case 'p': // powerup status (outputs "quad" "pent" and "eyes" according to status)
2071 if (cl.stats[STAT_ITEMS] & IT_QUAD)
2074 strlcat(temp, " ", sizeof(temp));
2075 strlcat(temp, "quad", sizeof(temp));
2077 if (cl.stats[STAT_ITEMS] & IT_INVULNERABILITY)
2080 strlcat(temp, " ", sizeof(temp));
2081 strlcat(temp, "pent", sizeof(temp));
2083 if (cl.stats[STAT_ITEMS] & IT_INVISIBILITY)
2086 strlcat(temp, " ", sizeof(temp));
2087 strlcat(temp, "eyes", sizeof(temp));
2090 case 'w': // weapon status (outputs "SSG:NG:SNG:GL:RL:LG" with the text between : characters omitted if you lack the weapon)
2091 if (cl.stats[STAT_ITEMS] & IT_SUPER_SHOTGUN)
2092 strlcat(temp, "SSG", sizeof(temp));
2093 strlcat(temp, ":", sizeof(temp));
2094 if (cl.stats[STAT_ITEMS] & IT_NAILGUN)
2095 strlcat(temp, "NG", sizeof(temp));
2096 strlcat(temp, ":", sizeof(temp));
2097 if (cl.stats[STAT_ITEMS] & IT_SUPER_NAILGUN)
2098 strlcat(temp, "SNG", sizeof(temp));
2099 strlcat(temp, ":", sizeof(temp));
2100 if (cl.stats[STAT_ITEMS] & IT_GRENADE_LAUNCHER)
2101 strlcat(temp, "GL", sizeof(temp));
2102 strlcat(temp, ":", sizeof(temp));
2103 if (cl.stats[STAT_ITEMS] & IT_ROCKET_LAUNCHER)
2104 strlcat(temp, "RL", sizeof(temp));
2105 strlcat(temp, ":", sizeof(temp));
2106 if (cl.stats[STAT_ITEMS] & IT_LIGHTNING)
2107 strlcat(temp, "LG", sizeof(temp));
2110 // not a recognized macro, print it as-is...
2116 // write the resulting text
2117 SZ_Write(&cls.netcon->message, (unsigned char *)temp, (int)strlen(temp));
2121 MSG_WriteByte(&cls.netcon->message, *s);
2124 MSG_WriteByte(&cls.netcon->message, 0);
2126 else // any other command is passed on as-is
2127 SZ_Write(&cls.netcon->message, (const unsigned char *)s, (int)strlen(s) + 1);
2134 Sends the entire command line over to the server
2137 void Cmd_ForwardToServer_f (cmd_state_t *cmd)
2141 if (!strcasecmp(Cmd_Argv(cmd, 0), "cmd"))
2143 // we want to strip off "cmd", so just send the args
2144 s = Cmd_Argc(cmd) > 1 ? Cmd_Args(cmd) : "";
2148 // we need to keep the command name, so send Cmd_Argv(cmd, 0), a space and then Cmd_Args(cmd)
2149 s = va(vabuf, sizeof(vabuf), "%s %s", Cmd_Argv(cmd, 0), Cmd_Argc(cmd) > 1 ? Cmd_Args(cmd) : "");
2151 // don't send an empty forward message if the user tries "cmd" by itself
2154 Cmd_ForwardStringToServer(s);
2162 Returns the position (1 to argc-1) in the command's argument list
2163 where the given parameter apears, or 0 if not present
2167 int Cmd_CheckParm (cmd_state_t *cmd, const char *parm)
2173 Con_Printf ("Cmd_CheckParm: NULL");
2177 for (i = 1; i < Cmd_Argc (cmd); i++)
2178 if (!strcasecmp (parm, Cmd_Argv(cmd, i)))
2186 void Cmd_SaveInitState(void)
2188 cmd_iter_t *cmd_iter;
2189 for (cmd_iter = cmd_iter_all; cmd_iter->cmd; cmd_iter++)
2191 cmd_state_t *cmd = cmd_iter->cmd;
2194 for (f = cmd->functions; f; f = f->next)
2195 f->initstate = true;
2196 for (a = cmd->alias; a; a = a->next)
2198 a->initstate = true;
2199 a->initialvalue = Mem_strdup(zonemempool, a->value);
2202 Cvar_SaveInitState(&cvars_all);
2205 void Cmd_RestoreInitState(void)
2207 cmd_iter_t *cmd_iter;
2208 for (cmd_iter = cmd_iter_all; cmd_iter->cmd; cmd_iter++)
2210 cmd_state_t *cmd = cmd_iter->cmd;
2211 cmd_function_t *f, **fp;
2212 cmdalias_t *a, **ap;
2213 for (fp = &cmd->functions; (f = *fp);)
2219 // destroy this command, it didn't exist at init
2220 Con_DPrintf("Cmd_RestoreInitState: Destroying command %s\n", f->name);
2225 for (ap = &cmd->alias; (a = *ap);)
2229 // restore this alias, it existed at init
2230 if (strcmp(a->value ? a->value : "", a->initialvalue ? a->initialvalue : ""))
2232 Con_DPrintf("Cmd_RestoreInitState: Restoring alias %s\n", a->name);
2235 a->value = Mem_strdup(zonemempool, a->initialvalue);
2241 // free this alias, it didn't exist at init...
2242 Con_DPrintf("Cmd_RestoreInitState: Destroying alias %s\n", a->name);
2250 Cvar_RestoreInitState(&cvars_all);