1

/* $Id$ */

     2

     3

/** @file squirrel.cpp allows loading squirrel scripts to control an AI */

     4

     5

#include "../stdafx.h"

     6

#include "../debug.h"

     7

#include "../openttd.h"

     8

#include "../string.h"

     9

#include "../fios.h"

    10

#include <sys/types.h>

    11

#include <sys/stat.h>

    12

    13

#include <squirrel.h>

    14

#include "../squirrel.hpp"

    15

#include "../squirrel_helper.hpp"

    16

#include "../squirrel_class.hpp"

    17

#include "../squirrel_std.hpp"

    18

#include "api/ai_controller.hpp"

    19

#include "ai_factory.hpp"

    20

#include "ai_squirrel.hpp"

    21

    22

/* Convert all AI related classes to Squirrel data.

    23

 * Note: this line a marker in squirrel_export.sh. Do not change! */

    24

#include "api/ai_abstractlist.hpp.sq"

    25

#include "api/ai_accounting.hpp.sq"

    26

#include "api/ai_airport.hpp.sq"

    27

#include "api/ai_base.hpp.sq"

    28

#include "api/ai_cargo.hpp.sq"

    29

#include "api/ai_company.hpp.sq"

    30

#include "api/ai_controller.hpp.sq"

    31

#include "api/ai_event.hpp.sq"

    32

#include "api/ai_event_types.hpp.sq"

    33

#include "api/ai_execmode.hpp.sq"

    34

#include "api/ai_industry.hpp.sq"

    35

#include "api/ai_industrylist.hpp.sq"

    36

#include "api/ai_industrylist_valuator.hpp.sq"

    37

#include "api/ai_list.hpp.sq"

    38

#include "api/ai_list_valuator.hpp.sq"

    39

#include "api/ai_map.hpp.sq"

    40

#include "api/ai_marine.hpp.sq"

    41

#include "api/ai_order.hpp.sq"

    42

#include "api/ai_pathfinder.hpp.sq"

    43

#include "api/ai_pathfinder_stupid.hpp.sq"

    44

#include "api/ai_road.hpp.sq"

    45

#include "api/ai_settings.hpp.sq"

    46

#include "api/ai_sign.hpp.sq"

    47

#include "api/ai_station.hpp.sq"

    48

#include "api/ai_stationlist.hpp.sq"

    49

#include "api/ai_stationlist_valuator.hpp.sq"

    50

#include "api/ai_testmode.hpp.sq"

    51

#include "api/ai_tile.hpp.sq"

    52

#include "api/ai_tilelist.hpp.sq"

    53

#include "api/ai_tilelist_valuator.hpp.sq"

    54

#include "api/ai_town.hpp.sq"

    55

#include "api/ai_townlist.hpp.sq"

    56

#include "api/ai_townlist_valuator.hpp.sq"

    57

#include "api/ai_transactionmode.hpp.sq"

    58

#include "api/ai_vehicle.hpp.sq"

    59

#include "api/ai_vehiclelist.hpp.sq"

    60

#include "api/ai_vehiclelist_valuator.hpp.sq"

    61

    62

static FSquirrel iFSquirrel; ///< Tell the AI-core that we have an AI with which we like to play.

    63

    64

/**

    65

 * Our tiny wrapper between C++ and Squirrel.

    66

 */

    67

class AIFactorySquirrel: public AIFactoryBase {

    68

public:

    69

	Squirrel *engine;

    70

	HSQOBJECT SQ_instance;

    71

	char *script_name;

    72

    73

	~AIFactorySquirrel();

    74

    75

	/* virtual */ const char   *GetAuthor()      { return this->engine->CallStringMethod (this->SQ_instance, "GetAuthor"); }

    76

	/* virtual */ const char   *GetName()        { return this->engine->CallStringMethod (this->SQ_instance, "GetName"); }

    77

	/* virtual */ const char   *GetDescription() { return this->engine->CallStringMethod (this->SQ_instance, "GetDescription"); }

    78

	/* virtual */ int           GetVersion()     { return this->engine->CallIntegerMethod(this->SQ_instance, "GetVersion"); }

    79

	/* virtual */ const char   *GetDate()        { return this->engine->CallStringMethod (this->SQ_instance, "GetDate"); }

    80

	/* virtual */ AIController *CreateInstance();

    81

    82

	/**

    83

	 * Register Squirrel script to the Factory.

    84

	 */

    85

	void RegisterSquirrel()        { this->RegisterFactory(this->GetName()); }

    86

    87

	/**

    88

	 * Check if a method exists in the script.

    89

	 */

    90

	void CheckMethods(AIFactorySquirrel *fbase, SQInteger *res, const char *name);

    91

};

    92

    93

AIFactorySquirrel::~AIFactorySquirrel()

    94

{

    95

	free(this->script_name);

    96

}

    97

    98

void AIFactorySquirrel::CheckMethods(AIFactorySquirrel *fbase, SQInteger *res, const char *name)

    99

{

   100

	if (!fbase->engine->MethodExists(fbase->SQ_instance, name)) {

   101

		char error[1024];

   102

		snprintf(error, sizeof(error), "Missing method '%s' for FactoryClass", name);

   103

		fbase->engine->ThrowError(error);

   104

		*res = SQ_ERROR;

   105

	}

   106

}

   107

   108

SQInteger FSquirrel::FactoryConstructor(HSQUIRRELVM vm)

   109

{

   110

	AIFactorySquirrel *fbase = new AIFactorySquirrel();

   111

	SQInteger res = 0;

   112

   113

	Squirrel::GetInstance(vm, &fbase->SQ_instance);

   114

	fbase->engine = ((FSquirrel *)Squirrel::GetGlobalPointer(vm))->engine;

   115

   116

	/* Check if all needed fields are there */

   117

	fbase->CheckMethods(fbase, &res, "GetAuthor");

   118

	fbase->CheckMethods(fbase, &res, "GetName");

   119

	fbase->CheckMethods(fbase, &res, "GetDescription");

   120

	fbase->CheckMethods(fbase, &res, "GetVersion");

   121

	fbase->CheckMethods(fbase, &res, "GetDate");

   122

	fbase->CheckMethods(fbase, &res, "CreateInstance");

   123

   124

	/* Abort if one method was missing */

   125

	if (res != 0) return res;

   126

   127

	fbase->RegisterSquirrel();

   128

	fbase->script_name = strdup(((FSquirrel *)Squirrel::GetGlobalPointer(vm))->current_script);

   129

   130

	return 0;

   131

}

   132

   133

extern bool FiosIsValidFile(const char *path, const struct dirent *ent, struct stat *sb);

   134

extern bool FiosIsHiddenFile(const struct dirent *ent);

   135

   136

   137

void FSquirrel::ScanDir(const char *dirname)

   138

{

   139

	struct stat sb;

   140

	struct dirent *dirent;

   141

	DIR *dir;

   142

	char d_name[256];

   143

	char script_name[256];

   144

	dir = ttd_opendir(dirname);

   145

	/* Dir not found, so do nothing */

   146

	if (dir == NULL) return;

   147

   148

	/* Walk all dirs trying to find a dir in which 'main.nut' exists */

   149

	while ((dirent = readdir(dir)) != NULL) {

   150

		ttd_strlcpy(d_name, FS2OTTD(dirent->d_name), sizeof(d_name));

   151

   152

		/* Found file must be directory, but not '.' or '..' */

   153

		if (FiosIsValidFile("ai/", dirent, &sb) && (sb.st_mode & S_IFDIR) &&

   154

				(!FiosIsHiddenFile(dirent) || strncasecmp(d_name, PERSONAL_DIR, strlen(d_name)) == 0) &&

   155

				strcmp(d_name, ".") != 0 && strcmp(d_name, "..") != 0) {

   156

			/* Create the full-length script-name */

   157

			strcpy(script_name, dirname);

   158

			strcat(script_name, PATHSEP);

   159

			strcat(script_name, d_name);

   160

			strcat(script_name, PATHSEP);

   161

			strcat(script_name, "main.nut");

   162

			/* If it exists, load it up */

   163

			if (FileExists(script_name)) {

   164

				DEBUG(ai, 6, "[squirrel] Loading script '%s' for AI handling", script_name);

   165

				this->current_script = script_name;

   166

				this->engine->LoadScript(this->current_script);

   167

			}

   168

		}

   169

	}

   170

	closedir(dir);

   171

}

   172

   173

void FSquirrel::Initializer()

   174

{

   175

	this->engine = new Squirrel();

   176

   177

	/* Create the AIFactory class, and bind the constructor */

   178

	this->engine->AddClassBegin("AIFactory");

   179

	this->engine->AddMethod("constructor", &FSquirrel::FactoryConstructor, 1, "x");

   180

	this->engine->AddClassEnd();

   181

   182

	/* Set a dummy AIController, so script can load */

   183

	this->engine->AddClassBegin("AIController");

   184

	this->engine->AddClassEnd();

   185

	/* Mark this class as global pointer */

   186

	this->engine->SetGlobalPointer(this);

   187

   188

	/* Scan the AI dir for scripts */

   189

	this->ScanDir("ai");

   190

}

   191

   192

FSquirrel::~FSquirrel()

   193

{

   194

	delete this->engine;

   195

}

   196

   197

AIController *AIFactorySquirrel::CreateInstance()

   198

{

   199

	const char *class_name = this->engine->CallStringMethod(this->SQ_instance, "CreateInstance");

   200

	AIControllerSquirrel *controller = new AIControllerSquirrel(this->script_name, class_name);

   201

   202

	return controller;

   203

}

   204

   205

void AIControllerSquirrel::RegisterClasses()

   206

{

   207

	/* Ignore AIFactory if we are really starting an AI */

   208

	this->engine->AddClassBegin("AIFactory");

   209

	this->engine->AddClassEnd();

   210

   211

	/* Register all classes */

   212

	squirrel_register_std(this->engine);

   213

	SQAIAbstractListRegister(this->engine);

   214

	SQAIAccountingRegister(this->engine);

   215

	SQAIAirportRegister(this->engine);

   216

	SQAIBaseRegister(this->engine);

   217

	SQAICargoRegister(this->engine);

   218

	SQAICompanyRegister(this->engine);

   219

	SQAIControllerRegister(this->engine);

   220

	SQAIEventControllerRegister(this->engine);

   221

	SQAIEventRegister(this->engine);

   222

	SQAIEventTestRegister(this->engine);

   223

	SQAIEventVehicleCrashRegister(this->engine);

   224

	SQAIExecModeRegister(this->engine);

   226

	SQAIIndustryListDistanceManhattanToTileRegister(this->engine);

   227

	SQAIIndustryListDistanceSquareToTileRegister(this->engine);

   228

	SQAIIndustryListLocationRegister(this->engine);

   229

	SQAIIndustryListProductionRegister(this->engine);

   230

	SQAIIndustryListRegister(this->engine);

   231

	SQAIIndustryRegister(this->engine);

   232

	SQAIListRandomizeRegister(this->engine);

   233

	SQAIListRegister(this->engine);

   234

	SQAIMapRegister(this->engine);

   235

	SQAIMarineRegister(this->engine);

   236

	SQAIOrderRegister(this->engine);

   237

	SQAIPathFinderRegister(this->engine);

   238

	SQAIPathFinderStupidRegister(this->engine);

   239

	SQAIRoadRegister(this->engine);

   240

	SQAISettingsRegister(this->engine);

   241

	SQAISignRegister(this->engine);

   242

	SQAIStationListCargoRatingRegister(this->engine);

   243

	SQAIStationListCargoWaitingRegister(this->engine);

   244

	SQAIStationListDistanceManhattanToTileRegister(this->engine);

   245

	SQAIStationListDistanceSquareToTileRegister(this->engine);

   246

	SQAIStationListLocationRegister(this->engine);

   247

	SQAIStationListRegister(this->engine);

   248

	SQAIStationRegister(this->engine);

   249

	SQAIStationVehicleListRegister(this->engine);

   250

	SQAITestModeRegister(this->engine);

   251

	SQAITileListBuildableRectangleRegister(this->engine);

   252

	SQAITileListBuildableRegister(this->engine);

   253

	SQAITileListCargoAcceptanceRegister(this->engine);

   254

	SQAITileListDistanceManhattanToTileRegister(this->engine);

   255

	SQAITileListDistanceSquareToTileRegister(this->engine);

   256

	SQAITileListHeightRegister(this->engine);

   257

	SQAITileListNeighbourRoadCountRegister(this->engine);

   258

	SQAITileListRegister(this->engine);

   259

	SQAITileListRoadTileRegister(this->engine);

   260

	SQAITileListSlopeRegister(this->engine);

   261

	SQAITileListWaterRegister(this->engine);

   262

	SQAITileRegister(this->engine);

   263

	SQAITownListDistanceManhattanToTileRegister(this->engine);

   264

	SQAITownListDistanceSquareToTileRegister(this->engine);

   265

	SQAITownListLocationRegister(this->engine);

   266

	SQAITownListPopulationRegister(this->engine);

   267

	SQAITownListRandomizeRegister(this->engine);

   268

	SQAITownListRegister(this->engine);

   269

	SQAITownRegister(this->engine);

   270

	SQAITransactionModeRegister(this->engine);

   271

	SQAIVehicleListAgeLeftRegister(this->engine);

   272

	SQAIVehicleListAgeRegister(this->engine);

   273

	SQAIVehicleListEngineTypeRegister(this->engine);

   274

	SQAIVehicleListLocationRegister(this->engine);

   275

	SQAIVehicleListMaxAgeRegister(this->engine);

   276

	SQAIVehicleListProfitLastYearRegister(this->engine);

   277

	SQAIVehicleListProfitThisYearRegister(this->engine);

   278

	SQAIVehicleListRegister(this->engine);

   279

	SQAIVehicleListUnitNumberRegister(this->engine);

   280

	SQAIVehicleListVehicleTypeRegister(this->engine);

   281

	SQAIVehicleRegister(this->engine);

   282

	SQAIVehicleStationListRegister(this->engine);

   283

   284

	this->engine->SetGlobalPointer(this->engine);

   285

}

   286

   287

AIControllerSquirrel::AIControllerSquirrel(const char *script, const char *class_name)

   288

{

   289

	this->engine = new Squirrel();

   290

	this->RegisterClasses();

   291

	this->engine->LoadScript(script);

   292

	/* Create the main-class */

   293

	this->engine->CreateClassInstance(class_name, this, &this->SQ_instance);

   294

	this->engine->CallMethod(this->SQ_instance, "constructor");

   295

}

   296

   297

AIControllerSquirrel::~AIControllerSquirrel()

   298

{

   299

	delete this->engine;

   300

}

   301

   302

/* virtual */ void AIControllerSquirrel::Start()

   303

{

   304

	this->engine->CallMethod(this->SQ_instance, "Start");

   305

}

   306

   307

/* virtual */ void AIControllerSquirrel::Stop()

   308

{

   309

	this->engine->CallMethod(this->SQ_instance, "Stop");

   310

}