1

/* $Id$ */

     2

     3

/*

     4

 * This file has the core function for AyStar

     5

 *  AyStar is a fast pathfinding routine and is used for things like

     6

 *  AI_pathfinding and Train_pathfinding.

     7

 *  For more information about AyStar (A* Algorithm), you can look at

     8

 *    http://en.wikipedia.org/wiki/A-star_search_algorithm

     9

 */

    10

    11

/*

    12

 * Friendly reminder:

    13

 *  Call (AyStar).free() when you are done with Aystar. It reserves a lot of memory

    14

 *  And when not free'd, it can cause system-crashes.

    15

 * Also remember that when you stop an algorithm before it is finished, your

    16

 * should call clear() yourself!

    17

 */

    18

    19

#include "stdafx.h"

    20

#include "openttd.h"

    21

#include "aystar.h"

    22

#include "helpers.hpp"

    23

    24

int _aystar_stats_open_size;

    25

int _aystar_stats_closed_size;

    26

    27

// This looks in the Hash if a node exists in ClosedList

    28

//  If so, it returns the PathNode, else NULL

    29

static PathNode* AyStarMain_ClosedList_IsInList(AyStar *aystar, const AyStarNode *node)

    30

{

    31

	return (PathNode*)Hash_Get(&aystar->ClosedListHash, node->tile, node->direction);

    32

}

    33

    34

// This adds a node to the ClosedList

    35

//  It makes a copy of the data

    36

static void AyStarMain_ClosedList_Add(AyStar *aystar, const PathNode *node)

    37

{

    38

	// Add a node to the ClosedList

    39

	PathNode *new_node = MallocT<PathNode>(1);

    40

	*new_node = *node;

    41

	Hash_Set(&aystar->ClosedListHash, node->node.tile, node->node.direction, new_node);

    42

}

    43

    44

// Checks if a node is in the OpenList

    45

//   If so, it returns the OpenListNode, else NULL

    46

static OpenListNode *AyStarMain_OpenList_IsInList(AyStar *aystar, const AyStarNode *node)

    47

{

    48

	return (OpenListNode*)Hash_Get(&aystar->OpenListHash, node->tile, node->direction);

    49

}

    50

    51

// Gets the best node from OpenList

    52

//  returns the best node, or NULL of none is found

    53

// Also it deletes the node from the OpenList

    54

static OpenListNode *AyStarMain_OpenList_Pop(AyStar *aystar)

    55

{

    56

	// Return the item the Queue returns.. the best next OpenList item.

    57

	OpenListNode *res = (OpenListNode*)aystar->OpenListQueue.pop(&aystar->OpenListQueue);

    58

	if (res != NULL) {

    59

		Hash_Delete(&aystar->OpenListHash, res->path.node.tile, res->path.node.direction);

    60

	}

    61

    62

	return res;

    63

}

    64

    65

// Adds a node to the OpenList

    66

//  It makes a copy of node, and puts the pointer of parent in the struct

    67

static void AyStarMain_OpenList_Add(AyStar *aystar, PathNode *parent, const AyStarNode *node, int f, int g)

    68

{

    69

	// Add a new Node to the OpenList

    70

	OpenListNode *new_node = MallocT<OpenListNode>(1);

    71

	new_node->g = g;

    72

	new_node->path.parent = parent;

    73

	new_node->path.node = *node;

    74

	Hash_Set(&aystar->OpenListHash, node->tile, node->direction, new_node);

    75

    76

	// Add it to the queue

    77

	aystar->OpenListQueue.push(&aystar->OpenListQueue, new_node, f);

    78

}

    79

    80

/*

    81

 * Checks one tile and calculate his f-value

    82

 *  return values:

    83

 * AYSTAR_DONE : indicates we are done

    84

 */

    85

int AyStarMain_CheckTile(AyStar *aystar, AyStarNode *current, OpenListNode *parent)

    86

