be_ai_chat.c

Go to the documentation of this file.

/*
===========================================================================
Copyright (C) 1999-2005 Id Software, Inc.

This file is part of Quake III Arena source code.

Quake III Arena source code 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.

Quake III Arena source code 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 Foobar; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
===========================================================================
*/

/*****************************************************************************
 * name:        be_ai_chat.c
 *
 * desc:        bot chat AI
 *
 * $Archive: /MissionPack/code/botlib/be_ai_chat.c $
 *
 *****************************************************************************/

#include "../game/q_shared.h"
#include "l_memory.h"
#include "l_libvar.h"
#include "l_script.h"
#include "l_precomp.h"
#include "l_struct.h"
#include "l_utils.h"
#include "l_log.h"
#include "aasfile.h"
#include "../game/botlib.h"
#include "../game/be_aas.h"
#include "be_aas_funcs.h"
#include "be_interface.h"
#include "../game/be_ea.h"
#include "../game/be_ai_chat.h"


//escape character
#define ESCAPE_CHAR             0x01    //'_'
//
// "hi ", people, " ", 0, " entered the game"
//becomes:
// "hi _rpeople_ _v0_ entered the game"
//

//match piece types
#define MT_VARIABLE                 1       //variable match piece
#define MT_STRING                   2       //string match piece
//reply chat key flags
#define RCKFL_AND                   1       //key must be present
#define RCKFL_NOT                   2       //key must be absent
#define RCKFL_NAME                  4       //name of bot must be present
#define RCKFL_STRING                8       //key is a string
#define RCKFL_VARIABLES             16      //key is a match template
#define RCKFL_BOTNAMES              32      //key is a series of botnames
#define RCKFL_GENDERFEMALE          64      //bot must be female
#define RCKFL_GENDERMALE            128     //bot must be male
#define RCKFL_GENDERLESS            256     //bot must be genderless
//time to ignore a chat message after using it
#define CHATMESSAGE_RECENTTIME  20

//the actuall chat messages
typedef struct bot_chatmessage_s
{
    char *chatmessage;                  //chat message string
    float time;                         //last time used
    struct bot_chatmessage_s *next;     //next chat message in a list
} bot_chatmessage_t;
//bot chat type with chat lines
typedef struct bot_chattype_s
{
    char name[MAX_CHATTYPE_NAME];
    int numchatmessages;
    bot_chatmessage_t *firstchatmessage;
    struct bot_chattype_s *next;
} bot_chattype_t;
//bot chat lines
typedef struct bot_chat_s
{
    bot_chattype_t *types;
} bot_chat_t;

//random string
typedef struct bot_randomstring_s
{
    char *string;
    struct bot_randomstring_s *next;
} bot_randomstring_t;
//list with random strings
typedef struct bot_randomlist_s
{
    char *string;
    int numstrings;
    bot_randomstring_t *firstrandomstring;
    struct bot_randomlist_s *next;
} bot_randomlist_t;

//synonym
typedef struct bot_synonym_s
{
    char *string;
    float weight;
    struct bot_synonym_s *next;
} bot_synonym_t;
//list with synonyms
typedef struct bot_synonymlist_s
{
    unsigned long int context;
    float totalweight;
    bot_synonym_t *firstsynonym;
    struct bot_synonymlist_s *next;
} bot_synonymlist_t;

//fixed match string
typedef struct bot_matchstring_s
{
    char *string;
    struct bot_matchstring_s *next;
} bot_matchstring_t;

//piece of a match template
typedef struct bot_matchpiece_s
{
    int type;
    bot_matchstring_t *firststring;
    int variable;
    struct bot_matchpiece_s *next;
} bot_matchpiece_t;
//match template
typedef struct bot_matchtemplate_s
{
    unsigned long int context;
    int type;
    int subtype;
    bot_matchpiece_t *first;
    struct bot_matchtemplate_s *next;
} bot_matchtemplate_t;

//reply chat key
typedef struct bot_replychatkey_s
{
    int flags;
    char *string;
    bot_matchpiece_t *match;
    struct bot_replychatkey_s *next;
} bot_replychatkey_t;
//reply chat
typedef struct bot_replychat_s
{
    bot_replychatkey_t *keys;
    float priority;
    int numchatmessages;
    bot_chatmessage_t *firstchatmessage;
    struct bot_replychat_s *next;
} bot_replychat_t;

