command.h File Reference

NeoMutt commands API. More...

#include "config.h"
#include <stdbool.h>
#include <stdint.h>
#include "mutt/lib.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
	ARRAY_HEAD (CommandArray, const struct Command *)
const struct Command *	commands_get (struct CommandArray *ca, const char *name)
	Get a Command by its name.
void	commands_clear (struct CommandArray *ca)
	Clear an Array of Commands.
bool	commands_init (void)
	Initialize commands array and register default commands.
bool	commands_register (struct CommandArray *ca, const struct Command *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 34 of file command.h.

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

Function Documentation

ARRAY_HEAD()

ARRAY_HEAD	(	CommandArray	,
		const struct Command *
	)

commands_get()

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

Get a Command by its name.

Parameters

ca	Command Array
name	Command name to lookup

Return values

ptr	Success, Command
NULL	Error, no such command

Definition at line 82 of file command.c.

{
  const struct Command **cp = NULL;
  ARRAY_FOREACH(cp, ca)
  {
    const struct Command *cmd = *cp;
 
    if (mutt_str_equal(name, cmd->name))
      return cmd;
  }
  return NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

commands_clear()

void commands_clear

(

struct CommandArray *

ca

)

Clear an Array of Commands.

Note

The Array itself is not freed

Definition at line 70 of file command.c.

{
  ARRAY_FREE(ca);
}

Here is the caller graph for this function:

commands_init()

bool commands_init

(

void

)

Initialize commands array and register default commands.

Definition at line 1748 of file commands.c.

{
  return commands_register(&NeoMutt->commands, MuttCommands);
}

Here is the call graph for this function:

Here is the caller graph for this function:

commands_register()

bool commands_register	(	struct CommandArray *	ca,
		const struct Command *	cmds
	)

Add commands to Commands array.

Parameters

ca	Command Array
cmds	New Commands to add

Return values

true

Success

Definition at line 51 of file command.c.

{
  if (!ca || !cmds)
    return false;
 
  for (int i = 0; cmds[i].name; i++)
  {
    ARRAY_ADD(ca, &cmds[i]);
  }
  ARRAY_SORT(ca, commands_sort, NULL);
 
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function: