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