mutt.h

Go to the documentation of this file.

#ifndef MUTT_MUTT_H
#define MUTT_MUTT_H

#include "config.h"
#include <stddef.h>
#include <limits.h>
#include <stdbool.h>
#include <stdint.h>
#include "config/lib.h"
#include "hook.h"
#include "keymap.h"
#include "mutt_commands.h"

struct Buffer;
struct ListHead;
struct Mapping;

/* On OS X 10.5.x, wide char functions are inlined by default breaking
 * --without-wc-funcs compilation
 */
#ifdef __APPLE_CC__
#define _DONT_USE_CTYPE_INLINE_
#endif

/* PATH_MAX is undefined on the hurd */
#ifndef PATH_MAX
#define PATH_MAX 4096
#endif

#ifdef HAVE_FGETS_UNLOCKED
#define fgets fgets_unlocked
#endif

#ifdef HAVE_FGETC_UNLOCKED
#define fgetc fgetc_unlocked
#endif

typedef uint16_t CompletionFlags;    
#define MUTT_COMP_NO_FLAGS       0   
#define MUTT_ALIAS         (1 << 0)  
#define MUTT_FILE          (1 << 1)  
#define MUTT_EFILE         (1 << 2)  
#define MUTT_CMD           (1 << 3)  
#define MUTT_PASS          (1 << 4)  
#define MUTT_CLEAR         (1 << 5)  
#define MUTT_COMMAND       (1 << 6)  
#define MUTT_PATTERN       (1 << 7)  
#define MUTT_LABEL         (1 << 8)  
#define MUTT_NM_QUERY      (1 << 9)  
#define MUTT_NM_TAG        (1 << 10) 

typedef uint16_t TokenFlags;               
#define MUTT_TOKEN_NO_FLAGS            0   
#define MUTT_TOKEN_EQUAL         (1 << 0)  
#define MUTT_TOKEN_CONDENSE      (1 << 1)  
#define MUTT_TOKEN_SPACE         (1 << 2)  
#define MUTT_TOKEN_QUOTE         (1 << 3)  
#define MUTT_TOKEN_PATTERN       (1 << 4)  
#define MUTT_TOKEN_COMMENT       (1 << 5)  
#define MUTT_TOKEN_SEMICOLON     (1 << 6)  
#define MUTT_TOKEN_BACKTICK_VARS (1 << 7)  
#define MUTT_TOKEN_NOSHELL       (1 << 8)  
#define MUTT_TOKEN_QUESTION      (1 << 9)  


enum MessageType
{
  MUTT_ALL = 1,    
  MUTT_NONE,       
  MUTT_NEW,        
  MUTT_OLD,        
  MUTT_REPLIED,    
  MUTT_READ,       
  MUTT_UNREAD,     
  MUTT_DELETE,     
  MUTT_UNDELETE,   
  MUTT_PURGE,      
  MUTT_DELETED,    
  MUTT_FLAG,       
  MUTT_TAG,        
  MUTT_UNTAG,      
  MUTT_LIMIT,      
  MUTT_EXPIRED,    
  MUTT_SUPERSEDED, 
  MUTT_TRASH,      

  MUTT_MT_MAX,
};

/* flags for parse_spam_list */
#define MUTT_SPAM   1
#define MUTT_NOSPAM 2

int mutt_init(bool skip_sys_rc, struct ListHead *commands);
struct ConfigSet *init_config(size_t size);

#define EXEC_SHELL "/bin/sh"

char *mutt_compile_help(char *buf, size_t buflen, enum MenuType menu, const struct Mapping *items);

int mutt_extract_token(struct Buffer *dest, struct Buffer *tok, TokenFlags flags);
void mutt_opts_free(void);
enum QuadOption query_quadoption(enum QuadOption opt, const char *prompt);
int mutt_label_complete(char *buf, size_t buflen, int numtabs);
int mutt_command_complete(char *buf, size_t buflen, int pos, int numtabs);
int mutt_var_value_complete(char *buf, size_t buflen, int pos);
bool mutt_nm_query_complete(char *buf, size_t buflen, int pos, int numtabs);
bool mutt_nm_tag_complete(char *buf, size_t buflen, int numtabs);
HookFlags mutt_get_hook_type(const char *name);
enum CommandResult mutt_parse_rc_line(/* const */ char *line, struct Buffer *token, struct Buffer *err);
int mutt_query_variables(struct ListHead *queries);
void reset_value(const char *name);

#ifdef HAVE_LIBUNWIND
void show_backtrace(void);
#endif

#endif /* MUTT_MUTT_H */