set.c File Reference

Parse the 'set' command. More...

#include "config.h"
#include <stdbool.h>
#include <stdio.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "mutt.h"
#include "set.h"
#include "dump.h"
#include "extract.h"
#include "muttlib.h"
#include "perror.h"

Include dependency graph for set.c:

Go to the source code of this file.

Functions
void	command_set_expand_value (int type, struct Buffer *value)
	Expand special characters.
enum CommandResult	command_set_set (struct Buffer *name, struct Buffer *value, struct Buffer *err)
	Set a variable to the given value.
enum CommandResult	command_set_increment (struct Buffer *name, struct Buffer *value, struct Buffer *err)
	Increment a variable by a value.
enum CommandResult	command_set_decrement (struct Buffer *name, struct Buffer *value, struct Buffer *err)
	Decrement a variable by a value.
enum CommandResult	command_set_unset (struct Buffer *name, struct Buffer *err)
	Unset a variable.
enum CommandResult	command_set_reset (struct Buffer *name, struct Buffer *err)
	Reset a variable.
enum CommandResult	command_set_toggle (struct Buffer *name, struct Buffer *err)
	Toggle a boolean, quad, or number variable.
enum CommandResult	command_set_query (struct Buffer *name, struct Buffer *err)
	Query a variable.
enum CommandResult	parse_set (const struct Command *cmd, struct Buffer *line, const struct ParseContext *pc, struct ParseError *pe)
	Parse the 'set' family of commands - Implements Command::parse() -.

Detailed Description

Parse the 'set' command.

Authors

• Richard Russon
• Dennis Schön
• Rayford Shireman

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

Function Documentation

command_set_expand_value()

void command_set_expand_value	(	int	type,
		struct Buffer *	value )

Expand special characters.

Parameters

	type	Type of the value, see note below
[in,out]	value	Buffer containing the value, will also contain the final result

Precondition

value is not NULL

Expand any special characters in paths, mailboxes or commands. e.g. ~ ($HOME), + ($folder)

The type influences which expansions are done.

Note

The type must be the full HashElem.type, not the sanitized CONFIG_TYPE(HashElem.type)

The value is expanded in-place

Definition at line 59 of file set.c.

