1

/* $Id$ */

     2

     3

/** @file squirrel.cpp the implementation of the Squirrel class. It handles all Squirrel-stuff and gives a nice API back to work with. */

     4

     5

#include <squirrel.h>

     6

#include <stdarg.h>

     7

#include "stdafx.h"

     8

#include "debug.h"

     9

#include "squirrel.hpp"

    10

#include "squirrel_std.hpp"

    11

#include "fileio.h"

    12

#include <sqstdaux.h>

    13

    14

void Squirrel::CompileError(HSQUIRRELVM vm, const SQChar *desc, const SQChar *source, SQInteger line, SQInteger column)

    15

{

    16

	SQChar buf[1024];

    17

    18

#ifdef _SQ64

    19

	scsnprintf(buf, lengthof(buf), _SC("Error %s:%ld/%ld: %s"), source, line, column, desc);

    20

#else

    21

	scsnprintf(buf, lengthof(buf), _SC("Error %s:%d/%d: %s"), source, line, column, desc);

    22

#endif

    23

    24

	/* Check if we have a custom print function */

    25

	SQPrintFunc *func = ((Squirrel *)sq_getforeignptr(vm))->print_func;

    26

	if (func == NULL) {

    27

		scfprintf(stderr, _SC("%s"), buf);

    28

	} else {

    29

		(*func)(true, buf);

    30

	}

    31

}

    32

    33

void Squirrel::ErrorPrintFunc(HSQUIRRELVM vm, const SQChar *s, ...)

    34

{

    35

	va_list arglist;

    36

	SQChar buf[1024];

    37

    38

	va_start(arglist, s);

    39

	scvsnprintf(buf, lengthof(buf), s, arglist);

    40

	va_end(arglist);

    41

    42

	/* Check if we have a custom print function */

    43

	SQPrintFunc *func = ((Squirrel *)sq_getforeignptr(vm))->print_func;

    44

	if (func == NULL) {

    45

		scfprintf(stderr, _SC("%s"), buf);

    46

	} else {

    47

		(*func)(true, buf);

    48

	}

    49

}

    50

    51

void Squirrel::RunError(HSQUIRRELVM vm, const SQChar *error)

    52

{

    53

	/* Set the print function to something that prints to stderr */

    54

	SQPRINTFUNCTION pf = sq_getprintfunc(vm);

    55

	sq_setprintfunc(vm, &Squirrel::ErrorPrintFunc);

    56

    57

	/* Check if we have a custom print function */

    58

	SQChar buf[1024];

    59

	scsnprintf(buf, lengthof(buf), _SC("Your script made an error: %s\n"), error);

    60

	SQPrintFunc *func = ((Squirrel *)sq_getforeignptr(vm))->print_func;

    61

	if (func == NULL) {

    62

		scfprintf(stderr, _SC("%s"), buf);

    63

	} else {

    64

		(*func)(true, buf);

    65

	}

    66

    67

	/* Print below the error the stack, so the users knows what is happening */

    68

	sqstd_printcallstack(vm);

    69

	/* Reset the old print function */

    70

	sq_setprintfunc(vm, pf);

    71

}

    72

    73

SQInteger Squirrel::_RunError(HSQUIRRELVM vm)

    74

{

    75

	const SQChar *sErr = 0;

    76

    77

	if (sq_gettop(vm) >= 1) {

    78

		if (SQ_SUCCEEDED(sq_getstring(vm, -1, &sErr))) {

    79

			Squirrel::RunError(vm, sErr);

    80

			return 0;

    81

		}

    82

	}

    83

    84

	Squirrel::RunError(vm, _SC("unknown error"));

    85

	return 0;

    86

}

    87

    88

void Squirrel::PrintFunc(HSQUIRRELVM vm, const SQChar *s, ...)

    89

{

    90

	va_list arglist;

    91

	SQChar buf[1024];

    92

    93

	va_start(arglist, s);

    94

	scvsnprintf(buf, lengthof(buf) - 2, s, arglist);

    95

	va_end(arglist);

    96

	scstrcat(buf, _SC("\n"));

    97

    98

	/* Check if we have a custom print function */

    99

	SQPrintFunc *func = ((Squirrel *)sq_getforeignptr(vm))->print_func;

   100

	if (func == NULL) {

   101

		scprintf(_SC("%s"), buf);

   102

	} else {

   103

		(*func)(false, buf);

   104

	}

   105

}

   106

   107

void Squirrel::AddMethod(const char *method_name, SQFUNCTION proc, uint nparam, const char *params, void *userdata, int size)

   108

{

   109

	sq_pushstring(this->vm, OTTD2FS(method_name), -1);

   110

   111

	if (size != 0) {

   112

		void *ptr = sq_newuserdata(vm, size);

   113

		memcpy(ptr, userdata, size);

   114

	}

   115

   116

	sq_newclosure(this->vm, proc, size != 0 ? 1 : 0);

   117

	if (nparam != 0) sq_setparamscheck(this->vm, nparam, OTTD2FS(params));

   118

	sq_setnativeclosurename(this->vm, -1, OTTD2FS(method_name));

   119

	sq_newslot(this->vm, -3, SQFalse);

   120

}

   121

   122

void Squirrel::AddConst(const char *var_name, int value)

   123

{

   124

	sq_pushstring(this->vm, OTTD2FS(var_name), -1);

   125

	sq_pushinteger(this->vm, value);

   126

	sq_newslot(this->vm, -3, SQTrue);

   127

}

   128

   129

void Squirrel::AddClassBegin(const char *class_name)

   130

{

   131

	sq_pushroottable(this->vm);

   132

	sq_pushstring(this->vm, OTTD2FS(class_name), -1);

   133

	sq_newclass(this->vm, SQFalse);

   134

}

   135

   136

void Squirrel::AddClassBegin(const char *class_name, const char *parent_class)

   137

{

   138

	sq_pushroottable(this->vm);

   139

	sq_pushstring(this->vm, OTTD2FS(class_name), -1);

   140

	sq_pushstring(this->vm, OTTD2FS(parent_class), -1);

   141

	if (SQ_FAILED(sq_get(this->vm, -3))) {

   142

		DEBUG(misc, 0, "[squirrel] Failed to initialize class '%s' based on parent class '%s'", class_name, parent_class);

   143

		DEBUG(misc, 0, "[squirrel] Make sure that '%s' exists before trying to define '%s'", parent_class, class_name);

   144

		return;

   145

	}

   146

	sq_newclass(this->vm, SQTrue);

   147

}

   148

   149

void Squirrel::AddClassEnd()

   150

{

   151

	sq_newslot(vm, -3, SQFalse);

   152

	sq_pop(vm, 1);

   153

}

   154

   155

bool Squirrel::MethodExists(HSQOBJECT instance, const char *method_name)

   156

{

   157

	int top = sq_gettop(this->vm);

   158

	/* Go to the instance-root */

   159

	sq_pushobject(this->vm, instance);

   160

	/* Find the function-name inside the script */

   161

	sq_pushstring(this->vm, OTTD2FS(method_name), -1);

   162

	if (SQ_FAILED(sq_get(this->vm, -2))) {

   163

		sq_settop(this->vm, top);

   164

		return false;

   165

	}

   166

	sq_settop(this->vm, top);

   167

	return true;

   168

}

   169

   170

void Squirrel::CallMethod(HSQOBJECT instance, const char *method_name, HSQOBJECT *ret)

   171

{

   172

	/* Store the current top */

   173

	int top = sq_gettop(this->vm);

   174

	/* Go to the instance-root */

   175

	sq_pushobject(this->vm, instance);

   176

	/* Find the function-name inside the script */

   177

	sq_pushstring(this->vm, OTTD2FS(method_name), -1);

   178

	if (SQ_FAILED(sq_get(this->vm, -2))) {

   179

		DEBUG(misc, 0, "[squirrel] Could not find '%s' in the class", method_name);

   180

		sq_settop(this->vm, top);

   181

		return;

   182

	}

   183

	/* Call the method */

   184

	sq_pushobject(this->vm, instance);

   185

	sq_call(this->vm, 1, ret == NULL ? SQFalse : SQTrue, SQFalse);

   186

	if (ret != NULL) sq_getstackobj(vm, -1, ret);

   187

	/* Reset the top */

   188

	sq_settop(this->vm, top);

   189

}

   190

   191

/* static */ bool Squirrel::CreateClassInstanceVM(HSQUIRRELVM vm, const char *class_name, void *real_instance, HSQOBJECT *instance, SQRELEASEHOOK release_hook)

   192

{

   193

	int oldtop = sq_gettop(vm);

   194

   195

	/* First, find the class */

   196

	sq_pushroottable(vm);

   197

	sq_pushstring(vm, OTTD2FS(class_name), -1);

   198

	if (SQ_FAILED(sq_get(vm, -2))) {

   199

		DEBUG(misc, 0, "[squirrel] Failed to find class by the name '%s'", class_name);

   200

		sq_settop(vm, oldtop);

   201

		return false;

   202

	}

   203

   204

	/* Create the instance */

   205

	if (SQ_FAILED(sq_createinstance(vm, -1))) {

   206

		DEBUG(misc, 0, "[squirrel] Failed to create instance for class '%s'", class_name);

   207

		sq_settop(vm, oldtop);

   208

		return false;

   209

	}

   210

   211

	if (instance != NULL) {

   212

		/* Find our instance */

   213

		sq_getstackobj(vm, -1, instance);

   214

		/* Add a reference to it, so it survives for ever */

   215

		sq_addref(vm, instance);

   216

	}

   217

	sq_remove(vm, -2); // Class-name

   218

	sq_remove(vm, -2); // Root-table

   219

   220

	/* Store it in the class */

   221

	sq_setinstanceup(vm, -1, real_instance);

   222

	if (release_hook != NULL) sq_setreleasehook(vm, -1, release_hook);

   223

   224

	if (instance != NULL) sq_settop(vm, oldtop);

   225

   226

	return true;

   227

}

   228

   229

bool Squirrel::CreateClassInstance(const char *class_name, void *real_instance, HSQOBJECT *instance)

   230

{

   231

	return Squirrel::CreateClassInstanceVM(this->vm, class_name, real_instance, instance, NULL);

   232

}

   233

   234

Squirrel::Squirrel()

   235

{

   236

	this->vm = sq_open(1024);

   237

	this->print_func = NULL;

   238

	this->global_pointer = NULL;

   239

   240

	/* Handle compile-errors ourself, so we can display it nicely */

   241

	sq_setcompilererrorhandler(this->vm, &Squirrel::CompileError);

   242

	sq_notifyallexceptions(this->vm, SQTrue);

   243

	/* Set a good print-function */

   244

	sq_setprintfunc(this->vm, &Squirrel::PrintFunc);

   245

	/* Handle runtime-errors ourself, so we can display it nicely */

   246

	sq_newclosure(this->vm, &Squirrel::_RunError, 0);

   247

	sq_seterrorhandler(this->vm);

   248

   249

	/* Set the foreigh pointer, so we can always find this instance from within the VM */

   250

	sq_setforeignptr(this->vm, this);

   251

   252

	sq_pushroottable(this->vm);

   253

	squirrel_register_global_std(this);

   254

}

   255

   256

static SQInteger _io_file_lexfeed_ASCII(SQUserPointer file)

   257

{

   258

	SQInteger ret;

   259

	char c;

   260

	if ((ret = fread(&c, sizeof(c), 1, (FILE *)file) > 0)) return c;

   261

	return 0;

   262

}

   263

   264

static SQInteger _io_file_lexfeed_UTF8(SQUserPointer file)

   265

{

   266

	static const SQInteger utf8_lengths[16] =

   267

	{

   268

		1, 1, 1, 1, 1, 1, 1, 1, /* 0000 to 0111 : 1 byte (plain ASCII) */

   269

		0, 0, 0, 0,             /* 1000 to 1011 : not valid */

   270

		2, 2,                   /* 1100, 1101 : 2 bytes */

   271

		3,                      /* 1110 : 3 bytes */

   272

		4                       /* 1111 : 4 bytes */

   273

	};

   274

	static unsigned char byte_masks[5] = {0, 0, 0x1F, 0x0F, 0x07};

   275

	unsigned char inchar;

   276

	SQInteger c = 0;

   277

	if (fread(&inchar, sizeof(inchar), 1, (FILE *)file) != 1) return 0;

   278

	c = inchar;

   279

   280

	if (c >= 0x80) {

   281

		SQInteger tmp;

   282

		SQInteger codelen = utf8_lengths[c >> 4];

   283

		if (codelen == 0) return 0;

   284

   285

		tmp = c & byte_masks[codelen];

   286

		for (SQInteger n = 0; n < codelen - 1; n++) {

   287

			tmp <<= 6;

   288

			if (fread(&inchar, sizeof(inchar), 1, (FILE *)file) != 1) return 0;

   289

			tmp |= inchar & 0x3F;

   290

		}

   291

		c = tmp;

   292

	}

   293

	return c;

   294

}

   295

   296

static SQInteger _io_file_lexfeed_UCS2_LE(SQUserPointer file)

   297

