commands.h File Reference

Setup NeoMutt Commands. More...

#include "core/lib.h"

Include dependency graph for commands.h:

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

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.

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

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 146 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 171 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: