commands.c File Reference

Setup NeoMutt Commands. More...

#include "config.h"
#include <stdio.h>
#include "mutt/lib.h"
#include "core/lib.h"
#include "parse/lib.h"
#include "ifdef.h"
#include "mailboxes.h"
#include "parse.h"
#include "setenv.h"
#include "source.h"

Include dependency graph for commands.c:

Go to the source code of this file.

Functions
const struct Command *	command_find_by_id (const struct CommandArray *ca, enum CommandId id)
	Find a NeoMutt Command by its CommandId.
const struct Command *	command_find_by_name (const struct CommandArray *ca, const char *name)
	Find a NeoMutt Command by its name.

Variables
const struct Command	CommandsCommands []
	General NeoMutt Commands.

Detailed Description

Setup NeoMutt 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.

Function Documentation

command_find_by_id()

const struct Command * command_find_by_id	(	const struct CommandArray *	ca,
		enum CommandId	id )

Find a NeoMutt Command by its CommandId.

Parameters

ca	Array of Commands
id	ID to find

Return values

ptr	Matching Command

Definition at line 120 of file commands.c.

{
  if (!ca || (id == CMD_NONE))
    return NULL;
 
  const struct Command **cp = NULL;
  ARRAY_FOREACH(cp, ca)
  {
    const struct Command *cmd = *cp;
 
    if (cmd->id == id)
      return cmd;
  }
 
  return NULL;
}

Here is the caller graph for this function:

command_find_by_name()

const struct Command * command_find_by_name	(	const struct CommandArray *	ca,
		const char *	name )

Find a NeoMutt Command by its name.

Parameters

ca	Array of Commands
name	Name to find

Return values

ptr	Matching Command

Note

If the name matches a Command Synonym, the real Command is returned.

Definition at line 145 of file commands.c.

{
  if (!ca || !name)
    return NULL;
 
  const struct Command **cp = NULL;
  ARRAY_FOREACH(cp, ca)
  {
    const struct Command *cmd = *cp;
 
    if (mutt_str_equal(cmd->name, name))
    {
      // If this is a synonym, look up the real Command
      if ((cmd->flags & CF_SYNONYM) && cmd->help)
      {
        const char *real_name = cmd->help;
        // Search for the real command (non-recursive, single pass)
        const struct Command **rp = NULL;
        ARRAY_FOREACH(rp, ca)
        {
          const struct Command *real_cmd = *rp;
          if (mutt_str_equal(real_cmd->name, real_name) && !(real_cmd->flags & CF_SYNONYM))
            return real_cmd;
        }
        return NULL; // Real command not found
      }
      return cmd;
    }
  }
 
  return NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

CommandsCommands

const struct Command CommandsCommands[]

General NeoMutt Commands.

Definition at line 43 of file commands.c.

                                          {
  // clang-format off
  { "cd", CMD_CD, parse_cd,
        N_("Change NeoMutt's current working directory"),
        N_("cd [ <directory> ]"),
        "configuration.html#cd" },
  { "echo", CMD_ECHO, parse_echo,
        N_("Print a message to the status line"),
        N_("echo <message>"),
        "advancedusage.html#echo" },
  { "finish", CMD_FINISH, parse_finish,
        N_("Stop reading current config file"),
        N_("finish"),
        "optionalfeatures.html#ifdef" },
  { "ifdef", CMD_IFDEF, parse_ifdef,
        N_("Conditionally include config commands if symbol defined"),
        N_("ifdef <symbol> '<config-command> [ <args> ... ]'"),
        "optionalfeatures.html#ifdef" },
  { "ifndef", CMD_IFNDEF, parse_ifdef,
        N_("Conditionally include if symbol is not defined"),
        N_("ifndef <symbol> '<config-command> [ <args> ... ]'"),
        "optionalfeatures.html#ifdef" },
  { "mailboxes", CMD_MAILBOXES, parse_mailboxes,
        N_("Define a list of mailboxes to watch"),
        N_("mailboxes [ -label <label> ] [ -notify ] [ -poll ] <mailbox> [ ... ]"),
        "configuration.html#mailboxes" },
  { "named-mailboxes", CMD_NAMED_MAILBOXES, parse_mailboxes,
        N_("Define a list of labelled mailboxes to watch"),
        N_("named-mailboxes [ -notify ] [ -poll ] <label> <mailbox> [ ... ]"),
        "configuration.html#mailboxes" },
  { "reset", CMD_RESET, parse_set,
        N_("Reset a config option to its initial value"),
        N_("reset <variable> [ <variable> ... ]"),
        "configuration.html#set" },
  { "set", CMD_SET, parse_set,
        N_("Set a config variable"),
        N_("set [ no | inv | & ] <variable> [?] | <variable> [=|+=|-=] <value> [...]"),
        "configuration.html#set" },
  { "setenv", CMD_SETENV, parse_setenv,
        N_("Set an environment variable"),
        N_("setenv { <variable>? | <variable>=<value> }"),
        "advancedusage.html#setenv" },
  { "source", CMD_SOURCE, parse_source,
        N_("Read and execute commands from a config file"),
        N_("source <filename> [ <filename> ... ]"),
        "configuration.html#source" },
  { "toggle", CMD_TOGGLE, parse_set,
        N_("Toggle the value of a boolean/quad config option"),
        N_("toggle <variable> [ ... ]"),
        "configuration.html#set" },
  { "unmailboxes", CMD_UNMAILBOXES, parse_unmailboxes,
        N_("Remove mailboxes from the watch list"),
        N_("unmailboxes { * | <mailbox> ... }"),
        "configuration.html#mailboxes" },
  { "unset", CMD_UNSET, parse_set,
        N_("Reset a config option to false/empty"),
        N_("unset <variable> [ <variable> ... ]"),
        "configuration.html#set" },
  { "unsetenv", CMD_UNSETENV, parse_setenv,
        N_("Unset an environment variable"),
        N_("unsetenv <variable>"),
        "advancedusage.html#setenv" },
  { "version", CMD_VERSION, parse_version,
        N_("Show NeoMutt version and build information"),
        N_("version"),
        "advancedusage.html#version" },
 
  { NULL, CMD_NONE, NULL, NULL, NULL, NULL, CF_NONE },
  // clang-format on
};