command.c File Reference

NeoMutt Commands. More...

#include "config.h"
#include <stddef.h>
#include "mutt/lib.h"
#include "command.h"

Include dependency graph for command.c:

Go to the source code of this file.

Functions
static int	commands_sort (const void *a, const void *b, void *sdata)
	Compare two commands by name - Implements sort_t -.
bool	commands_register (struct CommandArray *ca, const struct Command *cmds)
	Add commands to Commands array.
void	commands_clear (struct CommandArray *ca)
	Clear an Array of Commands.
const struct Command *	commands_get (struct CommandArray *ca, const char *name)
	Get a Command by its name.

Detailed Description

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

Function Documentation

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:

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_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: