/*
Copyright (C) 2002-2003 Victor Luchits

This program 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.

This program 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 this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

*/

// cg_public.h -- client game dll information visible to engine

#define	CGAME_API_VERSION	12

//
// structs and variables shared with the main engine
//

#define	CMD_BACKUP		64	// allow a lot of command backups for very fast systems
#define CMD_MASK		(CMD_BACKUP-1)

#define	MAX_PARSE_ENTITIES	1024

typedef struct
{
	qboolean		valid;			// cleared if delta parsing was invalid
	int				serverFrame;
	unsigned int	serverTime;		// time in the server when frame was created
	int				deltaFrame;
	qbyte			areabits[MAX_CM_AREAS/8];		// portalarea visibility bits
	player_state_t	playerState;
	int				numEntities;
	entity_state_t	parsedEntities[MAX_PARSE_ENTITIES];
	match_state_t	match;

} frame_t;

//===============================================================

//
// functions provided by the main engine
//
typedef struct
{
	// drops to console a client game error
	void			(*Error)( char *msg );

	// console messages
	void			(*Print)( char *msg );

	// console variable interaction
	cvar_t			*(*Cvar_Get)( char *name, char *value, int flags );
	cvar_t			*(*Cvar_Set)( char *name, char *value );
	void			(*Cvar_SetValue)( char *name, float value );
	cvar_t			*(*Cvar_ForceSet)( char *name, char *value );	// will return 0 0 if not found
	float			(*Cvar_VariableValue)( char *name );
	char			*(*Cvar_VariableString)( char *name );

	int				(*Cmd_Argc)( void );
	char			*(*Cmd_Argv)( int arg );
	char			*(*Cmd_Args)( void );	// concatenation of all argv >= 1

	void			(*Cmd_AddCommand)( char *name, void(*cmd)( void ) );
	void			(*Cmd_RemoveCommand)( char *cmd_name );
	void			(*Cmd_ExecuteText)( int exec_when, char *text );
	void			(*Cmd_Execute)( void );

	// files will be memory mapped read only
	// the returned buffer may be part of a larger pak file,
	// or a discrete file from anywhere in the quake search path
	// a -1 return means the file does not exist
	// NULL can be passed for buf to just determine existance
	int				(*FS_FOpenFile)( const char *filename, int *filenum, int mode );
	int				(*FS_Read)( void *buffer, size_t len, int file );
	int				(*FS_Write)( const void *buffer, size_t len, int file );
	int				(*FS_vPrintf)( int file, const char *fmt, va_list argptr ); // wsw -- PLX
	int				(*FS_Tell)( int file );
	int				(*FS_Seek)( int file, int offset, int whence );
	int				(*FS_Eof)( int file );
	int				(*FS_Flush)( int file );
	void			(*FS_FCloseFile)( int file );
	int				(*FS_GetFileList)( const char *dir, const char *extension, char *buf, size_t bufsize );
	char			*(*FS_Gamedir)( void );

	// key bindings
	char			*(*Key_GetBindingBuf)( int binding );
	char			*(*Key_KeynumToString)( int keynum );

	void			(*GetConfigString)( int i, char *str, int size );
	unsigned int	(*Milliseconds)( void );

	void			(*NET_GetUserCmd)( int frame, usercmd_t *cmd );
	int				(*NET_GetCurrentUserCmdNum)( void );
	void			(*NET_GetCurrentState)( int *incomingAcknowledged, int *outgoingSequence );

	// refresh system
	void			(*R_UpdateScreen)( void );
	int				(*R_GetClippedFragments)( vec3_t origin, float radius, vec3_t axis[3], int maxfverts, vec3_t *fverts, int maxfragments, fragment_t *fragments );
	void			(*R_ClearScene)( void );
	void			(*R_AddEntityToScene)( entity_t *ent );
	void			(*R_AddLightToScene)( vec3_t org, float intensity, float r, float g, float b, struct shader_s *shader );
	void			(*R_AddPolyToScene)( poly_t *poly );
	void			(*R_AddLightStyleToScene)( int style, float r, float g, float b );
	void			(*R_RenderScene)( refdef_t *fd );
	void			(*R_RegisterWorldModel)( char *name );
	void			(*R_ModelBounds)( struct model_s *mod, vec3_t mins, vec3_t maxs );
	struct model_s		*(*R_RegisterModel)( char *name );
	struct shader_s 	*(*R_RegisterPic)( char *name );
	struct shader_s 	*(*R_RegisterSkin)( char *name );
	struct skinfile_s 	*(*R_RegisterSkinFile)( char *name );
	qboolean		(*R_LerpTag)( orientation_t *orient, struct model_s *mod, int oldframe, int frame, float lerpfrac, const char *name );
#ifdef CGAMEGETLIGHTORIGIN
	//void R_LightGridForOrigin( vec3_t origin, vec3_t dir, vec4_t ambient, vec4_t diffuse, float radius )
	void			(*R_LightGridForOrigin)( vec3_t origin, vec3_t dir, vec4_t ambient, vec4_t diffuse, float radius );
#endif
	void			(*R_DrawStretchPic)( int x, int y, int w, int h, float s1, float t1, float s2, float t2, vec4_t color, struct shader_s *shader );
	void			(*R_TransformVectorToScreen)( refdef_t *rd, vec3_t in, vec2_t out );
	int				(*R_SkeletalGetNumBones)( struct model_s *mod, int *numFrames );
	int				(*R_SkeletalGetBoneInfo)( struct model_s *mod, int bone, char *name, int size, int *flags );
	void			(*R_SkeletalGetBonePose)( struct model_s *mod, int bone, int frame, bonepose_t *bonepose );

	// collision detection
	int				(*CM_NumInlineModels)( void );
	struct cmodel_s	*(*CM_InlineModel)( int num );
	struct cmodel_s	*(*CM_ModelForBBox)( vec3_t mins, vec3_t maxs );
	void			(*CM_BoxTrace)( trace_t *tr, vec3_t start, vec3_t end, vec3_t mins, vec3_t maxs, struct cmodel_s *cmodel, int brushmask );
	void			(*CM_TransformedBoxTrace)( trace_t *tr, vec3_t start, vec3_t end, vec3_t mins, vec3_t maxs, struct cmodel_s *cmodel, int brushmask, vec3_t origin, vec3_t angles );
	int				(*CM_PointContents)( vec3_t p, struct cmodel_s *cmodel );
	int				(*CM_TransformedPointContents)( vec3_t p, struct cmodel_s *cmodel, vec3_t origin, vec3_t angles );
	void			(*CM_InlineModelBounds)( struct cmodel_s *cmodel, vec3_t mins, vec3_t maxs );

	// sound system
	struct sfx_s	*(*S_RegisterSound)( char *name );	
	void			(*S_StartSound)( vec3_t origin, int entnum, int entchannel, struct sfx_s *sfx, float fvol, float attenuation, float timeofs );
	void			(*S_Update)( vec3_t origin, vec3_t v_forward, vec3_t v_right, vec3_t v_up );
	void			(*S_AddLoopSound)( struct sfx_s *sfx, vec3_t origin, float fvol, qboolean attenuate );
	void			(*S_StartBackgroundTrack)( char *intro, char *loop );
	void			(*S_StopBackgroundTrack)( void );

	// fonts
	struct mufont_s *(*SCR_RegisterFont)( char *name );
	void			(*SCR_DrawString)( int x, int y, int align, const char *str, struct mufont_s *font, vec4_t color );
	void			(*SCR_DrawStringLen)( int x, int y, int align, const char *str, size_t len, struct mufont_s *font, vec4_t color );
	size_t			(*SCR_strHeight)( struct mufont_s *font );
	size_t			(*SCR_strWidth)( const char *str, struct mufont_s *font, int maxlen );
	size_t			(*SCR_StrlenForWidth)( const char *str, struct mufont_s *font, size_t maxwidth );

	// managed memory allocation
	struct mempool_s *(*Mem_AllocPool)( const char *name, const char *filename, int fileline );
	void			*(*Mem_Alloc)( struct mempool_s *pool, int size, const char *filename, int fileline );
	void			(*Mem_Free)( void *data, const char *filename, int fileline );
	void			(*Mem_FreePool)( struct mempool_s **pool, const char *filename, int fileline );
	void			(*Mem_EmptyPool)( struct mempool_s *pool, const char *filename, int fileline );
} cgame_import_t;

//
// functions exported by the client game subsystem
//
typedef struct
{
	// if API is different, the dll cannot be used
	int				(*API)( void );

	// the init function will be called at each restart
	void			(*Init)( int playerNum, int vidWidth, int vidHeight );

	void			(*Shutdown)( void );

	void			(*ServerCommand)( void );

	void			(*InGameMenu)( void );

	void			(*LoadLayout)( char *s );

	void			(*NewFrameSnap)( frame_t *frame, frame_t *oldframe );

	void			(*GlobalSound)( vec3_t origin, int entnum, int entChannel, int soundNum, float fvol, float attenuation );
	void			(*GetEntitySoundOrigin)( int entNum, vec3_t org );

	void			(*Trace)( trace_t *tr, vec3_t start, vec3_t mins, vec3_t maxs, vec3_t end, int passent, int contentmask );
	void			(*RenderView)( float frameTime, int realTime, unsigned int serverTime, float stereo_separation, qboolean demoplaying );

} cgame_export_t;