{
  ASSERT(value);
  if (CONFIG_TYPE(type) == DT_PATH)
  {
    if (type & (D_PATH_DIR | D_PATH_FILE))
      expand_path(value, false);
    else
      mutt_path_tilde(value, NeoMutt->home_dir);
  }
  else if (IS_MAILBOX(type))
  {
    expand_path(value, false);
  }
  else if (IS_COMMAND(type))
  {
    struct Buffer *scratch = buf_pool_get();
    buf_copy(scratch, value);
 
    if (!mutt_str_equal(value->data, "builtin"))
    {
      expand_path(scratch, false);
    }
    buf_reset(value);
    buf_addstr(value, buf_string(scratch));
    buf_pool_release(&scratch);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

command_set_set()

enum CommandResult command_set_set	(	struct Buffer *	name,
		struct Buffer *	value,
		struct Buffer *	err )

Set a variable to the given value.

Parameters

[in]	name	Name of the config; must not be NULL
[in]	value	Value the config should be set to
[out]	err	Buffer for error messages

Return values

CommandResult

Result e.g. MUTT_CMD_SUCCESS

Precondition

name is not NULL

value is not NULL

This implements "set foo = bar" command where "bar" is present.

Definition at line 100 of file set.c.

{
  ASSERT(name);
  ASSERT(value);
  struct HashElem *he = cs_subset_lookup(NeoMutt->sub, name->data);
  if (!he)
  {
    // In case it is a my_var, we have to create it
    if (mutt_str_startswith(name->data, "my_"))
    {
      struct ConfigDef my_cdef = { 0 };
      my_cdef.name = name->data;
      my_cdef.type = DT_MYVAR;
      he = cs_create_variable(NeoMutt->sub->cs, &my_cdef, err);
      if (!he)
        return MUTT_CMD_ERROR; // LCOV_EXCL_LINE
    }
    else
    {
      buf_printf(err, _("Unknown option %s"), name->data);
      return MUTT_CMD_ERROR;
    }
  }
 
  if (he->type & D_INTERNAL_DEPRECATED)
  {
    mutt_warning(_("Option %s is deprecated"), name->data);
    return MUTT_CMD_SUCCESS;
  }
  int rc = CSR_ERR_CODE;
 
  if (CONFIG_TYPE(he->type) == DT_MYVAR)
  {
    // my variables do not expand their value
    rc = cs_subset_he_string_set(NeoMutt->sub, he, value->data, err);
  }
  else
  {
    command_set_expand_value(he->type, value);
    rc = cs_subset_he_string_set(NeoMutt->sub, he, value->data, err);
  }
  if (CSR_RESULT(rc) != CSR_SUCCESS)
  {
    if (rc & CSR_INV_WARNING)
      return MUTT_CMD_WARNING;
    return MUTT_CMD_ERROR;
  }
 
  return MUTT_CMD_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

command_set_increment()

enum CommandResult command_set_increment	(	struct Buffer *	name,
		struct Buffer *	value,
		struct Buffer *	err )

Increment a variable by a value.

Parameters

[in]	name	Name of the config; must not be NULL
[in]	value	Value the config should be incremented by
[out]	err	Buffer for error messages

Return values

CommandResult

Result e.g. MUTT_CMD_SUCCESS

Precondition

name is not NULL

value is not NULL

This implements "set foo += bar" command where "bar" is present.

Definition at line 164 of file set.c.

{
  ASSERT(name);
  ASSERT(value);
  struct HashElem *he = cs_subset_lookup(NeoMutt->sub, name->data);
  if (!he)
  {
    // In case it is a my_var, we have to create it
    if (mutt_str_startswith(name->data, "my_"))
    {
      struct ConfigDef my_cdef = { 0 };
      my_cdef.name = name->data;
      my_cdef.type = DT_MYVAR;
      he = cs_create_variable(NeoMutt->sub->cs, &my_cdef, err);
      if (!he)
        return MUTT_CMD_ERROR; // LCOV_EXCL_LINE
    }
    else
    {
      buf_printf(err, _("Unknown option %s"), name->data);
      return MUTT_CMD_ERROR;
    }
  }
 
  if (he->type & D_INTERNAL_DEPRECATED)
  {
    mutt_warning(_("Option %s is deprecated"), name->data);
    return MUTT_CMD_SUCCESS;
  }
 
  int rc = CSR_ERR_CODE;
 
  if (CONFIG_TYPE(he->type) == DT_MYVAR)
  {
    // my variables do not expand their value
    rc = cs_subset_he_string_plus_equals(NeoMutt->sub, he, value->data, err);
  }
  else
  {
    command_set_expand_value(he->type, value);
    rc = cs_subset_he_string_plus_equals(NeoMutt->sub, he, value->data, err);
  }
  if (CSR_RESULT(rc) != CSR_SUCCESS)
    return MUTT_CMD_ERROR;
 
  return MUTT_CMD_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

command_set_decrement()

enum CommandResult command_set_decrement	(	struct Buffer *	name,
		struct Buffer *	value,
		struct Buffer *	err )

Decrement a variable by a value.

Parameters

[in]	name	Name of the config; must not be NULL
[in]	value	Value the config should be decremented by
[out]	err	Buffer for error messages

Return values

CommandResult

Result e.g. MUTT_CMD_SUCCESS

Precondition

name is not NULL

value is not NULL

This implements "set foo -= bar" command where "bar" is present.

Definition at line 225 of file set.c.

{
  ASSERT(name);
  ASSERT(value);
  struct HashElem *he = cs_subset_lookup(NeoMutt->sub, name->data);
  if (!he)
  {
    buf_printf(err, _("Unknown option %s"), name->data);
    return MUTT_CMD_ERROR;
  }
 
  if (he->type & D_INTERNAL_DEPRECATED)
  {
    mutt_warning(_("Option %s is deprecated"), name->data);
    return MUTT_CMD_SUCCESS;
  }
 
  command_set_expand_value(he->type, value);
  int rc = cs_subset_he_string_minus_equals(NeoMutt->sub, he, value->data, err);
  if (CSR_RESULT(rc) != CSR_SUCCESS)
    return MUTT_CMD_ERROR;
 
  return MUTT_CMD_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

command_set_unset()

enum CommandResult command_set_unset	(	struct Buffer *	name,
		struct Buffer *	err )

Unset a variable.

Parameters

[in]	name	Name of the config variable to be unset
[out]	err	Buffer for error messages

Return values

CommandResult

Result e.g. MUTT_CMD_SUCCESS

Precondition

name is not NULL

This implements "unset foo"

Definition at line 261 of file set.c.

{
  ASSERT(name);
  struct HashElem *he = cs_subset_lookup(NeoMutt->sub, name->data);
  if (!he)
  {
    buf_printf(err, _("Unknown option %s"), name->data);
    return MUTT_CMD_ERROR;
  }
 
  if (he->type & D_INTERNAL_DEPRECATED)
  {
    mutt_warning(_("Option %s is deprecated"), name->data);
    return MUTT_CMD_SUCCESS;
  }
 
  int rc = CSR_ERR_CODE;
  if (CONFIG_TYPE(he->type) == DT_MYVAR)
  {
    rc = cs_subset_he_delete(NeoMutt->sub, he, err);
  }
  else if ((CONFIG_TYPE(he->type) == DT_BOOL) || (CONFIG_TYPE(he->type) == DT_QUAD))
  {
    rc = cs_subset_he_native_set(NeoMutt->sub, he, false, err);
  }
  else
  {
    rc = cs_subset_he_string_set(NeoMutt->sub, he, NULL, err);
  }
  if (CSR_RESULT(rc) != CSR_SUCCESS)
    return MUTT_CMD_ERROR; // LCOV_EXCL_LINE
 
  return MUTT_CMD_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

command_set_reset()

enum CommandResult command_set_reset	(	struct Buffer *	name,
		struct Buffer *	err )

Reset a variable.

Parameters

[in]	name	Name of the config variable to be reset
[out]	err	Buffer for error messages

Return values

CommandResult

Result e.g. MUTT_CMD_SUCCESS

Precondition

name is not NULL

This implements "reset foo" (foo being any config variable) and "reset all".

Definition at line 306 of file set.c.

{
  ASSERT(name);
  // Handle special "reset all" syntax
  if (mutt_str_equal(name->data, "all"))
  {
    struct HashElemArray hea = get_elem_list(NeoMutt->sub->cs, GEL_ALL_CONFIG);
    struct HashElem **hep = NULL;
    ARRAY_FOREACH(hep, &hea)
    {
      struct HashElem *he = *hep;
      if (CONFIG_TYPE(he->type) == DT_MYVAR)
        cs_subset_he_delete(NeoMutt->sub, he, err);
      else
        cs_subset_he_reset(NeoMutt->sub, he, NULL);
    }
 
    ARRAY_FREE(&hea);
    return MUTT_CMD_SUCCESS;
  }
 
  struct HashElem *he = cs_subset_lookup(NeoMutt->sub, name->data);
  if (!he)
  {
    buf_printf(err, _("Unknown option %s"), name->data);
    return MUTT_CMD_ERROR;
  }
 
  if (he->type & D_INTERNAL_DEPRECATED)
  {
    mutt_warning(_("Option %s is deprecated"), name->data);
    return MUTT_CMD_SUCCESS;
  }
 
  int rc = CSR_ERR_CODE;
  if (CONFIG_TYPE(he->type) == DT_MYVAR)
  {
    rc = cs_subset_he_delete(NeoMutt->sub, he, err);
  }
  else
  {
    rc = cs_subset_he_reset(NeoMutt->sub, he, err);
  }
  if (CSR_RESULT(rc) != CSR_SUCCESS)
    return MUTT_CMD_ERROR; // LCOV_EXCL_LINE
 
  return MUTT_CMD_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

command_set_toggle()

enum CommandResult command_set_toggle	(	struct Buffer *	name,
		struct Buffer *	err )

Toggle a boolean, quad, or number variable.

Parameters

[in]	name	Name of the config variable to be toggled
[out]	err	Buffer for error messages

Return values

CommandResult

Result e.g. MUTT_CMD_SUCCESS

Precondition

name is not NULL

This implements "toggle foo".

Definition at line 365 of file set.c.

{
  ASSERT(name);
  struct HashElem *he = cs_subset_lookup(NeoMutt->sub, name->data);
  if (!he)
  {
    buf_printf(err, _("Unknown option %s"), name->data);
    return MUTT_CMD_ERROR;
  }
 
  if (he->type & D_INTERNAL_DEPRECATED)
  {
    mutt_warning(_("Option %s is deprecated"), name->data);
    return MUTT_CMD_SUCCESS;
  }
 
  if (CONFIG_TYPE(he->type) == DT_BOOL)
  {
    bool_he_toggle(NeoMutt->sub, he, err);
  }
  else if (CONFIG_TYPE(he->type) == DT_QUAD)
  {
    quad_he_toggle(NeoMutt->sub, he, err);
  }
  else if (CONFIG_TYPE(he->type) == DT_NUMBER)
  {
    number_he_toggle(NeoMutt->sub, he, err);
  }
  else
  {
    buf_printf(err, _("Command '%s' can only be used with bool/quad variables"), "toggle");
    return MUTT_CMD_ERROR;
  }
  return MUTT_CMD_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

command_set_query()

enum CommandResult command_set_query	(	struct Buffer *	name,
		struct Buffer *	err )

Query a variable.

Parameters

[in]	name	Name of the config variable to queried
[out]	err	Buffer where the pretty printed result will be written to. On failure contains the error message.

Return values

CommandResult

Result e.g. MUTT_CMD_SUCCESS

Precondition

name is not NULL

This implements "set foo?". The buffer err will contain something like "set foo = bar".

Definition at line 411 of file set.c.

{
  ASSERT(name);
  // In the interactive case (outside of the initial parsing of neomuttrc) we
  // support additional syntax: "set" (no arguments) and "set all".
  // If not in interactive mode, we recognise them but do nothing.
 
  // Handle "set" (no arguments), i.e. show list of changed variables.
  if (buf_is_empty(name))
  {
    if (StartupComplete)
      return set_dump(GEL_CHANGED_CONFIG, err);
    else
      return MUTT_CMD_SUCCESS;
  }
  // Handle special "set all" syntax
  if (mutt_str_equal(name->data, "all"))
  {
    if (StartupComplete)
      return set_dump(GEL_ALL_CONFIG, err);
    else
      return MUTT_CMD_SUCCESS;
  }
 
  struct HashElem *he = cs_subset_lookup(NeoMutt->sub, name->data);
  if (!he)
  {
    buf_printf(err, _("Unknown option %s"), name->data);
    return MUTT_CMD_ERROR;
  }
 
  if (he->type & D_INTERNAL_DEPRECATED)
  {
    mutt_warning(_("Option %s is deprecated"), name->data);
    return MUTT_CMD_SUCCESS;
  }
 
  buf_addstr(err, name->data);
  buf_addch(err, '=');
  struct Buffer *value = buf_pool_get();
  int rc = cs_subset_he_string_get(NeoMutt->sub, he, value);
  if (CSR_RESULT(rc) != CSR_SUCCESS)
  {
    // LCOV_EXCL_START
    buf_reset(err);
    buf_addstr(err, value->data);
    buf_pool_release(&value);
    return MUTT_CMD_ERROR;
    // LCOV_EXCL_STOP
  }
  if (CONFIG_TYPE(he->type) == DT_PATH)
    pretty_mailbox(value);
 
  const int type = CONFIG_TYPE(he->type);
  if ((type != DT_BOOL) && (type != DT_NUMBER) && (type != DT_LONG) &&
      (type != DT_QUAD) && (type != DT_ENUM) && (type != DT_SORT))
  {
    pretty_var(value->data, err);
  }
  else
  {
    buf_addstr(err, value->data);
  }
  buf_pool_release(&value);
 
  return MUTT_CMD_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function: