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