//string list
typedef struct bot_stringlist_s
{
    char *string;
    struct bot_stringlist_s *next;
} bot_stringlist_t;

//chat state of a bot
typedef struct bot_chatstate_s
{
    int gender;                                         //0=it, 1=female, 2=male
    int client;                                         //client number
    char name[32];                                      //name of the bot
    char chatmessage[MAX_MESSAGE_SIZE];
    int handle;
    //the console messages visible to the bot
    bot_consolemessage_t *firstmessage;         //first message is the first typed message
    bot_consolemessage_t *lastmessage;          //last message is the last typed message, bottom of console
    //number of console messages stored in the state
    int numconsolemessages;
    //the bot chat lines
    bot_chat_t *chat;
} bot_chatstate_t;

typedef struct {
    bot_chat_t  *chat;
    char        filename[MAX_QPATH];
    char        chatname[MAX_QPATH];
} bot_ichatdata_t;

bot_ichatdata_t *ichatdata[MAX_CLIENTS];

bot_chatstate_t *botchatstates[MAX_CLIENTS+1];
//console message heap
bot_consolemessage_t *consolemessageheap = NULL;
bot_consolemessage_t *freeconsolemessages = NULL;
//list with match strings
bot_matchtemplate_t *matchtemplates = NULL;
//list with synonyms
bot_synonymlist_t *synonyms = NULL;
//list with random strings
bot_randomlist_t *randomstrings = NULL;
//reply chats
bot_replychat_t *replychats = NULL;

