lib.h

Go to the documentation of this file.

 
#ifndef MUTT_PATTERN_LIB_H
#define MUTT_PATTERN_LIB_H
 
#include <stdbool.h>
#include <stdint.h>
#include "mutt/lib.h"
#include "mutt.h"
#include "search_state.h"
 
struct AliasMenuData;
struct AliasView;
struct Email;
struct Envelope;
struct Mailbox;
struct MailboxView;
struct Menu;

#define MUTT_ALIAS_SIMPLESEARCH "~f %s | ~t %s | ~c %s"
 
extern const struct CompleteOps CompletePatternOps;

enum PatternCompFlag
{
  MUTT_PC_NONE             =       0,  
  MUTT_PC_FULL_MSG         = 1U << 0,  
  MUTT_PC_PATTERN_DYNAMIC  = 1U << 1,  
  MUTT_PC_SEND_MODE_SEARCH = 1U << 2,  
};
typedef uint8_t PatternCompFlags;

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;           
  long min;                        
  long max;                        
  struct PatternList *child;       
  union {
    regex_t *regex;                
    struct Group *group;           
    char *str;                     
    struct ListHead multi_cases;   
  } p;
#ifdef USE_DEBUG_GRAPHVIZ
  const char *raw_pattern;         
#endif
  SLIST_ENTRY(Pattern) entries;    
};
SLIST_HEAD(PatternList, Pattern);

enum PatternExecFlag
{
  MUTT_PAT_EXEC_NONE      =       0,  
  MUTT_MATCH_FULL_ADDRESS = 1U << 0,  
};
typedef uint8_t PatternExecFlags;

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_BCC,               
  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,          
  MUTT_PAT_NEWSGROUPS,        
  MUTT_PAT_MAX,
};

enum PatternAlias
{
  PAA_TAG,        
  PAA_UNTAG,      
  PAA_VISIBLE,    
};
 
bool mutt_pattern_exec(struct Pattern *pat, PatternExecFlags flags, struct Mailbox *m,
                       struct Email *e, struct PatternCache *cache);
bool mutt_pattern_alias_exec(struct Pattern *pat, PatternExecFlags flags,
                             struct AliasView *av, struct PatternCache *cache);
 
struct PatternList *mutt_pattern_comp(struct MailboxView *mv, 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_pattern(struct Buffer *buf);
 
bool mutt_is_list_recipient(bool all_addr, struct Envelope *env);
bool mutt_is_subscribed_list_recipient(bool all_addr, struct Envelope *env);
int mutt_pattern_func(struct MailboxView *mv, int op, char *prompt);
int mutt_pattern_alias_func(char *prompt, struct AliasMenuData *mdata, enum PatternAlias action, struct Menu *menu);
int mutt_search_command(struct MailboxView *mv, struct Menu *menu, int cur,
                        struct SearchState *state, SearchFlags flags);
int mutt_search_alias_command(struct Menu *menu, int cur,
                              struct SearchState *state, SearchFlags flags);
 
#endif /* MUTT_PATTERN_LIB_H */