1

/* $Id$ */

     2

     3

#include "../stdafx.h"

     4

#include "../openttd.h"

     5

#include "../variables.h"

     6

#include "../command.h"

     7

#include "../network.h"

     8

#include "../debug.h"

     9

#include "ai.h"

    10

#include "default/default.h"

    11

#include "../string.h"

    12

    13

/* Here we define the events */

    14

#define DEF_EVENTS

    15

#include "ai_event.h"

    16

#undef DEF_EVENTS

    17

    18

/* Here we keep track of all commands that are called via AI_DoCommandChecked,

    19

 *  in special we save the unique_id here. Now this id is given back

    20

 *  when the command fails or succeeds and is detected as added in this storage. */

    21

static AICommand *command_uid[MAX_PLAYERS];

    22

static AICommand *command_uid_tail[MAX_PLAYERS];

    23

static uint uids[MAX_PLAYERS];

    24

    25

/**

    26

 * Dequeues commands put in the queue via AI_PutCommandInQueue.

    27

 */

    28

void AI_DequeueCommands(byte player)

    29

{

    30

	AICommand *com, *entry_com;

    31

    32

	entry_com = _ai_player[player].queue;

    33

    34

	/* It happens that DoCommandP issues a new DoCommandAI which adds a new command

    35

	 *  to this very same queue (don't argue about this, if it currently doesn't

    36

	 *  happen I can tell you it will happen with AIScript -- TrueLight). If we

    37

	 *  do not make the queue NULL, that commands will be dequeued immediatly.

    38

	 *  Therefor we safe the entry-point to entry_com, and make the queue NULL, so

    39

	 *  the new queue can be safely built up. */

    40

	_ai_player[player].queue = NULL;

    41

	_ai_player[player].queue_tail = NULL;

    42

    43

	/* Dequeue all commands */

    44

	while ((com = entry_com) != NULL) {

    45

		_current_player = player;

    46

    47

		/* Copy the DP back in place */

    48

		memcpy(_decode_parameters, com->dp, sizeof(com->dp));

    49

		DoCommandP(com->tile, com->p1, com->p2, NULL, com->procc);

    50

    51

		/* Free item */

    52

		entry_com = com->next;

    53

		free(com);

    54

	}

    55

}

    56

    57

/**

    58

 * Needed for SP; we need to delay DoCommand with 1 tick, because else events

    59

 *  will make infinite loops (AIScript).

    60

 */

    61

void AI_PutCommandInQueue(byte player, uint tile, uint32 p1, uint32 p2, uint procc)

    62

{

    63

	AICommand *com;

    64

    65

	if (_ai_player[player].queue_tail == NULL) {

    66

		/* There is no item in the queue yet, create the queue */

    67

		_ai_player[player].queue = malloc(sizeof(AICommand));

    68

		_ai_player[player].queue_tail = _ai_player[player].queue;

    69

	} else {

    70

		/* Add an item at the end */

    71

		_ai_player[player].queue_tail->next = malloc(sizeof(AICommand));

    72

		_ai_player[player].queue_tail = _ai_player[player].queue_tail->next;

    73

	}

    74

    75

	/* This is our new item */

    76

	com = _ai_player[player].queue_tail;

    77

    78

	/* Assign the info */

    79

	com->tile  = tile;

    80

	com->p1    = p1;

    81

	com->p2    = p2;

    82

	com->procc = procc;

    83

	com->next  = NULL;

    84

    85

	/* Copy the decode_parameters */

    86

	memcpy(com->dp, _decode_parameters, sizeof(com->dp));

    87

}

    88

    89

/**

    90

 * Executes a raw DoCommand for the AI.

    91

 */

    92

int32 AI_DoCommand(uint tile, uint32 p1, uint32 p2, uint32 flags, uint procc)

    93

{

    94

	PlayerID old_lp;

    95

	int32 res = 0;

    96

    97

	/* If you enable DC_EXEC with DC_QUERY_COST you are a really strange

    98

	 *   person.. should we check for those funny jokes?

    99

	 */

   100

   101

	/* First, do a test-run to see if we can do this */

   102

	res = DoCommandByTile(tile, p1, p2, flags & ~DC_EXEC, procc);

   103

	/* The command failed, or you didn't want to execute, or you are quering, return */

   104

	if ((CmdFailed(res)) || !(flags & DC_EXEC) || (flags & DC_QUERY_COST))

   105

		return res;

   106

   107

	/* If we did a DC_EXEC, and the command did not return an error, execute it

   108

	    over the network */

   109

	if (flags & DC_AUTO)                  procc |= CMD_AUTO;

   110

	if (flags & DC_NO_WATER)              procc |= CMD_NO_WATER;

   111

   112

	/* NetworkSend_Command needs _local_player to be set correctly, so

   113

	    adjust it, and put it back right after the function */

   114

	old_lp = _local_player;

   115

	_local_player = _current_player;

   116

   117

#ifdef ENABLE_NETWORK

   118

	/* Send the command */

   119

	if (_networking)

   120

		/* Network is easy, send it to his handler */

   121

		NetworkSend_Command(tile, p1, p2, procc, NULL);

   122

	else

   123

#endif

   124

		/* If we execute BuildCommands directly in SP, we have a big problem with events

   125

		 *  so we need to delay is for 1 tick */

   126

		AI_PutCommandInQueue(_current_player, tile, p1, p2, procc);

   127

   128

	/* Set _local_player back */

   129

	_local_player = old_lp;

   130

   131

	return res;

   132

}

   133

   134

int32 AI_DoCommandChecked(uint tile, uint32 p1, uint32 p2, uint32 flags, uint procc)

   135

{

   136

	AICommand *new;

   137

	uint unique_id = uids[_current_player]++;

   138

	int32 res;

   139

   141

	if (CmdFailed(res))

   142

		return CMD_ERROR;

   143

   144

	/* Save the command and his things, together with the unique_id */

   145

	new = malloc(sizeof(AICommand));

   146

	new->tile  = tile;

   147

	new->p1    = p1;

   148

	new->p2    = p2;

   149

	new->procc = procc;

   150

	new->next  = NULL;

   151

	new->dp[0] = unique_id;

   152

   153

	/* Add it to the back of the list */

   154

	if (command_uid_tail[_current_player] == NULL)

   155

		command_uid_tail[_current_player] = new;

   156

	else

   157

		command_uid_tail[_current_player]->next = new;

   158

   159

	if (command_uid[_current_player] == NULL)

   160

		command_uid[_current_player] = new;

   161

   162

	AI_DoCommand(tile, p1, p2, flags, procc);

   163

	return unique_id;

   164

}

   165

   166

/**

   167

 * A command is executed for real, and is giving us his result (failed yes/no). Inform the AI with it via

   168

 *  an event.Z

   169

 */

   170

void AI_CommandResult(uint32 cmd, uint32 p1, uint32 p2, TileIndex tile, bool succeeded)

   171

{

   172

	AICommand *command = command_uid[_current_player];

   173

   174

	if (command == NULL)

   175

		return;

   176

   177

	if (command->procc != (cmd & 0xFF) || command->p1 != p1 || command->p2 != p2 || command->tile != tile) {

   178

		/* If we come here, we see a command that isn't at top in our list. This is okay, if the command isn't

   179

		 *  anywhere else in our list, else we have a big problem.. so check for that. If it isn't in our list,

   180

		 *  it is okay, else, drop the game.

   181

		 * Why do we have a big problem in the case it is in our list? Simply, we have a command sooner in

   182

		 *  our list that wasn't triggered to be failed or succeeded, so it is sitting there without an

   183

		 *  event, so the script will never know if it succeeded yes/no, so it can hang.. this is VERY bad

   184

		 *  and should never ever happen. */

   185

		while (command != NULL && (command->procc != (cmd & 0xFF) || command->p1 != p1 || command->p2 != p2 || command->tile != tile)) {

   186

			command = command->next;

   187

		}

   188

		assert(command == NULL);

   189

		return;

   190

	}

   191

   192

	command_uid[_current_player] = command_uid[_current_player]->next;

   193

	if (command_uid[_current_player] == NULL)

   194

		command_uid_tail[_current_player] = NULL;

   195

   196

	ai_event(_current_player, succeeded ? ottd_Event_CommandSucceeded : ottd_Event_CommandFailed, tile, command->dp[0]);

   197

	free(command);

   198

}

   199

   200

/**

   201

 * Run 1 tick of the AI. Don't overdo it, keep it realistic.

   202

 */

   203

static void AI_RunTick(PlayerID player)

   204

{

   205

	_current_player = player;

   206

   207

#ifdef GPMI

   208

	if (_ai.gpmi) {

   209

		gpmi_call_RunTick(_ai_player[player].module, _frame_counter);

   210

		return;

   211

	}

   212

#endif /* GPMI */

   213

   214

	{

   215

		extern void AiNewDoGameLoop(Player *p);

   216

   217

		Player *p = GetPlayer(player);

   218

   219

		if (_patches.ainew_active) {

   220

			AiNewDoGameLoop(p);

   221

		} else {

   222

			/* Enable all kind of cheats the old AI needs in order to operate correctly... */

   223

			_is_old_ai_player = true;

   224

			AiDoGameLoop(p);

   225

			_is_old_ai_player = false;

   226

		}

   227

	}

   228

}

   229

   230

   231

/**

   232

 * The gameloop for AIs.

   233

 *  Handles one tick for all the AIs.

   234

 */

   235

void AI_RunGameLoop(void)

   236

{

   237

	/* Don't do anything if ai is disabled */

   238

	if (!_ai.enabled) return;

   239

   240

	/* Don't do anything if we are a network-client

   241

	 *  (too bad when a client joins, he thinks the AIs are real, so it wants to control

   242

	 *   them.. this avoids that, while loading a network game in singleplayer, does make

   243

	 *   the AIs to continue ;))

   244

	 */

   245

	if (_networking && !_network_server && !_ai.network_client)

   246

		return;

   247

   248

	/* New tick */

   249

	_ai.tick++;

   250

   251

	/* Make sure the AI follows the difficulty rule.. */

   252

	assert(_opt.diff.competitor_speed <= 4);

   253

	if ((_ai.tick & ((1 << (4 - _opt.diff.competitor_speed)) - 1)) != 0)

   254

		return;

   255

   256

	/* Check for AI-client (so joining a network with an AI) */

   257

	if (_ai.network_client && _ai_player[_ai.network_playas].active) {

   258

		/* Run the script */

   259

		AI_DequeueCommands(_ai.network_playas);

   260

		AI_RunTick(_ai.network_playas);

   261

	} else if (!_networking || _network_server) {

   262

		/* Check if we want to run AIs (server or SP only) */

   263

		Player *p;

   264

   265

		FOR_ALL_PLAYERS(p) {

   266

			if (p->is_active && p->is_ai && _ai_player[p->index].active) {

   267

				/* Run the script */

   268

				AI_DequeueCommands(p->index);

   269

				AI_RunTick(p->index);

   270

			}

   271

		}

   272

	}

   273

   274

	_current_player = OWNER_NONE;

   275

}

   276

   277

#ifdef GPMI

   278

   279

void AI_ShutdownAIControl(bool with_error)

   280

{

   281

	if (_ai.gpmi_mod != NULL)

   282

		gpmi_mod_unload(_ai.gpmi_mod);

   283

	if (_ai.gpmi_pkg != NULL)

   284

		gpmi_pkg_unload(_ai.gpmi_pkg);

   285

   286

	if (with_error) {

   287

		DEBUG(ai, 0)("[AI] Failed to load AI Control, switching back to built-in AIs..");

   288

		_ai.gpmi = false;

   289

	}

   290

}

   291

   292

void (*ottd_GetNextAIData)(char **library, char **param);

   293

void (*ottd_SetAIParam)(char *param);

   294

   295

void AI_LoadAIControl(void)

   296

{

   297

	/* Load module */

   298

	_ai.gpmi_mod = gpmi_mod_load("ottd_ai_control_mod", NULL);

   299

	if (_ai.gpmi_mod == NULL) {

   300

		AI_ShutdownAIControl(true);

   301

		return;

   302

	}

   303

   304

	/* Load package */

   305

	if (gpmi_pkg_load("ottd_ai_control_pkg", 0, NULL, NULL, &_ai.gpmi_pkg)) {

   306

		AI_ShutdownAIControl(true);

   307

		return;

   308

	}

   309

   310

	/* Now link all the functions */

   311

	{

   312

		ottd_GetNextAIData = gpmi_pkg_resolve(_ai.gpmi_pkg, "ottd_GetNextAIData");

   313

		ottd_SetAIParam = gpmi_pkg_resolve(_ai.gpmi_pkg, "ottd_SetAIParam");

   314

   315

		if (ottd_GetNextAIData == NULL || ottd_SetAIParam == NULL)

   316

			AI_ShutdownAIControl(true);

   317

	}

   318

   319

	ottd_SetAIParam(_ai.gpmi_param);

   320

}

   321

   322

/**

   323

 * Dump an entry of the GPMI error stack (callback routine). This helps the user to trace errors back to their roots.

   324

 */

   325

void AI_PrintErrorStack(gpmi_err_stack_t *entry, char *string)

   326

{

   327

	DEBUG(ai, 0)("%s", string);

   328

}

   329

   330

#endif /* GPMI */

   331

   332

/**

   333

 * A new AI sees the day of light. You can do here what ever you think is needed.

   334

 */

   335

void AI_StartNewAI(PlayerID player)

   336

{

   337

	assert(player < MAX_PLAYERS);

   338

   339

#ifdef GPMI

   340

	/* Keep this in a different IF, because the function can turn _ai.gpmi off!! */

   341

	if (_ai.gpmi && _ai.gpmi_mod == NULL)

   342

		AI_LoadAIControl();

   343

   344

	if (_ai.gpmi) {

   345

		char *library = NULL;

   346

		char *params = NULL;

   347

   348

		ottd_GetNextAIData(&library, &params);

   349

		gpmi_error_stack_enable = 1;

   350

   351

		if (library != NULL) {

   352

			_ai_player[player].module = gpmi_mod_load(library, params);

   353

			free(library);

   354

		}

   355

		if (params != NULL)

   356

			free(params);

   357

   358

		if (_ai_player[player].module == NULL) {

   359

			DEBUG(ai, 0)("[AI] Failed to load AI, aborting. GPMI error stack:");

   360

			gpmi_err_stack_process_str(AI_PrintErrorStack);

   361

			return;

   362

		}

   363

		gpmi_error_stack_enable = 0;

   364

   365

	}

   366

#endif /* GPMI */

   367

   368

	/* Called if a new AI is booted */

   369

	_ai_player[player].active = true;

   370

}

   371

   372

/**

   373

 * This AI player died. Give it some chance to make a final puf.

   374

 */

   375

void AI_PlayerDied(PlayerID player)

   376

{

   377

	if (_ai.network_client && _ai.network_playas == player)

   378

		_ai.network_playas = OWNER_SPECTATOR;

   379

   380

	/* Called if this AI died */

   381

	_ai_player[player].active = false;

   382

   383

	if (command_uid[player] != NULL) {

   384

		while (command_uid[player] != NULL) {

   385

			AICommand *command = command_uid[player];

   386

			command_uid[player] = command->next;

   387

			free(command);

   388

		}

   389

   390

		command_uid[player] = NULL;

   391

		command_uid_tail[player] = NULL;

   392

	}

   393

   394

#ifdef GPMI

   395

	if (_ai_player[player].module != NULL)

   396

		gpmi_mod_unload(_ai_player[player].module);

   397

#endif /* GPMI */

   398

}

   399

   400

/**

   401

 * Initialize some AI-related stuff.

   402

 */

   403

void AI_Initialize(void)

   404

{

   405

	bool tmp_ai_network_client = _ai.network_client;

   406

	bool tmp_ai_gpmi = _ai.gpmi;

   407

#ifdef GPMI

   408

	char *tmp_ai_gpmi_param = strdup(_ai.gpmi_param);

   409

#endif /* GPMI */

   410

   411

	/* First, make sure all AIs are DEAD! */

   412

	AI_Uninitialize();

   413

   414

	memset(&_ai, 0, sizeof(_ai));

   415

	memset(_ai_player, 0, sizeof(_ai_player));

   416

	memset(uids, 0, sizeof(uids));

   417

	memset(command_uid, 0, sizeof(command_uid));

   418

	memset(command_uid_tail, 0, sizeof(command_uid_tail));

   419

   420

	_ai.network_client = tmp_ai_network_client;

   421

	_ai.network_playas = OWNER_SPECTATOR;

   422

	_ai.enabled = true;

   423

	_ai.gpmi = tmp_ai_gpmi;

   424

#ifdef GPMI

   425

	ttd_strlcpy(_ai.gpmi_param, tmp_ai_gpmi_param, sizeof(_ai.gpmi_param));

   426

	free(tmp_ai_gpmi_param);

   427

#endif /* GPMI */

   428

}

   429

   430

/**

   431

 * Deinitializer for AI-related stuff.

   432

 */

   433

void AI_Uninitialize(void)

   434

{

   435

	Player* p;

   436

   437

	FOR_ALL_PLAYERS(p) {

   438

		if (p->is_active && p->is_ai && _ai_player[p->index].active) AI_PlayerDied(p->index);

   439

	}

   440

   441

#ifdef GPMI

   442

	AI_ShutdownAIControl(false);

   443

#endif /* GPMI */

   444

}