cmd.c File Reference

#include "../game/q_shared.h"
#include "qcommon.h"

Include dependency graph for cmd.c:

Go to the source code of this file.

Data Structures
struct	cmd_function_s
struct	cmd_t
Defines
#define	MAX_CMD_BUFFER   16384
#define	MAX_CMD_LINE   1024
Typedefs
typedef cmd_function_s	cmd_function_t
Functions
void	Cbuf_AddText (const char *text)
void	Cbuf_Execute (void)
void	Cbuf_ExecuteText (int exec_when, const char *text)
void	Cbuf_Init (void)
void	Cbuf_InsertText (const char *text)
void	Cmd_AddCommand (const char *cmd_name, xcommand_t function)
int	Cmd_Argc (void)
char *	Cmd_Args (void)
void	Cmd_ArgsBuffer (char *buffer, int bufferLength)
char *	Cmd_ArgsFrom (int arg)
char *	Cmd_Argv (int arg)
void	Cmd_ArgvBuffer (int arg, char *buffer, int bufferLength)
char *	Cmd_Cmd ()
void	Cmd_CommandCompletion (void(*callback)(const char *s))
void	Cmd_Echo_f (void)
void	Cmd_Exec_f (void)
void	Cmd_ExecuteString (const char *text)
void	Cmd_Init (void)
void	Cmd_List_f (void)
void	Cmd_RemoveCommand (const char *cmd_name)
void	Cmd_TokenizeString (const char *text_in)
void	Cmd_Vstr_f (void)
void	Cmd_Wait_f (void)
Variables
int	cmd_argc
char *	cmd_argv [MAX_STRING_TOKENS]
char	cmd_cmd [BIG_INFO_STRING]
cmd_function_t *	cmd_functions
cmd_t	cmd_text
byte	cmd_text_buf [MAX_CMD_BUFFER]
char	cmd_tokenized [BIG_INFO_STRING+MAX_STRING_TOKENS]
int	cmd_wait

---

Define Documentation

#define MAX_CMD_BUFFER   16384

Definition at line 27 of file cmd.c.

#define MAX_CMD_LINE   1024

Definition at line 28 of file cmd.c. Referenced by Cbuf_Execute().

---

Typedef Documentation

typedef struct cmd_function_s cmd_function_t

Referenced by Cmd_AddCommand(), Cmd_CommandCompletion(), Cmd_ExecuteString(), Cmd_List_f(), and Cmd_RemoveCommand().

---

Function Documentation

void Cbuf_AddText (  const char *  text  )

Definition at line 88 of file cmd.c. References cmd_text, Com_Memcpy(), Com_Printf(), cmd_t::cursize, cmd_t::data, l, cmd_t::maxsize, and strlen(). Referenced by Cbuf_ExecuteText(), CL_AddKeyUpCommands(), CL_CgameSystemCalls(), CL_FirstSnapshot(), CL_GetServerCommand(), CL_KeyEvent(), CL_NextDemo(), CL_Reconnect_f(), CL_StartDemoLoop(), Com_AddStartupCommands(), Com_EventLoop(), Com_Init(), Console_Key(), FS_Restart(), MainWndProc(), and SV_Frame(). { int l; l = strlen (text); if (cmd_text.cursize + l >= cmd_text.maxsize) { Com_Printf ("Cbuf_AddText: overflow\n"); return; } Com_Memcpy(&cmd_text.data[cmd_text.cursize], text, l); cmd_text.cursize += l; }

Here is the call graph for this function:

void Cbuf_Execute (  void   )

