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 "api/ai_controller.hpp"

    18

#include "ai_factory.hpp"

    19

#include "ai_squirrel.hpp"

    20

    21

/* Convert all AI related classes to Squirrel data */

    22

#define DEFINE_SQUIRREL_CLASS

    23

#include "api/ai_base.hpp"

    24

#include "api/ai_cargo.hpp"

    25

#include "api/ai_controller.hpp"

    26

#include "api/ai_company.hpp"

    27

#include "api/ai_execmode.hpp"

    28

#include "api/ai_industry.hpp"

    29

#include "api/ai_map.hpp"

    30

#include "api/ai_settings.hpp"

    31

#include "api/ai_testmode.hpp"

    32

#include "api/ai_town.hpp"

    34

#undef DEFINE_SQUIRREL_CLASS

    35

    36

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

    37

    38

/**

    39

 * Our tiny wrapper between C++ and Squirrel.

    40

 */

    41

class AIFactorySquirrel: public AIFactoryBase {

    42

public:

    43

	Squirrel *engine;

    44

	HSQOBJECT SQ_instance;

    45

	char *script_name;

    46

    47

	~AIFactorySquirrel();

    48

    49

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

    50

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

    51

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

    52

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

    53

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

    54

	/* virtual */ AIController *CreateInstance();

    55

    56

	/**

    57

	 * Register Squirrel script to the Factory.

    58

	 */

    59

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

    60

    61

	/**

    62

	 * Check if a method exists in the script.

    63

	 */

    64

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

    65

};

    66

    67

AIFactorySquirrel::~AIFactorySquirrel()

    68

{

    69

	free(this->script_name);

    70

}

    71

    72

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

    73

{

    74

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

    75

		char error[1024];

    76

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

    77

		fbase->engine->ThrowError(error);

    78

		*res = SQ_ERROR;

    79

	}

    80

}

    81

    82

SQInteger FSquirrel::FactoryConstructor(HSQUIRRELVM vm)

    83

{

    84

	AIFactorySquirrel *fbase = new AIFactorySquirrel();

    85

	SQInteger res = 0;

    86

    87

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

    88

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

    89

    90

	/* Check if all needed fields are there */

    91

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

    92

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

    93

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

    94

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

    95

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

    96

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

    97

    98

	/* Abort if one method was missing */

    99

	if (res != 0) return res;

   100

   101

	fbase->RegisterSquirrel();

   102

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

   103

   104

	return 0;

   105

}

   106

   107

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

   108

extern bool FiosIsHiddenFile(const struct dirent *ent);

   109

   110

   111

void FSquirrel::ScanDir(const char *dirname)

   112

{

   113

	struct stat sb;

   114

	struct dirent *dirent;

   115

	DIR *dir;

   116

	char d_name[256];

   117

	char script_name[256];

   118

	dir = ttd_opendir(dirname);

   119

	/* Dir not found, so do nothing */

   120

	if (dir == NULL) return;

   121

   122

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

   123

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

   124

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

   125

   126

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

   127

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

   128

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

   129

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

   130

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

   131

			strcpy(script_name, dirname);

   132

			strcat(script_name, PATHSEP);

   133

			strcat(script_name, d_name);

   134

			strcat(script_name, PATHSEP);

   135

			strcat(script_name, "main.nut");

   136

			/* If it exists, load it up */

   137

			if (FileExists(script_name)) {

   138

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

   139

				this->current_script = script_name;

   140

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

   141

			}

   142

		}

   143

	}

   144

	closedir(dir);

   145

}

   146

   147

void FSquirrel::Initializer()

   148

{

   149

	this->engine = new Squirrel();

   150

   151

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

   152

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

   153

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

   154

	this->engine->AddClassEnd();

   155

   156

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

   157

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

   158

	this->engine->AddClassEnd();

   159

	/* Mark this class as global pointer */

   160

	this->engine->SetGlobalPointer(this);

   161

   162

	/* Scan the AI dir for scripts */

   163

	this->ScanDir("ai");

   164

}

   165

   166

FSquirrel::~FSquirrel()

   167

{

   168

	delete this->engine;

   169

}

   170

   171

AIController *AIFactorySquirrel::CreateInstance()

   172

{

   173

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

   174

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

   175

   176

	return controller;

   177

}

   178

   179

void AIControllerSquirrel::RegisterClasses()

   180

{

   181

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

   182

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

   183

	this->engine->AddClassEnd();

   184

   185

	/* Register all classes */

   186

	SQAIBaseRegister(this->engine);

   187

	SQAICargoRegister(this->engine);

   188

	SQAICompanyRegister(this->engine);

   189

	SQAIControllerRegister(this->engine);

   190

	SQAIExecModeRegister(this->engine);

   191

	SQAIIndustryRegister(this->engine);

   192

	SQAIMapRegister(this->engine);

   193

	SQAISettingsRegister(this->engine);

   194

	SQAITestModeRegister(this->engine);

   195

	SQAITownRegister(this->engine);

   197

   198

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

   199

}

   200

   201

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

   202

{

   203

	this->engine = new Squirrel();

   204

	this->RegisterClasses();

   205

	this->engine->LoadScript(script);

   206

	/* Create the main-class */

   207

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

   208

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

   209

}

   210

   211

AIControllerSquirrel::~AIControllerSquirrel()

   212

{

   213

	delete this->engine;

   214

}

   215

   216

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

   217

{

   218

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

   219

}

   220

   221

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

   222

{

   223

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

   224

}