{

    87

	int new_f, new_g, new_h;

    88

	PathNode *closedlist_parent;

    89

	OpenListNode *check;

    90

    91

	// Check the new node against the ClosedList

    92

	if (AyStarMain_ClosedList_IsInList(aystar, current) != NULL) return AYSTAR_DONE;

    93

    94

	// Calculate the G-value for this node

    95

	new_g = aystar->CalculateG(aystar, current, parent);

    96

	// If the value was INVALID_NODE, we don't do anything with this node

    97

	if (new_g == AYSTAR_INVALID_NODE) return AYSTAR_DONE;

    98

    99

	// There should not be given any other error-code..

   100

	assert(new_g >= 0);

   101

	// Add the parent g-value to the new g-value

   102

	new_g += parent->g;

   103

	if (aystar->max_path_cost != 0 && (uint)new_g > aystar->max_path_cost) return AYSTAR_DONE;

   104

   105

	// Calculate the h-value

   106

	new_h = aystar->CalculateH(aystar, current, parent);

   107

	// There should not be given any error-code..

   108

	assert(new_h >= 0);

   109

   110

	// The f-value if g + h

   111

	new_f = new_g + new_h;

   112

   113

	// Get the pointer to the parent in the ClosedList (the currentone is to a copy of the one in the OpenList)

   114

	closedlist_parent = AyStarMain_ClosedList_IsInList(aystar, &parent->path.node);

   115

   116

	// Check if this item is already in the OpenList

   117

	check = AyStarMain_OpenList_IsInList(aystar, current);

   118

	if (check != NULL) {

   119

		uint i;

   120

		// Yes, check if this g value is lower..

   121

		if (new_g > check->g) return AYSTAR_DONE;

   122

		aystar->OpenListQueue.del(&aystar->OpenListQueue, check, 0);

   123

		// It is lower, so change it to this item

   124

		check->g = new_g;

   125

		check->path.parent = closedlist_parent;

   126

		/* Copy user data, will probably have changed */

   127

		for (i = 0; i < lengthof(current->user_data); i++) {

   128

			check->path.node.user_data[i] = current->user_data[i];

   129

		}

   130

		// Readd him in the OpenListQueue

   131

		aystar->OpenListQueue.push(&aystar->OpenListQueue, check, new_f);

   132

	} else {

   133

		// A new node, add him to the OpenList

   134

		AyStarMain_OpenList_Add(aystar, closedlist_parent, current, new_f, new_g);

   135

	}

   136

   137

	return AYSTAR_DONE;

   138

}

   139

   140

/*

   141

 * This function is the core of AyStar. It handles one item and checks

   142

 *  his neighbour items. If they are valid, they are added to be checked too.

   143

 *  return values:

   144

 *   AYSTAR_EMPTY_OPENLIST : indicates all items are tested, and no path

   145

 *    has been found.

   146

 *   AYSTAR_LIMIT_REACHED : Indicates that the max_nodes limit has been

   147

 *    reached.

   148

 *   AYSTAR_FOUND_END_NODE : indicates we found the end. Path_found now is true, and in path is the path found.

   149

 *   AYSTAR_STILL_BUSY : indicates we have done this tile, did not found the path yet, and have items left to try.

   150

 */

   151

int AyStarMain_Loop(AyStar *aystar)

   152

{

   153

	int i, r;

   154

   155

	// Get the best node from OpenList

   156

	OpenListNode *current = AyStarMain_OpenList_Pop(aystar);

   157

	// If empty, drop an error

   158

	if (current == NULL) return AYSTAR_EMPTY_OPENLIST;

   159

   160

	// Check for end node and if found, return that code

   161

	if (aystar->EndNodeCheck(aystar, current) == AYSTAR_FOUND_END_NODE) {

   162

		if (aystar->FoundEndNode != NULL)

   163

			aystar->FoundEndNode(aystar, current);

   164

		free(current);

   165

		return AYSTAR_FOUND_END_NODE;

   166

	}

   167

   168

	// Add the node to the ClosedList

   169

	AyStarMain_ClosedList_Add(aystar, &current->path);

   170

   171

	// Load the neighbours

   172

	aystar->GetNeighbours(aystar, current);

   173

   174

	// Go through all neighbours

   175

	for (i = 0; i < aystar->num_neighbours; i++) {

   176

		// Check and add them to the OpenList if needed

   177

		r = aystar->checktile(aystar, &aystar->neighbours[i], current);

   178

	}

   179

   180

	// Free the node

   181

	free(current);

   182

   183

	if (aystar->max_search_nodes != 0 && Hash_Size(&aystar->ClosedListHash) >= aystar->max_search_nodes) {

   184

		/* We've expanded enough nodes */

   185

		return AYSTAR_LIMIT_REACHED;

   186

	} else {

   187

		// Return that we are still busy

   188

		return AYSTAR_STILL_BUSY;

   189

	}

   190

}

   191

   192

/*

   193

 * This function frees the memory it allocated

   194

 */

   195

void AyStarMain_Free(AyStar *aystar)

   196

{

   197

	aystar->OpenListQueue.free(&aystar->OpenListQueue, false);

   198

	/* 2nd argument above is false, below is true, to free the values only

   199

	 * once */

   200

	delete_Hash(&aystar->OpenListHash, true);

   201

	delete_Hash(&aystar->ClosedListHash, true);

   202

#ifdef AYSTAR_DEBUG

   203

	printf("[AyStar] Memory free'd\n");

   204

#endif

   205

}

   206

   207

/*

   208

 * This function make the memory go back to zero

   209

 *  This function should be called when you are using the same instance again.

   210

 */

   211

