commands.c File Reference

Lua Commands. More...

#include "config.h"
#include <lauxlib.h>
#include <lua.h>
#include <stdbool.h>
#include <stdio.h>
#include "mutt/lib.h"
#include "core/lib.h"
#include "lib.h"
#include "parse/lib.h"
#include "muttlib.h"

Include dependency graph for commands.c:

Go to the source code of this file.

Macros
#define	LUA_COMPAT_ALL
#define	LUA_COMPAT_5_1

Functions
bool	lua_init_state (lua_State **l)
	Initialise a Lua State.
enum CommandResult	parse_lua (const struct Command *cmd, struct Buffer *line, const struct ParseContext *pc, struct ParseError *pe)
	Parse the 'lua' command - Implements Command::parse() -.
enum CommandResult	parse_lua_source (const struct Command *cmd, struct Buffer *line, const struct ParseContext *pc, struct ParseError *pe)
	Parse the 'lua-source' command - Implements Command::parse() -.
void	lua_cleanup (void)
	Clean up Lua.

Variables
lua_State *	LuaState
	Global Lua State.
const struct Command	LuaCommands []
	List of NeoMutt commands to register.

Detailed Description

Lua Commands.

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 commands.c.

Macro Definition Documentation

LUA_COMPAT_ALL

#define LUA_COMPAT_ALL

Definition at line 30 of file commands.c.

LUA_COMPAT_5_1

#define LUA_COMPAT_5_1

Definition at line 33 of file commands.c.

Function Documentation

lua_init_state()

bool lua_init_state

(

lua_State **

l

)

Initialise a Lua State.

Parameters

[out]

l

Lua State

Return values

true	Successful

Definition at line 440 of file lua.c.

{
  if (!l)
    return false;
  if (*l)
    return true;
 
  mutt_debug(LL_DEBUG2, "enter\n");
  *l = luaL_newstate();
 
  if (!*l)
  {
    mutt_error(_("Error: Couldn't load the lua interpreter"));
    return false;
  }
 
  lua_atpanic(*l, lua_handle_panic);
 
  /* load various Lua libraries */
  luaL_openlibs(*l);
  lua_expose_mutt(*l);
 
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

lua_cleanup()

void lua_cleanup

(

void

)

Clean up Lua.

Definition at line 167 of file commands.c.

{
  if (LuaState)
  {
    lua_close(LuaState);
    LuaState = NULL;
  }
}

Here is the caller graph for this function:

Variable Documentation

LuaState

lua_State* LuaState

extern

Global Lua State.

Definition at line 56 of file lua.c.

LuaCommands

const struct Command LuaCommands[]

Initial value:

= {
  
  { "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_NO_FLAGS },
  
}

List of NeoMutt commands to register.

Definition at line 149 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_NO_FLAGS },
  // clang-format on
};