lua_2commands_8c_source.html

#ifndef LUA_COMPAT_ALL

#define LUA_COMPAT_ALL

#endif

#ifndef LUA_COMPAT_5_1

#define LUA_COMPAT_5_1

#endif


#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"


extern lua_State *LuaState;


bool lua_init_state(lua_State **l);


enum CommandResult parse_lua(const struct Command *cmd, struct Buffer *line,

                             const struct ParseContext *pc, struct ParseError *pe)

{

  struct Buffer *err = pe->message;


  if (!MoreArgs(line))

  {

    buf_printf(err, _("%s: too few arguments"), cmd->name);

    return MUTT_CMD_WARNING;

  }


  // From here on, use the remainder of `line`, raw

  enum CommandResult rc = MUTT_CMD_ERROR;


  lua_init_state(&LuaState);

  mutt_debug(LL_DEBUG2, "%s\n", line->dptr);


  if (luaL_dostring(LuaState, line->dptr) != LUA_OK)

  {

    mutt_debug(LL_DEBUG2, "%s -> failure\n", line->dptr);

    buf_printf(err, "%s: %s", line->dptr, lua_tostring(LuaState, -1));

    /* pop error message from the stack */

    lua_pop(LuaState, 1);

    goto done;

  }

  mutt_debug(LL_DEBUG2, "%s -> success\n", line->dptr);

  buf_reset(line); // Clear the rest of the line


  rc = MUTT_CMD_SUCCESS;


done:

  return rc;

}


enum CommandResult parse_lua_source(const struct Command *cmd, struct Buffer *line,

                                    const struct ParseContext *pc, struct ParseError *pe)

{

  struct Buffer *err = pe->message;


  if (!MoreArgs(line))

  {

    buf_printf(err, _("%s: too few arguments"), cmd->name);

    return MUTT_CMD_WARNING;

  }


  struct Buffer *token = buf_pool_get();

  enum CommandResult rc = MUTT_CMD_ERROR;


  mutt_debug(LL_DEBUG2, "enter\n");


  lua_init_state(&LuaState);


  if (parse_extract_token(token, line, TOKEN_NO_FLAGS) != 0)

  {

    buf_printf(err, _("source: error at %s"), line->dptr);

    goto done;

  }

  if (MoreArgs(line))

  {

    buf_printf(err, _("%s: too many arguments"), cmd->name);

    rc = MUTT_CMD_WARNING;

    goto done;

  }


  expand_path(token, false);


  if (luaL_dofile(LuaState, buf_string(token)) != LUA_OK)

  {

    mutt_error(_("Couldn't source lua source: %s"), lua_tostring(LuaState, -1));

    lua_pop(LuaState, 1);

    goto done;

  }


  rc = MUTT_CMD_SUCCESS;


done:

  buf_pool_release(&token);

  return rc;

}


const struct Command LuaCommands[] = {

  // 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

};


void lua_cleanup(void)

{

  if (LuaState)

  {

    lua_close(LuaState);

    LuaState = NULL;

  }

}


buf_printf
int buf_printf(struct Buffer *buf, const char *fmt,...)
Format a string overwriting a Buffer.
Definition buffer.c:161

buf_reset
void buf_reset(struct Buffer *buf)
Reset an existing Buffer.
Definition buffer.c:76

buf_string
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition buffer.h:96

CF_NO_FLAGS
#define CF_NO_FLAGS
No flags are set.
Definition command.h:48

CMD_LUA_SOURCE
@ CMD_LUA_SOURCE
:lua-source
Definition command.h:89

CMD_LUA
@ CMD_LUA
:lua
Definition command.h:88

CMD_NONE
@ CMD_NONE
No Command.
Definition command.h:59

CommandResult
CommandResult
Error codes for command_t parse functions.
Definition command.h:37

MUTT_CMD_SUCCESS
@ MUTT_CMD_SUCCESS
Success: Command worked.
Definition command.h:40

MUTT_CMD_ERROR
@ MUTT_CMD_ERROR
Error: Can't help the user.
Definition command.h:38

MUTT_CMD_WARNING
@ MUTT_CMD_WARNING
Warning: Help given to the user.
Definition command.h:39

lib.h
Convenience wrapper for the core headers.

parse_extract_token
int parse_extract_token(struct Buffer *dest, struct Buffer *line, TokenFlags flags)
Extract one token from a string.
Definition extract.c:49

MoreArgs
#define MoreArgs(buf)
Definition extract.h:31

TOKEN_NO_FLAGS
#define TOKEN_NO_FLAGS
No flags are set.
Definition extract.h:45

parse_lua_source
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() -.
Definition commands.c:97

parse_lua
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() -.
Definition commands.c:57

mutt_error
#define mutt_error(...)
Definition logging2.h:94

mutt_debug
#define mutt_debug(LEVEL,...)
Definition logging2.h:91

LL_DEBUG2
@ LL_DEBUG2
Log at debug level 2.
Definition logging2.h:46

lua_init_state
bool lua_init_state(lua_State **l)
Initialise a Lua State.
Definition lua.c:446

LuaState
lua_State * LuaState
Global Lua State.
Definition lua.c:56

lua_cleanup
void lua_cleanup(void)
Clean up Lua.
Definition commands.c:164

LuaCommands
const struct Command LuaCommands[]
List of NeoMutt commands to register.
Definition commands.c:146

lib.h
Integrated Lua scripting.

lib.h
Convenience wrapper for the library headers.

N_
#define N_(a)
Definition message.h:32

_
#define _(a)
Definition message.h:28

expand_path
void expand_path(struct Buffer *buf, bool regex)
Create the canonical path.
Definition muttlib.c:122

muttlib.h
Some miscellaneous functions.

lib.h
Text parsing functions.

buf_pool_get
struct Buffer * buf_pool_get(void)
Get a Buffer from the pool.
Definition pool.c:91

buf_pool_release
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition pool.c:111

Buffer
String manipulation buffer.
Definition buffer.h:36

Buffer::dptr
char * dptr
Current read/write position.
Definition buffer.h:38

Command
Definition command.h:158

Command::name
const char * name
Name of the Command.
Definition command.h:159

ParseContext
Context for config parsing (history/backtrace)
Definition pcontext.h:34

ParseError
Detailed error information from config parsing.
Definition perror.h:34

ParseError::message
struct Buffer * message
Error message.
Definition perror.h:35