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_func.h"

     9

#include "../fileio.h"

    10

#include "../fios.h"

    11

#include "table/strings.h"

    12

#include <sys/types.h>

    13

#include <sys/stat.h>

    14

    15

#include <squirrel.h>

    16

#include "../squirrel.hpp"

    17

#include "../squirrel_helper.hpp"

    18

#include "../squirrel_class.hpp"

    19

#include "../squirrel_std.hpp"

    20

#include "api/ai_controller.hpp"

    21

#include "ai_factory.hpp"

    22

#include "ai_squirrel.hpp"

    23

    24

/* Convert all AI related classes to Squirrel data.

    25

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

    26

#include "api/ai_abstractlist.hpp.sq"

    27

#include "api/ai_accounting.hpp.sq"

    28

#include "api/ai_airport.hpp.sq"

    29

#include "api/ai_base.hpp.sq"

    30

#include "api/ai_bridge.hpp.sq"

    31

#include "api/ai_bridgelist.hpp.sq"

    32

#include "api/ai_cargo.hpp.sq"

    33

#include "api/ai_cargolist.hpp.sq"

    34

#include "api/ai_company.hpp.sq"

    35

#include "api/ai_controller.hpp.sq"

    36

#include "api/ai_date.hpp.sq"

    37

#include "api/ai_engine.hpp.sq"

    38

#include "api/ai_enginelist.hpp.sq"

    39

#include "api/ai_error.hpp.sq"

    40

#include "api/ai_event.hpp.sq"

    41

#include "api/ai_event_types.hpp.sq"

    42

#include "api/ai_execmode.hpp.sq"

    43

#include "api/ai_industry.hpp.sq"

    44

#include "api/ai_industrylist.hpp.sq"

    45

#include "api/ai_list.hpp.sq"

    46

#include "api/ai_log.hpp.sq"

    47

#include "api/ai_map.hpp.sq"

    48

#include "api/ai_marine.hpp.sq"

    49

#include "api/ai_order.hpp.sq"

    50

#include "api/ai_road.hpp.sq"

    51

#include "api/ai_settings.hpp.sq"

    52

#include "api/ai_sign.hpp.sq"

    53

#include "api/ai_station.hpp.sq"

    54

#include "api/ai_stationlist.hpp.sq"

    55

#include "api/ai_subsidy.hpp.sq"

    56

#include "api/ai_subsidylist.hpp.sq"

    57

#include "api/ai_testmode.hpp.sq"

    58

#include "api/ai_tile.hpp.sq"

    59

#include "api/ai_tilelist.hpp.sq"

    60

#include "api/ai_town.hpp.sq"

    61

#include "api/ai_townlist.hpp.sq"

    62

#include "api/ai_transactionmode.hpp.sq"

    63

#include "api/ai_tunnel.hpp.sq"

    64

#include "api/ai_vehicle.hpp.sq"

    65

#include "api/ai_vehiclelist.hpp.sq"

    66

    67

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

    68

    69

/**

    70

 * Our tiny wrapper between C++ and Squirrel.

    71

 */

    72

class AIFactorySquirrel: public AIFactoryBase {

    73

public:

    74

	Squirrel *engine;

    75

	HSQOBJECT SQ_instance;

    76

	char *script_name;

    77

    78

	~AIFactorySquirrel();

    79

    80

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

    81

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

    82

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

    83

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

    84

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

    85

	/* virtual */ AIController *CreateInstance();

    86

    87

	/**

    88

	 * Register Squirrel script to the Factory.

    89

	 */

    90

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

    91

    92

	/**

    93

	 * Check if a method exists in the script.

    94

	 */

    95

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

    96

};

    97

    98

AIFactorySquirrel::~AIFactorySquirrel()

    99

{

   100

	free(this->script_name);

   101

}

   102

   103

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

   104

{

   105

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

   106

		char error[1024];

   107

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

   108

		fbase->engine->ThrowError(error);

   109

		*res = SQ_ERROR;

   110

	}

   111

}

   112

   113

SQInteger FSquirrel::FactoryConstructor(HSQUIRRELVM vm)

   114

{

   115

	AIFactorySquirrel *fbase = new AIFactorySquirrel();

   116

	SQInteger res = 0;

   117

   118

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

   119

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

   120

   121

	/* Check if all needed fields are there */

   122

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

   123

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

   124

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

   125

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

   126

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

   127

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

   128

   129

	/* Abort if one method was missing */

   130

	if (res != 0) return res;

   131

   132

	fbase->RegisterSquirrel();

   133

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

   134

   135

	return 0;

   136

}

   137

   138

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

   139

extern bool FiosIsHiddenFile(const struct dirent *ent);

   140

   141

   142

void FSquirrel::ScanDir(const char *dirname)

   143

