mutt_commands.h File Reference

Mapping from user command name to function. More...

#include <stdint.h>

Include dependency graph for mutt_commands.h:

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

Go to the source code of this file.

Data Structures
struct	Command
	A user-callable command. More...

Typedefs
typedef enum CommandResult(*	command_t) (struct Buffer *buf, struct Buffer *s, unsigned long data, struct Buffer *err)
	typedef command_t - Prototype for a function to parse a command More...

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
const struct Command *	mutt_command_get (const char *s)
	Get a Command by its name. More...
void	mutt_commands_apply (void *data, void(*application)(void *, const struct Command *))

Detailed Description

Mapping from user command name to function.

Authors

• Bernard Pratz

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

Typedef Documentation

command_t

typedef enum CommandResult(* command_t) (struct Buffer *buf, struct Buffer *s, unsigned long data, struct Buffer *err)

typedef command_t - Prototype for a function to parse a command

Parameters

buf	Temporary Buffer space
s	Buffer containing string to be parsed
data	Flags associated with the command
err	Buffer for error messages

Return values

CommandResult

Result e.g. MUTT_CMD_SUCCESS

Definition at line 49 of file mutt_commands.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 33 of file mutt_commands.h.

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

Function Documentation

mutt_command_get()

const struct Command* mutt_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 2618 of file init.c.

{
  for (int i = 0; Commands[i].name; i++)
    if (mutt_str_strcmp(s, Commands[i].name) == 0)
      return &Commands[i];
  return NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_commands_apply()

void mutt_commands_apply	(	void *	data,
		void(*)(void *, const struct Command *)	application
	)

Here is the caller graph for this function: