rc.h File Reference

Parse lines from a runtime configuration (rc) file. More...

#include "core/lib.h"

Include dependency graph for rc.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
enum CommandResult	parse_rc_buffer (struct Buffer *line, struct Buffer *token, struct Buffer *err)
	Parse a line of user config.
enum CommandResult	parse_rc_line (const char *line, struct Buffer *err)
	Parse a line of user config.

Detailed Description

Parse lines from a runtime configuration (rc) file.

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 rc.h.

Function Documentation

parse_rc_buffer()

enum CommandResult parse_rc_buffer	(	struct Buffer *	line,
		struct Buffer *	token,
		struct Buffer *	err )

Parse a line of user config.

Parameters

line	config line to read
token	scratch buffer to be used by parser
err	where to write error messages

Return values

CommandResult

Result e.g. MUTT_CMD_SUCCESS

The reason for token is to avoid having to allocate and deallocate a lot of memory if we are parsing many lines. the caller can pass in the memory to use, which avoids having to create new space for every call to this function.

Definition at line 47 of file rc.c.

{
  if (buf_is_empty(line))
    return 0;
 
  enum CommandResult rc = MUTT_CMD_SUCCESS;
 
  buf_reset(err);
 
  /* Read from the beginning of line->data */
  buf_seek(line, 0);
 
  SKIPWS(line->dptr);
  while (*line->dptr)
  {
    if (*line->dptr == '#')
      break; /* rest of line is a comment */
    if (*line->dptr == ';')
    {
      line->dptr++;
      continue;
    }
    parse_extract_token(token, line, TOKEN_NO_FLAGS);
 
    bool match = false;
    const struct Command **cp = NULL;
    ARRAY_FOREACH(cp, &NeoMutt->commands)
    {
      const struct Command *cmd = *cp;
 
      if (mutt_str_equal(token->data, cmd->name))
      {
        mutt_debug(LL_DEBUG1, "NT_COMMAND: %s\n", cmd->name);
        rc = cmd->parse(token, line, cmd->data, err);
        if ((rc == MUTT_CMD_WARNING) || (rc == MUTT_CMD_ERROR) || (rc == MUTT_CMD_FINISH))
          goto finish; /* Propagate return code */
 
        notify_send(NeoMutt->notify, NT_COMMAND, 0, (void *) cmd);
        match = true;
        break; /* Continue with next command */
      }
    }
 
    if (!match)
    {
      buf_printf(err, _("%s: unknown command"), buf_string(token));
      rc = MUTT_CMD_ERROR;
      break; /* Ignore the rest of the line */
    }
  }
 
finish:
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

parse_rc_line()

enum CommandResult parse_rc_line	(	const char *	line,
		struct Buffer *	err )

Parse a line of user config.

Parameters

line	Config line to read
err	Where to write error messages

Return values

CommandResult

Result e.g. MUTT_CMD_SUCCESS

Definition at line 109 of file rc.c.

{
  if (!line || (*line == '\0'))
    return MUTT_CMD_ERROR;
 
  struct Buffer *line_buffer = buf_pool_get();
  struct Buffer *token = buf_pool_get();
 
  buf_strcpy(line_buffer, line);
 
  enum CommandResult rc = parse_rc_buffer(line_buffer, token, err);
 
  buf_pool_release(&line_buffer);
  buf_pool_release(&token);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function: