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_industry.hpp"

    28

#include "api/ai_map.hpp"

    29

#include "api/ai_town.hpp"

    30

#undef DEFINE_SQUIRREL_CLASS

    31

    32

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

    33

    34

/**

    35

 * Our tiny wrapper between C++ and Squirrel.

    36

 */

    37

class AIFactorySquirrel: public AIFactoryBase {

    38

public:

    39

	Squirrel *engine;

    40

	HSQOBJECT SQ_instance;

    41

	char *script_name;

    42

    43

	~AIFactorySquirrel();

    44

    45

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

    46

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

    47

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

    48

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

    49

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

    50

	/* virtual */ AIController *CreateInstance();

    51

    52

	/**

    53

	 * Register Squirrel script to the Factory.

    54

	 */

    55

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

    56

    57

	/**

    58

	 * Check if a method exists in the script.

    59

	 */

    60

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

    61

};

    62

    63

AIFactorySquirrel::~AIFactorySquirrel()

    64

{

    65

	free(this->script_name);

    66

}

    67

    68

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

    69

{

    70

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

    71

		char error[1024];

    72

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

    73

		fbase->engine->ThrowError(error);

    74

		*res = SQ_ERROR;

    75

	}

    76

}

    77

    78

SQInteger FSquirrel::FactoryConstructor(HSQUIRRELVM vm)

    79

{

    80

	AIFactorySquirrel *fbase = new AIFactorySquirrel();

    81

	SQInteger res = 0;

    82

    83

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

    84

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

    85

    86

	/* Check if all needed fields are there */

    87

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

    88

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

    89

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

    90

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

    91

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

    92

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

    93

    94

	/* Abort if one method was missing */

    95

	if (res != 0) return res;

    96

    97

	fbase->RegisterSquirrel();

    98

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

    99

   100

	return 0;

   101

}

   102

   103

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

   104

extern bool FiosIsHiddenFile(const struct dirent *ent);

   105

   106

   107

void FSquirrel::ScanDir(const char *dirname)

   108

{

   109

	struct stat sb;

   110

	struct dirent *dirent;

   111

	DIR *dir;

   112

	char d_name[256];

   113

	char script_name[256];

   114

	dir = ttd_opendir(dirname);

   115

	/* Dir not found, so do nothing */

   116

	if (dir == NULL) return;

   117

   118

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

   119

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

   120

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

   121

   122

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

   123

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

   124

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

   125

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

   126

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

   127

			strcpy(script_name, dirname);

   128

			strcat(script_name, PATHSEP);

   129

			strcat(script_name, d_name);

   130

			strcat(script_name, PATHSEP);

   131

			strcat(script_name, "main.nut");

   132

			/* If it exists, load it up */

   133

			if (FileExists(script_name)) {

   134

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

   135

				this->current_script = script_name;

   136

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

   137

			}

   138

		}

   139

	}

   140

	closedir(dir);

   141

}

   142

   143

void FSquirrel::Initializer()

   144

{

   145

	this->engine = new Squirrel();

   146

   147

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

   148

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

   149

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

   150

	this->engine->AddClassEnd();

   151

   152

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

   153

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

   154

	this->engine->AddClassEnd();

   155

	/* Mark this class as global pointer */

   156

	this->engine->SetGlobalPointer(this);

   157

   158

	/* Scan the AI dir for scripts */

   159

	this->ScanDir("ai");

   160

}

   161

   162

FSquirrel::~FSquirrel()

   163

{

   164

	delete this->engine;

   165

}

   166

   167

AIController *AIFactorySquirrel::CreateInstance()

   168

{

   169

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

   170

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

   171

   172

	return controller;

   173

}

   174

   175

void AIControllerSquirrel::RegisterClasses()

   176

{

   177

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

   178

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

   179

	this->engine->AddClassEnd();

   180

   181

	/* Register all classes */

   182

	SQAIBaseRegister(this->engine);

   183

	SQAICargoRegister(this->engine);

   184

	SQAICompanyRegister(this->engine);

   185

	SQAIControllerRegister(this->engine);

   186

	SQAIIndustryRegister(this->engine);

   187

	SQAIMapRegister(this->engine);

   188

	SQAITownRegister(this->engine);

   189

   190

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

   191

}

   192

   193

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

   194

{

   195

	this->engine = new Squirrel();

   196

	this->RegisterClasses();

   197

	this->engine->LoadScript(script);

   198

	/* Create the main-class */

   199

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

   200

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

   201

}

   202

   203

AIControllerSquirrel::~AIControllerSquirrel()

   204

{

   205

	delete this->engine;

   206

}

   207

   209

{

   211

}