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_VERIFYSIG,                /* verify PGP signatures */
 174   OPT_LISTREPLY,
 175 #ifdef USE_NNTP
 176   OPT_TOMODERATED,
 177   OPT_NNTPRECONNECT,
 178   OPT_CATCHUP,
 179   OPT_FOLLOWUPTOPOSTER,
 180 #endif                          /* USE_NNTP */
 181
 182   /* THIS MUST BE THE LAST VALUE. */
 183   OPT_MAX
 184 };
 185
 186 /* flags to ci_send_message() */
 187 #define SENDREPLY       (1<<0)
 188 #define SENDGROUPREPLY  (1<<1)
 189 #define SENDLISTREPLY   (1<<2)
 190 #define SENDFORWARD     (1<<3)
 191 #define SENDPOSTPONED   (1<<4)
 192 #define SENDBATCH       (1<<5)
 193 #define SENDRESEND      (1<<6)
 194 #define SENDNEWS        (1<<7)
 195
 196 /* flags to _mutt_select_file() */
 197 #define M_SEL_BUFFY     (1<<0)
 198 #define M_SEL_MULTI     (1<<1)
 199 #define M_SEL_FOLDER    (1<<2)
 200
 201 /* boolean vars */
 202 enum {
 203   OPTALLOW8BIT,
 204   OPTALLOWANSI,
 205   OPTARROWCURSOR,
 206   OPTASCIICHARS,
 207   OPTASKBCC,
 208   OPTASKCC,
 209   OPTASKFOLLOWUP,
 210   OPTASKXCOMMENTTO,
 211   OPTATTACHSPLIT,
 212   OPTAUTOEDIT,
 213   OPTAUTOTAG,
 214   OPTBOUNCEDELIVERED,
 215   OPTBRAILLEFRIENDLY,
 216   OPTCHECKNEW,
 217   OPTCOLLAPSEUNREAD,
 218   OPTCONFIRMAPPEND,
 219   OPTCONFIRMCREATE,
 220   OPTDELETEUNTAG,
 221   OPTDELSP,
 222   OPTDIGESTCOLLAPSE,
 223   OPTDUPTHREADS,
 224   OPTEDITHDRS,
 225   OPTENCODEFROM,
 226   OPTFASTREPLY,
 227   OPTFCCATTACH,
 228   OPTFCCCLEAR,
 229   OPTFOLLOWUPTO,
 230   OPTFORCEBUFFYCHECK,
 231   OPTFORCENAME,
 232   OPTFORWDECODE,
 233   OPTFORWQUOTE,
 234 #ifdef HAVE_QDBM
 235   OPTHCACHECOMPRESS,
 236 #endif
 237   OPTHDRS,
 238   OPTHEADER,
 239   OPTHELP,
 240   OPTHIDDENHOST,
 241   OPTHIDELIMITED,
 242   OPTHIDEMISSING,
 243   OPTHIDETHREADSUBJECT,
 244   OPTHIDETOPLIMITED,
 245   OPTHIDETOPMISSING,
 246   OPTIGNORELISTREPLYTO,
 247   OPTIMAPCHECKSUBSCRIBED,
 248   OPTIMAPLSUB,
 249   OPTIMAPPASSIVE,
 250   OPTIMAPPEEK,
 251   OPTIMAPSERVERNOISE,
 252   OPTIMPLICITAUTOVIEW,
 253   OPTINCLUDEONLYFIRST,
 254   OPTKEEPFLAGGED,
 255   OPTMAILDIRTRASH,
 256   OPTMARKERS,
 257   OPTMARKOLD,
 258   OPTMBOXPANE,
 259   OPTMENUSCROLL,                /* scroll menu instead of implicit next-page */
 260   OPTMENUMOVEOFF,
 261   OPTMETAKEY,                   /* interpret ALT-x as ESC-x */
 262   OPTMETOO,
 263   OPTMHPURGE,
 264   OPTMIMEFORWDECODE,
 265   OPTNARROWTREE,
 266   OPTPAGERSTOP,
 267   OPTPIPEDECODE,
 268   OPTPIPESPLIT,
 269   OPTPOPAUTHTRYALL,
 270   OPTPOPLAST,
 271   OPTPRINTDECODE,
 272   OPTPRINTSPLIT,
 273   OPTPROMPTAFTER,
 274   OPTQUOTEEMPTY,
 275   OPTQUOTEQUOTED,
 276   OPTREADONLY,
 277   OPTREPLYSELF,
 278   OPTRESOLVE,
 279   OPTREVALIAS,
 280   OPTREVNAME,
 281   OPTREVREAL,
 282   OPTSCORE,
 283   OPTSIGDASHES,
 284   OPTSORTRE,
 285   OPTSPAMSEP,
 286   OPTSTATUSONTOP,
 287   OPTSTRICTMAILTO,
 288   OPTSTRICTTHREADS,
 289   OPTSTRIPWAS,
 290   OPTSTUFFQUOTED,
 291   OPTSUSPEND,
 292   OPTTEXTFLOWED,
 293   OPTTHOROUGHSRC,
 294   OPTTHREADRECEIVED,
 295   OPTTILDE,
 296   OPTUNCOLLAPSEJUMP,
 297   OPTUSEFROM,
 298 #ifdef HAVE_LIBIDN
 299   OPTUSEIDN,
 300 #endif
 301   OPTUSEIPV6,
 302   OPTWAITKEY,
 303   OPTWEED,
 304   OPTWRAP,
 305   OPTWRAPSEARCH,
 306   OPTWRITEBCC,                  /* write out a bcc header? */
 307   OPTXMAILER,
 308   OPTXMAILTO,                   /* 1 if $edit_header is forcebly set */
 309   OPTXTERMSETTITLES,
 310
 311   /* PGP options */
 312
 313   OPTCRYPTAUTOSIGN,
 314   OPTCRYPTAUTOENCRYPT,
 315   OPTCRYPTAUTOPGP,
 316   OPTCRYPTAUTOSMIME,
 317   OPTCRYPTREPLYENCRYPT,
 318   OPTCRYPTREPLYSIGN,
 319   OPTCRYPTREPLYSIGNENCRYPTED,
 320   OPTSMIMEISDEFAULT,
 321   OPTPGPAUTODEC,
 322   OPTPGPRETAINABLESIG,
 323   OPTFORWDECRYPT,
 324   OPTPGPSHOWUNUSABLE,
 325
 326   /* news options */
 327
 328 #ifdef USE_NNTP
 329   OPTSHOWNEWNEWS,
 330   OPTSHOWONLYUNREAD,
 331   OPTSAVEUNSUB,
 332   OPTLOADDESC,
 333   OPTXCOMMENTTO,
 334 #endif                          /* USE_NNTP */
 335
 336   /* pseudo options */
 337
 338   OPTAUXSORT,                   /* (pseudo) using auxillary sort function */
 339   OPTFORCEREFRESH,              /* (pseudo) refresh even during macros */
 340   OPTNOCURSES,                  /* (pseudo) when sending in batch mode */
 341   OPTNEEDREDRAW,                /* (pseudo) to notify caller of a submenu */
 342   OPTSEARCHREVERSE,             /* (pseudo) used by ci_search_command */
 343   OPTMSGERR,                    /* (pseudo) used by mutt_error/mutt_message */
 344   OPTSEARCHINVALID,             /* (pseudo) used to invalidate the search pat */
 345   OPTSIGNALSBLOCKED,            /* (pseudo) using by mutt_block_signals () */
 346   OPTSYSSIGNALSBLOCKED,         /* (pseudo) using by mutt_block_signals_system () */
 347   OPTNEEDRESORT,                /* (pseudo) used to force a re-sort */
 348   OPTRESORTINIT,                /* (pseudo) used to force the next resort to be from scratch */
 349   OPTVIEWATTACH,                /* (pseudo) signals that we are viewing attachments */
 350   OPTFORCEREDRAWINDEX,          /* (pseudo) used to force a redraw in the main index */
 351   OPTFORCEREDRAWPAGER,          /* (pseudo) used to force a redraw in the pager */
 352   OPTSORTSUBTHREADS,            /* (pseudo) used when $sort_aux changes */
 353   OPTNEEDRESCORE,               /* (pseudo) set when the `score' command is used */
 354   OPTATTACHMSG,                 /* (pseudo) used by attach-message */
 355   OPTHIDEREAD,                  /* (pseudo) whether or not hide read messages */
 356   OPTKEEPQUIET,                 /* (pseudo) shut up the message and refresh
 357                                  *          functions while we are executing an
 358                                  *          external program.
 359                                  */
 360   OPTMENUCALLER,                /* (pseudo) tell menu to give caller a take */
 361   OPTREDRAWTREE,                /* (pseudo) redraw the thread tree */
 362   OPTPGPCHECKTRUST,             /* (pseudo) used by pgp_select_key () */
 363   OPTUNBUFFEREDINPUT,           /* (pseudo) don't use key buffer */
 364
 365 #ifdef USE_NNTP
 366   OPTNEWS,                      /* (pseudo) used to change reader mode */
 367   OPTNEWSSEND,                  /* (pseudo) used to change behavior when posting */
 368   OPTNEWSCACHE,                 /* (pseudo) used to indicate if news cache exist */
 369 #endif
 370   OPTSHORTENHIERARCHY,          /* set when to shorten "hierarchies" in the sidebar */
 371   OPTSIDEBARNEWMAILONLY,
 372   OPTMAX
 373 };
 374
 375 #define mutt_bit_alloc(n) p_new(char, (n + 7) / 8)
 376 #define mutt_bit_set(v,n) v[n/8] |= (1 << (n % 8))
 377 #define mutt_bit_unset(v,n) v[n/8] &= ~(1 << (n % 8))
 378 #define mutt_bit_toggle(v,n) v[n/8] ^= (1 << (n % 8))
 379 #define mutt_bit_isset(v,n) (v[n/8] & (1 << (n % 8)))
 380
 381 #define set_option(x) mutt_bit_set(Options,x)
 382 #define unset_option(x) mutt_bit_unset(Options,x)
 383 #define toggle_option(x) mutt_bit_toggle(Options,x)
 384 #define option(x) mutt_bit_isset(Options,x)
 385
 386 void mutt_init (int, string_list_t *);
 387
 388 typedef struct thread {
 389   unsigned int fake_thread:1;
 390   unsigned int duplicate_thread:1;
 391   unsigned int sort_children:1;
 392   unsigned int check_subject:1;
 393   unsigned int visible:1;
 394   unsigned int deep:1;
 395   unsigned int subtree_visible:2;
 396   unsigned int next_subtree_visible:1;
 397   struct thread *parent;
 398   struct thread *child;
 399   struct thread *next;
 400   struct thread *prev;
 401   HEADER *message;
 402   HEADER *sort_key;
 403 } THREAD;
 404
 405 typedef struct compress_info compress_info;
 406 typedef struct pattern_t pattern_t;
 407
 408 typedef struct {
 409   char *path;
 410   FILE *fp;
 411   time_t mtime;
 412   time_t mtime_cur;             /* used with maildir folders */
 413   off_t size;
 414   off_t vsize;
 415   char *pattern;                /* limit pattern string */
 416   pattern_t *limit_pattern;     /* compiled limit pattern */
 417   HEADER **hdrs;
 418   HEADER *last_tag;             /* last tagged msg. used to link threads */
 419   THREAD *tree;                 /* top of thread tree */
 420   hash_t *id_hash;                /* hash table by msg id */
 421   hash_t *subj_hash;              /* hash table by subject */
 422   hash_t *thread_hash;            /* hash table for threading */
 423   int *v2r;                     /* mapping from virtual to real msgno */
 424   int hdrmax;                   /* number of pointers in hdrs */
 425   int msgcount;                 /* number of messages in the mailbox */
 426   int vcount;                   /* the number of virtual messages */
 427   int tagged;                   /* how many messages are tagged? */
 428   int new;                      /* how many new messages? */
 429   int unread;                   /* how many unread messages? */
 430   int deleted;                  /* how many deleted messages */
 431   int appended;                 /* how many saved messages? */
 432   int flagged;                  /* how many flagged messages */
 433   int msgnotreadyet;            /* which msg "new" in pager, -1 if none */
 434   void *data;                   /* driver specific data */
 435
 436   short magic;                  /* mailbox type */
 437
 438   compress_info *cinfo;         /* compressed mbox module private data */
 439   char *realpath;               /* path to compressed mailbox */
 440
 441   unsigned int locked:1;        /* is the mailbox locked? */
 442   unsigned int changed:1;       /* mailbox has been modified */
 443   unsigned int readonly:1;      /* don't allow changes to the mailbox */
 444   unsigned int dontwrite:1;     /* dont write the mailbox on close */
 445   unsigned int append:1;        /* mailbox is opened in append mode */
 446   unsigned int quiet:1;         /* inhibit status messages? */
 447   unsigned int collapsed:1;     /* are all threads collapsed? */
 448   unsigned int closing:1;       /* mailbox is being closed */
 449   unsigned int counting:1;      /* do we just want to cound? */
 450 } CONTEXT;
 451
 452 /* for attachment counter */
 453 typedef struct {
 454   char *major;
 455   int major_int;
 456   const char *minor;
 457   regex_t minor_rx;
 458 } ATTACH_MATCH;
 459
 460 /* Flags for mutt_count_body_parts() */
 461 #define M_PARTS_TOPLEVEL (1<<0) /* is the top-level part */
 462 #define M_PARTS_RECOUNT (1<<1) /* force recount */
 463
 464 #include "protos.h"
 465 #include "globals.h"
 466
 467 #endif /* !_MUTT_H */