// vi: set ts=4 sw=4 :
// vim: set tw=75 :

// meta_api.h - description of metamod's DLL interface

/*
 * Copyright (c) 2001-2003 Will Day <willday@hpgx.net>
 *
 *    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.
 *
 */

#ifndef META_API_H
#define META_API_H

#ifdef _MSC_VER
#pragma warning ( disable : 869 )
#endif

//#include "dllapi.h"				// GETENTITYAPI_FN, etc
//#include "engine_api.h"			// GET_ENGINE_FUNCTIONS_FN, etc
#include "plinfo.h"				// plugin_info_t, etc
#include "mutil.h"				// mutil_funcs_t, etc
//#include "osdep.h"				// DLLEXPORT, etc

// Version consists of "major:minor", two separate integer numbers.
// Version 1	original
// Version 2	added plugin_info_t **pinfo
// Version 3	init split into query and attach, added detach
// Version 4	added (PLUG_LOADTIME now) to attach
// Version 5	changed mm ifvers int* to string, moved pl ifvers to info
// Version 5:1	added link support for entity "adminmod_timer" (adminmod)
// Version 5:2	added gamedll_funcs to meta_attach() [v1.0-rc2]
// Version 5:3	added mutil_funcs to meta_query() [v1.05]
// Version 5:4	added centersay utility functions [v1.06]
// Version 5:5	added Meta_Init to plugin API [v1.08]
// Version 5:6	added CallGameEntity utility function [v1.09]
// Version 5:7	added GetUserMsgID, GetUserMsgName util funcs [v1.11]
// Version 5:8	added GetPluginPath [v1.11]
// Version 5:9	added GetGameInfo [v1.14]
// Version 5:10 added GINFO_REALDLL_FULLPATH for GetGameInfo [v1.17]
// Version 5:11 added plugin loading and unloading API [v1.18]
// Version 5:12 added util code for checking player query status [v1.18]
// Version 5:13 added cvarquery2 support and api for calling hook tables [v1.19]
#define META_INTERFACE_VERSION "5:13"

#ifdef UNFINISHED
// Version 5:99	added event hook utility functions [v.???]
#define META_INTERFACE_VERSION "5:99"
#endif /* UNFINISHED */

// Flags returned by a plugin's api function.
// NOTE: order is crucial, as greater/less comparisons are made.
typedef enum {
	MRES_UNSET = 0,
	MRES_IGNORED,		// plugin didn't take any action
	MRES_HANDLED,		// plugin did something, but real function should still be called
	MRES_OVERRIDE,		// call real function, but use my return value
	MRES_SUPERCEDE,		// skip real function; use my return value
} META_RES;

// Variables provided to plugins.
typedef struct meta_globals_s {
	META_RES mres;			// writable; plugin's return flag
	META_RES prev_mres;		// readable; return flag of the previous plugin called
	META_RES status;		// readable; "highest" return flag so far
	void *orig_ret;			// readable; return value from "real" function
	void *override_ret;		// readable; return value from overriding/superceding plugin
} meta_globals_t;

extern meta_globals_t *gpMetaGlobals;
#define SET_META_RESULT(result)				gpMetaGlobals->mres=result
#define RETURN_META(result)					gpMetaGlobals->mres=result; return
#define RETURN_META_VALUE(result, value)	gpMetaGlobals->mres=result; return(value)
#define META_RESULT_STATUS					gpMetaGlobals->status
#define META_RESULT_PREVIOUS				gpMetaGlobals->prev_mres
#define META_RESULT_ORIG_RET(type)			*(type *)gpMetaGlobals->orig_ret
#define META_RESULT_OVERRIDE_RET(type)		*(type *)gpMetaGlobals->override_ret

// Table of getapi functions, retrieved from each plugin.
typedef struct {
	void*	pfnGetEntityAPI;
	void*	pfnGetEntityAPI_Post;
	void*	pfnGetEntityAPI2;
	void*	pfnGetEntityAPI2_Post;
	void*	pfnGetNewDLLFunctions;
	void*	pfnGetNewDLLFunctions_Post;
	void*	pfnGetEngineFunctions;
	void*	pfnGetEngineFunctions_Post;
} META_FUNCTIONS;

// Declared in plugin; referenced in macros.
extern mutil_funcs_t* mUtil;

struct DLL_FUNCTIONS;
struct NEW_DLL_FUNCTIONS;

typedef struct gamedll_funcs_s
{
	DLL_FUNCTIONS* dllapi_table;
	NEW_DLL_FUNCTIONS* newapi_table;
} gamedll_funcs_t;

extern gamedll_funcs_t* gpGamedllFuncs;

#endif /* META_API_H */