{

   298

	SQInteger ret;

   299

	wchar_t c;

   300

	if ((ret = fread(&c, sizeof(c), 1, (FILE *)file) > 0)) return (SQChar)c;

   301

	return 0;

   302

}

   303

   304

static SQInteger _io_file_lexfeed_UCS2_BE(SQUserPointer file)

   305

{

   306

	SQInteger ret;

   307

	unsigned short c;

   308

	if ((ret = fread(&c, sizeof(c), 1, (FILE *)file) > 0)) {

   309

		c = ((c >> 8) & 0x00FF)| ((c << 8) & 0xFF00);

   310

		return (SQChar)c;

   311

	}

   312

	return 0;

   313

}

   314

   315

static SQInteger _io_file_read(SQUserPointer file, SQUserPointer buf, SQInteger size)

   316

{

   317

	SQInteger ret = fread(buf, 1, size, (FILE *)file);

   318

	if (ret == 0) return -1;

   319

	return ret;

   320

}

   321

   322

/* static */ SQRESULT Squirrel::LoadFile(HSQUIRRELVM vm, const char *filename, SQBool printerror)

   323

{

   324

	FILE *file = FioFOpenFile(filename, "rb", AI_DIR);

   325

	SQInteger ret;

   326

	unsigned short us;

   327

	unsigned char uc;

   328

	SQLEXREADFUNC func;

   329

   330

	if (file != NULL) {

   331

		ret = fread(&us, 1, sizeof(us), file);

   332

		/* Most likely an empty file */

   333

		if (ret != 2) us = 0;

   334

   335

		switch (us) {

   336

			case SQ_BYTECODE_STREAM_TAG: // BYTECODE

   337

				fseek(file, -2, SEEK_CUR);

   338

				if (SQ_SUCCEEDED(sq_readclosure(vm, _io_file_read, file))) {

   339

					FioFCloseFile(file);

   340

					return SQ_OK;

   341

				}

   342

				return sq_throwerror(vm, _SC("Couldn't read bytecode"));

   343

			case 0xFFFE: func = _io_file_lexfeed_UCS2_BE; break; // UTF-16 little endian

   344

			case 0xFEFF: func = _io_file_lexfeed_UCS2_LE; break; // UTF-16 big endian

   345

			case 0xBBEF: // UTF-8

   346

				if (fread(&uc, 1, sizeof(uc), file) == 0) {

   347

					FioFCloseFile(file);

   348

					return sq_throwerror(vm, _SC("I/O error"));

   349

				}

   350

				if (uc != 0xBF) {

   351

					FioFCloseFile(file);

   352

					return sq_throwerror(vm, _SC("Unrecognized encoding"));

   353

				}

   354

				func = _io_file_lexfeed_UTF8;

   355

				break;

   356

			default: func = _io_file_lexfeed_ASCII; fseek(file, -2, SEEK_CUR); break; // ASCII

   357

		}

   358

   359

		if (SQ_SUCCEEDED(sq_compile(vm, func, file, OTTD2FS(filename), printerror))) {

   360

			FioFCloseFile(file);

   361

			return SQ_OK;

   362

		}

   363

		FioFCloseFile(file);

   364

		return SQ_ERROR;

   365

	}

   366

	return sq_throwerror(vm, _SC("cannot open the file"));

   367

}

   368

   369

/* static */ bool Squirrel::LoadScript(HSQUIRRELVM vm, const char *script, bool in_root)

   370

{

   371

	/* Make sure we are always in the root-table */

   372

	if (in_root) sq_pushroottable(vm);

   373

   374

	/* Load and run the script */

   375

	if (SQ_SUCCEEDED(LoadFile(vm, script, SQTrue))) {

   376

		sq_push(vm, -2);

   377

		if (SQ_SUCCEEDED(sq_call(vm, 1, SQFalse, SQTrue))) {

   378

			sq_pop(vm, 1);

   379

			return true;

   380

		}

   381

	}

   382

   383

	DEBUG(misc, 0, "[squirrel] Failed to compile '%s'", script);

   384

	return false;

   385

}

   386

   387

bool Squirrel::LoadScript(const char *script)

   388

{

   389

	return LoadScript(this->vm, script);

   390

}

   391

   392

Squirrel::~Squirrel()

   393

{

   394

	/* Clean up the stuff */

   395

	sq_pop(this->vm, 1);

   396

	sq_close(this->vm);

   397

}