mutt_thread.h

Go to the documentation of this file.

 
#ifndef MUTT_MUTT_THREAD_H
#define MUTT_MUTT_THREAD_H
 
#include <stdbool.h>
#include <stdint.h>
#include <sys/types.h>
#include "config/lib.h"
 
struct Buffer;
struct Email;
struct EmailArray;
struct Mailbox;
struct MailboxView;
 
struct ThreadsContext
{
  struct MailboxView *mailbox_view; 
  struct MuttThread  *tree;         
  struct HashTable   *hash;         
  enum SortType       c_sort;       
  enum SortType       c_sort_aux;   
};
 
enum TreeChar
{
  MUTT_TREE_LLCORNER = 1, 
  MUTT_TREE_ULCORNER,     
  MUTT_TREE_LTEE,         
  MUTT_TREE_HLINE,        
  MUTT_TREE_VLINE,        
  MUTT_TREE_SPACE,        
  MUTT_TREE_RARROW,       
  MUTT_TREE_STAR,         
  MUTT_TREE_HIDDEN,       
  MUTT_TREE_EQUALS,       
  MUTT_TREE_TTEE,         
  MUTT_TREE_BTEE,         
  MUTT_TREE_MISSING,      
  MUTT_TREE_MAX,
 
  MUTT_SPECIAL_INDEX = MUTT_TREE_MAX, 
};
 
typedef uint8_t MuttThreadFlags;         
#define MUTT_THREAD_NO_FLAGS          0  
#define MUTT_THREAD_COLLAPSE    (1 << 0) 
#define MUTT_THREAD_UNCOLLAPSE  (1 << 1) 
#define MUTT_THREAD_UNREAD      (1 << 2) 
#define MUTT_THREAD_NEXT_UNREAD (1 << 3) 
#define MUTT_THREAD_FLAGGED     (1 << 4) 
 
enum MessageInThread
{
  MIT_NUM_MESSAGES, 
  MIT_POSITION,     
};
 
enum UseThreads
{
  UT_UNSET,     
  UT_FLAT,      
  UT_THREADS,   
  UT_REVERSE,   
};
 
extern const struct EnumDef UseThreadsTypeDef;
 
int mutt_traverse_thread(struct Email *e, MuttThreadFlags flag);
#define mutt_collapse_thread(e)         mutt_traverse_thread(e, MUTT_THREAD_COLLAPSE)
#define mutt_uncollapse_thread(e)       mutt_traverse_thread(e, MUTT_THREAD_UNCOLLAPSE)
#define mutt_thread_contains_unread(e)  mutt_traverse_thread(e, MUTT_THREAD_UNREAD)
#define mutt_thread_contains_flagged(e) mutt_traverse_thread(e, MUTT_THREAD_FLAGGED)
#define mutt_thread_next_unread(e)      mutt_traverse_thread(e, MUTT_THREAD_NEXT_UNREAD)
 
enum UseThreads mutt_thread_style(void);
#define mutt_using_threads() (mutt_thread_style() > UT_FLAT)
const char *get_use_threads_str(enum UseThreads value);
int sort_validator(const struct ConfigSet *cs, const struct ConfigDef *cdef,
                   intptr_t value, struct Buffer *err);
 
int mutt_aside_thread(struct Email *e, bool forwards, bool subthreads);
#define mutt_next_thread(e)        mutt_aside_thread(e, true,  false)
#define mutt_previous_thread(e)    mutt_aside_thread(e, false, false)
#define mutt_next_subthread(e)     mutt_aside_thread(e, true,  true)
#define mutt_previous_subthread(e) mutt_aside_thread(e, false, true)
 
struct ThreadsContext *mutt_thread_ctx_init          (struct MailboxView *mv);
void                   mutt_thread_ctx_free          (struct ThreadsContext **ptr);
void                   mutt_thread_collapse_collapsed(struct ThreadsContext *tctx);
void                   mutt_thread_collapse          (struct ThreadsContext *tctx, bool collapse);
bool                   mutt_thread_can_collapse      (struct Email *e);
 
void                   mutt_clear_threads     (struct ThreadsContext *tctx);
void                   mutt_draw_tree         (struct ThreadsContext *tctx);
bool                   mutt_link_threads      (struct Email *parent, struct EmailArray *children, struct Mailbox *m);
struct HashTable *     mutt_make_id_hash      (struct Mailbox *m);
int                    mutt_messages_in_thread(struct Mailbox *m, struct Email *e, enum MessageInThread mit);
int                    mutt_parent_message    (struct Email *e, bool find_root);
off_t                  mutt_set_vnum          (struct Mailbox *m);
void                   mutt_sort_threads      (struct ThreadsContext *tctx, bool init);
 
#endif /* MUTT_MUTT_THREAD_H */