mirror of
https://github.com/VCMP-SqMod/SqMod.git
synced 2024-11-08 08:47:17 +01:00
4a6bfc086c
Switched to POCO library for unified platform/library interface. Deprecated the external module API. It was creating more problems than solving. Removed most built-in libraries in favor of system libraries for easier maintenance. Cleaned and secured code with help from static analyzers.
249 lines
9.0 KiB
C++
249 lines
9.0 KiB
C++
//
|
|
// SqratScript: Script Compilation and Execution
|
|
//
|
|
|
|
//
|
|
// Copyright (c) 2009 Brandon Jones
|
|
//
|
|
// This software is provided 'as-is', without any express or implied
|
|
// warranty. In no event will the authors be held liable for any damages
|
|
// arising from the use of this software.
|
|
//
|
|
// Permission is granted to anyone to use this software for any purpose,
|
|
// including commercial applications, and to alter it and redistribute it
|
|
// freely, subject to the following restrictions:
|
|
//
|
|
// 1. The origin of this software must not be misrepresented; you must not
|
|
// claim that you wrote the original software. If you use this software
|
|
// in a product, an acknowledgment in the product documentation would be
|
|
// appreciated but is not required.
|
|
//
|
|
// 2. Altered source versions must be plainly marked as such, and must not be
|
|
// misrepresented as being the original software.
|
|
//
|
|
// 3. This notice may not be removed or altered from any source
|
|
// distribution.
|
|
//
|
|
|
|
#pragma once
|
|
|
|
#include <squirrelex.h>
|
|
#include <sqstdio.h>
|
|
|
|
#include <string.h>
|
|
|
|
#include "sqratObject.h"
|
|
|
|
namespace Sqrat {
|
|
|
|
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
/// Helper class for managing Squirrel scripts
|
|
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
class Script : public Object {
|
|
public:
|
|
|
|
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
/// Default constructor
|
|
///
|
|
/// \param v VM that the Script will be associated with
|
|
///
|
|
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
Script() : Object(true) {
|
|
}
|
|
|
|
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
/// Sets up the Script using a string containing a Squirrel script
|
|
///
|
|
/// \param script String containing a file path to a Squirrel script
|
|
/// \param name Optional string containing the script's name (for errors)
|
|
///
|
|
/// \remarks
|
|
/// This function MUST have its Error handled if it occurred.
|
|
///
|
|
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
void CompileString(const string& script, const string& name = _SC("")) {
|
|
HSQUIRRELVM vm = SqVM();
|
|
if(!sq_isnull(mObj)) {
|
|
sq_release(vm, &mObj);
|
|
sq_resetobject(&mObj);
|
|
}
|
|
|
|
#if !defined (SCRAT_NO_ERROR_CHECKING)
|
|
if(SQ_FAILED(sq_compilebuffer(vm, script.c_str(), static_cast<SQInteger>(script.size() /** sizeof(SQChar)*/), name.c_str(), true))) {
|
|
SQTHROW(vm, LastErrorString(vm));
|
|
return;
|
|
}
|
|
#else
|
|
sq_compilebuffer(vm, script.c_str(), static_cast<SQInteger>(script.size() /** sizeof(SQChar)*/), name.c_str(), true);
|
|
#endif
|
|
sq_getstackobj(vm,-1,&mObj);
|
|
sq_addref(vm, &mObj);
|
|
sq_pop(vm, 1);
|
|
}
|
|
|
|
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
/// Sets up the Script using a string containing a Squirrel script
|
|
///
|
|
/// \param script String containing a file path to a Squirrel script
|
|
/// \param errMsg String that is filled with any errors that may occur
|
|
/// \param name Optional string containing the script's name (for errors)
|
|
///
|
|
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
bool CompileString(const string& script, string& errMsg, const string& name = _SC("")) {
|
|
HSQUIRRELVM vm = SqVM();
|
|
if(!sq_isnull(mObj)) {
|
|
sq_release(vm, &mObj);
|
|
sq_resetobject(&mObj);
|
|
}
|
|
|
|
#if !defined (SCRAT_NO_ERROR_CHECKING)
|
|
if(SQ_FAILED(sq_compilebuffer(vm, script.c_str(), static_cast<SQInteger>(script.size() /** sizeof(SQChar)*/), name.c_str(), true))) {
|
|
errMsg = LastErrorString(vm);
|
|
return false;
|
|
}
|
|
#else
|
|
sq_compilebuffer(vm, script.c_str(), static_cast<SQInteger>(script.size() /** sizeof(SQChar)*/), name.c_str(), true);
|
|
#endif
|
|
sq_getstackobj(vm,-1,&mObj);
|
|
sq_addref(vm, &mObj);
|
|
sq_pop(vm, 1);
|
|
return true;
|
|
}
|
|
|
|
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
/// Sets up the Script using a file containing a Squirrel script
|
|
///
|
|
/// \param path File path containing a Squirrel script
|
|
///
|
|
/// \remarks
|
|
/// This function MUST have its Error handled if it occurred.
|
|
///
|
|
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
void CompileFile(const string& path) {
|
|
HSQUIRRELVM vm = SqVM();
|
|
if(!sq_isnull(mObj)) {
|
|
sq_release(vm, &mObj);
|
|
sq_resetobject(&mObj);
|
|
}
|
|
|
|
#if !defined (SCRAT_NO_ERROR_CHECKING)
|
|
if(SQ_FAILED(sqstd_loadfile(vm, path.c_str(), true))) {
|
|
SQTHROW(vm, LastErrorString(vm));
|
|
return;
|
|
}
|
|
#else
|
|
sqstd_loadfile(vm, path.c_str(), true);
|
|
#endif
|
|
sq_getstackobj(vm,-1,&mObj);
|
|
sq_addref(vm, &mObj);
|
|
sq_pop(vm, 1);
|
|
}
|
|
|
|
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
/// Sets up the Script using a file containing a Squirrel script
|
|
///
|
|
/// \param path File path containing a Squirrel script
|
|
/// \param errMsg String that is filled with any errors that may occur
|
|
///
|
|
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
bool CompileFile(const string& path, string& errMsg) {
|
|
HSQUIRRELVM vm = SqVM();
|
|
if(!sq_isnull(mObj)) {
|
|
sq_release(vm, &mObj);
|
|
sq_resetobject(&mObj);
|
|
}
|
|
|
|
#if !defined (SCRAT_NO_ERROR_CHECKING)
|
|
if(SQ_FAILED(sqstd_loadfile(vm, path.c_str(), true))) {
|
|
errMsg = LastErrorString(vm);
|
|
return false;
|
|
}
|
|
#else
|
|
sqstd_loadfile(vm, path.c_str(), true);
|
|
#endif
|
|
sq_getstackobj(vm,-1,&mObj);
|
|
sq_addref(vm, &mObj);
|
|
sq_pop(vm, 1);
|
|
return true;
|
|
}
|
|
|
|
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
/// Runs the script
|
|
///
|
|
/// \remarks
|
|
/// This function MUST have its Error handled if it occurred.
|
|
///
|
|
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
void Run() {
|
|
HSQUIRRELVM vm = SqVM();
|
|
#if !defined (SCRAT_NO_ERROR_CHECKING)
|
|
if(!sq_isnull(mObj)) {
|
|
SQRESULT result;
|
|
SQInteger top = sq_gettop(vm);
|
|
sq_pushobject(vm, mObj);
|
|
sq_pushroottable(vm);
|
|
result = sq_call(vm, 1, false, true);
|
|
sq_settop(vm, top);
|
|
if(SQ_FAILED(result)) {
|
|
SQTHROW(vm, LastErrorString(vm));
|
|
return;
|
|
}
|
|
}
|
|
#else
|
|
SQInteger top = sq_gettop(vm);
|
|
sq_pushobject(vm, obj);
|
|
sq_pushroottable(vm);
|
|
sq_call(vm, 1, false, true);
|
|
sq_settop(vm, top);
|
|
#endif
|
|
}
|
|
|
|
#if !defined (SCRAT_NO_ERROR_CHECKING)
|
|
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
/// Runs the script
|
|
///
|
|
/// \param errMsg String that is filled with any errors that may occur
|
|
///
|
|
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
bool Run(string& errMsg) {
|
|
HSQUIRRELVM vm = SqVM();
|
|
if(!sq_isnull(mObj)) {
|
|
SQRESULT result;
|
|
SQInteger top = sq_gettop(vm);
|
|
sq_pushobject(vm, mObj);
|
|
sq_pushroottable(vm);
|
|
result = sq_call(vm, 1, false, true);
|
|
sq_settop(vm, top);
|
|
if(SQ_FAILED(result)) {
|
|
errMsg = LastErrorString(vm);
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
#endif
|
|
|
|
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
/// Writes the byte code of the Script to a file
|
|
///
|
|
/// \param path File path to write to
|
|
///
|
|
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
void WriteCompiledFile(const string& path) {
|
|
HSQUIRRELVM vm = SqVM();
|
|
#if !defined (SCRAT_NO_ERROR_CHECKING)
|
|
if(!sq_isnull(mObj)) {
|
|
sq_pushobject(vm, mObj);
|
|
sqstd_writeclosuretofile(vm, path.c_str());
|
|
}
|
|
#else
|
|
sq_pushobject(vm, obj);
|
|
sqstd_writeclosuretofile(vm, path.c_str());
|
|
#endif
|
|
sq_pop(vm, 1); // needed?
|
|
}
|
|
};
|
|
|
|
}
|