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