lib.h

Go to the documentation of this file.

#ifndef MUTT_PATTERN_LIB_H
#define MUTT_PATTERN_LIB_H

#include "config.h"
#include <stddef.h>
#include <stdbool.h>
#include <stdint.h>
#include "mutt/lib.h"
#include "mutt.h"

struct AliasMenuData;
struct AliasView;
struct ConfigSet;
struct Email;
struct Envelope;
struct Mailbox;
struct Menu;

#define MUTT_ALIAS_SIMPLESEARCH "~f %s | ~t %s | ~c %s"

/* These Config Variables are only used in pattern.c */
extern bool C_ThoroughSearch;

typedef uint8_t PatternCompFlags;       
#define MUTT_PC_NO_FLAGS            0   
#define MUTT_PC_FULL_MSG        (1<<0)  
#define MUTT_PC_PATTERN_DYNAMIC (1<<1)  
#define MUTT_PC_SEND_MODE_SEARCH (1<<2) 


struct Pattern
{
  short op;                      
  bool pat_not      : 1;         
  bool all_addr     : 1;         
  bool string_match : 1;         
  bool group_match  : 1;         
  bool ign_case     : 1;         
  bool is_alias     : 1;         
  bool dynamic      : 1;         
  bool sendmode     : 1;         
  bool is_multi     : 1;         
  int min;                       
  int max;                       
  struct PatternList *child;     
  union {
    regex_t *regex;              
    struct Group *group;         
    char *str;                   
    struct ListHead multi_cases; 
  } p;
  SLIST_ENTRY(Pattern) entries;  
};
SLIST_HEAD(PatternList, Pattern);

typedef uint8_t PatternExecFlags;         
#define MUTT_PAT_EXEC_NO_FLAGS         0  
#define MUTT_MATCH_FULL_ADDRESS  (1 << 0) 


struct PatternCache
{
  int list_all;       
  int list_one;       
  int sub_all;        
  int sub_one;        
  int pers_recip_all; 
  int pers_recip_one; 
  int pers_from_all;  
  int pers_from_one;  
};

enum PatternType
{
  MUTT_PAT_AND = MUTT_MT_MAX, 
  MUTT_PAT_OR,                
  MUTT_PAT_THREAD,            
  MUTT_PAT_PARENT,            
  MUTT_PAT_CHILDREN,          
  MUTT_PAT_TO,                
  MUTT_PAT_CC,                
  MUTT_PAT_COLLAPSED,         
  MUTT_PAT_SUBJECT,           
  MUTT_PAT_FROM,              
  MUTT_PAT_DATE,              
  MUTT_PAT_DATE_RECEIVED,     
  MUTT_PAT_DUPLICATED,        
  MUTT_PAT_UNREFERENCED,      
  MUTT_PAT_BROKEN,            
  MUTT_PAT_ID,                
  MUTT_PAT_ID_EXTERNAL,       
  MUTT_PAT_BODY,              
  MUTT_PAT_HEADER,            
  MUTT_PAT_HORMEL,            
  MUTT_PAT_WHOLE_MSG,         
  MUTT_PAT_SENDER,            
  MUTT_PAT_MESSAGE,           
  MUTT_PAT_SCORE,             
  MUTT_PAT_SIZE,              
  MUTT_PAT_REFERENCE,         
  MUTT_PAT_RECIPIENT,         
  MUTT_PAT_LIST,              
  MUTT_PAT_SUBSCRIBED_LIST,   
  MUTT_PAT_PERSONAL_RECIP,    
  MUTT_PAT_PERSONAL_FROM,     
  MUTT_PAT_ADDRESS,           
  MUTT_PAT_CRYPT_SIGN,        
  MUTT_PAT_CRYPT_VERIFIED,    
  MUTT_PAT_CRYPT_ENCRYPT,     
  MUTT_PAT_PGP_KEY,           
  MUTT_PAT_XLABEL,            
  MUTT_PAT_SERVERSEARCH,      
  MUTT_PAT_DRIVER_TAGS,       
  MUTT_PAT_MIMEATTACH,        
  MUTT_PAT_MIMETYPE,          
#ifdef USE_NNTP
  MUTT_PAT_NEWSGROUPS,        
#endif
  MUTT_PAT_MAX,
};

int mutt_pattern_exec(struct Pattern *pat, PatternExecFlags flags, struct Mailbox *m,
                      struct Email *e, struct PatternCache *cache);
int mutt_pattern_alias_exec(struct Pattern *pat, PatternExecFlags flags,
                            struct AliasView *av, struct PatternCache *cache);

struct PatternList *mutt_pattern_comp(const char *s, PatternCompFlags flags, struct Buffer *err);
void mutt_check_simple(struct Buffer *s, const char *simple);
void mutt_pattern_free(struct PatternList **pat);
bool dlg_select_pattern(char *buf, size_t buflen);

int mutt_which_case(const char *s);
int mutt_is_list_recipient(bool all_addr, struct Envelope *e);
int mutt_is_subscribed_list_recipient(bool all_addr, struct Envelope *e);
int mutt_pattern_func(int op, char *prompt);
int mutt_pattern_alias_func(int op, char *prompt, char *title, struct AliasMenuData *mdata, struct Menu *menu);
int mutt_search_command(struct Mailbox *m, int cur, int op);
int mutt_search_alias_command(struct Menu *menu, int cur, int op);

bool mutt_limit_current_thread(struct Email *e);
bool config_init_pattern(struct ConfigSet *cs);

#endif /* MUTT_PATTERN_LIB_H */