mirror of
https://gitlab.freedesktop.org/pipewire/wireplumber.git
synced 2026-06-16 00:18:26 +02:00
a824ae910f
Scripts are always deactivated (and not finalized) before core disconnects, so we need to make sure the scripts don't hold a strong reference when creating them. They must only hold a strong reference of the Lua state if activated. In order to implement this properly, the lua_State has been wrapped into a GObject so that the 'lua-engine' construct-only property is a weak reference of the Lua state. Then, when the script is activated, a strong reference of the Lua state is held so the script can work. This strong reference is later dropped when the script is deactivated (right before the core is disconnected), avoiding leaked proxy warning messages in the log if a script has a global variable holding a proxy (Eg the alsa monitor in alsa.lua).
100 lines
3.1 KiB
C
100 lines
3.1 KiB
C
/* WirePlumber
|
|
*
|
|
* Copyright © 2020 Collabora Ltd.
|
|
* @author George Kiagiadakis <george.kiagiadakis@collabora.com>
|
|
*
|
|
* SPDX-License-Identifier: MIT
|
|
*/
|
|
|
|
#ifndef __WPLUA_H__
|
|
#define __WPLUA_H__
|
|
|
|
#include <wp/wp.h>
|
|
|
|
#include <lua.h>
|
|
#include <lauxlib.h>
|
|
#include <lualib.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
/**
|
|
* WP_DOMAIN_LUA:
|
|
*
|
|
* @brief A <a href="https://developer.gnome.org/glib/stable/glib-Error-Reporting.html#GError">
|
|
* GError</a> domain for errors that occurred within the context of the
|
|
* WirePlumber lua library.
|
|
*/
|
|
#define WP_DOMAIN_LUA (wp_domain_lua_quark ())
|
|
GQuark wp_domain_lua_quark (void);
|
|
|
|
/**
|
|
* WpLuaError:
|
|
*
|
|
* @brief
|
|
* @em WP_LUA_ERROR_COMPILATION: a compilation error, i.e. invalid Lua code
|
|
* @em WP_LUA_ERROR_RUNTIME: a runtime error, i.e. misbehaving Lua code
|
|
*
|
|
* Error codes that can appear in a
|
|
* <a href="https://developer.gnome.org/glib/stable/glib-Error-Reporting.html#GError">
|
|
* GError</a> when the error domain is %WP_DOMAIN_LUA
|
|
*/
|
|
typedef enum {
|
|
WP_LUA_ERROR_COMPILATION,
|
|
WP_LUA_ERROR_RUNTIME,
|
|
} WpLuaError;
|
|
|
|
typedef enum {
|
|
WP_LUA_SANDBOX_ISOLATE_ENV = 1,
|
|
} WpLuaSandboxFlags;
|
|
|
|
#define WPLUA_TYPE_STATE (wplua_state_get_type ())
|
|
G_DECLARE_FINAL_TYPE (WpLuaState, wplua_state, WPLUA, STATE, GObject)
|
|
WpLuaState * wplua_state_new (void);
|
|
lua_State * wplua_state_get (WpLuaState *self);
|
|
|
|
void wplua_enable_sandbox (lua_State * L, WpLuaSandboxFlags flags);
|
|
int wplua_push_sandbox (lua_State * L);
|
|
|
|
void wplua_register_type_methods (lua_State * L, GType type,
|
|
lua_CFunction constructor, const luaL_Reg * methods);
|
|
|
|
GType wplua_gvalue_userdata_type (lua_State *L, int idx);
|
|
|
|
/* push -> transfer full; get -> transfer none */
|
|
void wplua_pushobject (lua_State * L, gpointer object);
|
|
gpointer wplua_toobject (lua_State *L, int idx);
|
|
gpointer wplua_checkobject (lua_State *L, int idx, GType type);
|
|
gboolean wplua_isobject (lua_State *L, int idx, GType type);
|
|
|
|
/* push -> transfer full; get -> transfer none */
|
|
void wplua_pushboxed (lua_State * L, GType type, gpointer object);
|
|
gpointer wplua_toboxed (lua_State *L, int idx);
|
|
gpointer wplua_checkboxed (lua_State *L, int idx, GType type);
|
|
gboolean wplua_isboxed (lua_State *L, int idx, GType type);
|
|
|
|
/* transfer floating */
|
|
GClosure * wplua_checkclosure (lua_State *L, int idx);
|
|
GClosure * wplua_function_to_closure (lua_State *L, int idx);
|
|
|
|
void wplua_enum_to_lua (lua_State *L, gint enum_val, GType enum_type);
|
|
gint wplua_lua_to_enum (lua_State *L, int idx, GType enum_type);
|
|
|
|
void wplua_lua_to_gvalue (lua_State *L, int idx, GValue *v);
|
|
int wplua_gvalue_to_lua (lua_State *L, const GValue *v);
|
|
|
|
GVariant * wplua_lua_to_gvariant (lua_State *L, int idx);
|
|
void wplua_gvariant_to_lua (lua_State *L, GVariant *p);
|
|
|
|
WpProperties * wplua_table_to_properties (lua_State *L, int idx);
|
|
void wplua_properties_to_table (lua_State *L, WpProperties *p);
|
|
|
|
gboolean wplua_load_buffer (lua_State * L, const gchar *buf, gsize size,
|
|
GError **error);
|
|
gboolean wplua_load_uri (lua_State * L, const gchar *uri, GError **error);
|
|
gboolean wplua_load_path (lua_State * L, const gchar *path, GError **error);
|
|
|
|
gboolean wplua_pcall (lua_State * L, int nargs, int nres, GError **error);
|
|
|
|
G_END_DECLS
|
|
|
|
#endif
|