command.h File Reference

NeoMutt commands API. More...

#include "config.h"
#include <stddef.h>
#include <stdint.h>

Include dependency graph for command.h:

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

Go to the source code of this file.

Data Structures
struct	Command

Enumerations
enum	CommandResult { MUTT_CMD_ERROR = -1 , MUTT_CMD_WARNING = -2 , MUTT_CMD_SUCCESS = 0 , MUTT_CMD_FINISH = 1 }
	Error codes for command_t parse functions. More...

Functions
struct Command *	command_get (const char *s)
	Get a Command by its name.
size_t	commands_array (struct Command **first)
	Get Commands array.
void	commands_cleanup (void)
	Free Commands array.
void	commands_init (void)
	Initialize commands array and register default commands.
void	commands_register (const struct Command *cmds, const size_t num_cmds)
	Add commands to Commands array.

Detailed Description

NeoMutt commands API.

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

Enumeration Type Documentation

CommandResult

enum CommandResult

Error codes for command_t parse functions.

Enumerator
MUTT_CMD_ERROR	Error: Can't help the user.
MUTT_CMD_WARNING	Warning: Help given to the user.
MUTT_CMD_SUCCESS	Success: Command worked.
MUTT_CMD_FINISH	Finish: Stop processing this file.

Definition at line 35 of file command.h.

{
  MUTT_CMD_ERROR   = -1, 
  MUTT_CMD_WARNING = -2, 
  MUTT_CMD_SUCCESS =  0, 
  MUTT_CMD_FINISH  =  1  
};

Function Documentation

command_get()

struct Command * command_get

(

const char *

s

)

Get a Command by its name.

Parameters

s	Command string to lookup

Return values

ptr	Success, Command
NULL	Error, no such command

Definition at line 87 of file command.c.

{
  struct Command *cmd = NULL;
  ARRAY_FOREACH(cmd, &Commands)
  {
    if (mutt_str_equal(s, cmd->name))
      return cmd;
  }
  return NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

commands_array()

size_t commands_array

(

struct Command **

first

)

Get Commands array.

Parameters

first

Set to first element of Commands array

Return values

num	Size of Commands array

Definition at line 75 of file command.c.

{
  *first = ARRAY_FIRST(&Commands);
  return ARRAY_SIZE(&Commands);
}

Here is the caller graph for this function:

commands_cleanup()

void commands_cleanup

(

void

)

Free Commands array.

Definition at line 65 of file command.c.

{
  ARRAY_FREE(&Commands);
}

Here is the caller graph for this function:

commands_init()

void commands_init

(

void

)

Initialize commands array and register default commands.

Definition at line 1723 of file commands.c.

{
  commands_register(MuttCommands, mutt_array_size(MuttCommands));
}

Here is the call graph for this function:

Here is the caller graph for this function:

commands_register()

void commands_register	(	const struct Command *	cmds,
		const size_t	num_cmds
	)

Add commands to Commands array.

Parameters

cmds	Array of Commands
num_cmds	Number of Commands in the Array

Definition at line 53 of file command.c.

{
  for (int i = 0; i < num_cmds; i++)
  {
    ARRAY_ADD(&Commands, cmds[i]);
  }
  ARRAY_SORT(&Commands, commands_sort, NULL);
}

Here is the call graph for this function:

Here is the caller graph for this function: