93 lines
3.1 KiB
C++
93 lines
3.1 KiB
C++
/*
|
|
https://github.com/peterix/dfhack
|
|
Copyright (c) 2009-2011 Petr Mrázek (peterix@gmail.com)
|
|
|
|
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 <string>
|
|
#include <sstream>
|
|
#include <vector>
|
|
#include <map>
|
|
|
|
#include "DataDefs.h"
|
|
|
|
#include <lua.h>
|
|
#include <lauxlib.h>
|
|
|
|
namespace DFHack { namespace Lua {
|
|
/**
|
|
* Create or initialize a lua interpreter with access to DFHack tools.
|
|
*/
|
|
DFHACK_EXPORT lua_State *Open(color_ostream &out, lua_State *state = NULL);
|
|
|
|
/**
|
|
* Load a module using require().
|
|
*/
|
|
DFHACK_EXPORT bool Require(color_ostream &out, lua_State *state,
|
|
const std::string &module, bool setglobal = false);
|
|
|
|
/**
|
|
* Push the pointer onto the stack as a wrapped DF object of the given type.
|
|
*/
|
|
DFHACK_EXPORT void PushDFObject(lua_State *state, type_identity *type, void *ptr);
|
|
|
|
/**
|
|
* Check that the value is a wrapped DF object of the given type, and if so return the pointer.
|
|
*/
|
|
DFHACK_EXPORT void *GetDFObject(lua_State *state, type_identity *type, int val_index, bool exact_type = false);
|
|
|
|
/**
|
|
* Push the pointer onto the stack as a wrapped DF object of a specific type.
|
|
*/
|
|
template<class T>
|
|
void PushDFObject(lua_State *state, T *ptr) {
|
|
PushDFObject(state, df::identity_traits<T>::get(), ptr);
|
|
}
|
|
|
|
/**
|
|
* Check that the value is a wrapped DF object of the correct type, and if so return the pointer.
|
|
*/
|
|
template<class T>
|
|
T *GetDFObject(lua_State *state, int val_index, bool exact_type = false) {
|
|
return (T*)GetDFObject(state, df::identity_traits<T>::get(), val_index, exact_type);
|
|
}
|
|
|
|
/**
|
|
* Invoke lua function via pcall. Returns true if success.
|
|
* If an error is signalled, and perr is true, it is printed and popped from the stack.
|
|
*/
|
|
DFHACK_EXPORT bool SafeCall(color_ostream &out, lua_State *state, int nargs, int nres, bool perr = true);
|
|
|
|
/**
|
|
* Returns the ostream passed to SafeCall.
|
|
*/
|
|
DFHACK_EXPORT color_ostream *GetOutput(lua_State *state);
|
|
|
|
/**
|
|
* Run an interactive interpreter loop if possible, or return false.
|
|
*/
|
|
DFHACK_EXPORT bool InterpreterLoop(color_ostream &out, lua_State *state,
|
|
const char *prompt = NULL, int env = 0, const char *hfile = NULL);
|
|
}}
|
|
|