// Copyright (C) 1999-2000 Id Software, Inc.
//
/*****************************************************************************
 * name:		be_ai_chat.h
 *
 * desc:		char AI
 *
 * $Archive: /StarTrek/Code-DM/game/be_ai_chat.h $
 * $Author: Jmonroe $
 * $Revision: 1 $
 * $Modtime: 1/21/00 10:12p $
 * $Date: 1/25/00 6:26p $
 *
 *****************************************************************************/

#ifndef BE_AI_CHAT_H_
#define BE_AI_CHAT_H_

enum be_ai_chatLimits_e {
	MAX_MATCHVARIABLES = 8,
	MAX_CHATTYPE_NAME = 32,
	MAX_MESSAGE_SIZE = 256,
};

enum be_ai_chatGender_e {
	CHAT_GENDERLESS,
	CHAT_GENDERFEMALE,
	CHAT_GENDERMALE
};

enum be_ai_chatType_e {
	CHAT_ALL,
	CHAT_TEAM
};

//a console message
typedef struct bot_consolemessage_s {
	int32_t handle;
	double time;								//!<message time
	int32_t type;								//!<message type
	char message[MAX_MESSAGE_SIZE];				//!<message
	struct bot_consolemessage_s *prev, *next;	//!<prev and next in list
} bot_consolemessage_t;

//!match variable
typedef struct bot_matchvariable_s {
	char offset;
	int32_t length;
} bot_matchvariable_t;

//!returned to AI when a match is found
typedef struct bot_match_s {
	char string[MAX_MESSAGE_SIZE];
	int32_t type;
	int32_t subtype;
	bot_matchvariable_t variables[MAX_MATCHVARIABLES];
} bot_match_t;

//!setup the chat AI
int BotSetupChatAI(void);
//!shutdown the chat AI
void BotShutdownChatAI(void);
//!returns the handle to a newly allocated chat state
int BotAllocChatState(void);
//!frees the chatstate
void BotFreeChatState(int handle);
//!adds a console message to the chat state
void BotQueueConsoleMessage(int chatstate, int type, char *message);
//!removes the console message from the chat state
void BotRemoveConsoleMessage(int chatstate, int handle);
//!returns the next console message from the state
int BotNextConsoleMessage(int chatstate, bot_consolemessage_t *cm);
//!returns the number of console messages currently stored in the state
int BotNumConsoleMessages(int chatstate);
//!enters a chat message of the given type
void BotInitialChat(int chatstate, char *type, int mcontext, char *var0, char *var1, char *var2, char *var3, char *var4, char *var5, char *var6, char *var7);
//!returns the number of initial chat messages of the given type
int BotNumInitialChats(int chatstate, char *type);
//!find a reply for the given message
int BotReplyChat(int chatstate, char *message, int mcontext, int vcontext, char *var0, char *var1, char *var2, char *var3, char *var4, char *var5, char *var6, char *var7);
//!returns the length of the currently selected chat message
int BotChatLength(int chatstate);
//!enters the selected chat message
void BotEnterChat(int chatstate, int client, int sendto);
//!get the chat message ready to be output
void BotGetChatMessage(int chatstate, char *buf, int size);
//!checks if the first string contains the second one, returns index into first string or -1 if not found
int StringContains(char *str1, char *str2, int casesensitive);
//!finds a match for the given string
int BotFindMatch(char *str, bot_match_t *match, unsigned long int context);
//!returns a variable from a match
void BotMatchVariable(bot_match_t *match, int variable, char *buf, int size);
//!unify all the white spaces in the string
void UnifyWhiteSpaces(char *string);
//!replace all the context related synonyms in the string
void BotReplaceSynonyms(char *string, unsigned long int context);
//!loads a chat file for the chat state
int BotLoadChatFile(int chatstate, char *chatfile, char *chatname);
//!store the gender of the bot in the chat state
void BotSetChatGender(int chatstate, int gender);
//!store the bot name in the chat state
void BotSetChatName(int chatstate, char *name);

#endif /* BE_AI_CHAT_H_ */