module.c File Reference

Definition of the Lua Module. More...

#include "config.h"
#include <lua.h>
#include <stdbool.h>
#include <stddef.h>
#include "mutt/lib.h"
#include "core/lib.h"
#include "module_data.h"

Include dependency graph for module.c:

Go to the source code of this file.

Functions
static bool	lua_init (struct NeoMutt *n)
	Initialise a Module - Implements Module::init()
static bool	lua_commands_register (struct NeoMutt *n, struct CommandArray *ca)
	Register NeoMutt Commands - Implements Module::commands_register()
static bool	lua_cleanup (struct NeoMutt *n, void *data)
	Clean up a Module - Implements Module::cleanup()

Variables
const struct Command	LuaCommands []
	List of NeoMutt commands to register.
const struct Module	ModuleLua
	Module for the Lua library.

Detailed Description

Definition of the Lua Module.

Authors

• Richard Russon

Copyright

This program 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.

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.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file module.c.

Function Documentation

lua_init()

static bool lua_init ( struct NeoMutt * n )

static

Initialise a Module - Implements Module::init()

Definition at line 42 of file module.c.

{
  struct LuaModuleData *mod_data = MUTT_MEM_CALLOC(1, struct LuaModuleData);
  neomutt_set_module_data(n, MODULE_ID_LUA, mod_data);
 
  mod_data->notify = notify_new();
  notify_set_parent(mod_data->notify, n->notify);
 
  return true;
}

Here is the call graph for this function:

lua_commands_register()

static bool lua_commands_register ( struct NeoMutt * n, struct CommandArray * ca )

static

Register NeoMutt Commands - Implements Module::commands_register()

Definition at line 56 of file module.c.

{
  return commands_register(ca, LuaCommands);
}

Here is the call graph for this function:

lua_cleanup()

static bool lua_cleanup ( struct NeoMutt * n, void * data )

static

Clean up a Module - Implements Module::cleanup()

Definition at line 64 of file module.c.

{
  struct LuaModuleData *mod_data = data;
 
  notify_free(&mod_data->notify);
 
  lua_State *lua_state = mod_data->lua_state;
  if (lua_state)
  {
    lua_close(lua_state);
    mod_data->lua_state = NULL;
  }
 
  FREE(&mod_data);
  return true;
}

Here is the call graph for this function:

Variable Documentation

LuaCommands

const struct Command LuaCommands[]

extern

List of NeoMutt commands to register.

Definition at line 151 of file commands.c.

                                     {
  // clang-format off
  { "lua", CMD_LUA, parse_lua,
        N_("Run a Lua expression or call a Lua function"),
        N_("lua <lua-command>"),
        "optionalfeatures.html#lua" },
  { "lua-source", CMD_LUA_SOURCE, parse_lua_source,
        N_("Execute a Lua script file"),
        N_("lua-source <filename>"),
        "optionalfeatures.html#lua" },
 
  { NULL, CMD_NONE, NULL, NULL, NULL, NULL, CF_NONE },
  // clang-format on
};

ModuleLua

const struct Module ModuleLua

Initial value:

= {
  MODULE_ID_LUA,
  "lua",
  lua_init,
  NULL, 
  NULL, 
  lua_commands_register,
  NULL, 
  NULL, 
  lua_cleanup,
}

Module for the Lua library.

Definition at line 84 of file module.c.

                                {
  MODULE_ID_LUA,
  "lua",
  lua_init,
  NULL, // config_define_types
  NULL, // config_define_variables
  lua_commands_register,
  NULL, // gui_init
  NULL, // gui_cleanup
  lua_cleanup,
};