warzone2100/lib/script/chat_processing.h

78 lines
2.6 KiB
C
Raw Normal View History

/*
This file is part of Warzone 2100.
Copyright (C) 1999-2004 Eidos Interactive
Copyright (C) 2005-2007 Warzone Resurrection Project
Warzone 2100 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.
Warzone 2100 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 Warzone 2100; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
/*
* chat_processing.h
*
* Misc definitions for chat parser
*/
#ifndef _chat_processing_h
#define _chat_processing_h
#include "lib/framework/frame.h"
#include "src/basedef.h"
#include "src/droiddef.h"
#include "src/structuredef.h"
#include "lib/script/script.h"
#ifndef MAXSTRLEN
#define MAXSTRLEN 255
#endif
/* Max number of commands in a player chat message */
#define MAX_CHAT_COMMANDS 10
/* Max number of parameters allowed in a single chat message command */
#define MAX_CHAT_CMD_PARAMS 10
/* Holds information for each recognized
* command in a chat message */
typedef struct _chat_command_data
{
const char *pCmdDescription; /* String representing a certain command */
BOOL bPlayerAddressed[MAX_PLAYERS]; /* Flag to indicate whether a command was addressed to a certain player */
SDWORD numCmdParams; /* Number of extracted parameters associated with each command */
INTERP_VAL parameter[MAX_CHAT_CMD_PARAMS]; /* Parameters extracted from text - to be used with scripts */
}CHAT_CMD_DATA;
typedef struct _chat_command
{
char lastMessage[MAXSTRLEN]; /* Parse the same mesage only once - in case more than one player is trying to parse */
SDWORD numCommands; /* Total number of commands in chat message */
CHAT_CMD_DATA cmdData[MAX_CHAT_COMMANDS]; /* Holds information for each recognized command */
}CHAT_MSG;
extern CHAT_MSG chat_msg;
/* Store parameter extracted from the message - for scripts */
//extern BOOL chat_store_parameter(INTERP_VAL *parameter);
extern void chat_error(const char *pMessage,...);
extern void chatGetErrorData(int *pLine, char **ppText);
/* Set the current input buffer for the lexer */
extern void chatSetInputBuffer(char *pBuffer, UDWORD size);
// Load message
extern BOOL chatLoad(char *pData, UDWORD size);
#endif