mutt.h

   1 /*
   2  * Copyright notice from original mutt:
   3  * Copyright (C) 1996-2002 Michael R. Elkins <me@mutt.org>
   4  * Copyright (C) 2004 g10 Code GmbH
   5  *
   6  * This file is part of mutt-ng, see http://www.muttng.org/.
   7  * It's licensed under the GNU General Public License,
   8  * please see the file GPL in the top level source directory.
   9  */
  10
  11 #ifndef _MUTT_H
  12 #define _MUTT_H
  13
  14 #include <lib-lib/lib-lib.h>
  15 #include <lib-mime/mime.h>
  16 #include <lib-lua/lib-lua.h>
  17
  18 #define MUTT_VERSION (VERSION)
  19
  20 /* nifty trick I stole from ELM 2.5alpha. */
  21 #ifdef MAIN_C
  22 #define WHERE
  23 #define INITVAL(x) = x
  24 #else
  25 #define WHERE extern
  26 #define INITVAL(x)
  27 #endif
  28
  29 typedef struct {
  30   int ch;                       /* raw key pressed */
  31   int op;                       /* function op */
  32 } event_t;
  33
  34 /* types for mutt_add_hook() */
  35 #define M_FOLDERHOOK    (1<<0)
  36 #define M_MBOXHOOK      (1<<1)
  37 #define M_SENDHOOK      (1<<2)
  38 #define M_FCCHOOK       (1<<3)
  39 #define M_SAVEHOOK      (1<<4)
  40 #define M_MESSAGEHOOK   (1<<5)
  41 #define M_CRYPTHOOK     (1<<6)
  42 #define M_REPLYHOOK     (1<<7)
  43 #define M_SEND2HOOK     (1<<8)
  44
  45 #define M_OPENHOOK      (1<<9)
  46 #define M_APPENDHOOK    (1<<10)
  47 #define M_CLOSEHOOK     (1<<11)
  48
  49 /* tree characters for linearize_tree and print_enriched_string */
  50 #define M_TREE_LLCORNER         1
  51 #define M_TREE_ULCORNER         2
  52 #define M_TREE_LTEE             3
  53 #define M_TREE_HLINE            4
  54 #define M_TREE_VLINE            5
  55 #define M_TREE_SPACE            6
  56 #define M_TREE_RARROW           7
  57 #define M_TREE_STAR             8
  58 #define M_TREE_HIDDEN           9
  59 #define M_TREE_EQUALS           10
  60 #define M_TREE_TTEE             11
  61 #define M_TREE_BTEE             12
  62 #define M_TREE_MISSING          13
  63 #define M_TREE_MAX              14
  64
  65 #define M_THREAD_COLLAPSE       (1<<0)
  66 #define M_THREAD_UNCOLLAPSE     (1<<1)
  67 #define M_THREAD_GET_HIDDEN     (1<<2)
  68 #define M_THREAD_UNREAD         (1<<3)
  69 #define M_THREAD_NEXT_UNREAD    (1<<4)
  70
  71 enum {
  72   /* modes for mutt_view_attachment() */
  73   M_REGULAR = 1,
  74   M_MAILCAP,
  75   M_AS_TEXT,
  76
  77   /* action codes used by mutt_set_flag() and mutt_pattern_function() */
  78   M_ALL,
  79   M_NONE,
  80   M_NEW,
  81   M_OLD,
  82   M_REPLIED,
  83   M_READ,
  84   M_UNREAD,
  85   M_DELETE,
  86   M_UNDELETE,
  87   M_DELETED,
  88   M_APPENDED,
  89   M_PURGED,
  90   M_FLAG,
  91   M_TAG,
  92   M_UNTAG,
  93   M_LIMIT,
  94   M_EXPIRED,
  95   M_SUPERSEDED,
  96
  97   /* actions for mutt_pattern_comp/mutt_pattern_exec */
  98   M_AND,
  99   M_OR,
 100   M_TO,
 101   M_CC,
 102   M_COLLAPSED,
 103   M_SUBJECT,
 104   M_FROM,
 105   M_DATE,
 106   M_DATE_RECEIVED,
 107   M_DUPLICATED,
 108   M_UNREFERENCED,
 109   M_ID,
 110   M_BODY,
 111   M_HEADER,
 112   M_HORMEL,
 113   M_WHOLE_MSG,
 114   M_SENDER,
 115   M_MESSAGE,
 116   M_SCORE,
 117   M_SIZE,
 118   M_REFERENCE,
 119   M_RECIPIENT,
 120   M_LIST,
 121   M_SUBSCRIBED_LIST,
 122   M_PERSONAL_RECIP,
 123   M_PERSONAL_FROM,
 124   M_ADDRESS,
 125   M_CRYPT_SIGN,
 126   M_CRYPT_VERIFIED,
 127   M_CRYPT_ENCRYPT,
 128   M_PGP_KEY,
 129   M_XLABEL,
 130   M_MIMEATTACH,
 131 #ifdef USE_NNTP
 132   M_NEWSGROUPS,
 133 #endif
 134   M_REALNAME,
 135   M_MULTIPART,
 136
 137   /* Options for Mailcap lookup */
 138   M_EDIT,
 139   M_COMPOSE,
 140   M_PRINT,
 141   M_AUTOVIEW,
 142
 143   /* options for socket code */
 144   M_NEW_SOCKET,
 145
 146   /* Options for mutt_save_attachment */
 147   M_SAVE_APPEND,
 148   M_SAVE_OVERWRITE
 149 };
 150
 151 /* quad-option vars */
 152 enum {
 153   OPT_ABORT,
 154   OPT_ATTACH,
 155   OPT_BOUNCE,
 156   OPT_COPY,
 157   OPT_DELETE,
 158   OPT_FORWEDIT,
 159   OPT_INCLUDE,
 160   OPT_IMAPRECONNECT,
 161   OPT_MFUPTO,
 162   OPT_MIMEFWD,
 163   OPT_MIMEFWDREST,
 164   OPT_MOVE,
 165   OPT_POPDELETE,
 166   OPT_POPRECONNECT,
 167   OPT_POSTPONE,
 168   OPT_PRINT,
 169   OPT_REPLYTO,
 170   OPT_RECALL,
 171   OPT_SUBJECT,
 172   OPT_LISTREPLY,
 173 #ifdef USE_NNTP
 174   OPT_TOMODERATED,
 175   OPT_NNTPRECONNECT,
 176   OPT_CATCHUP,
 177   OPT_FOLLOWUPTOPOSTER,
 178 #endif                          /* USE_NNTP */
 179
 180   /* THIS MUST BE THE LAST VALUE. */
 181   OPT_MAX
 182 };
 183
 184 /* flags to ci_send_message() */
 185 #define SENDREPLY       (1<<0)
 186 #define SENDGROUPREPLY  (1<<1)
 187 #define SENDLISTREPLY   (1<<2)
 188 #define SENDFORWARD     (1<<3)
 189 #define SENDPOSTPONED   (1<<4)
 190 #define SENDBATCH       (1<<5)
 191 #define SENDRESEND      (1<<6)
 192 #define SENDNEWS        (1<<7)
 193
 194 /* flags to mutt_select_file() */
 195 #define M_SEL_BUFFY     (1<<0)
 196 #define M_SEL_MULTI     (1<<1)
 197 #define M_SEL_FOLDER    (1<<2)
 198
 199 /* boolean vars */
 200 enum {
 201   OPTALLOW8BIT,
 202   OPTASKBCC,
 203   OPTASKCC,
 204   OPTASKFOLLOWUP,
 205   OPTATTACHSPLIT,
 206   OPTAUTOEDIT,
 207   OPTAUTOTAG,
 208   OPTBOUNCEDELIVERED,
 209   OPTCHECKNEW,
 210   OPTCOLLAPSEUNREAD,
 211   OPTCONFIRMAPPEND,
 212   OPTCONFIRMCREATE,
 213   OPTDELETEUNTAG,
 214   OPTDELSP,
 215   OPTDIGESTCOLLAPSE,
 216   OPTDUPTHREADS,
 217   OPTEDITHDRS,
 218   OPTENCODEFROM,
 219   OPTFASTREPLY,
 220   OPTFCCATTACH,
 221   OPTFCCCLEAR,
 222   OPTFOLLOWUPTO,
 223   OPTFORCEBUFFYCHECK,
 224   OPTFORCENAME,
 225   OPTFORWDECODE,
 226   OPTFORWQUOTE,
 227 #ifdef HAVE_QDBM
 228   OPTHCACHECOMPRESS,
 229 #endif
 230   OPTHEADER,
 231   OPTHIDDENHOST,
 232   OPTHIDELIMITED,
 233   OPTHIDEMISSING,
 234   OPTHIDETHREADSUBJECT,
 235   OPTHIDETOPLIMITED,
 236   OPTHIDETOPMISSING,
 237   OPTIGNORELISTREPLYTO,
 238   OPTIMAPCHECKSUBSCRIBED,
 239   OPTIMAPLSUB,
 240   OPTIMAPPASSIVE,
 241   OPTIMAPSERVERNOISE,
 242   OPTIMPLICITAUTOVIEW,
 243   OPTKEEPFLAGGED,
 244   OPTMAILDIRTRASH,
 245   OPTMARKERS,
 246   OPTMARKOLD,
 247   OPTMBOXPANE,
 248   OPTMETOO,
 249   OPTMHPURGE,
 250   OPTMIMEFORWDECODE,
 251   OPTNARROWTREE,
 252   OPTPAGERSTOP,
 253   OPTPIPEDECODE,
 254   OPTPIPESPLIT,
 255   OPTPOPLAST,
 256   OPTPRINTDECODE,
 257   OPTPRINTSPLIT,
 258   OPTPROMPTAFTER,
 259   OPTQUOTEEMPTY,
 260   OPTQUOTEQUOTED,
 261   OPTRESOLVE,
 262   OPTREVALIAS,
 263   OPTREVNAME,
 264   OPTREVREAL,
 265   OPTSIGDASHES,
 266   OPTSORTRE,
 267   OPTSTRICTMAILTO,
 268   OPTSTRICTTHREADS,
 269   OPTSTRIPWAS,
 270   OPTSTUFFQUOTED,
 271   OPTTEXTFLOWED,
 272   OPTTHOROUGHSRC,
 273   OPTTHREADRECEIVED,
 274   OPTTILDE,
 275   OPTUNCOLLAPSEJUMP,
 276   OPTUSEFROM,
 277 #ifdef HAVE_LIBIDN
 278   OPTUSEIDN,
 279 #endif
 280   OPTWAITKEY,
 281   OPTWEED,
 282   OPTWRAP,
 283   OPTWRAPSEARCH,
 284   OPTWRITEBCC,                  /* write out a bcc header? */
 285   OPTXMAILER,
 286   OPTXMAILTO,                   /* 1 if $edit_header is forcebly set */
 287   OPTXTERMSETTITLES,
 288
 289   /* PGP options */
 290
 291   OPTPGPRETAINABLESIG,
 292   OPTFORWDECRYPT,
 293   OPTPGPSHOWUNUSABLE,
 294
 295   /* news options */
 296
 297 #ifdef USE_NNTP
 298   OPTSHOWNEWNEWS,
 299   OPTSHOWONLYUNREAD,
 300   OPTLOADDESC,
 301 #endif                          /* USE_NNTP */
 302
 303   /* pseudo options */
 304
 305   OPTAUXSORT,                   /* (pseudo) using auxillary sort function */
 306   OPTFORCEREFRESH,              /* (pseudo) refresh even during macros */
 307   OPTNOCURSES,                  /* (pseudo) when sending in batch mode */
 308   OPTNEEDREDRAW,                /* (pseudo) to notify caller of a submenu */
 309   OPTSEARCHREVERSE,             /* (pseudo) used by ci_search_command */
 310   OPTMSGERR,                    /* (pseudo) used by mutt_error/mutt_message */
 311   OPTSEARCHINVALID,             /* (pseudo) used to invalidate the search pat */
 312   OPTSIGNALSBLOCKED,            /* (pseudo) using by mutt_block_signals () */
 313   OPTSYSSIGNALSBLOCKED,         /* (pseudo) using by mutt_block_signals_system () */
 314   OPTNEEDRESORT,                /* (pseudo) used to force a re-sort */
 315   OPTRESORTINIT,                /* (pseudo) used to force the next resort to be from scratch */
 316   OPTVIEWATTACH,                /* (pseudo) signals that we are viewing attachments */
 317   OPTFORCEREDRAWINDEX,          /* (pseudo) used to force a redraw in the main index */
 318   OPTFORCEREDRAWPAGER,          /* (pseudo) used to force a redraw in the pager */
 319   OPTSORTSUBTHREADS,            /* (pseudo) used when $sort_aux changes */
 320   OPTNEEDRESCORE,               /* (pseudo) set when the `score' command is used */
 321   OPTATTACHMSG,                 /* (pseudo) used by attach-message */
 322   OPTHIDEREAD,                  /* (pseudo) whether or not hide read messages */
 323   OPTKEEPQUIET,                 /* (pseudo) shut up the message and refresh
 324                                  *          functions while we are executing an
 325                                  *          external program.
 326                                  */
 327   OPTMENUCALLER,                /* (pseudo) tell menu to give caller a take */
 328   OPTREDRAWTREE,                /* (pseudo) redraw the thread tree */
 329   OPTPGPCHECKTRUST,             /* (pseudo) used by pgp_select_key () */
 330   OPTUNBUFFEREDINPUT,           /* (pseudo) don't use key buffer */
 331
 332 #ifdef USE_NNTP
 333   OPTNEWS,                      /* (pseudo) used to change reader mode */
 334   OPTNEWSSEND,                  /* (pseudo) used to change behavior when posting */
 335 #endif
 336   OPTSHORTENHIERARCHY,          /* set when to shorten "hierarchies" in the sidebar */
 337   OPTSIDEBARNEWMAILONLY,
 338   OPTMAX
 339 };
 340
 341 #define mutt_bit_set(v,n)    (v[n/8] |=  (1 << (n % 8)))
 342 #define mutt_bit_unset(v,n)  (v[n/8] &= ~(1 << (n % 8)))
 343 #define mutt_bit_toggle(v,n) (v[n/8] ^=  (1 << (n % 8)))
 344 #define mutt_bit_isset(v,n)  (v[n/8] &   (1 << (n % 8)))
 345
 346 #define set_option(x)    mutt_bit_set(Options,x)
 347 #define unset_option(x)  mutt_bit_unset(Options,x)
 348 #define toggle_option(x) mutt_bit_toggle(Options,x)
 349 #define option(x)        mutt_bit_isset(Options,x)
 350
 351 void mutt_init (int, string_list_t *);
 352
 353 typedef struct thread {
 354   unsigned int fake_thread:1;
 355   unsigned int duplicate_thread:1;
 356   unsigned int sort_children:1;
 357   unsigned int check_subject:1;
 358   unsigned int visible:1;
 359   unsigned int deep:1;
 360   unsigned int subtree_visible:2;
 361   unsigned int next_subtree_visible:1;
 362   struct thread *parent;
 363   struct thread *child;
 364   struct thread *next;
 365   struct thread *prev;
 366   HEADER *message;
 367   HEADER *sort_key;
 368 } THREAD;
 369
 370 typedef struct compress_info compress_info;
 371 typedef struct pattern_t pattern_t;
 372
 373 typedef struct {
 374   char *path;
 375   FILE *fp;
 376   time_t mtime;
 377   time_t mtime_cur;             /* used with maildir folders */
 378   off_t size;
 379   off_t vsize;
 380   char *pattern;                /* limit pattern string */
 381   pattern_t *limit_pattern;     /* compiled limit pattern */
 382   HEADER **hdrs;
 383   HEADER *last_tag;             /* last tagged msg. used to link threads */
 384   THREAD *tree;                 /* top of thread tree */
 385   hash_t *id_hash;                /* hash table by msg id */
 386   hash_t *subj_hash;              /* hash table by subject */
 387   hash_t *thread_hash;            /* hash table for threading */
 388   int *v2r;                     /* mapping from virtual to real msgno */
 389   int hdrmax;                   /* number of pointers in hdrs */
 390   int msgcount;                 /* number of messages in the mailbox */
 391   int vcount;                   /* the number of virtual messages */
 392   int tagged;                   /* how many messages are tagged? */
 393   int new;                      /* how many new messages? */
 394   int unread;                   /* how many unread messages? */
 395   int deleted;                  /* how many deleted messages */
 396   int appended;                 /* how many saved messages? */
 397   int flagged;                  /* how many flagged messages */
 398   int msgnotreadyet;            /* which msg "new" in pager, -1 if none */
 399   void *data;                   /* driver specific data */
 400
 401   short magic;                  /* mailbox type */
 402
 403   compress_info *cinfo;         /* compressed mbox module private data */
 404   char *realpath;               /* path to compressed mailbox */
 405
 406   unsigned int locked:1;        /* is the mailbox locked? */
 407   unsigned int changed:1;       /* mailbox has been modified */
 408   unsigned int readonly:1;      /* don't allow changes to the mailbox */
 409   unsigned int dontwrite:1;     /* dont write the mailbox on close */
 410   unsigned int append:1;        /* mailbox is opened in append mode */
 411   unsigned int quiet:1;         /* inhibit status messages? */
 412   unsigned int collapsed:1;     /* are all threads collapsed? */
 413   unsigned int closing:1;       /* mailbox is being closed */
 414   unsigned int counting:1;      /* do we just want to cound? */
 415 } CONTEXT;
 416
 417 /* for attachment counter */
 418 typedef struct {
 419   char *major;
 420   int major_int;
 421   const char *minor;
 422   regex_t minor_rx;
 423 } ATTACH_MATCH;
 424
 425 /* Flags for mutt_count_body_parts() */
 426 #define M_PARTS_TOPLEVEL (1<<0) /* is the top-level part */
 427 #define M_PARTS_RECOUNT (1<<1) /* force recount */
 428
 429 #include "protos.h"
 430 #include "globals.h"
 431
 432 #endif /* !_MUTT_H */