diff -r 000000000000 -r d15304fcb7a7 metamod/mutil.cpp --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/metamod/mutil.cpp Tue Apr 06 07:36:14 2004 +0000 @@ -0,0 +1,351 @@ +// vi: set ts=4 sw=4 : +// vim: set tw=75 : + +// mutil.cpp - utility functions to provide to plugins + +/* + * Copyright (c) 2001-2003 Will Day + * + * This file is part of Metamod. + * + * Metamod is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License as published by the + * Free Software Foundation; either version 2 of the License, or (at + * your option) any later version. + * + * Metamod is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with Metamod; if not, write to the Free Software Foundation, + * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * In addition, as a special exception, the author gives permission to + * link the code of this program with the Half-Life Game Engine ("HL + * Engine") and Modified Game Libraries ("MODs") developed by Valve, + * L.L.C ("Valve"). You must obey the GNU General Public License in all + * respects for all of the code used other than the HL Engine and MODs + * from Valve. If you modify this file, you may extend this exception + * to your version of the file, but you are not obligated to do so. If + * you do not wish to do so, delete this exception statement from your + * version. + * + */ + +#include // vsnprintf(), etc +#include // vs_start(), etc + +#include // always + +#include "mutil.h" // me +#include "mhook.h" // class MHookList, etc +#include "linkent.h" // ENTITY_FN, etc +#include "metamod.h" // Hooks, etc +#include "meta_api.h" // +#include "types_meta.h" // mBOOL +#include "osdep.h" // win32 vsnprintf, etc +#include "sdk_util.h" // ALERT, etc + +hudtextparms_t default_csay_tparms = { + -1, 0.25, // x, y + 2, // effect + 0, 255, 0, 0, // r, g, b, a1 + 0, 0, 0, 0, // r2, g2, b2, a2 + 0, 0, 10, 10, // fadein, fadeout, hold, fxtime + 1 // channel +}; + +// Log to console; newline added. +void mutil_LogConsole(plid_t /* plid */, const char *fmt, ...) { + va_list ap; + char buf[MAX_LOGMSG_LEN]; + unsigned int len; + + va_start(ap, fmt); + vsnprintf(buf, sizeof(buf), fmt, ap); + va_end(ap); + // end msg with newline + len=strlen(buf); + if(len < sizeof(buf)-2) // -1 null, -1 for newline + strcat(buf, "\n"); + else + buf[len-1] = '\n'; + + SERVER_PRINT(buf); +} + +// Log regular message to logs; newline added. +void mutil_LogMessage(plid_t plid, const char *fmt, ...) { + va_list ap; + char buf[MAX_LOGMSG_LEN]; + plugin_info_t *plinfo; + + plinfo=(plugin_info_t *)plid; + va_start(ap, fmt); + vsnprintf(buf, sizeof(buf), fmt, ap); + va_end(ap); + ALERT(at_logged, "[%s] %s\n", plinfo->logtag, buf); +} + +// Log an error message to logs; newline added. +void mutil_LogError(plid_t plid, const char *fmt, ...) { + va_list ap; + char buf[MAX_LOGMSG_LEN]; + plugin_info_t *plinfo; + + plinfo=(plugin_info_t *)plid; + va_start(ap, fmt); + vsnprintf(buf, sizeof(buf), fmt, ap); + va_end(ap); + ALERT(at_logged, "[%s] ERROR: %s\n", plinfo->logtag, buf); +} + +// Log a message only if cvar "developer" set; newline added. +void mutil_LogDeveloper(plid_t plid, const char *fmt, ...) { + va_list ap; + char buf[MAX_LOGMSG_LEN]; + plugin_info_t *plinfo; + + if((int) CVAR_GET_FLOAT("developer") == 0) + return; + + plinfo=(plugin_info_t *)plid; + va_start(ap, fmt); + vsnprintf(buf, sizeof(buf), fmt, ap); + va_end(ap); + ALERT(at_logged, "[%s] dev: %s\n", plinfo->logtag, buf); +} + +// Print message on center of all player's screens. Uses default text +// parameters (color green, 10 second fade-in). +void mutil_CenterSay(plid_t plid, const char *fmt, ...) { + va_list ap; + va_start(ap, fmt); + mutil_CenterSayVarargs(plid, default_csay_tparms, fmt, ap); + va_end(ap); +} + +// Print a center-message, with given text parameters. +void mutil_CenterSayParms(plid_t plid, hudtextparms_t tparms, const char *fmt, ...) { + va_list ap; + va_start(ap, fmt); + mutil_CenterSayVarargs(plid, tparms, fmt, ap); + va_end(ap); +} + +// Print a center-message, with text parameters and varargs. Provides +// functionality to the above center_say interfaces. +void mutil_CenterSayVarargs(plid_t plid, hudtextparms_t tparms, + const char *fmt, va_list ap) +{ + char buf[MAX_LOGMSG_LEN]; + int n; + edict_t *pEntity; + CBaseEntity *pPlayer; + + vsnprintf(buf, sizeof(buf), fmt, ap); + + mutil_LogMessage(plid, "(centersay) %s", buf); + for(n=1; n <= gpGlobals->maxClients; n++) { + pEntity=INDEXENT(n); + if(FNullEnt(pEntity) || pEntity->free) + continue; + pPlayer=(CBaseEntity*)GET_PRIVATE(pEntity); + UTIL_HudMessage(pPlayer, tparms, buf); + } +} + +// Allow plugins to call the entity functions in the GameDLL. In +// particular, calling "player()" as needed by most Bots. Suggested by +// Jussi Kivilinna. +qboolean mutil_CallGameEntity(plid_t plid, const char *entStr, entvars_t *pev) { + plugin_info_t *plinfo; + ENTITY_FN pfnEntity; + + plinfo=(plugin_info_t *)plid; + META_DEBUG(8, ("Looking up game entity '%s' for plugin '%s'", entStr, + plinfo->name)); + pfnEntity = (ENTITY_FN) DLSYM(GameDLL.handle, entStr); + if(!pfnEntity) { + META_ERROR("Couldn't find game entity '%s' in game DLL '%s' for plugin '%s'", entStr, GameDLL.name, plinfo->name); + return(false); + } + META_DEBUG(7, ("Calling game entity '%s' for plugin '%s'", entStr, + plinfo->name)); + (*pfnEntity)(pev); + return(true); +} + +// Find a usermsg, registered by the gamedll, with the corresponding +// msgname, and return remaining info about it (msgid, size). +int mutil_GetUserMsgID(plid_t plid, const char *msgname, int *size) { + plugin_info_t *plinfo; + MRegMsg *umsg; + + plinfo=(plugin_info_t *)plid; + META_DEBUG(8, ("Looking up usermsg name '%s' for plugin '%s'", msgname, + plinfo->name)); + umsg=RegMsgs->find(msgname); + if(umsg) { + if(size) + *size=umsg->size; + return(umsg->msgid); + } + else + return(0); +} + +// Find a usermsg, registered by the gamedll, with the corresponding +// msgid, and return remaining info about it (msgname, size). +const char *mutil_GetUserMsgName(plid_t plid, int msgid, int *size) { + plugin_info_t *plinfo; + MRegMsg *umsg; + + plinfo=(plugin_info_t *)plid; + META_DEBUG(8, ("Looking up usermsg id '%d' for plugin '%s'", msgid, + plinfo->name)); + // Guess names for any built-in Engine messages mentioned in the SDK; + // from dlls/util.h. + if(msgid < 64) { + switch(msgid) { + case SVC_TEMPENTITY: + if(size) *size=-1; + return("tempentity?"); + case SVC_INTERMISSION: + if(size) *size=-1; + return("intermission?"); + case SVC_CDTRACK: + if(size) *size=-1; + return("cdtrack?"); + case SVC_WEAPONANIM: + if(size) *size=-1; + return("weaponanim?"); + case SVC_ROOMTYPE: + if(size) *size=-1; + return("roomtype?"); + case SVC_DIRECTOR: + if(size) *size=-1; + return("director?"); + } + } + umsg=RegMsgs->find(msgid); + if(umsg) { + if(size) + *size=umsg->size; + // 'name' is assumed to be a constant string, allocated in the + // gamedll. + return(umsg->name); + } + else + return(NULL); +} + +// Return the full path of the plugin's loaded dll/so file. +const char *mutil_GetPluginPath(plid_t plid) { + static char buf[PATH_MAX]; + MPlugin *plug; + + plug=Plugins->find(plid); + if(!plug) { + META_ERROR("GetPluginPath: couldn't find plugin '%s'", + plid->name); + return(NULL); + } + STRNCPY(buf, plug->pathname, sizeof(buf)); + return(buf); +} + +// Return various string-based info about the game/MOD/gamedll. +const char *mutil_GetGameInfo(plid_t plid, ginfo_t type) { + static char buf[MAX_STRBUF_LEN]; + const char *cp; + switch(type) { + case GINFO_NAME: + cp=GameDLL.name; + break; + case GINFO_DESC: + cp=GameDLL.desc; + break; + case GINFO_GAMEDIR: + cp=GameDLL.gamedir; + break; + case GINFO_DLL_FULLPATH: + cp=GameDLL.pathname; + break; + case GINFO_DLL_FILENAME: + cp=GameDLL.file; + break; + case GINFO_REALDLL_FULLPATH: + cp=GameDLL.real_pathname; + break; + default: + META_ERROR("GetGameInfo: invalid request '%d' from plugin '%s'", + type, plid->name); + return(NULL); + } + STRNCPY(buf, cp, sizeof(buf)); + return(buf); +} + +#ifdef UNFINISHED +int mutil_HookGameEvent(plid_t plid, game_event_t event, + event_func_t pfnHandle) +{ + return(Hooks->add(plid, event, pfnHandle)); +} + +int mutil_HookLogTrigger(plid_t plid, const char *trigger, + logmatch_func_t pfnHandle) +{ + return(Hooks->add(plid, H_TRIGGER, trigger, pfnHandle)); +} + +int mutil_HookLogString(plid_t plid, const char *string, + logmatch_func_t pfnHandle) +{ + return(Hooks->add(plid, H_STRING, string, pfnHandle)); +} + +int mutil_HookLogRegex(plid_t plid, const char *pattern, + logmatch_func_t pfnHandle) +{ + return(Hooks->add(plid, H_STRING, pattern, pfnHandle)); +} + +qboolean mutil_RemoveHookID(plid_t plid, int hookid) { + mBOOL ret; + ret=Hooks->remove(plid, hookid); + if(ret==mTRUE) return(true); + else return(false); +} + +int mutil_RemoveHookAll(plid_t plid) { + return(Hooks->remove_all(plid)); +} +#endif /* UNFINISHED */ + +// Meta Utility Function table. +mutil_funcs_t MetaUtilFunctions = { + mutil_LogConsole, // pfnLogConsole + mutil_LogMessage, // pfnLogMessage + mutil_LogError, // pfnLogError + mutil_LogDeveloper, // pfnLogDeveloper + mutil_CenterSay, // pfnCenterSay + mutil_CenterSayParms, // pfnCenterSayParms + mutil_CenterSayVarargs, // pfnCenterSayVarargs + mutil_CallGameEntity, // pfnCallGameEntity + mutil_GetUserMsgID, // pfnGetUserMsgID + mutil_GetUserMsgName, // pfnGetUserMsgName + mutil_GetPluginPath, // pfnGetPluginPath + mutil_GetGameInfo, // pfnGetGameInfo +#ifdef UNFINISHED + mutil_HookGameEvent, // pfnGameEvent + mutil_HookLogTrigger, // pfnLogTrigger + mutil_HookLogString, // pfnLogString + mutil_HookLogRegex, // pfnLogRegex + mutil_RemoveHookID, // pfnRemoveHookID + mutil_RemoveHookAll, // pfnRemoveHookAll +#endif /* UNFINISHED */ +};