{

   144

	struct stat sb;

   145

	struct dirent *dirent;

   146

	DIR *dir;

   147

	char d_name[MAX_PATH];

   148

	char script_name[MAX_PATH];

   149

	dir = ttd_opendir(dirname);

   150

	/* Dir not found, so do nothing */

   151

	if (dir == NULL) return;

   152

   153

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

   154

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

   155

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

   156

   157

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

   158

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

   159

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

   160

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

   161

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

   162

			ttd_strlcpy(script_name, dirname, sizeof(script_name));

   163

			ttd_strlcat(script_name, PATHSEP, sizeof(script_name));

   164

			ttd_strlcat(script_name, d_name, sizeof(script_name));

   165

			ttd_strlcat(script_name, PATHSEP, sizeof(script_name));

   166

			ttd_strlcat(script_name, "main.nut", sizeof(script_name));

   167

			/* If it exists, load it up */

   168

			if (FileExists(script_name)) {

   169

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

   170

				this->current_script = script_name;

   171

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

   172

			}

   173

		}

   174

	}

   175

	closedir(dir);

   176

}

   177

   178

void FSquirrel::Initializer()

   179

{

   180

	this->engine = new Squirrel();

   181

   182

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

   183

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

   184

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

   185

	this->engine->AddClassEnd();

   186

   187

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

   188

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

   189

	this->engine->AddClassEnd();

   190

	/* Mark this class as global pointer */

   191

	this->engine->SetGlobalPointer(this);

   192

   193

	/* Scan the AI dir for scripts */

   194

	this->ScanDir("ai");

   195

}

   196

   197

FSquirrel::~FSquirrel()

   198

{

   199

	delete this->engine;

   200

}

   201

   202

AIController *AIFactorySquirrel::CreateInstance()

   203

{

   204

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

   205

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

   206

   207

	return controller;

   208

}

   209

   210

void AIControllerSquirrel::RegisterClasses()

   211

{

   212

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

   213

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

   214

	this->engine->AddClassEnd();

   215

   216

	/* Register all classes */

   217

	squirrel_register_std(this->engine);

   218

	SQAIAbstractList_Register(this->engine);

   219

	SQAIAccounting_Register(this->engine);

   220

	SQAIAirport_Register(this->engine);

   221

	SQAIBase_Register(this->engine);

   222

	SQAIBridge_Register(this->engine);

   223

	SQAIBridgeList_Register(this->engine);

   224

	SQAIBridgeList_Length_Register(this->engine);

   225

	SQAICargo_Register(this->engine);

   226

	SQAICargoList_Register(this->engine);

   227

	SQAICompany_Register(this->engine);

   228

	SQAIController_Register(this->engine);

   229

	SQAIDate_Register(this->engine);

   230

	SQAIEngine_Register(this->engine);

   231

	SQAIEngineList_Register(this->engine);

   232

	SQAIError_Register(this->engine);

   233

	SQAIEvent_Register(this->engine);

   238

	SQAIEventController_Register(this->engine);

   239

	SQAIEventEnginePreview_Register(this->engine);

   240

	SQAIEventSubsidyAwarded_Register(this->engine);

   241

	SQAIEventSubsidyExpired_Register(this->engine);

   242

	SQAIEventSubsidyOffer_Register(this->engine);

   243

	SQAIEventSubsidyOfferExpired_Register(this->engine);

   244

	SQAIEventTest_Register(this->engine);

   245

	SQAIEventVehicleCrash_Register(this->engine);

   246

	SQAIExecMode_Register(this->engine);

   247

	SQAIIndustry_Register(this->engine);

   248

	SQAIIndustryList_Register(this->engine);

   249

	SQAIIndustryList_CargoAccepting_Register(this->engine);

   250

	SQAIIndustryList_CargoProducing_Register(this->engine);

   251

	SQAIList_Register(this->engine);

   252

	SQAILog_Register(this->engine);

   253

	SQAIMap_Register(this->engine);

   254

	SQAIMarine_Register(this->engine);

   255

	SQAIOrder_Register(this->engine);

   256

	SQAIRoad_Register(this->engine);

   257

	SQAISettings_Register(this->engine);

   258

	SQAISign_Register(this->engine);

   259

	SQAIStation_Register(this->engine);

   260

	SQAIStationList_Register(this->engine);

   261

	SQAIStationList_Vehicle_Register(this->engine);

   262

	SQAISubsidy_Register(this->engine);

   263

	SQAISubsidyList_Register(this->engine);

   264

	SQAITestMode_Register(this->engine);

   265

	SQAITile_Register(this->engine);

   266

	SQAITileList_Register(this->engine);

   267

	SQAITileList_IndustryAccepting_Register(this->engine);

   268

	SQAITileList_IndustryProducing_Register(this->engine);

   269

	SQAITown_Register(this->engine);

   270

	SQAITownList_Register(this->engine);

   271

	SQAITransactionMode_Register(this->engine);

   272

	SQAITunnel_Register(this->engine);

   273

	SQAIVehicle_Register(this->engine);

   274

	SQAIVehicleList_Register(this->engine);

   275

	SQAIVehicleList_Station_Register(this->engine);

   276

   277

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

   278

}

   279

   280

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

   281

{

   282

	this->engine = new Squirrel();

   283

	this->engine->SetPrintFunction(&AIControllerSquirrel::PrintFunc);

   284

	this->RegisterClasses();

   285

	this->engine->LoadScript(script);

   286

	/* Create the main-class */

   287

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

   288

	if (this->engine->MethodExists(this->SQ_instance, "constructor"))

   289

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

   290

}

   291

   292

AIControllerSquirrel::~AIControllerSquirrel()

   293

{

   294

	delete this->engine;

   295

}

   296

   297

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

   298

{

   299

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

   300

}

   301

   302

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

   303

{

   304

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

   305

}