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

Macros
#define	CF_NO_FLAGS   0
	No flags are set.
#define	CF_SYNONYM   (1 << 0)
	Command is a synonym for another command.
#define	CF_DEPRECATED   (1 << 1)
	Command is deprecated.
#define	CMD_NO_DATA   0
	Convenience symbol.

Typedefs
typedef uint8_t	CommandFlags
	Special characters that end a text string.

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...
enum	CommandId {   CMD_NONE = 0 , CMD_ACCOUNT_HOOK , CMD_ALIAS , CMD_ALTERNATES ,   CMD_ALTERNATIVE_ORDER , CMD_APPEND_HOOK , CMD_ATTACHMENTS , CMD_AUTO_VIEW ,   CMD_BIND , CMD_CD , CMD_CHARSET_HOOK , CMD_CLOSE_HOOK ,   CMD_COLOR , CMD_CRYPT_HOOK , CMD_ECHO , CMD_EXEC ,   CMD_FCC_HOOK , CMD_FCC_SAVE_HOOK , CMD_FINISH , CMD_FOLDER_HOOK ,   CMD_GROUP , CMD_HEADER_ORDER , CMD_HOOKS , CMD_ICONV_HOOK ,   CMD_IFDEF , CMD_IFNDEF , CMD_IGNORE , CMD_INDEX_FORMAT_HOOK ,   CMD_LISTS , CMD_LUA , CMD_LUA_SOURCE , CMD_MACRO ,   CMD_MAILBOXES , CMD_MAILTO_ALLOW , CMD_MBOX_HOOK , CMD_MESSAGE_HOOK ,   CMD_MIME_LOOKUP , CMD_MONO , CMD_MY_HEADER , CMD_NAMED_MAILBOXES ,   CMD_NOSPAM , CMD_OPEN_HOOK , CMD_PUSH , CMD_REPLY_HOOK ,   CMD_RESET , CMD_SAVE_HOOK , CMD_SCORE , CMD_SEND2_HOOK ,   CMD_SEND_HOOK , CMD_SET , CMD_SETENV , CMD_SHUTDOWN_HOOK ,   CMD_SIDEBAR_PIN , CMD_SIDEBAR_UNPIN , CMD_SOURCE , CMD_SPAM ,   CMD_STARTUP_HOOK , CMD_SUBJECT_REGEX , CMD_SUBSCRIBE , CMD_SUBSCRIBE_TO ,   CMD_TAG_FORMATS , CMD_TAG_TRANSFORMS , CMD_TIMEOUT_HOOK , CMD_TOGGLE ,   CMD_UNALIAS , CMD_UNALTERNATES , CMD_UNALTERNATIVE_ORDER , CMD_UNATTACHMENTS ,   CMD_UNAUTO_VIEW , CMD_UNBIND , CMD_UNCOLOR , CMD_UNGROUP ,   CMD_UNHEADER_ORDER , CMD_UNHOOK , CMD_UNIGNORE , CMD_UNLISTS ,   CMD_UNMACRO , CMD_UNMAILBOXES , CMD_UNMAILTO_ALLOW , CMD_UNMIME_LOOKUP ,   CMD_UNMONO , CMD_UNMY_HEADER , CMD_UNSCORE , CMD_UNSET ,   CMD_UNSETENV , CMD_UNSUBJECT_REGEX , CMD_UNSUBSCRIBE , CMD_UNSUBSCRIBE_FROM ,   CMD_VERSION }
	ID of Command. 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_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.

Macro Definition Documentation

CF_NO_FLAGS

#define CF_NO_FLAGS   0

No flags are set.

Definition at line 46 of file command.h.

CF_SYNONYM

#define CF_SYNONYM   (1 << 0)

Command is a synonym for another command.

Definition at line 47 of file command.h.

CF_DEPRECATED

#define CF_DEPRECATED   (1 << 1)

Command is deprecated.

Definition at line 48 of file command.h.

CMD_NO_DATA

#define CMD_NO_DATA   0

Convenience symbol.

Definition at line 148 of file command.h.

Typedef Documentation

CommandFlags

typedef uint8_t CommandFlags

Special characters that end a text string.

Flags, e.g. CF_NO_FLAGS

Definition at line 45 of 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  
};

CommandId

enum CommandId

ID of Command.

All the Commands in NeoMutt.

