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