command.h

Go to the documentation of this file.

 
#ifndef MUTT_CORE_COMMAND_H
#define MUTT_CORE_COMMAND_H
 
#include "config.h"
#include <stdbool.h>
#include <stdint.h>
#include "mutt/lib.h"
 
struct ParseContext;
struct ParseError;

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

typedef uint8_t CommandFlags;        
#define CF_NO_FLAGS               0  
#define CF_SYNONYM         (1 <<  0) 
#define CF_DEPRECATED      (1 <<  1) 

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,               
};
 
#define CMD_NO_DATA  0    

struct Command
{
  const char     *name;    
  enum CommandId  id;      

  enum CommandResult (*parse)(const struct Command *cmd, struct Buffer *line, const struct ParseContext *pc, struct ParseError *pe);
 
  intptr_t data;        
 
  const char *help;     
  const char *proto;    
  const char *path;     
 
  CommandFlags flags;   
};
ARRAY_HEAD(CommandArray, const struct Command *);
 
const struct Command *commands_get     (struct CommandArray *ca, const char *name);
void                  commands_clear   (struct CommandArray *ca);
bool                  commands_register(struct CommandArray *ca, const struct Command *cmds);
 
#endif /* MUTT_CORE_COMMAND_H */