mirror of
https://gitea.wildfiregames.com/0ad/0ad.git
synced 2026-07-29 04:12:46 +00:00
# Rewrite of the game's simulation system
Giant merge from http://svn.wildfiregames.com/hg-source/file/5fb522019d5e Infrastructure is largely complete, gameplay is largely missing Disabled by default; use command-line flag "-sim2" (Second attempt at commit...) This was SVN commit r7259.
This commit is contained in:
Ykkrosh
@@ -0,0 +1,306 @@
|
||||
/* Copyright (C) 2009 Wildfire Games.
|
||||
* This file is part of 0 A.D.
|
||||
*
|
||||
* 0 A.D. is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 2 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* 0 A.D. is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with 0 A.D. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#ifndef INCLUDED_SCRIPTINTERFACE
|
||||
#define INCLUDED_SCRIPTINTERFACE
|
||||
|
||||
// XXX: This is largely copied from tools/atlas/AtlasScript
|
||||
// Duplication is bad - they should use a shared version of the common code,
|
||||
// and just add their own extensions individually
|
||||
|
||||
#include <memory>
|
||||
#include <vector>
|
||||
#include <string>
|
||||
|
||||
#include "ScriptTypes.h"
|
||||
#include "ScriptVal.h"
|
||||
|
||||
// Set the maximum number of function arguments that can be handled
|
||||
// (This should be as small as possible (for compiler efficiency),
|
||||
// but as large as necessary for all wrapped functions)
|
||||
#define SCRIPT_INTERFACE_MAX_ARGS 4
|
||||
|
||||
struct ScriptInterface_impl;
|
||||
class ScriptClass;
|
||||
class ScriptInterface
|
||||
{
|
||||
public:
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
* @param nativeScopeName Name of global object that functions (via RegisterFunction) will
|
||||
* be placed into, as a scoping mechanism; typically "Engine"
|
||||
* @param cx NULL if the object should create and manage its own context; otherwise
|
||||
* an existing context which it will share
|
||||
*/
|
||||
ScriptInterface(const char* nativeScopeName, JSContext* cx = NULL);
|
||||
|
||||
~ScriptInterface();
|
||||
|
||||
/**
|
||||
* Shut down the JS system to clean up memory. Must only be called when there
|
||||
* are no ScriptInterfaces alive.
|
||||
*/
|
||||
static void ShutDown();
|
||||
|
||||
void SetCallbackData(void* cbdata);
|
||||
static void* GetCallbackData(JSContext* cx);
|
||||
|
||||
JSContext* GetContext();
|
||||
|
||||
/**
|
||||
* Call a constructor function, roughly equivalent to JS "new ctor".
|
||||
*
|
||||
* @return The new object; or 0 on failure, and logs an error message
|
||||
*/
|
||||
jsval CallConstructor(jsval ctor);
|
||||
|
||||
/**
|
||||
* Call the named property on the given object, with void return type and 0 arguments
|
||||
*/
|
||||
bool CallFunctionVoid(jsval val, const char* name);
|
||||
|
||||
/**
|
||||
* Call the named property on the given object, with void return type and 1 argument
|
||||
*/
|
||||
template<typename T0>
|
||||
bool CallFunctionVoid(jsval val, const char* name, const T0& a0);
|
||||
|
||||
/**
|
||||
* Call the named property on the given object, with void return type and 2 arguments
|
||||
*/
|
||||
template<typename T0, typename T1>
|
||||
bool CallFunctionVoid(jsval val, const char* name, const T0& a0, const T1& a1);
|
||||
|
||||
/**
|
||||
* Call the named property on the given object, with return type R and 0 arguments
|
||||
*/
|
||||
template<typename R>
|
||||
bool CallFunction(jsval val, const char* name, R& ret);
|
||||
|
||||
/**
|
||||
* Call the named property on the given object, with return type R and 1 argument
|
||||
*/
|
||||
template<typename T0, typename R>
|
||||
bool CallFunction(jsval val, const char* name, const T0& a0, R& ret);
|
||||
|
||||
/**
|
||||
* Call the named property on the given object, with return type R and 2 arguments
|
||||
*/
|
||||
template<typename T0, typename T1, typename R>
|
||||
bool CallFunction(jsval val, const char* name, const T0& a0, const T1& a1, R& ret);
|
||||
|
||||
jsval GetGlobalObject();
|
||||
|
||||
/**
|
||||
* Set the named property on the global object
|
||||
*/
|
||||
template<typename T>
|
||||
bool SetGlobal(const char* name, const T& value);
|
||||
|
||||
/**
|
||||
* Set the named property on the given object.
|
||||
* Optionally makes it {ReadOnly, DontDelete, DontEnum}.
|
||||
*/
|
||||
template<typename T>
|
||||
bool SetProperty(jsval obj, const char* name, const T& value, bool constant);
|
||||
|
||||
template<typename T>
|
||||
bool GetProperty(jsval obj, const char* name, T& out);
|
||||
|
||||
bool EnumeratePropertyNamesWithPrefix(jsval obj, const char* prefix, std::vector<std::string>& out);
|
||||
|
||||
bool SetPrototype(jsval obj, jsval proto);
|
||||
|
||||
bool Eval(const char* code);
|
||||
|
||||
template<typename T> bool Eval(const char* code, T& out);
|
||||
|
||||
/**
|
||||
* Report the given error message through the JS error reporting mechanism,
|
||||
* and throw a JS exception. (Callers can check IsPendingException, and must
|
||||
* return JS_FALSE in that case to propagate the exception.)
|
||||
*/
|
||||
void ReportError(const char* msg);
|
||||
|
||||
/**
|
||||
* Load and execute the given script in a new function scope.
|
||||
* @param filename Name for debugging purposes (not used to load the file)
|
||||
* @param code JS code to execute
|
||||
* @return true on successful compilation and execution; false otherwise
|
||||
*/
|
||||
bool LoadScript(const std::wstring& filename, const std::wstring& code);
|
||||
|
||||
/**
|
||||
* Convert a jsval to a C++ type. (This might trigger GC.)
|
||||
*/
|
||||
template<typename T> static bool FromJSVal(JSContext* cx, jsval val, T& ret);
|
||||
|
||||
/**
|
||||
* Convert a C++ type to a jsval. (This might trigger GC. The return
|
||||
* value must be rooted if you don't want it to be collected.)
|
||||
*/
|
||||
template<typename T> static jsval ToJSVal(JSContext* cx, T const& val);
|
||||
|
||||
bool AddRoot(void* ptr, const char* name);
|
||||
bool RemoveRoot(void* ptr);
|
||||
|
||||
// Helper class for automatically rooting values
|
||||
class LocalRootScope
|
||||
{
|
||||
JSContext* m_cx;
|
||||
bool m_OK;
|
||||
public:
|
||||
// Tries to enter local root scope, so newly created
|
||||
// values won't be GCed. This might fail, so check OK()
|
||||
LocalRootScope(JSContext* cx);
|
||||
// Returns true if the local root scope was successfully entered
|
||||
bool OK();
|
||||
// Leaves the local root scope
|
||||
~LocalRootScope();
|
||||
private:
|
||||
LocalRootScope& operator=(const LocalRootScope&);
|
||||
};
|
||||
#define LOCAL_ROOT_SCOPE LocalRootScope scope(GetContext()); if (! scope.OK()) return false
|
||||
|
||||
private:
|
||||
bool CallFunction_(jsval val, const char* name, std::vector<jsval>& args, jsval& ret);
|
||||
bool Eval_(const char* code, jsval& ret);
|
||||
bool SetGlobal_(const char* name, jsval value);
|
||||
bool SetProperty_(jsval obj, const char* name, jsval value, bool readonly);
|
||||
bool GetProperty_(jsval obj, const char* name, jsval& value);
|
||||
static bool IsExceptionPending(JSContext* cx);
|
||||
static JSClass* GetClass(JSContext* cx, JSObject* obj);
|
||||
static void* GetPrivate(JSContext* cx, JSObject* obj);
|
||||
|
||||
void Register(const char* name, JSNative fptr, size_t nargs);
|
||||
std::auto_ptr<ScriptInterface_impl> m;
|
||||
|
||||
// The nasty macro/template bits are split into a separate file so you don't have to look at them
|
||||
public:
|
||||
#include "NativeWrapperDecls.h"
|
||||
// This declares:
|
||||
//
|
||||
// template <R, T0..., TR (*fptr) (void* cbdata, T0...)>
|
||||
// void RegisterFunction(const char* functionName);
|
||||
//
|
||||
// template <R, T0..., TR (*fptr) (void* cbdata, T0...)>
|
||||
// static JSNative call;
|
||||
//
|
||||
// template <R, T0..., JSClass*, TC, TR (TC:*fptr) (T0...)>
|
||||
// static JSNative callMethod;
|
||||
//
|
||||
// template <dummy, T0...>
|
||||
// static size_t nargs();
|
||||
};
|
||||
|
||||
// Implement those declared functions
|
||||
#include "NativeWrapperDefns.h"
|
||||
|
||||
template<typename R>
|
||||
bool ScriptInterface::CallFunction(jsval val, const char* name, R& ret)
|
||||
{
|
||||
LOCAL_ROOT_SCOPE;
|
||||
jsval jsRet;
|
||||
std::vector<jsval> argv;
|
||||
bool ok = CallFunction_(val, name, argv, jsRet);
|
||||
if (!ok)
|
||||
return false;
|
||||
return FromJSVal(GetContext(), jsRet, ret);
|
||||
}
|
||||
|
||||
template<typename T0>
|
||||
bool ScriptInterface::CallFunctionVoid(jsval val, const char* name, const T0& a0)
|
||||
{
|
||||
LOCAL_ROOT_SCOPE;
|
||||
jsval jsRet;
|
||||
std::vector<jsval> argv;
|
||||
argv.push_back(ToJSVal(GetContext(), a0));
|
||||
return CallFunction_(val, name, argv, jsRet);
|
||||
}
|
||||
|
||||
template<typename T0, typename T1>
|
||||
bool ScriptInterface::CallFunctionVoid(jsval val, const char* name, const T0& a0, const T1& a1)
|
||||
{
|
||||
LOCAL_ROOT_SCOPE;
|
||||
jsval jsRet;
|
||||
std::vector<jsval> argv;
|
||||
argv.push_back(ToJSVal(GetContext(), a0));
|
||||
argv.push_back(ToJSVal(GetContext(), a1));
|
||||
return CallFunction_(val, name, argv, jsRet);
|
||||
}
|
||||
|
||||
template<typename T0, typename R>
|
||||
bool ScriptInterface::CallFunction(jsval val, const char* name, const T0& a0, R& ret)
|
||||
{
|
||||
LOCAL_ROOT_SCOPE;
|
||||
jsval jsRet;
|
||||
std::vector<jsval> argv;
|
||||
argv.push_back(ToJSVal(GetContext(), a0));
|
||||
bool ok = CallFunction_(val, name, argv, jsRet);
|
||||
if (!ok)
|
||||
return false;
|
||||
return FromJSVal(GetContext(), jsRet, ret);
|
||||
}
|
||||
|
||||
template<typename T0, typename T1, typename R>
|
||||
bool ScriptInterface::CallFunction(jsval val, const char* name, const T0& a0, const T1& a1, R& ret)
|
||||
{
|
||||
LOCAL_ROOT_SCOPE;
|
||||
jsval jsRet;
|
||||
std::vector<jsval> argv;
|
||||
argv.push_back(ToJSVal(GetContext(), a0));
|
||||
argv.push_back(ToJSVal(GetContext(), a1));
|
||||
bool ok = CallFunction_(val, name, argv, jsRet);
|
||||
if (!ok)
|
||||
return false;
|
||||
return FromJSVal(GetContext(), jsRet, ret);
|
||||
}
|
||||
|
||||
template<typename T>
|
||||
bool ScriptInterface::SetGlobal(const char* name, const T& value)
|
||||
{
|
||||
LOCAL_ROOT_SCOPE;
|
||||
return SetGlobal_(name, ToJSVal(GetContext(), value));
|
||||
}
|
||||
|
||||
template<typename T>
|
||||
bool ScriptInterface::SetProperty(jsval obj, const char* name, const T& value, bool readonly)
|
||||
{
|
||||
LOCAL_ROOT_SCOPE;
|
||||
return SetProperty_(obj, name, ToJSVal(GetContext(), value), readonly);
|
||||
}
|
||||
|
||||
template<typename T>
|
||||
bool ScriptInterface::GetProperty(jsval obj, const char* name, T& out)
|
||||
{
|
||||
jsval val;
|
||||
if (! GetProperty_(obj, name, val))
|
||||
return false;
|
||||
return FromJSVal(GetContext(), val, out);
|
||||
}
|
||||
|
||||
template<typename T>
|
||||
bool ScriptInterface::Eval(const char* code, T& ret)
|
||||
{
|
||||
jsval rval;
|
||||
if (! Eval_(code, rval))
|
||||
return false;
|
||||
return FromJSVal(GetContext(), rval, ret);
|
||||
}
|
||||
|
||||
#endif // INCLUDED_SCRIPTINTERFACE
|
||||
Reference in New Issue
Block a user