Definition at line 168 of file cmd.c. References Cmd_ExecuteString(), cmd_text, cmd_wait, Com_Memcpy(), cmd_t::cursize, cmd_t::data, i, line, MAX_CMD_LINE, and memmove(). Referenced by Cbuf_ExecuteText(), CL_Init(), CL_NextDemo(), Com_Frame(), and Com_Init(). { int i; char *text; char line[MAX_CMD_LINE]; int quotes; while (cmd_text.cursize) { if ( cmd_wait ) { // skip out while text still remains in buffer, leaving it // for next frame cmd_wait--; break; } // find a \n or ; line break text = (char *)cmd_text.data; quotes = 0; for (i=0 ; i< cmd_text.cursize ; i++) { if (text[i] == '"') quotes++; if ( !(quotes&1) && text[i] == ';') break; // don't break if inside a quoted string if (text[i] == '\n' || text[i] == '\r' ) break; } if( i >= (MAX_CMD_LINE - 1)) { i = MAX_CMD_LINE - 1; } Com_Memcpy (line, text, i); line[i] = 0; // delete the text from the command buffer and move remaining commands down // this is necessary because commands (exec) can insert data at the // beginning of the text buffer if (i == cmd_text.cursize) cmd_text.cursize = 0; else { i++; cmd_text.cursize -= i; memmove (text, text+i, cmd_text.cursize); } // execute the command line Cmd_ExecuteString (line); } }

Here is the call graph for this function:

void Cbuf_ExecuteText (  int  exec_when, const char *  text )

Definition at line 141 of file cmd.c. References Cbuf_AddText(), Cbuf_Execute(), Cbuf_InsertText(), Cmd_ExecuteString(), Com_Error(), ERR_FATAL, EXEC_APPEND, EXEC_INSERT, EXEC_NOW, and strlen(). Referenced by CL_Frame(), CL_KeyEvent(), CL_UISystemCalls(), MainWndProc(), RoQShutdown(), and SV_GameSystemCalls(). { switch (exec_when) { case EXEC_NOW: if (text && strlen(text) > 0) { Cmd_ExecuteString (text); } else { Cbuf_Execute(); } break; case EXEC_INSERT: Cbuf_InsertText (text); break; case EXEC_APPEND: Cbuf_AddText (text); break; default: Com_Error (ERR_FATAL, "Cbuf_ExecuteText: bad exec_when"); } }

Here is the call graph for this function:

void Cbuf_Init (  void   )

Definition at line 74 of file cmd.c. References cmd_text, cmd_t::cursize, cmd_t::data, and cmd_t::maxsize. Referenced by Com_Init(). { cmd_text.data = cmd_text_buf; cmd_text.maxsize = MAX_CMD_BUFFER; cmd_text.cursize = 0; }

void Cbuf_InsertText (  const char *  text  )

Definition at line 111 of file cmd.c. References cmd_text, Com_Memcpy(), Com_Printf(), cmd_t::cursize, cmd_t::data, i, cmd_t::maxsize, and strlen(). Referenced by Cbuf_ExecuteText(), Cmd_Exec_f(), and Cmd_Vstr_f(). { int len; int i; len = strlen( text ) + 1; if ( len + cmd_text.cursize > cmd_text.maxsize ) { Com_Printf( "Cbuf_InsertText overflowed\n" ); return; } // move the existing command text for ( i = cmd_text.cursize - 1 ; i >= 0 ; i-- ) { cmd_text.data[ i + len ] = cmd_text.data[ i ]; } // copy the new text in Com_Memcpy( cmd_text.data, text, len - 1 ); // add a \n cmd_text.data[ len - 1 ] = '\n'; cmd_text.cursize += len; }

Here is the call graph for this function:

void Cmd_AddCommand (  const char *  cmd_name, xcommand_t  function )

Definition at line 550 of file cmd.c. References cmd_function_t, cmd_functions, Com_Printf(), CopyString(), cmd_function_s::function, cmd_function_s::name, cmd_function_s::next, S_Malloc(), and strcmp(). Referenced by CL_AddCgameCommand(), CL_Init(), CL_InitInput(), CL_InitKeyCommands(), Cmd_Init(), Com_Init(), Com_InitHunkMemory(), Con_Init(), Cvar_Init(), FS_Startup(), GLimp_Init(), IN_Init(), S_Init(), SV_AddOperatorCommands(), Sys_Init(), and VM_Init(). { cmd_function_t *cmd; // fail if the command already exists for ( cmd = cmd_functions ; cmd ; cmd=cmd->next ) { if ( !strcmp( cmd_name, cmd->name ) ) { // allow completion-only commands to be silently doubled if ( function != NULL ) { Com_Printf ("Cmd_AddCommand: %s already defined\n", cmd_name); } return; } } // use a small malloc to avoid zone fragmentation cmd = S_Malloc (sizeof(cmd_function_t)); cmd->name = CopyString( cmd_name ); cmd->function = function; cmd->next = cmd_functions; cmd_functions = cmd; }

Here is the call graph for this function:

int Cmd_Argc (  void   )

Definition at line 329 of file cmd.c. Referenced by CL_CgameSystemCalls(), CL_Connect_f(), CL_ForwardCommandToServer(), CL_ForwardToServer_f(), CL_GetServerCommand(), CL_GlobalServers_f(), CL_Ping_f(), CL_PlayDemo_f(), CL_Record_f(), CL_ServerStatus_f(), CL_Setenv_f(), CL_UISystemCalls(), Cmd_Echo_f(), Cmd_Exec_f(), Cmd_ExecuteString(), Cmd_List_f(), Cmd_Vstr_f(), Cmd_Wait_f(), Com_Error_f(), Com_Freeze_f(), Com_Meminfo_f(), Com_WriteConfig_f(), Con_Dump_f(), Cvar_Command(), Cvar_List_f(), Cvar_Reset_f(), Cvar_Set_f(), Cvar_SetA_f(), Cvar_SetS_f(), Cvar_SetU_f(), Cvar_Toggle_f(), Field_CompleteCommand(), FS_Dir_f(), FS_NewDir_f(), FS_PureServerSetLoadedPaks(), FS_PureServerSetReferencedPaks(), FS_TouchFile_f(), Key_Bind_f(), Key_Unbind_f(), keyConcatArgs(), S_Music_f(), S_Play_f(), SV_Ban_f(), SV_BanNum_f(), SV_ConSay_f(), SV_DumpUser_f(), SV_GameSystemCalls(), SV_GetPlayerByName(), SV_GetPlayerByNum(), SV_Kick_f(), SV_KickNum_f(), SV_MapRestart_f(), and SV_VerifyPaks_f(). { return cmd_argc; }

char* Cmd_Args (  void   )

Definition at line 365 of file cmd.c. References cmd_argc, cmd_argv, i, and strcat(). Referenced by CL_ForwardToServer_f(), Cmd_ArgsBuffer(), and SV_ConSay_f(). { static char cmd_args[MAX_STRING_CHARS]; int i; cmd_args[0] = 0; for ( i = 1 ; i < cmd_argc ; i++ ) { strcat( cmd_args, cmd_argv[i] ); if ( i != cmd_argc-1 ) { strcat( cmd_args, " " ); } } return cmd_args; }

Here is the call graph for this function:

void Cmd_ArgsBuffer (  char *  buffer, int  bufferLength )

Definition at line 412 of file cmd.c. References buffer, Cmd_Args(), and Q_strncpyz(). Referenced by CL_CgameSystemCalls(). { Q_strncpyz( buffer, Cmd_Args(), bufferLength ); }

Here is the call graph for this function:

char* Cmd_ArgsFrom (  int  arg  )

Definition at line 387 of file cmd.c. References cmd_argc, cmd_argv, i, and strcat(). Referenced by CL_ConfigstringModified(). { static char cmd_args[BIG_INFO_STRING]; int i; cmd_args[0] = 0; if (arg < 0) arg = 0; for ( i = arg ; i < cmd_argc ; i++ ) { strcat( cmd_args, cmd_argv[i] ); if ( i != cmd_argc-1 ) { strcat( cmd_args, " " ); } } return cmd_args; }

Here is the call graph for this function:

char* Cmd_Argv (  int  arg  )

Definition at line 338 of file cmd.c. References cmd_argv. Referenced by CL_ConfigstringModified(), CL_Connect_f(), CL_ConnectionlessPacket(), CL_ForwardCommandToServer(), CL_GetServerCommand(), CL_GlobalServers_f(), CL_MotdPacket(), CL_Ping_f(), CL_PlayCinematic_f(), CL_PlayDemo_f(), CL_Record_f(), CL_ServerStatus_f(), CL_Setenv_f(), CL_SetModel_f(), Cmd_ArgvBuffer(), Cmd_Echo_f(), Cmd_Exec_f(), Cmd_List_f(), Cmd_Vstr_f(), Cmd_Wait_f(), Com_Freeze_f(), Com_SafeMode(), Com_StartupVariable(), Com_WriteConfig_f(), Con_Dump_f(), Cvar_Command(), Cvar_List_f(), Cvar_Reset_f(), Cvar_Set_f(), Cvar_SetA_f(), Cvar_SetS_f(), Cvar_SetU_f(), Cvar_Toggle_f(), Field_CompleteCommand(), FS_Dir_f(), FS_NewDir_f(), FS_PureServerSetLoadedPaks(), FS_PureServerSetReferencedPaks(), FS_TouchFile_f(), IN_KeyDown(), IN_KeyUp(), Key_Bind_f(), Key_Unbind_f(), keyConcatArgs(), S_Music_f(), S_Play_f(), SV_AuthorizeIpPacket(), SV_BeginDownload_f(), SV_ConnectionlessPacket(), SV_DirectConnect(), SV_ExecuteClientCommand(), SV_GetPlayerByName(), SV_GetPlayerByNum(), SV_Kick_f(), SV_Map_f(), SV_MapRestart_f(), SV_NextDownload_f(), SV_UpdateUserinfo_f(), SV_VerifyPaks_f(), SVC_Info(), SVC_RemoteCommand(), and SVC_Status(). { if ( (unsigned)arg >= cmd_argc ) { return ""; } return cmd_argv[arg]; }

void Cmd_ArgvBuffer (  int  arg, char *  buffer, int  bufferLength )

Definition at line 353 of file cmd.c. References buffer, Cmd_Argv(), and Q_strncpyz(). Referenced by CL_CgameSystemCalls(), CL_UISystemCalls(), and SV_GameSystemCalls(). { Q_strncpyz( buffer, Cmd_Argv( arg ), bufferLength ); }

Here is the call graph for this function:

char* Cmd_Cmd (  void   )

Definition at line 425 of file cmd.c. Referenced by CL_Rcon_f(), and SVC_RemoteCommand(). { return cmd_cmd; }

void Cmd_CommandCompletion (  void(*)(const char *s)  callback  )

Definition at line 605 of file cmd.c. References cmd_function_t, cmd_function_s::name, and cmd_function_s::next. Referenced by Field_CompleteCommand(). { cmd_function_t *cmd; for (cmd=cmd_functions ; cmd ; cmd=cmd->next) { callback( cmd->name ); } }

void Cmd_Echo_f (  void   )

Definition at line 291 of file cmd.c. References Cmd_Argc(), Cmd_Argv(), Com_Printf(), and i. Referenced by Cmd_Init(). { int i; for (i=1 ; i<Cmd_Argc() ; i++) Com_Printf ("%s ",Cmd_Argv(i)); Com_Printf ("\n"); }

Here is the call graph for this function:

void Cmd_Exec_f (  void   )

Definition at line 239 of file cmd.c. References Cbuf_InsertText(), Cmd_Argc(), Cmd_Argv(), COM_DefaultExtension(), Com_Printf(), f, FS_FreeFile(), FS_ReadFile(), and Q_strncpyz(). Referenced by Cmd_Init(). { char *f; int len; char filename[MAX_QPATH]; if (Cmd_Argc () != 2) { Com_Printf ("exec <filename> : execute a script file\n"); return; } Q_strncpyz( filename, Cmd_Argv(1), sizeof( filename ) ); COM_DefaultExtension( filename, sizeof( filename ), ".cfg" ); len = FS_ReadFile( filename, (void **)&f); if (!f) { Com_Printf ("couldn't exec %s\n",Cmd_Argv(1)); return; } Com_Printf ("execing %s\n",Cmd_Argv(1)); Cbuf_InsertText (f); FS_FreeFile (f); }

Here is the call graph for this function:

void Cmd_ExecuteString (  const char *  text  )

Definition at line 621 of file cmd.c. References CL_ForwardCommandToServer(), CL_GameCommand(), Cmd_Argc(), cmd_argv, cmd_function_t, cmd_functions, Cmd_TokenizeString(), com_cl_running, com_sv_running, Cvar_Command(), cmd_function_s::function, cvar_s::integer, cmd_function_s::name, cmd_function_s::next, Q_stricmp(), SV_GameCommand(), and UI_GameCommand(). Referenced by Cbuf_Execute(), Cbuf_ExecuteText(), and SVC_RemoteCommand(). { cmd_function_t *cmd, **prev; // execute the command line Cmd_TokenizeString( text ); if ( !Cmd_Argc() ) { return; // no tokens } // check registered command functions for ( prev = &cmd_functions ; *prev ; prev = &cmd->next ) { cmd = *prev; if ( !Q_stricmp( cmd_argv[0],cmd->name ) ) { // rearrange the links so that the command will be // near the head of the list next time it is used *prev = cmd->next; cmd->next = cmd_functions; cmd_functions = cmd; // perform the action if ( !cmd->function ) { // let the cgame or game handle it break; } else { cmd->function (); } return; } } // check cvars if ( Cvar_Command() ) { return; } // check client game commands if ( com_cl_running && com_cl_running->integer && CL_GameCommand() ) { return; } // check server game commands if ( com_sv_running && com_sv_running->integer && SV_GameCommand() ) { return; } // check ui commands if ( com_cl_running && com_cl_running->integer && UI_GameCommand() ) { return; } // send it as a server command if we are connected // this will usually result in a chat message CL_ForwardCommandToServer ( text ); }

Here is the call graph for this function:

void Cmd_Init (  void   )

Definition at line 708 of file cmd.c. References Cmd_AddCommand(), Cmd_Echo_f(), Cmd_Exec_f(), Cmd_List_f(), Cmd_Vstr_f(), and Cmd_Wait_f(). Referenced by Com_Init(). { Cmd_AddCommand ("cmdlist",Cmd_List_f); Cmd_AddCommand ("exec",Cmd_Exec_f); Cmd_AddCommand ("vstr",Cmd_Vstr_f); Cmd_AddCommand ("echo",Cmd_Echo_f); Cmd_AddCommand ("wait", Cmd_Wait_f); }

Here is the call graph for this function:

void Cmd_List_f (  void   )

Definition at line 681 of file cmd.c. References Cmd_Argc(), Cmd_Argv(), cmd_function_t, Com_Filter(), Com_Printf(), i, match(), cmd_function_s::name, cmd_function_s::next, and qfalse. Referenced by Cmd_Init(). { cmd_function_t *cmd; int i; char *match; if ( Cmd_Argc() > 1 ) { match = Cmd_Argv( 1 ); } else { match = NULL; } i = 0; for (cmd=cmd_functions ; cmd ; cmd=cmd->next) { if (match && !Com_Filter(match, cmd->name, qfalse)) continue; Com_Printf ("%s\n", cmd->name); i++; } Com_Printf ("%i commands\n", i); }

Here is the call graph for this function:

void Cmd_RemoveCommand (  const char *  cmd_name  )

Definition at line 577 of file cmd.c. References cmd_function_t, cmd_function_s::name, cmd_function_s::next, strcmp(), and Z_Free(). Referenced by CL_CgameSystemCalls(), CL_Shutdown(), FS_Shutdown(), IN_Shutdown(), S_Shutdown(), and SV_RemoveOperatorCommands(). { cmd_function_t *cmd, **back; back = &cmd_functions; while( 1 ) { cmd = *back; if ( !cmd ) { // command wasn't active return; } if ( !strcmp( cmd_name, cmd->name ) ) { *back = cmd->next; if (cmd->name) { Z_Free(cmd->name); } Z_Free (cmd); return; } back = &cmd->next; } }

Here is the call graph for this function:

void Cmd_TokenizeString (  const char *  text_in  )

Definition at line 442 of file cmd.c. References cmd_argc, cmd_argv, cmd_cmd, Com_DPrintf(), and Q_strncpyz(). Referenced by CL_ConnectionlessPacket(), CL_GetServerCommand(), Cmd_ExecuteString(), Com_SafeMode(), Com_StartupVariable(), Field_CompleteCommand(), FS_PureServerSetLoadedPaks(), FS_PureServerSetReferencedPaks(), SV_ConnectionlessPacket(), SV_ExecuteClientCommand(), and SV_VerifyPaks_f(). { const char *text; char *textOut; #ifdef TKN_DBG // FIXME TTimo blunt hook to try to find the tokenization of userinfo Com_DPrintf("Cmd_TokenizeString: %s\n", text_in); #endif // clear previous args cmd_argc = 0; if ( !text_in ) { return; } Q_strncpyz( cmd_cmd, text_in, sizeof(cmd_cmd) ); text = text_in; textOut = cmd_tokenized; while ( 1 ) { if ( cmd_argc == MAX_STRING_TOKENS ) { return; // this is usually something malicious } while ( 1 ) { // skip whitespace while ( *text && *text <= ' ' ) { text++; } if ( !*text ) { return; // all tokens parsed } // skip // comments if ( text[0] == '/' && text[1] == '/' ) { return; // all tokens parsed } // skip /* */ comments if ( text[0] == '/' && text[1] =='*' ) { while ( *text && ( text[0] != '*' || text[1] != '/' ) ) { text++; } if ( !*text ) { return; // all tokens parsed } text += 2; } else { break; // we are ready to parse a token } } // handle quoted strings // NOTE TTimo this doesn't handle \" escaping if ( *text == '"' ) { cmd_argv[cmd_argc] = textOut; cmd_argc++; text++; while ( *text && *text != '"' ) { *textOut++ = *text++; } *textOut++ = 0; if ( !*text ) { return; // all tokens parsed } text++; continue; } // regular token cmd_argv[cmd_argc] = textOut; cmd_argc++; // skip until whitespace, quote, or command while ( *text > ' ' ) { if ( text[0] == '"' ) { break; } if ( text[0] == '/' && text[1] == '/' ) { break; } // skip /* */ comments if ( text[0] == '/' && text[1] =='*' ) { break; } *textOut++ = *text++; } *textOut++ = 0; if ( !*text ) { return; // all tokens parsed } } }

Here is the call graph for this function:

void Cmd_Vstr_f (  void   )

Definition at line 271 of file cmd.c. References Cbuf_InsertText(), Cmd_Argc(), Cmd_Argv(), Com_Printf(), Cvar_VariableString(), v, and va(). Referenced by Cmd_Init(). { char *v; if (Cmd_Argc () != 2) { Com_Printf ("vstr <variablename> : execute a variable command\n"); return; } v = Cvar_VariableString( Cmd_Argv( 1 ) ); Cbuf_InsertText( va("%s\n", v ) ); }

Here is the call graph for this function:

void Cmd_Wait_f (  void   )

Definition at line 52 of file cmd.c. References atoi, Cmd_Argc(), Cmd_Argv(), and cmd_wait. Referenced by Cmd_Init(). { if ( Cmd_Argc() == 2 ) { cmd_wait = atoi( Cmd_Argv( 1 ) ); } else { cmd_wait = 1; } }

Here is the call graph for this function:

---

Variable Documentation

int cmd_argc [static]

Definition at line 317 of file cmd.c. Referenced by Cmd_Args(), Cmd_ArgsFrom(), and Cmd_TokenizeString().

char* cmd_argv[MAX_STRING_TOKENS] [static]

Definition at line 318 of file cmd.c. Referenced by Cmd_Args(), Cmd_ArgsFrom(), Cmd_Argv(), Cmd_ExecuteString(), and Cmd_TokenizeString().

char cmd_cmd[BIG_INFO_STRING] [static]

Definition at line 320 of file cmd.c. Referenced by Cmd_TokenizeString().

cmd_function_t* cmd_functions [static]

Definition at line 322 of file cmd.c. Referenced by Cmd_AddCommand(), and Cmd_ExecuteString().

cmd_t cmd_text

Definition at line 37 of file cmd.c. Referenced by Cbuf_AddText(), Cbuf_Execute(), Cbuf_Init(), and Cbuf_InsertText().

byte cmd_text_buf[MAX_CMD_BUFFER]

Definition at line 38 of file cmd.c.

char cmd_tokenized[BIG_INFO_STRING+MAX_STRING_TOKENS] [static]

Definition at line 319 of file cmd.c.

int cmd_wait

Definition at line 36 of file cmd.c. Referenced by Cbuf_Execute(), and Cmd_Wait_f().

---