xqf/src/game.h

/* XQF - Quake server browser and launcher
 * Copyright (C) 1998-2000 Roman Pozlevich <roma@botik.ru>
 *
 * 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
 */

#ifndef __GAME_H__
#define __GAME_H__

#include <sys/types.h>
#include <stdio.h>

#include <gtk/gtk.h>

#include "xqf.h"
#include "launch.h"
#include "pixmaps.h"


// game->flags
enum {
	GAME_CONNECT                = 0x00001,
	GAME_RECORD                 = 0x00002,
	GAME_SPECTATE               = 0x00004,
	GAME_PASSWORD               = 0x00008,
	GAME_RCON                   = 0x00010,
	GAME_ADMIN                  = 0x00020,
	GAME_QUAKE1_PLAYER_COLORS   = 0x00100,
	GAME_QUAKE1_SKIN            = 0x00200,
	GAME_LAUNCH_HOSTPORT        = 0x00400, // use hostport rule as port when launching
	GAME_MASTER_QUAKE3          = 0x01000, // master server protocol version is in games_data["masterprotocol"]
	GAME_MASTER_CDKEY           = 0x02000, // master server requires CD key
	GAME_MASTER_STEAM           = 0x04000, // server side filter
};

// game->color_flags
enum {
	COLOR_DOOM3                 = 0x00001, // Doom 3 ^^ is empty string
	COLOR_QUAKE3_ALPHA          = 0x00002, // ioquake3 ^[a-zA-Z] color codes
	COLOR_QUAKE3_ANY            = 0x00004, // Quake 3 ^ followed by any character besides ^ color codes
	COLOR_QUAKE3_NUMERIC        = 0x00008, // Quake 3 ^[0-9] color codes
	COLOR_QUAKE4                = 0x00010, // Quake 4 color codes
	COLOR_SAVAGE                = 0x00020, // Savage color codes
	COLOR_WOLFET                = 0x00040, // Wolfenstein: Enemy Territory color codes
	COLOR_XONOTIC               = 0x00080, // Xonotic color codes
};

struct game {
	enum server_type type;
	unsigned long flags;
	unsigned long color_flags;

	char *name;
	unsigned short default_port;
	unsigned short default_master_port;

	char *id;
	char *qstat_str;
	char *qstat_option;
	char *qstat_master_option;
	const char* icon; // xpm symbol name
	struct pixmap *pix;

	struct player * (*parse_player) (char *tokens[], int num, struct server *s);
	void (*parse_server) (char *tokens[], int num, struct server *s);
	void (*analyze_serverinfo) (struct server *s);
	int (*config_is_valid) (struct server *s);
	int (*write_config) (const struct condef *con);
	int (*exec_client) (const struct condef *con, int forkit);
	/** \brief find a list of custom config files
	 *
	 * this->main_mods as well as mod directories inside
	 * this->real_home and dir will be scanned
	 * @param this pointer to game
	 * @param dir full path to game directory or NULL to use this->real_dir
	 * @param mod which mod
	 * @return list of found config files
	 */
	GList * (*custom_cfgs) (struct game* this, const char *dir, const char *mod);
	void (*save_info) (FILE *f, struct server *s);

	/* map functions */
	/** determine installed maps, destroys previous data */
	void (*init_maps)(enum server_type);
	/** return true if s->map is installed, false otherwise */
	gboolean (*has_map)(struct server* s);
	/** acquire image data, function allocates space in buf, returns size. buf
	 * must be freed by caller */
	size_t (*get_mapshot)(struct server* s, guchar** buf);

	char *arch_identifier;
	enum CPU (*identify_cpu) (struct server *s, const char *versionstr);
	enum OS (*identify_os) (struct server *s, char *versionstr);

	char *cmd;
	char *dir;
	char *real_dir;

	/** called when either cmd or dir have changed. Also on xqf startup */
	void (*cmd_or_dir_changed)(struct game* g);

	/** load preferences from config */
	void (*prefs_load)(struct game* g);

	/** sync preference dialog to config */
	void (*update_prefs)(struct game* g);

	/** built in default game specific home directory */
	char *default_home;

	/** tilde expanded game specific home directory */
	char *real_home;

	/** NULL terminated list of main mods (eg baseq3 for q3)*/
	char** main_mod;

	/** NULL terminated list of commands to search in $PATH for suggestion */
	char** command;

	/** NULL terminated list attributes and keys. used for filling games_data  */
	char** attributes;

	char *game_cfg;
	GData *games_data;
	GSList *custom_args;

	/** game specific private data */
	void *pd;
};

extern struct game games[];

extern enum server_type id2type (const char *id);
extern const char *type2id (enum server_type type);
extern GtkWidget *game_pixmap_with_label (enum server_type type);

// retreive game specific value that belongs to key, do not free return value!
const char* game_get_attribute(enum server_type type, const char* key);
// set game specific key/value pair, value is _not_ copied but will be freed internally
const char* game_set_attribute(enum server_type type, const char* key, char* value);

// set game specific key/value pair, value is _not_ copied and will not be freed internally
const char* game_set_attribute_const(enum server_type type, const char* attr, const char* value);

void init_games(void);
void games_done(void);

#endif /* __GAME_H__ */