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"

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) 

struct Command
{
  const char *name;     

  enum CommandResult (*parse)(const struct Command *cmd, struct Buffer *line, struct Buffer *err);
 
  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_init    (void);
bool                  commands_register(struct CommandArray *ca, const struct Command *cmds);
 
#endif /* MUTT_CORE_COMMAND_H */