void AyStarMain_Clear(AyStar *aystar)

   212

{

   213

	// Clean the Queue, but not the elements within. That will be done by

   214

	// the hash.

   215

	aystar->OpenListQueue.clear(&aystar->OpenListQueue, false);

   216

	// Clean the hashes

   217

	clear_Hash(&aystar->OpenListHash, true);

   218

	clear_Hash(&aystar->ClosedListHash, true);

   219

   220

#ifdef AYSTAR_DEBUG

   221

	printf("[AyStar] Cleared AyStar\n");

   222

#endif

   223

}

   224

   225

/*

   226

 * This is the function you call to run AyStar.

   227

 *  return values:

   228

 *   AYSTAR_FOUND_END_NODE : indicates we found an end node.

   229

 *   AYSTAR_NO_PATH : indicates that there was no path found.

   230

 *   AYSTAR_STILL_BUSY : indicates we have done some checked, that we did not found the path yet, and that we still have items left to try.

   231

 * When the algorithm is done (when the return value is not AYSTAR_STILL_BUSY)

   232

 * aystar->clear() is called. Note that when you stop the algorithm halfway,

   233

 * you should still call clear() yourself!

   234

 */

   235

int AyStarMain_Main(AyStar *aystar) {

   236

	int r, i = 0;

   237

	// Loop through the OpenList

   238

	//  Quit if result is no AYSTAR_STILL_BUSY or is more than loops_per_tick

   239

	while ((r = aystar->loop(aystar)) == AYSTAR_STILL_BUSY && (aystar->loops_per_tick == 0 || ++i < aystar->loops_per_tick)) { }

   240

#ifdef AYSTAR_DEBUG

   241

	switch (r) {

   242

		case AYSTAR_FOUND_END_NODE: printf("[AyStar] Found path!\n"); break;

   243

		case AYSTAR_EMPTY_OPENLIST: printf("[AyStar] OpenList run dry, no path found\n"); break;

   244

		case AYSTAR_LIMIT_REACHED:  printf("[AyStar] Exceeded search_nodes, no path found\n"); break;

   245

		default: break;

   246

	}

   247

#endif

   248

	if (r != AYSTAR_STILL_BUSY) {

   249

		/* We're done, clean up */

   250

		_aystar_stats_open_size = aystar->OpenListHash.size;

   251

		_aystar_stats_closed_size = aystar->ClosedListHash.size;

   252

		aystar->clear(aystar);

   253

	}

   254

   255

	switch (r) {

   256

		case AYSTAR_FOUND_END_NODE: return AYSTAR_FOUND_END_NODE;

   257

		case AYSTAR_EMPTY_OPENLIST:

   258

		case AYSTAR_LIMIT_REACHED:  return AYSTAR_NO_PATH;

   259

		default:                    return AYSTAR_STILL_BUSY;

   260

	}

   261

}

   262

   263

/*

   264

 * Adds a node from where to start an algorithm. Multiple nodes can be added

   265

 * if wanted. You should make sure that clear() is called before adding nodes

   266

 * if the AyStar has been used before (though the normal main loop calls

   267

 * clear() automatically when the algorithm finishes

   268

 * g is the cost for starting with this node.

   269

 */

   270

void AyStarMain_AddStartNode(AyStar *aystar, AyStarNode *start_node, uint g)

   271

{

   272

#ifdef AYSTAR_DEBUG

   273

	printf("[AyStar] Starting A* Algorithm from node (%d, %d, %d)\n",

   274

		TileX(start_node->tile), TileY(start_node->tile), start_node->direction);

   275

#endif

   276

	AyStarMain_OpenList_Add(aystar, NULL, start_node, 0, g);

   277

}

   278

   279

void init_AyStar(AyStar *aystar, Hash_HashProc hash, uint num_buckets)

   280

{

   281

	// Allocated the Hash for the OpenList and ClosedList

   282

	init_Hash(&aystar->OpenListHash, hash, num_buckets);

   283

	init_Hash(&aystar->ClosedListHash, hash, num_buckets);

   284

   285

	// Set up our sorting queue

   286

	//  BinaryHeap allocates a block of 1024 nodes

   287

	//  When thatone gets full it reserves an otherone, till this number

   288

	//  That is why it can stay this high

   289

	init_BinaryHeap(&aystar->OpenListQueue, 102400);

   290

   291

	aystar->addstart  = AyStarMain_AddStartNode;

   292

	aystar->main      = AyStarMain_Main;

   293

	aystar->loop      = AyStarMain_Loop;

   294

	aystar->free      = AyStarMain_Free;

   295

	aystar->clear     = AyStarMain_Clear;

   296

	aystar->checktile = AyStarMain_CheckTile;

   297

}