//========================================================================
//
// Parameter:               -
// Returns:                 -
// Changes Globals:     -
//========================================================================
bot_chatstate_t *BotChatStateFromHandle(int handle)
{
    if (handle <= 0 || handle > MAX_CLIENTS)
    {
        botimport.Print(PRT_FATAL, "chat state handle %d out of range\n", handle);
        return NULL;
    } //end if
    if (!botchatstates[handle])
    {
        botimport.Print(PRT_FATAL, "invalid chat state %d\n", handle);
        return NULL;
    } //end if
    return botchatstates[handle];
} //end of the function BotChatStateFromHandle
//===========================================================================
// initialize the heap with unused console messages
//
// Parameter:               -
// Returns:                 -
// Changes Globals:     -
//===========================================================================
void InitConsoleMessageHeap(void)
{
    int i, max_messages;

    if (consolemessageheap) FreeMemory(consolemessageheap);
    //
    max_messages = (int) LibVarValue("max_messages", "1024");
    consolemessageheap = (bot_consolemessage_t *) GetClearedHunkMemory(max_messages *
                                                sizeof(bot_consolemessage_t));
    consolemessageheap[0].prev = NULL;
    consolemessageheap[0].next = &consolemessageheap[1];
    for (i = 1; i < max_messages-1; i++)
    {
        consolemessageheap[i].prev = &consolemessageheap[i - 1];
        consolemessageheap[i].next = &consolemessageheap[i + 1];
    } //end for
    consolemessageheap[max_messages-1].prev = &consolemessageheap[max_messages-2];
    consolemessageheap[max_messages-1].next = NULL;
    //pointer to the free console messages
    freeconsolemessages = consolemessageheap;
} //end of the function InitConsoleMessageHeap
//===========================================================================
// allocate one console message from the heap
//
// Parameter:               -
// Returns:                 -
// Changes Globals:     -
//===========================================================================
bot_consolemessage_t *AllocConsoleMessage(void)
{
    bot_consolemessage_t *message;
    message = freeconsolemessages;
    if (freeconsolemessages) freeconsolemessages = freeconsolemessages->next;
    if (freeconsolemessages) freeconsolemessages->prev = NULL;
    return message;
} //end of the function AllocConsoleMessage
//===========================================================================
// deallocate one console message from the heap
//
// Parameter:               -
// Returns:                 -
// Changes Globals:     -
//===========================================================================
void FreeConsoleMessage(bot_consolemessage_t *message)
{
    if (freeconsolemessages) freeconsolemessages->prev = message;
    message->prev = NULL;
    message->next = freeconsolemessages;
    freeconsolemessages = message;
} //end of the function FreeConsoleMessage
//===========================================================================
//
// Parameter:               -
// Returns:                 -
// Changes Globals:     -
//===========================================================================
void BotRemoveConsoleMessage(int chatstate, int handle)
{
    bot_consolemessage_t *m, *nextm;
    bot_chatstate_t *cs;

    cs = BotChatStateFromHandle(chatstate);
    if (!cs) return;

    for (m = cs->firstmessage; m; m = nextm)
    {
        nextm = m->next;
        if (m->handle == handle)
        {
            if (m->next) m->next->prev = m->prev;
            else cs->lastmessage = m->prev;
            if (m->prev) m->prev->next = m->next;
            else cs->firstmessage = m->next;

            FreeConsoleMessage(m);
            cs->numconsolemessages--;
            break;
        } //end if
    } //end for
} //end of the function BotRemoveConsoleMessage
//===========================================================================
//
// Parameter:               -
// Returns:                 -
// Changes Globals:     -
//===========================================================================
void BotQueueConsoleMessage(int chatstate, int type, char *message)
{
    bot_consolemessage_t *m;
    bot_chatstate_t *cs;

    cs = BotChatStateFromHandle(chatstate);
    if (!cs) return;

    m = AllocConsoleMessage();
    if (!m)
    {
        botimport.Print(PRT_ERROR, "empty console message heap\n");
        return;
    } //end if
    cs->handle++;
    if (cs->handle <= 0 || cs->handle > 8192) cs->handle = 1;
    m->handle = cs->handle;
    m->time = AAS_Time();
    m->type = type;
    strncpy(m->message, message, MAX_MESSAGE_SIZE);
    m->next = NULL;
    if (cs->lastmessage)
    {
        cs->lastmessage->next = m;
        m->prev = cs->lastmessage;
        cs->lastmessage = m;
    } //end if
    else
    {
        cs->lastmessage = m;
        cs->firstmessage = m;
        m->prev = NULL;
    } //end if
    cs->numconsolemessages++;
} //end of the function BotQueueConsoleMessage
//===========================================================================
//
// Parameter:               -
// Returns:                 -
// Changes Globals:     -
//===========================================================================
int BotNextConsoleMessage(int chatstate, bot_consolemessage_t *cm)
{
    bot_chatstate_t *cs;

    cs = BotChatStateFromHandle(chatstate);
    if (!cs) return 0;
    if (cs->firstmessage)
    {
        Com_Memcpy(cm, cs->firstmessage, sizeof(bot_consolemessage_t));
        cm->next = cm->prev = NULL;
        return cm->handle;
    } //end if
    return 0;
} //end of the function BotConsoleMessage
//===========================================================================
//
// Parameter:               -
// Returns:                 -
// Changes Globals:     -
//===========================================================================
int BotNumConsoleMessages(int chatstate)
{
    bot_chatstate_t *cs;

    cs = BotChatStateFromHandle(chatstate);
    if (!cs) return 0;
    return cs->numconsolemessages;
} //end of the function BotNumConsoleMessages
//===========================================================================
//
// Parameter:               -
// Returns:                 -
// Changes Globals:     -
//===========================================================================
int IsWhiteSpace(char c)
{
    if ((c >= 'a' && c <= 'z')
        || (c >= 'A' && c <= 'Z')
        || (c >= '0' && c <= '9')
        || c == '(' || c == ')'
        || c == '?' || c == ':'
        || c == '\''|| c == '/'
        || c == ',' || c == '.'
        || c == '[' || c == ']'
        || c == '-' || c == '_'
        || c == '+' || c == '=') return qfalse;
    return qtrue;
} //end of the function IsWhiteSpace
//===========================================================================
//
// Parameter:           -
// Returns:             -
// Changes Globals:     -
//===========================================================================
void BotRemoveTildes(char *message)
{
    int i;

    //remove all tildes from the chat message
    for (i = 0; message[i]; i++)
    {
        if (message[i] == '~')
        {
            memmove(&message[i], &message[i+1], strlen(&message[i+1])+1);
        } //end if
    } //end for
} //end of the function BotRemoveTildes
//===========================================================================
//
// Parameter:               -
// Returns:                 -
// Changes Globals:     -
//===========================================================================
void UnifyWhiteSpaces(char *string)
{
    char *ptr, *oldptr;

    for (ptr = oldptr = string; *ptr; oldptr = ptr)
    {
        while(*ptr && IsWhiteSpace(*ptr)) ptr++;
        if (ptr > oldptr)
        {
            //if not at the start and not at the end of the string
            //write only one space
            if (oldptr > string && *ptr) *oldptr++ = ' ';
            //remove all other white spaces
            if (ptr > oldptr) memmove(oldptr, ptr, strlen(ptr)+1);
        } //end if
        while(*ptr && !IsWhiteSpace(*ptr)) ptr++;
    } //end while
} //end of the function UnifyWhiteSpaces
//===========================================================================
//
// Parameter:               -
// Returns:                 -
// Changes Globals:     -
//===========================================================================
int StringContains(char *str1, char *str2, int casesensitive)
{
    int len, i, j, index;

    if (str1 == NULL || str2 == NULL) return -1;

    len = strlen(str1) - strlen(str2);
    index = 0;
    for (i = 0; i <= len; i++, str1++, index++)
    {
        for (j = 0; str2[j]; j++)
        {
            if (casesensitive)
            {
                if (str1[j] != str2[j]) break;
            } //end if
            else
            {
                if (toupper(str1[j]) != toupper(str2[j])) break;
            } //end else
        } //end for
        if (!str2[j]) return index;
    } //end for
    return -1;
} //end of the function StringContains
//===========================================================================
//
// Parameter:               -
// Returns:                 -
// Changes Globals:     -
//===========================================================================
char *StringContainsWord(char *str1, char *str2, int casesensitive)
{
    int len, i, j;

    len = strlen(str1) - strlen(str2);
    for (i = 0; i <= len; i++, str1++)
    {
        //if not at the start of the string
        if (i)
        {
            //skip to the start of the next word
            while(*str1 && *str1 != ' ' && *str1 != '.' && *str1 != ',' && *str1 != '!') str1++;
            if (!*str1) break;
            str1++;
        } //end for
        //compare the word
        for (j = 0; str2[j]; j++)
        {
            if (casesensitive)
            {
                if (str1[j] != str2[j]) break;
            } //end if
            else
            {
                if (toupper(str1[j]) != toupper(str2[j])) break;
            } //end else
        } //end for
        //if there was a word match
        if (!str2[j])
        {
            //if the first string has an end of word
            if (!str1[j] || str1[j] == ' ' || str1[j] == '.' || str1[j] == ',' || str1[j] == '!') return str1;
        } //end if
    } //end for
    return NULL;
} //end of the function StringContainsWord
//===========================================================================
//
// Parameter:               -
// Returns:                 -
// Changes Globals:     -
//===========================================================================
void StringReplaceWords(char *string, char *synonym, char *replacement)
{
    char *str, *str2;

    //find the synonym in the string
    str = StringContainsWord(string, synonym, qfalse);
    //if the synonym occured in the string
    while(str)
    {
        //if the synonym isn't part of the replacement which is already in the string
        //usefull for abreviations
        str2 = StringContainsWord(string, replacement, qfalse);
        while(str2)
        {
            if (str2 <= str && str < str2 + strlen(replacement)) break;
            str2 = StringContainsWord(str2+1, replacement, qfalse);
        } //end while
        if (!str2)
        {
            memmove(str + strlen(replacement), str+strlen(synonym), strlen(str+strlen(synonym))+1);
            //append the synonum replacement
            Com_Memcpy(str, replacement, strlen(replacement));
        } //end if
        //find the next synonym in the string
        str = StringContainsWord(str+strlen(replacement), synonym, qfalse);
    } //end if
} //end of the function StringReplaceWords
//===========================================================================
//
// Parameter:               -
// Returns:                 -
// Changes Globals:     -
//===========================================================================
void BotDumpSynonymList(bot_synonymlist_t *synlist)
{
    FILE *fp;
    bot_synonymlist_t *syn;
    bot_synonym_t *synonym;

    fp = Log_FilePointer();
    if (!fp) return;
    for (syn = synlist; syn; syn = syn->next)
    {
            fprintf(fp, "%ld : [", syn->context);
        for (synonym = syn->firstsynonym; synonym; synonym = synonym->next)
        {
            fprintf(fp, "(\"%s\", %1.2f)", synonym->string, synonym->weight);
            if (synonym->next) fprintf(fp, ", ");
        } //end for
        fprintf(fp, "]\n");
    } //end for
} //end of the function BotDumpSynonymList
//===========================================================================
//
// Parameter:               -
// Returns:                 -
// Changes Globals:     -
//===========================================================================
bot_synonymlist_t *BotLoadSynonyms(char *filename)
{
    int pass, size, contextlevel, numsynonyms;
    unsigned long int context, contextstack[32];
    char *ptr = NULL;
    source_t *source;
    token_t token;
    bot_synonymlist_t *synlist, *lastsyn, *syn;
    bot_synonym_t *synonym, *lastsynonym;

    size = 0;
    synlist = NULL; //make compiler happy
    syn = NULL; //make compiler happy
    synonym = NULL; //make compiler happy
    //the synonyms are parsed in two phases
    for (pass = 0; pass < 2; pass++)
    {
        //
        if (pass && size) ptr = (char *) GetClearedHunkMemory(size);
        //
        PC_SetBaseFolder(BOTFILESBASEFOLDER);
        source = LoadSourceFile(filename);
        if (!source)
        {
            botimport.Print(PRT_ERROR, "counldn't load %s\n", filename);
            return NULL;
        } //end if
        //
        context = 0;
        contextlevel = 0;
        synlist = NULL; //list synonyms
        lastsyn = NULL; //last synonym in the list
        //
        while(PC_ReadToken(source, &token))
        {
            if (token.type == TT_NUMBER)
            {
                context |= token.intvalue;
                contextstack[contextlevel] = token.intvalue;
                contextlevel++;
                if (contextlevel >= 32)
                {
                    SourceError(source, "more than 32 context levels");
                    FreeSource(source);
                    return NULL;
                } //end if
                if (!PC_ExpectTokenString(source, "{"))
                {
                    FreeSource(source);
                    return NULL;
                } //end if
            } //end if
            else if (token.type == TT_PUNCTUATION)
            {
                if (!strcmp(token.string, "}"))
                {
                    contextlevel--;
                    if (contextlevel < 0)
                    {
                        SourceError(source, "too many }");
                        FreeSource(source);
                        return NULL;
                    } //end if
                    context &= ~contextstack[contextlevel];
                } //end if
                else if (!strcmp(token.string, "["))
                {
                    size += sizeof(bot_synonymlist_t);
                    if (pass)
                    {
                        syn = (bot_synonymlist_t *) ptr;
                        ptr += sizeof(bot_synonymlist_t);
                        syn->context = context;
                        syn->firstsynonym = NULL;
                        syn->next = NULL;
                        if (lastsyn) lastsyn->next = syn;
                        else synlist = syn;
                        lastsyn = syn;
                    } //end if
                    numsynonyms = 0;
                    lastsynonym = NULL;
                    while(1)
                    {
                        if (!PC_ExpectTokenString(source, "(") ||
                            !PC_ExpectTokenType(source, TT_STRING, 0, &token))
                        {
                            FreeSource(source);
                            return NULL;
                        } //end if
                        StripDoubleQuotes(token.string);
                        if (strlen(token.string) <= 0)
                        {
                            SourceError(source, "empty string", token.string);
                            FreeSource(source);
                            return NULL;
                        } //end if
                        size += sizeof(bot_synonym_t) + strlen(token.string) + 1;
                        if (pass)
                        {
                            synonym = (bot_synonym_t *) ptr;
                            ptr += sizeof(bot_synonym_t);
                            synonym->string = ptr;
                            ptr += strlen(token.string) + 1;
                            strcpy(synonym->string, token.string);
                            //
                            if (lastsynonym) lastsynonym->next = synonym;
                            else syn->firstsynonym = synonym;
                            lastsynonym = synonym;
                        } //end if
                        numsynonyms++;
                        if (!PC_ExpectTokenString(source, ",") ||
                            !PC_ExpectTokenType(source, TT_NUMBER, 0, &token) ||
                            !PC_ExpectTokenString(source, ")"))
                        {
                            FreeSource(source);
                            return NULL;
                        } //end if
                        if (pass)
                        {
                            synonym->weight = token.floatvalue;
                            syn->totalweight += synonym->weight;
                        } //end if
                        if (PC_CheckTokenString(source, "]")) break;
                        if (!PC_ExpectTokenString(source, ","))
                        {
                            FreeSource(source);
                            return NULL;
                        } //end if
                    } //end while
                    if (numsynonyms < 2)
                    {
                        SourceError(source, "synonym must have at least two entries\n");
                        FreeSource(source);
                        return NULL;
                    } //end if
                } //end else
                else
                {
                    SourceError(source, "unexpected %s", token.string);
                    FreeSource(source);
                    return NULL;
                } //end if
            } //end else if
        } //end while
        //
        FreeSource(source);
        //
        if (contextlevel > 0)
        {
            SourceError(source, "missing }");
            return NULL;
        } //end if
    } //end for
    botimport.Print(PRT_MESSAGE, "loaded %s\n", filename);
    //
    //BotDumpSynonymList(synlist);
    //
    return synlist;
} //end of the function BotLoadSynonyms
//===========================================================================
// replace all the synonyms in the string
//
// Parameter:               -
// Returns:                 -
// Changes Globals:     -
//===========================================================================
void BotReplaceSynonyms(char *string, unsigned long int context)
{
    bot_synonymlist_t *syn;
    bot_synonym_t *synonym;

    for (syn = synonyms; syn; syn = syn->next)
    {
        if (!(syn->context & context)) continue;
        for (synonym = syn->firstsynonym->next; synonym; synonym = synonym->next)
        {
            StringReplaceWords(string, synonym->string, syn->firstsynonym->string);
        } //end for
    } //end for
} //end of the function BotReplaceSynonyms
//===========================================================================
//
// Parameter:               -
// Returns:                 -
// Changes Globals:     -
//===========================================================================
void BotReplaceWeightedSynonyms(char *string, unsigned long int context)
{
    bot_synonymlist_t *syn;
    bot_synonym_t *synonym, *replacement;
    float weight, curweight;

    for (syn = synonyms; syn; syn = syn->next)
    {
        if (!(syn->context & context)) continue;
        //choose a weighted random replacement synonym
        weight = random() * syn->totalweight;
        if (!weight) continue;
        curweight = 0;
        for (replacement = syn->firstsynonym; replacement; replacement = replacement->next)
        {
            curweight += replacement->weight;
            if (weight < curweight) break;
        } //end for
        if (!replacement) continue;
        //replace all synonyms with the replacement
        for (synonym = syn->firstsynonym; synonym; synonym = synonym->next)
        {
            if (synonym == replacement) continue;
            StringReplaceWords(string, synonym->string, replacement->string);
        } //end for
    } //end for
} //end of the function BotReplaceWeightedSynonyms
//===========================================================================
//
// Parameter:               -
// Returns:                 -
// Changes Globals:     -
//===========================================================================
void BotReplaceReplySynonyms(char *string, unsigned long int context)
{
    char *str1, *str2, *replacement;
    bot_synonymlist_t *syn;
    bot_synonym_t *synonym;

    for (str1 = string; *str1; )
    {
        //go to the start of the next word
        while(*str1 && *str1 <= ' ') str1++;
        if (!*str1) break;
        //
        for (syn = synonyms; syn; syn = syn->next)
        {
            if (!(syn->context & context)) continue;
            for (synonym = syn->firstsynonym->next; synonym; synonym = synonym->next)
            {
                str2 = synonym->string;
                //if the synonym is not at the front of the string continue
                str2 = StringContainsWord(str1, synonym->string, qfalse);
                if (!str2 || str2 != str1) continue;
                //
                replacement = syn->firstsynonym->string;
                //if the replacement IS in front of the string continue
                str2 = StringContainsWord(str1, replacement, qfalse);
                if (str2 && str2 == str1) continue;
                //
                memmove(str1 + strlen(replacement), str1+strlen(synonym->string),
                            strlen(str1+strlen(synonym->string)) + 1);
                //append the synonum replacement
                Com_Memcpy(str1, replacement, strlen(replacement));
                //
                break;
            } //end for
            //if a synonym has been replaced
            if (synonym) break;
        } //end for
        //skip over this word
        while(*str1 && *str1 > ' ') str1++;
        if (!*str1) break;
    } //end while
} //end of the function BotReplaceReplySynonyms
//===========================================================================
//
// Parameter:           -
// Returns:             -
// Changes Globals:     -
//===========================================================================
int BotLoadChatMessage(source_t *source, char *chatmessagestring)
{
    char *ptr;
    token_t token;

    ptr = chatmessagestring;
    *ptr = 0;
    //
    while(1)
    {
        if (!PC_ExpectAnyToken(source, &token)) return qfalse;
        //fixed string
        if (token.type == TT_STRING)
        {
            StripDoubleQuotes(token.string);
            if (strlen(ptr) + strlen(token.string) + 1 > MAX_MESSAGE_SIZE)
            {
                SourceError(source, "chat message too long\n");
                return qfalse;
            } //end if
            strcat(ptr, token.string);
        } //end else if
        //variable string
        else if (token.type == TT_NUMBER && (token.subtype & TT_INTEGER))
        {
            if (strlen(ptr) + 7 > MAX_MESSAGE_SIZE)
            {
                SourceError(source, "chat message too long\n");
                return qfalse;
            } //end if
            sprintf(&ptr[strlen(ptr)], "%cv%ld%c", ESCAPE_CHAR, token.intvalue, ESCAPE_CHAR);
        } //end if
        //random string
        else if (token.type == TT_NAME)
        {
            if (strlen(ptr) + 7 > MAX_MESSAGE_SIZE)
            {
                SourceError(source, "chat message too long\n");
                return qfalse;
            } //end if
            sprintf(&ptr[strlen(ptr)], "%cr%s%c", ESCAPE_CHAR, token.string, ESCAPE_CHAR);
        } //end else if
        else
        {
            SourceError(source, "unknown message component %s\n", token.string);
            return qfalse;
        } //end else
        if (PC_CheckTokenString(source, ";")) break;
        if (!PC_ExpectTokenString(source, ",")) return qfalse;
    } //end while
    //
    return qtrue;
} //end of the function BotLoadChatMessage
//===========================================================================
//
// Parameter:               -
// Returns:                 -
// Changes Globals:     -
//===========================================================================
void BotDumpRandomStringList(bot_randomlist_t *randomlist)
{
    FILE *fp;
    bot_randomlist_t *random;
    bot_randomstring_t *rs;

    fp = Log_FilePointer();
    if (!fp) return;
    for (random = randomlist; random; random = random->next)
    {
        fprintf(fp, "%s = {", random->string);
        for (rs = random->firstrandomstring; rs; rs = rs->next)
        {
            fprintf(fp, "\"%s\"", rs->string);
            if (rs->next) fprintf(fp, ", ");
            else fprintf(fp, "}\n");
        } //end for
    } //end for
} //end of the function BotDumpRandomStringList
//===========================================================================
//
// Parameter:               -
// Returns:                 -
// Changes Globals:     -
//===========================================================================
bot_randomlist_t *BotLoadRandomStrings(char *filename)
{
    int pass, size;
    char *ptr = NULL, chatmessagestring[MAX_MESSAGE_SIZE];
    source_t *source;
    token_t token;
    bot_randomlist_t *randomlist, *lastrandom, *random;
    bot_randomstring_t *randomstring;

#ifdef DEBUG
    int starttime = Sys_MilliSeconds();
#endif //DEBUG

    size = 0;
    randomlist = NULL;
    random = NULL;
    //the synonyms are parsed in two phases
    for (pass = 0; pass < 2; pass++)
    {
        //
        if (pass && size) ptr = (char *) GetClearedHunkMemory(size);
        //
        PC_SetBaseFolder(BOTFILESBASEFOLDER);
        source = LoadSourceFile(filename);
        if (!source)
        {
            botimport.Print(PRT_ERROR, "counldn't load %s\n", filename);
            return NULL;
        } //end if
        //
        randomlist = NULL; //list
        lastrandom = NULL; //last
        //
        while(PC_ReadToken(source, &token))
        {
            if (token.type != TT_NAME)
            {
                SourceError(source, "unknown random %s", token.string);
                FreeSource(source);
                return NULL;
            } //end if
            size += sizeof(bot_randomlist_t) + strlen(token.string) + 1;
            if (pass)
            {
                random = (bot_randomlist_t *) ptr;
                ptr += sizeof(bot_randomlist_t);
                random->string = ptr;
                ptr += strlen(token.string) + 1;
                strcpy(random->string, token.string);
                random->firstrandomstring = NULL;
                random->numstrings = 0;
                //
                if (lastrandom) lastrandom->next = random;
                else randomlist = random;
                lastrandom = random;
            } //end if
            if (!PC_ExpectTokenString(source, "=") ||
                !PC_ExpectTokenString(source, "{"))
            {
                FreeSource(source);
                return NULL;
            } //end if
            while(!PC_CheckTokenString(source, "}"))
            {
                if (!BotLoadChatMessage(source, chatmessagestring))
                {
                    FreeSource(source);
                    return NULL;
                } //end if
                size += sizeof(bot_randomstring_t) + strlen(chatmessagestring) + 1;
                if (pass)
                {
                    randomstring = (bot_randomstring_t *) ptr;
                    ptr += sizeof(bot_randomstring_t);
                    randomstring->string = ptr;
                    ptr += strlen(chatmessagestring) + 1;
                    strcpy(randomstring->string, chatmessagestring);
                    //
                    random->numstrings++;
                    randomstring->next = random->firstrandomstring;
                    random->firstrandomstring = randomstring;
                } //end if
            } //end while
        } //end while
        //free the source after one pass
        FreeSource(source);
    } //end for
    botimport.Print(PRT_MESSAGE, "loaded %s\n", filename);
    //
#ifdef DEBUG
    botimport.Print(PRT_MESSAGE, "random strings %d msec\n", Sys_MilliSeconds() - starttime);
    //BotDumpRandomStringList(randomlist);
#endif //DEBUG
    //
    return randomlist;
} //end of the function BotLoadRandomStrings
//===========================================================================
//
// Parameter:               -
// Returns:                 -
// Changes Globals:     -
//===========================================================================
char *RandomString(char *name)
{
    bot_randomlist_t *random;
    bot_randomstring_t *rs;
    int i;

    for (random = randomstrings; random; random = random->next)
    {
        if (!strcmp(random->string, name))
        {
            i = random() * random->numstrings;
            for (rs = random->firstrandomstring; rs; rs = rs->next)
            {
                if (--i < 0) break;
            } //end for
            if (rs)
            {
                return rs->string;
            } //end if
        } //end for
    } //end for
    return NULL;
} //end of the function RandomString
//===========================================================================
//
// Parameter:               -
// Returns:                 -
// Changes Globals:     -
//===========================================================================
void BotDumpMatchTemplates(bot_matchtemplate_t *matches)
{
    FILE *fp;
    bot_matchtemplate_t *mt;
    bot_matchpiece_t *mp;
    bot_matchstring_t *ms;

    fp = Log_FilePointer();
    if (!fp) return;
    for (mt = matches; mt; mt = mt->next)
    {
            fprintf(fp, "{ " );
        for (mp = mt->first; mp; mp = mp->next)
        {
            if (mp->type == MT_STRING)
            {
                for (ms = mp->firststring; ms; ms = ms->next)
                {
                    fprintf(fp, "\"%s\"", ms->string);
                    if (ms->next) fprintf(fp, "|");
                } //end for
            } //end if
            else if (mp->type == MT_VARIABLE)
            {
                fprintf(fp, "%d", mp->variable);
            } //end else if
            if (mp->next) fprintf(fp, ", ");
        } //end for
        fprintf(fp, " = (%d, %d);}\n", mt->type, mt->subtype);
    } //end for
} //end of the function BotDumpMatchTemplates
//===========================================================================
//
// Parameter:               -
// Returns:                 -
// Changes Globals:     -
//===========================================================================
void BotFreeMatchPieces(bot_matchpiece_t *matchpieces)
{
    bot_matchpiece_t *mp, *nextmp;
    bot_matchstring_t *ms, *nextms;

    for (mp = matchpieces; mp; mp = nextmp)
    {
        nextmp = mp->next;
        if (mp->type == MT_STRING)
        {
            for (ms = mp->firststring; ms; ms = nextms)
            {
                nextms = ms->next;
                FreeMemory(ms);
            } //end for
        } //end if
        FreeMemory(mp);
    } //end for
} //end of the function BotFreeMatchPieces
//===========================================================================
//
// Parameter:               -
// Returns:                 -
// Changes Globals:     -
//===========================================================================
bot_matchpiece_t *BotLoadMatchPieces(source_t *source, char *endtoken)
{
    int lastwasvariable, emptystring;
    token_t token;
    bot_matchpiece_t *matchpiece, *firstpiece, *lastpiece;
    bot_matchstring_t *matchstring, *lastmatchstring;

    firstpiece = NULL;
    lastpiece = NULL;
    //
    lastwasvariable = qfalse;
    //
    while(