Damjan AdamicandAndre Bernet
955d5775cb
* Add Lua getUsage() function that returns percent of already used up instructions in current script execution cycle. It can be used to avoid script being killed when doing long lasting tasks (like telemetry logs loading and parsing) * Compilation fixes * Doc fix * Disable Lua script instructions limit in DEBUG mode
178 lines
6.3 KiB
C
178 lines
6.3 KiB
C
/*
|
|
* Copyright (C) OpenTX
|
|
*
|
|
* Based on code named
|
|
* th9x - http://code.google.com/p/th9x
|
|
* er9x - http://code.google.com/p/er9x
|
|
* gruvin9x - http://code.google.com/p/gruvin9x
|
|
*
|
|
* License GPLv2: http://www.gnu.org/licenses/gpl-2.0.html
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License version 2 as
|
|
* published by the Free Software Foundation.
|
|
*
|
|
* This program 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.
|
|
*/
|
|
|
|
#ifndef _LUA_API_H_
|
|
#define _LUA_API_H_
|
|
|
|
#if defined(LUA)
|
|
|
|
extern "C" {
|
|
#include <lua.h>
|
|
#include <lauxlib.h>
|
|
#include <lualib.h>
|
|
#include <lrotable.h>
|
|
#include <lgc.h>
|
|
}
|
|
|
|
#ifndef LUA_SCRIPT_LOAD_MODE
|
|
// Can force loading of binary (.luac) or plain-text (.lua) versions of scripts specifically, and control
|
|
// compilation options. See interface.cpp:luaLoadScriptFileToState() <mode> parameter description for details.
|
|
#if !defined(LUA_COMPILER) || defined(SIMU) || defined(DEBUG)
|
|
#define LUA_SCRIPT_LOAD_MODE "T" // prefer loading .lua source file for full debug info
|
|
#else
|
|
#define LUA_SCRIPT_LOAD_MODE "bt" // binary or text, whichever is newer
|
|
#endif
|
|
#endif
|
|
|
|
extern lua_State * lsScripts;
|
|
extern lua_State * lsWidgets;
|
|
extern bool luaLcdAllowed;
|
|
#if defined(COLORLCD)
|
|
extern uint32_t luaExtraMemoryUsage;
|
|
#endif
|
|
|
|
void luaInit();
|
|
void luaInitThemesAndWidgets();
|
|
#define LUA_INIT_THEMES_AND_WIDGETS() luaInitThemesAndWidgets()
|
|
|
|
#define lua_registernumber(L, n, i) (lua_pushnumber(L, (i)), lua_setglobal(L, (n)))
|
|
#define lua_registerint(L, n, i) (lua_pushinteger(L, (i)), lua_setglobal(L, (n)))
|
|
#define lua_pushtablenil(L, k) (lua_pushstring(L, (k)), lua_pushnil(L), lua_settable(L, -3))
|
|
#define lua_pushtableboolean(L, k, v) (lua_pushstring(L, (k)), lua_pushboolean(L, (v)), lua_settable(L, -3))
|
|
#define lua_pushtableinteger(L, k, v) (lua_pushstring(L, (k)), lua_pushinteger(L, (v)), lua_settable(L, -3))
|
|
#define lua_pushtablenumber(L, k, v) (lua_pushstring(L, (k)), lua_pushnumber(L, (v)), lua_settable(L, -3))
|
|
#define lua_pushtablestring(L, k, v) (lua_pushstring(L, (k)), lua_pushstring(L, (v)), lua_settable(L, -3))
|
|
#define lua_pushtablenzstring(L, k, v) { char tmp[sizeof(v)+1]; strncpy(tmp, (v), sizeof(v)); tmp[sizeof(v)] = '\0'; lua_pushstring(L, (k)); lua_pushstring(L, tmp); lua_settable(L, -3); }
|
|
#define lua_pushtablezstring(L, k, v) { char tmp[sizeof(v)+1]; zchar2str(tmp, (v), sizeof(v)); lua_pushstring(L, (k)); lua_pushstring(L, tmp); lua_settable(L, -3); }
|
|
#define lua_registerlib(L, name, tab) (luaL_newmetatable(L, name), luaL_setfuncs(L, tab, 0), lua_setglobal(L, name))
|
|
|
|
#define RUN_MIX_SCRIPT (1 << 0)
|
|
#define RUN_FUNC_SCRIPT (1 << 1)
|
|
#define RUN_TELEM_BG_SCRIPT (1 << 2)
|
|
#define RUN_TELEM_FG_SCRIPT (1 << 3)
|
|
#define RUN_STNDAL_SCRIPT (1 << 4)
|
|
|
|
enum luaScriptInputType {
|
|
INPUT_TYPE_FIRST = 0,
|
|
INPUT_TYPE_VALUE = INPUT_TYPE_FIRST,
|
|
INPUT_TYPE_SOURCE,
|
|
INPUT_TYPE_LAST = INPUT_TYPE_SOURCE
|
|
};
|
|
|
|
struct ScriptInput {
|
|
const char *name;
|
|
uint8_t type;
|
|
int16_t min;
|
|
int16_t max;
|
|
int16_t def;
|
|
};
|
|
struct ScriptOutput {
|
|
const char *name;
|
|
int16_t value;
|
|
};
|
|
enum ScriptState {
|
|
SCRIPT_OK,
|
|
SCRIPT_NOFILE,
|
|
SCRIPT_SYNTAX_ERROR,
|
|
SCRIPT_PANIC,
|
|
SCRIPT_KILLED
|
|
};
|
|
enum ScriptReference {
|
|
SCRIPT_MIX_FIRST,
|
|
SCRIPT_MIX_LAST=SCRIPT_MIX_FIRST+MAX_SCRIPTS-1,
|
|
SCRIPT_FUNC_FIRST,
|
|
SCRIPT_FUNC_LAST=SCRIPT_FUNC_FIRST+MAX_SPECIAL_FUNCTIONS-1,
|
|
SCRIPT_TELEMETRY_FIRST,
|
|
SCRIPT_TELEMETRY_LAST=SCRIPT_TELEMETRY_FIRST+MAX_SCRIPTS, // telem0 and telem1 .. telem7
|
|
};
|
|
struct ScriptInternalData {
|
|
uint8_t reference;
|
|
uint8_t state;
|
|
int run;
|
|
int background;
|
|
uint8_t instructions;
|
|
};
|
|
struct ScriptInputsOutputs {
|
|
uint8_t inputsCount;
|
|
ScriptInput inputs[MAX_SCRIPT_INPUTS];
|
|
uint8_t outputsCount;
|
|
ScriptOutput outputs[MAX_SCRIPT_OUTPUTS];
|
|
};
|
|
#define INTERPRETER_RUNNING_STANDALONE_SCRIPT 1
|
|
#define INTERPRETER_RELOAD_PERMANENT_SCRIPTS 2
|
|
#define INTERPRETER_PANIC 255
|
|
extern uint8_t luaState;
|
|
extern uint8_t luaScriptsCount;
|
|
extern ScriptInternalData standaloneScript;
|
|
extern ScriptInternalData scriptInternalData[MAX_SCRIPTS];
|
|
extern ScriptInputsOutputs scriptInputsOutputs[MAX_SCRIPTS];
|
|
void luaClose(lua_State ** L);
|
|
bool luaTask(event_t evt, uint8_t scriptType, bool allowLcdUsage);
|
|
void checkLuaMemoryUsage();
|
|
void luaExec(const char * filename);
|
|
void luaDoGc(lua_State * L, bool full);
|
|
void luaError(lua_State * L, uint8_t error, bool acknowledge=true);
|
|
uint32_t luaGetMemUsed(lua_State * L);
|
|
void luaGetValueAndPush(lua_State * L, int src);
|
|
#define luaGetCpuUsed(idx) scriptInternalData[idx].instructions
|
|
uint8_t isTelemetryScriptAvailable(uint8_t index);
|
|
#define LUA_LOAD_MODEL_SCRIPTS() luaState |= INTERPRETER_RELOAD_PERMANENT_SCRIPTS
|
|
#define LUA_LOAD_MODEL_SCRIPT(idx) luaState |= INTERPRETER_RELOAD_PERMANENT_SCRIPTS
|
|
// Lua PROTECT/UNPROTECT
|
|
#include <setjmp.h>
|
|
struct our_longjmp {
|
|
struct our_longjmp *previous;
|
|
jmp_buf b;
|
|
volatile int status; /* error code */
|
|
};
|
|
extern struct our_longjmp * global_lj;
|
|
#define PROTECT_LUA() { struct our_longjmp lj; \
|
|
lj.previous = global_lj; /* chain new error handler */ \
|
|
global_lj = &lj; \
|
|
if (setjmp(lj.b) == 0)
|
|
#define UNPROTECT_LUA() global_lj = lj.previous; } /* restore old error handler */
|
|
|
|
extern uint16_t maxLuaInterval;
|
|
extern uint16_t maxLuaDuration;
|
|
extern uint8_t instructionsPercent;
|
|
|
|
#if defined(PCBTARANIS)
|
|
#define IS_MASKABLE(key) ((key) != KEY_EXIT && (key) != KEY_ENTER && ((luaState & INTERPRETER_RUNNING_STANDALONE_SCRIPT) || (key) != KEY_PAGE))
|
|
#elif defined(PCBHORUS)
|
|
#define IS_MASKABLE(key) ((key) != KEY_EXIT && (key) != KEY_ENTER)
|
|
#endif
|
|
struct LuaField {
|
|
uint16_t id;
|
|
char desc[50];
|
|
};
|
|
bool luaFindFieldByName(const char * name, LuaField & field, unsigned int flags=0);
|
|
void luaLoadThemes();
|
|
void luaRegisterLibraries(lua_State * L);
|
|
void registerBitmapClass(lua_State * L);
|
|
void luaSetInstructionsLimit(lua_State* L, int count);
|
|
int luaLoadScriptFileToState(lua_State * L, const char * filename, const char * mode);
|
|
#else // defined(LUA)
|
|
#define luaInit()
|
|
#define LUA_INIT_THEMES_AND_WIDGETS()
|
|
#define LUA_LOAD_MODEL_SCRIPTS()
|
|
#endif // defined(LUA)
|
|
|
|
#endif // _LUA_API_H_
|