commands.c File Reference

Lua Commands. More...

#include "config.h"
#include <lauxlib.h>
#include <lua.h>
#include <lualib.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "lib.h"
#include "parse/lib.h"
#include "muttlib.h"
#include "version.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.
static enum CommandResult	parse_lua (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'lua' command - Implements Command::parse() -.
static enum CommandResult	parse_lua_source (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'lua-source' command - Implements Command::parse() -.
void	lua_init (void)
	Setup feature commands.
void	lua_cleanup (void)
	Clean up Lua.

Variables
lua_State *	LuaState
	Global Lua State.
static 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 437 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_init()

void lua_init

(

void

)

Setup feature commands.

Definition at line 128 of file commands.c.

{
  commands_register(&NeoMutt->commands, LuaCommands);
}

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 136 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 57 of file lua.c.

LuaCommands

const struct Command LuaCommands[]

static

Initial value:

= {
  
  { "lua",        parse_lua,        0 },
  { "lua-source", parse_lua_source, 0 },
  { NULL, NULL, 0 },
  
}

List of NeoMutt commands to register.

Definition at line 117 of file commands.c.

                                            {
  // clang-format off
  { "lua",        parse_lua,        0 },
  { "lua-source", parse_lua_source, 0 },
  { NULL, NULL, 0 },
  // clang-format on
};