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

    23

int _aystar_stats_open_size;

    24

int _aystar_stats_closed_size;

    25

    26

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

    27

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

    28

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

    29

{

    30

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

    31

}

    32

    33

// This adds a node to the ClosedList

    34

//  It makes a copy of the data

    35

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

    36

{

    37

	// Add a node to the ClosedList

    38

	PathNode *new_node = malloc(sizeof(PathNode));

    39

	*new_node = *node;

    40

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

    41

}

    42

    43

// Checks if a node is in the OpenList

    44

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

    45

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

    46

{

    47

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

    48

}

    49

    50

// Gets the best node from OpenList

    51

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

    52

// Also it deletes the node from the OpenList

    53

static OpenListNode *AyStarMain_OpenList_Pop(AyStar *aystar)

    54

{

    55

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

    56

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

    57

	if (res != NULL)

    58

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

    59

    60

	return res;

    61

}

    62

    63

// Adds a node to the OpenList

    64

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

    65

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

    66

{

    67

	// Add a new Node to the OpenList

    68

	OpenListNode* new_node = malloc(sizeof(OpenListNode));

    69

	new_node->g = g;

    70

	new_node->path.parent = parent;

    71

	new_node->path.node = *node;

    72

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

    73

    74

	// Add it to the queue

    75

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

    76

}

    77

    78

/*

    79

 * Checks one tile and calculate his f-value

    80

 *  return values:

    81

 *	AYSTAR_DONE : indicates we are done

    82

 */

    83

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

    84

	int new_f, new_g, new_h;

    85

	PathNode *closedlist_parent;

    86

	OpenListNode *check;

    87

    88

	// Check the new node against the ClosedList

    89

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

    90

    91

	// Calculate the G-value for this node

    92

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

    93

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

    94

	if (new_g == AYSTAR_INVALID_NODE) return AYSTAR_DONE;

    95

    96

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

    97

	assert(new_g >= 0);

    98

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

    99

	new_g += parent->g;

   100

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

   101

   102

	// Calculate the h-value

   103

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

   104

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

   105

	assert(new_h >= 0);

   106

   107

	// The f-value if g + h

   108

	new_f = new_g + new_h;

   109

   110

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

   111

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

   112

   113

	// Check if this item is already in the OpenList

   114

	if ((check = AyStarMain_OpenList_IsInList(aystar, current)) != NULL) {

   115

		uint i;

   116

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

   117

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

   118

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

   119

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

   120

		check->g = new_g;

   121

		check->path.parent = closedlist_parent;

   122

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

   123

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

   124

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

   125

		// Readd him in the OpenListQueue

   126

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

   127

	} else {

   128

		// A new node, add him to the OpenList

   129

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

   130

	}

   131

   132

	return AYSTAR_DONE;

   133

}

   134

   135

/*

   136

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

   137

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

   138

 *  return values:

   139

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

   140

 *	has been found.

   141

 *	AYSTAR_LIMIT_REACHED : Indicates that the max_nodes limit has been

   142

 *	reached.

   143

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

   144

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

   145

 */

   146

int AyStarMain_Loop(AyStar *aystar) {

   147

	int i, r;

   148

   149

	// Get the best node from OpenList

   150

	OpenListNode *current = AyStarMain_OpenList_Pop(aystar);

   151

	// If empty, drop an error

   152

	if (current == NULL) {

   153

		return AYSTAR_EMPTY_OPENLIST;

   154

	}

   155

   156

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

   157

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

   158

		if (aystar->FoundEndNode != NULL)

   159

			aystar->FoundEndNode(aystar, current);

   160

		free(current);

   161

		return AYSTAR_FOUND_END_NODE;

   162

	}

   163

   164

	// Add the node to the ClosedList

   165

	AyStarMain_ClosedList_Add(aystar, &current->path);

   166

   167

	// Load the neighbours

   168

	aystar->GetNeighbours(aystar, current);

   169

   170

	// Go through all neighbours

   171

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

   172

		// Check and add them to the OpenList if needed

   173

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

   174

	}

   175

   176

	// Free the node

   177

	free(current);

   178

   179

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

   180

		/* We've expanded enough nodes */

   181

		return AYSTAR_LIMIT_REACHED;

   182

	} else {

   183

		// Return that we are still busy

   184

		return AYSTAR_STILL_BUSY;

   185

	}

   186

}

   187

   188

/*

   189

 * This function frees the memory it allocated

   190

 */

   191

void AyStarMain_Free(AyStar *aystar) {

   192

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

   193

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

   194

	 * once */

   195

	delete_Hash(&aystar->OpenListHash, true);

   196

	delete_Hash(&aystar->ClosedListHash, true);

   197

#ifdef AYSTAR_DEBUG

   198

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

   199

#endif

   200

}

   201

   202

/*

   203

 * This function make the memory go back to zero

   204

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

   205

 */

   206

void AyStarMain_Clear(AyStar *aystar) {

   207

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

   208

	// the hash.

   209

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

   210

	// Clean the hashes

   211

	clear_Hash(&aystar->OpenListHash, true);

   212

	clear_Hash(&aystar->ClosedListHash, true);

   213

   214

#ifdef AYSTAR_DEBUG

   215

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

   216

#endif

   217

}

   218

   219

/*

   220

 * This is the function you call to run AyStar.

   221

 *  return values:

   222

 *	AYSTAR_FOUND_END_NODE : indicates we found an end node.

   223

 *	AYSTAR_NO_PATH : indicates that there was no path found.

   224

 *	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.

   225

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

   226

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

   227

 * you should still call clear() yourself!

   228

 */

   229

int AyStarMain_Main(AyStar *aystar) {

   230

	int r, i = 0;

   231

	// Loop through the OpenList

   232

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

   233

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

   234

#ifdef AYSTAR_DEBUG

   235

	if (r == AYSTAR_FOUND_END_NODE)

   236

		printf("[AyStar] Found path!\n");

   237

	else if (r == AYSTAR_EMPTY_OPENLIST)

   238

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

   239

	else if (r == AYSTAR_LIMIT_REACHED)

   240

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

   241

#endif

   242

	if (r != AYSTAR_STILL_BUSY) {

   243

		/* We're done, clean up */

   244

		_aystar_stats_open_size = aystar->OpenListHash.size;

   245

		_aystar_stats_closed_size = aystar->ClosedListHash.size;

   246

		aystar->clear(aystar);

   247

	}

   248

   249

	// Check result-value

   250

	if (r == AYSTAR_FOUND_END_NODE) return AYSTAR_FOUND_END_NODE;

   251

	// Check if we have some left in the OpenList

   252

	if (r == AYSTAR_EMPTY_OPENLIST || r == AYSTAR_LIMIT_REACHED) return AYSTAR_NO_PATH;

   253

   254

	// Return we are still busy

   255

	return AYSTAR_STILL_BUSY;

   256

}

   257

   258

/*

   259

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

   260

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

   261

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

   262

 * clear() automatically when the algorithm finishes

   263

 * g is the cost for starting with this node.

   264

 */

   265

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

   266

#ifdef AYSTAR_DEBUG

   267

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

   268

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

   269

#endif

   270

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

   271

}

   272

   273

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

   274

	// Allocated the Hash for the OpenList and ClosedList

   275

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

   276

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

   277

   278

	// Set up our sorting queue

   279

	//  BinaryHeap allocates a block of 1024 nodes

   280

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

   281

	//  That is why it can stay this high

   282

	init_BinaryHeap(&aystar->OpenListQueue, 102400);

   283

   284

	aystar->addstart	= AyStarMain_AddStartNode;

   285

	aystar->main		= AyStarMain_Main;

   286

	aystar->loop		= AyStarMain_Loop;

   287

	aystar->free		= AyStarMain_Free;

   288

	aystar->clear		= AyStarMain_Clear;

   289

	aystar->checktile	= AyStarMain_CheckTile;

   290

}