Enumerator
CMD_NONE	No Command.
CMD_ACCOUNT_HOOK	:account-hook
CMD_ALIAS	:alias See also CMD_UNALIAS
CMD_ALTERNATES	:alternates See also CMD_UNALTERNATES
CMD_ALTERNATIVE_ORDER	:alternative-order See also CMD_UNALTERNATIVE_ORDER, AlternativeOrderList
CMD_APPEND_HOOK	:append-hook See also CMD_CLOSE_HOOK, CMD_OPEN_HOOK
CMD_ATTACHMENTS	:attachments See also CMD_UNATTACHMENTS
CMD_AUTO_VIEW	:auto-view See also CMD_UNAUTO_VIEW, AutoViewList
CMD_BIND	:bind See also CMD_UNBIND
CMD_CD	:cd
CMD_CHARSET_HOOK	:charset-hook
CMD_CLOSE_HOOK	:close-hook See also CMD_APPEND_HOOK, CMD_OPEN_HOOK
CMD_COLOR	:color See also CMD_UNCOLOR
CMD_CRYPT_HOOK	:crypt-hook
CMD_ECHO	:echo
CMD_EXEC	:exec
CMD_FCC_HOOK	:fcc-hook
CMD_FCC_SAVE_HOOK	:fcc-save-hook
CMD_FINISH	:finish See also CMD_IFDEF, CMD_IFNDEF
CMD_FOLDER_HOOK	:folder-hook
CMD_GROUP	:group See also CMD_UNGROUP
CMD_HEADER_ORDER	:header-order See also CMD_UNHEADER_ORDER, HeaderOrderList
CMD_HOOKS	:hooks
CMD_ICONV_HOOK	:iconv-hook
CMD_IFDEF	:ifdef See also CMD_FINISH, CMD_IFNDEF
CMD_IFNDEF	:ifndef See also CMD_FINISH, CMD_IFDEF
CMD_IGNORE	:ignore See also CMD_UNIGNORE
CMD_INDEX_FORMAT_HOOK	:index-format-hook
CMD_LISTS	:lists See also CMD_UNLISTS
CMD_LUA	:lua
CMD_LUA_SOURCE	:lua-source
CMD_MACRO	:macro See also CMD_UNMACRO
CMD_MAILBOXES	:mailboxes See also CMD_NAMED_MAILBOXES, CMD_UNMAILBOXES
CMD_MAILTO_ALLOW	:mailto-allow See also CMD_UNMAILTO_ALLOW, MailToAllow
CMD_MBOX_HOOK	:mbox-hook
CMD_MESSAGE_HOOK	:message-hook
CMD_MIME_LOOKUP	:mime-lookup See also CMD_UNMIME_LOOKUP, MimeLookupList
CMD_MONO	:mono See also CMD_UNMONO
CMD_MY_HEADER	:my-header See also CMD_UNMY_HEADER
CMD_NAMED_MAILBOXES	:named-mailboxes See also CMD_MAILBOXES, CMD_UNMAILBOXES
CMD_NOSPAM	:nospam See also CMD_SPAM
CMD_OPEN_HOOK	:open-hook See also CMD_APPEND_HOOK, CMD_CLOSE_HOOK
CMD_PUSH	:push
CMD_REPLY_HOOK	:reply-hook
CMD_RESET	:reset See also CMD_SET, CMD_TOGGLE, CMD_UNSET
CMD_SAVE_HOOK	:save-hook
CMD_SCORE	:score See also CMD_UNSCORE
CMD_SEND2_HOOK	:send2-hook
CMD_SEND_HOOK	:send-hook
CMD_SET	:set See also CMD_RESET, CMD_TOGGLE, CMD_UNSET
CMD_SETENV	:setenv See also CMD_UNSETENV
CMD_SHUTDOWN_HOOK	:shutdown-hook
CMD_SIDEBAR_PIN	:sidebar-pin See also CMD_SIDEBAR_UNPIN
CMD_SIDEBAR_UNPIN	:sidebar-unpin See also CMD_SIDEBAR_PIN
CMD_SOURCE	:source
CMD_SPAM	:spam See also CMD_NOSPAM
CMD_STARTUP_HOOK	:startup-hook
CMD_SUBJECT_REGEX	:subject-regex See also CMD_UNSUBJECT_REGEX
CMD_SUBSCRIBE	:subscribe See also CMD_UNSUBSCRIBE
CMD_SUBSCRIBE_TO	:subscribe-to See also CMD_UNSUBSCRIBE_FROM
CMD_TAG_FORMATS	:tag-formats See also CMD_TAG_TRANSFORMS
CMD_TAG_TRANSFORMS	:tag-transforms See also CMD_TAG_FORMATS
CMD_TIMEOUT_HOOK	:timeout-hook
CMD_TOGGLE	:toggle See also CMD_RESET, CMD_SET, CMD_UNSET
CMD_UNALIAS	:unalias See also CMD_ALIAS
CMD_UNALTERNATES	:unalternates See also CMD_ALTERNATES
CMD_UNALTERNATIVE_ORDER	:unalternative-order See also CMD_ALTERNATIVE_ORDER, AlternativeOrderList
CMD_UNATTACHMENTS	:unattachments See also CMD_ATTACHMENTS
CMD_UNAUTO_VIEW	:unauto-view See also CMD_AUTO_VIEW, AutoViewList
CMD_UNBIND	:unbind See also CMD_BIND
CMD_UNCOLOR	:uncolor See also CMD_COLOR
CMD_UNGROUP	:ungroup See also CMD_GROUP
CMD_UNHEADER_ORDER	:unheader-order See also CMD_HEADER_ORDER, HeaderOrderList
CMD_UNHOOK	:unhook
CMD_UNIGNORE	:unignore See also CMD_IGNORE
CMD_UNLISTS	:unlists See also CMD_LISTS
CMD_UNMACRO	:unmacro See also CMD_MACRO
CMD_UNMAILBOXES	:unmailboxes See also CMD_MAILBOXES, CMD_NAMED_MAILBOXES
CMD_UNMAILTO_ALLOW	:unmailto-allow See also CMD_MAILTO_ALLOW, MailToAllow
CMD_UNMIME_LOOKUP	:unmime-lookup See also CMD_MIME_LOOKUP, MimeLookupList
CMD_UNMONO	:unmono See also CMD_MONO
CMD_UNMY_HEADER	:unmy-header See also CMD_MY_HEADER
CMD_UNSCORE	:unscore See also CMD_SCORE
CMD_UNSET	:unset See also CMD_RESET, CMD_SET, CMD_TOGGLE
CMD_UNSETENV	:unsetenv See also CMD_SETENV
CMD_UNSUBJECT_REGEX	:unsubject-regex See also CMD_SUBJECT_REGEX
CMD_UNSUBSCRIBE	:unsubscribe See also CMD_SUBSCRIBE
CMD_UNSUBSCRIBE_FROM	:unsubscribe-from See also CMD_SUBSCRIBE_TO
CMD_VERSION	:version

Definition at line 55 of file command.h.

{
  CMD_NONE = 0,              
  CMD_ACCOUNT_HOOK,          
  CMD_ALIAS,                 
  CMD_ALTERNATES,            
  CMD_ALTERNATIVE_ORDER,     
  CMD_APPEND_HOOK,           
  CMD_ATTACHMENTS,           
  CMD_AUTO_VIEW,             
  CMD_BIND,                  
  CMD_CD,                    
  CMD_CHARSET_HOOK,          
  CMD_CLOSE_HOOK,            
  CMD_COLOR,                 
  CMD_CRYPT_HOOK,            
  CMD_ECHO,                  
  CMD_EXEC,                  
  CMD_FCC_HOOK,              
  CMD_FCC_SAVE_HOOK,         
  CMD_FINISH,                
  CMD_FOLDER_HOOK,           
  CMD_GROUP,                 
  CMD_HEADER_ORDER,          
  CMD_HOOKS,                 
  CMD_ICONV_HOOK,            
  CMD_IFDEF,                 
  CMD_IFNDEF,                
  CMD_IGNORE,                
  CMD_INDEX_FORMAT_HOOK,     
  CMD_LISTS,                 
  CMD_LUA,                   
  CMD_LUA_SOURCE,            
  CMD_MACRO,                 
  CMD_MAILBOXES,             
  CMD_MAILTO_ALLOW,          
  CMD_MBOX_HOOK,             
  CMD_MESSAGE_HOOK,          
  CMD_MIME_LOOKUP,           
  CMD_MONO,                  
  CMD_MY_HEADER,             
  CMD_NAMED_MAILBOXES,       
  CMD_NOSPAM,                
  CMD_OPEN_HOOK,             
  CMD_PUSH,                  
  CMD_REPLY_HOOK,            
  CMD_RESET,                 
  CMD_SAVE_HOOK,             
  CMD_SCORE,                 
  CMD_SEND2_HOOK,            
  CMD_SEND_HOOK,             
  CMD_SET,                   
  CMD_SETENV,                
  CMD_SHUTDOWN_HOOK,         
  CMD_SIDEBAR_PIN,           
  CMD_SIDEBAR_UNPIN,         
  CMD_SOURCE,                
  CMD_SPAM,                  
  CMD_STARTUP_HOOK,          
  CMD_SUBJECT_REGEX,         
  CMD_SUBSCRIBE,             
  CMD_SUBSCRIBE_TO,          
  CMD_TAG_FORMATS,           
  CMD_TAG_TRANSFORMS,        
  CMD_TIMEOUT_HOOK,          
  CMD_TOGGLE,                
  CMD_UNALIAS,               
  CMD_UNALTERNATES,          
  CMD_UNALTERNATIVE_ORDER,   
  CMD_UNATTACHMENTS,         
  CMD_UNAUTO_VIEW,           
  CMD_UNBIND,                
  CMD_UNCOLOR,               
  CMD_UNGROUP,               
  CMD_UNHEADER_ORDER,        
  CMD_UNHOOK,                
  CMD_UNIGNORE,              
  CMD_UNLISTS,               
  CMD_UNMACRO,               
  CMD_UNMAILBOXES,           
  CMD_UNMAILTO_ALLOW,        
  CMD_UNMIME_LOOKUP,         
  CMD_UNMONO,                
  CMD_UNMY_HEADER,           
  CMD_UNSCORE,               
  CMD_UNSET,                 
  CMD_UNSETENV,              
  CMD_UNSUBJECT_REGEX,       
  CMD_UNSUBSCRIBE,           
  CMD_UNSUBSCRIBE_FROM,      
  CMD_VERSION,               
};

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