module_api.h

Go to the documentation of this file.

 
#ifndef MUTT_CORE_MODULE_H
#define MUTT_CORE_MODULE_H
 
#include <stdbool.h>
 
struct CommandArray;
struct ConfigSet;
struct NeoMutt;

enum ModuleId
{
  // These two have priority
  MODULE_ID_MAIN,          
  MODULE_ID_GUI,           
 
  MODULE_ID_ADDRESS,       
  MODULE_ID_ALIAS,         
  MODULE_ID_ATTACH,        
  MODULE_ID_AUTOCRYPT,     
  MODULE_ID_BCACHE,        
  MODULE_ID_BROWSER,       
  MODULE_ID_COLOR,         
  MODULE_ID_COMMANDS,      
  MODULE_ID_COMPLETE,      
  MODULE_ID_COMPMBOX,      
  MODULE_ID_COMPOSE,       
  MODULE_ID_COMPRESS,      
  MODULE_ID_CONFIG,        
  MODULE_ID_CONN,          
  MODULE_ID_CONVERT,       
  MODULE_ID_CORE,          
  MODULE_ID_EDITOR,        
  MODULE_ID_EMAIL,         
  MODULE_ID_ENVELOPE,      
  MODULE_ID_EXPANDO,       
  MODULE_ID_HCACHE,        
  MODULE_ID_HELPBAR,       
  MODULE_ID_HISTORY,       
  MODULE_ID_HOOKS,         
  MODULE_ID_IMAP,          
  MODULE_ID_INDEX,         
  MODULE_ID_KEY,           
  MODULE_ID_LUA,           
  MODULE_ID_MAILDIR,       
  MODULE_ID_MBOX,          
  MODULE_ID_MENU,          
  MODULE_ID_MH,            
  MODULE_ID_MUTT,          
  MODULE_ID_NCRYPT,        
  MODULE_ID_NNTP,          
  MODULE_ID_NOTMUCH,       
  MODULE_ID_PAGER,         
  MODULE_ID_PARSE,         
  MODULE_ID_PATTERN,       
  MODULE_ID_POP,           
  MODULE_ID_POSTPONE,      
  MODULE_ID_PROGRESS,      
  MODULE_ID_QUESTION,      
  MODULE_ID_SEND,          
  MODULE_ID_SIDEBAR,       
  MODULE_ID_STORE,         
  MODULE_ID_MAX,
};

struct Module
{
  enum ModuleId mid;                  
  const char *name;                   

  bool (*init)(struct NeoMutt *n);

  bool (*config_define_types)(struct NeoMutt *n, struct ConfigSet *cs);

  bool (*config_define_variables)(struct NeoMutt *n, struct ConfigSet *cs);

  bool (*commands_register)(struct NeoMutt *n, struct CommandArray *ca);

  bool (*gui_init)(struct NeoMutt *n);

  void (*gui_cleanup)(struct NeoMutt *n);

  bool (*cleanup)(struct NeoMutt *n);
};
 
#endif /* MUTT_CORE_MODULE_H */