X-Git-Url: http://git.xonotic.org/?p=xonotic%2Fdarkplaces.git;a=blobdiff_plain;f=cmd.h;h=bb1a84f2f8c8db3bb9b56a938c459a3587fdc173;hp=bee0a1f36b520b0695e863e0cdeda6de942a3e3d;hb=HEAD;hpb=305eb3834a21c5ceaee8531f645848878ad10152 diff --git a/cmd.h b/cmd.h index bee0a1f3..9aa59adb 100644 --- a/cmd.h +++ b/cmd.h @@ -44,33 +44,35 @@ The game starts with a Cbuf_AddText ("exec quake.rc\n"); Cbuf_Execute (); struct cmd_state_s; // Command flags -#define CF_NONE 0 -#define CF_CLIENT (1<<0) // cvar/command that only the client can change/execute -#define CF_SERVER (1<<1) // cvar/command that only the server can change/execute -#define CF_CLIENT_FROM_SERVER (1<<2) // command that the server is allowed to execute on the client -#define CF_SERVER_FROM_CLIENT (1<<3) // command the client is allowed to execute on the server as a stringcmd -#define CF_CHEAT (1<<4) // command or cvar that gives an unfair advantage over other players and is blocked unless sv_cheats is 1 -#define CF_ARCHIVE (1<<5) // cvar should have its set value saved to config.cfg and persist across sessions -#define CF_READONLY (1<<6) // cvar cannot be changed from the console or the command buffer -#define CF_NOTIFY (1<<7) // cvar should trigger a chat notification to all connected clients when changed -#define CF_SERVERINFO (1<<8) // command or cvar relevant to serverinfo string handling -#define CF_USERINFO (1<<9) // command or cvar used to communicate userinfo to the server -#define CF_PERSISTENT (1<<10) // cvar must not be reset on gametype switch (such as scr_screenshot_name, which otherwise isn't set to the mod name properly) -#define CF_PRIVATE (1<<11) // cvar should not be $ expanded or sent to the server under any circumstances (rcon_password, etc) -#define CF_MAXFLAGSVAL ((1<<12) - 1) // used to determine if flags is valid +#define CF_NONE 0u +#define CF_CLIENT (1u<<0) ///< cvar/command that only the client can change/execute +#define CF_SERVER (1u<<1) ///< cvar/command that only the server can change/execute +#define CF_CLIENT_FROM_SERVER (1u<<2) ///< command that the server is allowed to execute on the client +#define CF_SERVER_FROM_CLIENT (1u<<3) ///< command the client is allowed to execute on the server as a stringcmd +#define CF_CHEAT (1u<<4) ///< command or cvar that gives an unfair advantage over other players and is blocked unless sv_cheats is 1 +#define CF_ARCHIVE (1u<<5) ///< cvar should have its set value saved to config.cfg and persist across sessions +#define CF_READONLY (1u<<6) ///< cvar cannot be changed from the console or the command buffer, and is considered CF_PERSISTENT +#define CF_NOTIFY (1u<<7) ///< cvar should trigger a chat notification to all connected clients when changed +#define CF_SERVERINFO (1u<<8) ///< command or cvar relevant to serverinfo string handling +#define CF_USERINFO (1u<<9) ///< command or cvar used to communicate userinfo to the server +#define CF_PERSISTENT (1u<<10) ///< cvar must not be reset on gametype switch (such as scr_screenshot_name, which otherwise isn't set to the mod name properly) +#define CF_PRIVATE (1u<<11) ///< cvar should not be $ expanded or sent to the server under any circumstances (rcon_password, etc) +#define CF_MAXFLAGSVAL ((1u<<12) - 1) ///< used to determine if flags is valid // for internal use only! -#define CF_DEFAULTSET (1<<30) -#define CF_ALLOCATED (1<<31) +#define CF_REGISTERED (1u<<29) ///< created by Cvar_RegisterVariable() +#define CF_DEFAULTSET (1u<<30) +#define CF_ALLOCATED (1u<<31) ///< created by Cvar_Get() (console or QC) +// UBSan: unsigned literals because left shifting by 31 causes signed overflow, although it works as expected on x86. -#define CF_SHARED 3 +#define CF_SHARED (CF_CLIENT | CF_SERVER) typedef void(*xcommand_t) (struct cmd_state_s *cmd); typedef enum cmd_source_s { - src_client, ///< came in over a net connection as a clc_stringcmd - ///< host_client will be valid during this state. - src_local ///< from the command buffer + src_client, ///< came in over a net connection as a clc_stringcmd + ///< host_client will be valid during this state. + src_local ///< from the command buffer } cmd_source_t; typedef struct cmd_alias_s @@ -78,21 +80,21 @@ typedef struct cmd_alias_s struct cmd_alias_s *next; char name[MAX_ALIAS_NAME]; char *value; - qbool initstate; // indicates this command existed at init - char *initialvalue; // backup copy of value at init + qbool initstate; ///< indicates this command existed at init + char *initialvalue; ///< backup copy of value at init } cmd_alias_t; typedef struct cmd_function_s { - int flags; + unsigned flags; struct cmd_function_s *next; const char *name; const char *description; xcommand_t function; qbool qcfunc; - struct cmd_function_s *overridden; // the engine cmd overriden by this QC cmd, if applicable + struct cmd_function_s *overridden; ///< the engine cmd overriden by this QC cmd, if applicable qbool autofunc; - qbool initstate; // indicates this command existed at init + qbool initstate; ///< indicates this command existed at init } cmd_function_t; /// container for user-defined QC functions and aliases, shared between different command interpreters @@ -134,44 +136,41 @@ typedef struct cmd_state_s cmd_buf_t *cbuf; - cmd_userdefined_t *userdefined; // possible csqc functions and aliases to execute + cmd_userdefined_t *userdefined; ///< possible csqc functions and aliases to execute cmd_function_t *engine_functions; - struct cvar_state_s *cvars; // which cvar system is this cmd state able to access? (&cvars_all or &cvars_null) - int cvars_flagsmask; // which CVAR_* flags should be visible to this interpreter? (CF_CLIENT | CF_SERVER, or just CF_SERVER) + struct cvar_state_s *cvars; ///< which cvar system is this cmd state able to access? (&cvars_all or &cvars_null) + unsigned cvars_flagsmask; ///< which CVAR_* flags should be visible to this interpreter? (CF_CLIENT | CF_SERVER, or just CF_SERVER) + unsigned cmd_flagsmask; ///< cmd flags that identify this interpreter - int cmd_flags; // cmd flags that identify this interpreter - - qbool (*Handle)(struct cmd_state_s *, struct cmd_function_s *, const char *, enum cmd_source_s); - qbool (*NotFound)(struct cmd_state_s *, struct cmd_function_s *, const char *, enum cmd_source_s); + qbool (*Handle)(struct cmd_state_s *, struct cmd_function_s *, const char *, size_t, enum cmd_source_s); } cmd_state_t; -qbool Cmd_Callback(cmd_state_t *cmd, cmd_function_t *func, const char *text, cmd_source_t src); -qbool Cmd_CL_Callback(cmd_state_t *cmd, cmd_function_t *func, const char *text, cmd_source_t src); -qbool Cmd_SV_Callback(cmd_state_t *cmd, cmd_function_t *func, const char *text, cmd_source_t src); -qbool Cmd_SV_NotFound(cmd_state_t *cmd, cmd_function_t *func, const char *text, cmd_source_t src); +qbool Cmd_Callback(cmd_state_t *cmd, cmd_function_t *func); +qbool Cmd_CL_Callback(cmd_state_t *cmd, cmd_function_t *func, const char *text, size_t textlen, cmd_source_t src); +qbool Cmd_SV_Callback(cmd_state_t *cmd, cmd_function_t *func, const char *text, size_t textlen, cmd_source_t src); typedef struct cmd_input_s { llist_t list; cmd_state_t *source; - double delay; - size_t size; - size_t length; + vec_t delay; + size_t size; ///< excludes \0 terminator + size_t length; ///< excludes \0 terminator char *text; qbool pending; } cmd_input_t; -extern cmd_userdefined_t cmd_userdefined_all; // aliases and csqc functions -extern cmd_userdefined_t cmd_userdefined_null; // intentionally empty +extern cmd_userdefined_t cmd_userdefined_all; ///< aliases and csqc functions +extern cmd_userdefined_t cmd_userdefined_null; ///< intentionally empty -// command interpreter for local commands injected by SVQC, CSQC, MQC, server or client engine code -// uses cmddefs_all +/// command interpreter for local commands injected by SVQC, CSQC, MQC, server or client engine code +/// uses cmddefs_all extern cmd_state_t *cmd_local; -// command interpreter for server commands received over network from clients -// uses cmddefs_null +/// command interpreter for server commands received over network from clients +/// uses cmddefs_null extern cmd_state_t *cmd_serverfromclient; extern qbool host_stuffcmdsrun; @@ -198,10 +197,12 @@ void Cbuf_InsertText (cmd_state_t *cmd, const char *text); void Cbuf_Execute (cmd_buf_t *cbuf); /*! Performs deferred commands and runs Cbuf_Execute, called by Host_Frame */ void Cbuf_Frame (cmd_buf_t *cbuf); +/// Clears all command buffers +void Cbuf_Clear(cmd_buf_t *cbuf); //=========================================================================== -/* +/** Command execution takes a null terminated string, breaks it into tokens, then searches for a command or variable that matches the first token. @@ -215,15 +216,16 @@ not apropriate. void Cmd_Init(void); void Cmd_Shutdown(void); -// called by Host_Init, this marks cvars, commands and aliases with their init values +/// called by Host_Init, this marks cvars, commands and aliases with their init values void Cmd_SaveInitState(void); -// called by FS_GameDir_f, this restores cvars, commands and aliases to init values +/// Restores cvars, commands and aliases to their init values +/// and deletes any that were added since init. void Cmd_RestoreInitState(void); -void Cmd_AddCommand(int flags, const char *cmd_name, xcommand_t function, const char *description); -// called by the init functions of other parts of the program to -// register commands and functions to call for them. -// The cmd_name is referenced later, so it should not be in temp memory +/// called by the init functions of other parts of the program to +/// register commands and functions to call for them. +/// The cmd_name is referenced later, so it should not be in temp memory +void Cmd_AddCommand(unsigned flags, const char *cmd_name, xcommand_t function, const char *description); /// used by the cvar code to check for cvar / command name overlap qbool Cmd_Exists (cmd_state_t *cmd, const char *cmd_name); @@ -233,41 +235,42 @@ qbool Cmd_Exists (cmd_state_t *cmd, const char *cmd_name); const char *Cmd_CompleteCommand (cmd_state_t *cmd, const char *partial); int Cmd_CompleteAliasCountPossible (cmd_state_t *cmd, const char *partial); - const char **Cmd_CompleteAliasBuildList (cmd_state_t *cmd, const char *partial); - int Cmd_CompleteCountPossible (cmd_state_t *cmd, const char *partial); - const char **Cmd_CompleteBuildList (cmd_state_t *cmd, const char *partial); - void Cmd_CompleteCommandPrint (cmd_state_t *cmd, const char *partial); - const char *Cmd_CompleteAlias (cmd_state_t *cmd, const char *partial); - void Cmd_CompleteAliasPrint (cmd_state_t *cmd, const char *partial); // Enhanced console completion by Fett erich@heintz.com - // Added by EvilTypeGuy eviltypeguy@qeradiant.com -int Cmd_Argc (cmd_state_t *cmd); -const char *Cmd_Argv (cmd_state_t *cmd, int arg); -const char *Cmd_Args (cmd_state_t *cmd); -// The functions that execute commands get their parameters with these -// functions. Cmd_Argv(cmd, ) will return an empty string, not a NULL -// if arg > argc, so string operations are always safe. +// The functions that execute commands get their parameters with these functions. +static inline int Cmd_Argc (cmd_state_t *cmd) +{ + return cmd->argc; +} +/// Cmd_Argv(cmd, ) will return an empty string (not a NULL) if arg > argc, so string operations are always safe. +static inline const char *Cmd_Argv(cmd_state_t *cmd, int arg) +{ + if (arg >= cmd->argc ) + return cmd->null_string; + return cmd->argv[arg]; +} +static inline const char *Cmd_Args (cmd_state_t *cmd) +{ + return cmd->args; +} /// Returns the position (1 to argc-1) in the command's argument list /// where the given parameter apears, or 0 if not present int Cmd_CheckParm (cmd_state_t *cmd, const char *parm); -//void Cmd_TokenizeString (char *text); -// Takes a null terminated string. Does not need to be /n terminated. -// breaks the string up into arg tokens. - /// Parses a single line of text into arguments and tries to execute it. /// The text can come from the command buffer, a remote client, or stdin. -void Cmd_ExecuteString (cmd_state_t *cmd, const char *text, cmd_source_t src, qbool lockmutex); +void Cmd_ExecuteString(cmd_state_t *cmd, const char *text, size_t textlen, cmd_source_t src, qbool lockmutex); +/// Like Cmd_ExecuteString, but with variable expansion. +void Cmd_PreprocessAndExecuteString(cmd_state_t *cmd, const char *text, size_t textlen, cmd_source_t src, qbool lockmutex); /// quotes a string so that it can be used as a command argument again; /// quoteset is a string that contains one or more of ", \, $ and specifies