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   M_REALNAME,
 132   M_MULTIPART,
 133
 134   /* Options for Mailcap lookup */
 135   M_EDIT,
 136   M_COMPOSE,
 137   M_PRINT,
 138   M_AUTOVIEW,
 139
 140   /* options for socket code */
 141   M_NEW_SOCKET,
 142
 143   /* Options for mutt_save_attachment */
 144   M_SAVE_APPEND,
 145   M_SAVE_OVERWRITE
 146 };
 147
 148 /* quad-option vars */
 149 enum {
 150   OPT_ABORT,
 151   OPT_ATTACH,
 152   OPT_BOUNCE,
 153   OPT_COPY,
 154   OPT_DELETE,
 155   OPT_FORWEDIT,
 156   OPT_INCLUDE,
 157   OPT_IMAPRECONNECT,
 158   OPT_MFUPTO,
 159   OPT_MIMEFWD,
 160   OPT_MIMEFWDREST,
 161   OPT_MOVE,
 162   OPT_POPDELETE,
 163   OPT_POPRECONNECT,
 164   OPT_POSTPONE,
 165   OPT_PRINT,
 166   OPT_REPLYTO,
 167   OPT_RECALL,
 168   OPT_SUBJECT,
 169   OPT_LISTREPLY,
 170
 171   /* THIS MUST BE THE LAST VALUE. */
 172   OPT_MAX
 173 };
 174
 175 /* flags to ci_send_message() */
 176 #define SENDREPLY       (1<<0)
 177 #define SENDGROUPREPLY  (1<<1)
 178 #define SENDLISTREPLY   (1<<2)
 179 #define SENDFORWARD     (1<<3)
 180 #define SENDPOSTPONED   (1<<4)
 181 #define SENDBATCH       (1<<5)
 182 #define SENDRESEND      (1<<6)
 183 #define SENDNEWS        (1<<7)
 184
 185 /* boolean vars */
 186 enum {
 187   OPTALLOW8BIT,
 188   OPTASKBCC,
 189   OPTASKCC,
 190   OPTASKFOLLOWUP,
 191   OPTATTACHSPLIT,
 192   OPTAUTOEDIT,
 193   OPTAUTOTAG,
 194   OPTBOUNCEDELIVERED,
 195   OPTCHECKNEW,
 196   OPTCOLLAPSEUNREAD,
 197   OPTCONFIRMAPPEND,
 198   OPTCONFIRMCREATE,
 199   OPTDELETEUNTAG,
 200   OPTDELSP,
 201   OPTDIGESTCOLLAPSE,
 202   OPTDUPTHREADS,
 203   OPTEDITHDRS,
 204   OPTENCODEFROM,
 205   OPTFASTREPLY,
 206   OPTFCCATTACH,
 207   OPTFCCCLEAR,
 208   OPTFOLLOWUPTO,
 209   OPTFORCEBUFFYCHECK,
 210   OPTFORCENAME,
 211   OPTFORWDECODE,
 212   OPTFORWQUOTE,
 213   OPTHEADER,
 214   OPTHIDDENHOST,
 215   OPTHIDELIMITED,
 216   OPTHIDEMISSING,
 217   OPTHIDETHREADSUBJECT,
 218   OPTHIDETOPLIMITED,
 219   OPTHIDETOPMISSING,
 220   OPTIGNORELISTREPLYTO,
 221   OPTIMAPCHECKSUBSCRIBED,
 222   OPTIMAPLSUB,
 223   OPTIMAPPASSIVE,
 224   OPTIMAPSERVERNOISE,
 225   OPTIMPLICITAUTOVIEW,
 226   OPTKEEPFLAGGED,
 227   OPTMAILDIRTRASH,
 228   OPTMARKERS,
 229   OPTMARKOLD,
 230   OPTMBOXPANE,
 231   OPTSHORTENHIERARCHY,          /* set when to shorten "hierarchies" in the sidebar */
 232   OPTSIDEBARNEWMAILONLY,
 233   OPTMETOO,
 234   OPTMHPURGE,
 235   OPTMIMEFORWDECODE,
 236   OPTNARROWTREE,
 237   OPTPAGERSTOP,
 238   OPTPIPEDECODE,
 239   OPTPIPESPLIT,
 240   OPTPOPLAST,
 241   OPTPRINTDECODE,
 242   OPTPRINTSPLIT,
 243   OPTPROMPTAFTER,
 244   OPTQUOTEEMPTY,
 245   OPTQUOTEQUOTED,
 246   OPTRESOLVE,
 247   OPTREVALIAS,
 248   OPTREVNAME,
 249   OPTREVREAL,
 250   OPTSIGDASHES,
 251   OPTSORTRE,
 252   OPTSTRICTMAILTO,
 253   OPTSTRICTTHREADS,
 254   OPTSTRIPWAS,
 255   OPTSTUFFQUOTED,
 256   OPTTEXTFLOWED,
 257   OPTTHOROUGHSRC,
 258   OPTTHREADRECEIVED,
 259   OPTTILDE,
 260   OPTUNCOLLAPSEJUMP,
 261   OPTUSEFROM,
 262   OPTUSEIDN,
 263   OPTWAITKEY,
 264   OPTWEED,
 265   OPTWRAP,
 266   OPTWRAPSEARCH,
 267   OPTWRITEBCC,                  /* write out a bcc header? */
 268   OPTXMAILER,
 269   OPTXMAILTO,                   /* 1 if $edit_header is forcebly set */
 270   OPTXTERMSETTITLES,
 271
 272   /* PGP options */
 273   OPTPGPRETAINABLESIG,
 274   OPTFORWDECRYPT,
 275   OPTPGPSHOWUNUSABLE,
 276
 277   /* news options */
 278   OPTSHOWNEWNEWS,
 279   OPTSHOWONLYUNREAD,
 280   OPTLOADDESC,
 281
 282   /* pseudo options */
 283
 284   OPTAUXSORT,                   /* (pseudo) using auxillary sort function */
 285   OPTFORCEREFRESH,              /* (pseudo) refresh even during macros */
 286   OPTNOCURSES,                  /* (pseudo) when sending in batch mode */
 287   OPTNEEDREDRAW,                /* (pseudo) to notify caller of a submenu */
 288   OPTSEARCHREVERSE,             /* (pseudo) used by ci_search_command */
 289   OPTMSGERR,                    /* (pseudo) used by mutt_error/mutt_message */
 290   OPTSEARCHINVALID,             /* (pseudo) used to invalidate the search pat */
 291   OPTSIGNALSBLOCKED,            /* (pseudo) using by mutt_block_signals () */
 292   OPTSYSSIGNALSBLOCKED,         /* (pseudo) using by mutt_block_signals_system () */
 293   OPTNEEDRESORT,                /* (pseudo) used to force a re-sort */
 294   OPTRESORTINIT,                /* (pseudo) used to force the next resort to be from scratch */
 295   OPTVIEWATTACH,                /* (pseudo) signals that we are viewing attachments */
 296   OPTFORCEREDRAWINDEX,          /* (pseudo) used to force a redraw in the main index */
 297   OPTFORCEREDRAWPAGER,          /* (pseudo) used to force a redraw in the pager */
 298   OPTSORTSUBTHREADS,            /* (pseudo) used when $sort_aux changes */
 299   OPTNEEDRESCORE,               /* (pseudo) set when the `score' command is used */
 300   OPTATTACHMSG,                 /* (pseudo) used by attach-message */
 301   OPTHIDEREAD,                  /* (pseudo) whether or not hide read messages */
 302   OPTKEEPQUIET,                 /* (pseudo) shut up the message and refresh
 303                                  *          functions while we are executing an
 304                                  *          external program.
 305                                  */
 306   OPTMENUCALLER,                /* (pseudo) tell menu to give caller a take */
 307   OPTREDRAWTREE,                /* (pseudo) redraw the thread tree */
 308   OPTPGPCHECKTRUST,             /* (pseudo) used by pgp_select_key () */
 309   OPTUNBUFFEREDINPUT,           /* (pseudo) don't use key buffer */
 310   OPTNEWS,                      /* (pseudo) used to change reader mode */
 311   OPTNEWSSEND,                  /* (pseudo) used to change behavior when posting */
 312   OPTMAX
 313 };
 314
 315 #define mutt_bit_set(v,n)    (v[n / 8] |=  (1 << (n & 7)))
 316 #define mutt_bit_unset(v,n)  (v[n / 8] &= ~(1 << (n & 7)))
 317 #define mutt_bit_toggle(v,n) (v[n / 8] ^=  (1 << (n & 7)))
 318 #define mutt_bit_isset(v,n)  (v[n / 8] &   (1 << (n & 7)))
 319
 320 #define set_option(x)        mutt_bit_set(Options, x)
 321 #define unset_option(x)      mutt_bit_unset(Options, x)
 322 #define toggle_option(x)     mutt_bit_toggle(Options, x)
 323 #define option(x)            mutt_bit_isset(Options, x)
 324
 325 void mutt_init (int, string_list_t *);
 326
 327 typedef struct thread {
 328   unsigned int fake_thread:1;
 329   unsigned int duplicate_thread:1;
 330   unsigned int sort_children:1;
 331   unsigned int check_subject:1;
 332   unsigned int visible:1;
 333   unsigned int deep:1;
 334   unsigned int subtree_visible:2;
 335   unsigned int next_subtree_visible:1;
 336   struct thread *parent;
 337   struct thread *child;
 338   struct thread *next;
 339   struct thread *prev;
 340   HEADER *message;
 341   HEADER *sort_key;
 342 } THREAD;
 343
 344 typedef struct compress_info compress_info;
 345 typedef struct pattern_t pattern_t;
 346
 347 typedef struct {
 348   char *path;
 349   FILE *fp;
 350   time_t mtime;
 351   time_t mtime_cur;             /* used with maildir folders */
 352   off_t size;
 353   off_t vsize;
 354   char *pattern;                /* limit pattern string */
 355   pattern_t *limit_pattern;     /* compiled limit pattern */
 356   HEADER **hdrs;
 357   HEADER *last_tag;             /* last tagged msg. used to link threads */
 358   THREAD *tree;                 /* top of thread tree */
 359   hash_t *id_hash;                /* hash table by msg id */
 360   hash_t *subj_hash;              /* hash table by subject */
 361   hash_t *thread_hash;            /* hash table for threading */
 362   int *v2r;                     /* mapping from virtual to real msgno */
 363   int hdrmax;                   /* number of pointers in hdrs */
 364   int msgcount;                 /* number of messages in the mailbox */
 365   int vcount;                   /* the number of virtual messages */
 366   int tagged;                   /* how many messages are tagged? */
 367   int new;                      /* how many new messages? */
 368   int unread;                   /* how many unread messages? */
 369   int deleted;                  /* how many deleted messages */
 370   int appended;                 /* how many saved messages? */
 371   int flagged;                  /* how many flagged messages */
 372   int msgnotreadyet;            /* which msg "new" in pager, -1 if none */
 373   void *data;                   /* driver specific data */
 374
 375   short magic;                  /* mailbox type */
 376
 377   compress_info *cinfo;         /* compressed mbox module private data */
 378   char *realpath;               /* path to compressed mailbox */
 379
 380   unsigned int locked:1;        /* is the mailbox locked? */
 381   unsigned int changed:1;       /* mailbox has been modified */
 382   unsigned int readonly:1;      /* don't allow changes to the mailbox */
 383   unsigned int dontwrite:1;     /* dont write the mailbox on close */
 384   unsigned int append:1;        /* mailbox is opened in append mode */
 385   unsigned int quiet:1;         /* inhibit status messages? */
 386   unsigned int collapsed:1;     /* are all threads collapsed? */
 387   unsigned int closing:1;       /* mailbox is being closed */
 388   unsigned int counting:1;      /* do we just want to cound? */
 389 } CONTEXT;
 390
 391 /* for attachment counter */
 392 typedef struct {
 393   char *major;
 394   int major_int;
 395   const char *minor;
 396   regex_t minor_rx;
 397 } ATTACH_MATCH;
 398
 399 /* Flags for mutt_count_body_parts() */
 400 #define M_PARTS_TOPLEVEL (1<<0) /* is the top-level part */
 401 #define M_PARTS_RECOUNT (1<<1) /* force recount */
 402
 403 #include "protos.h"
 404 #include "globals.h"
 405
 406 #endif /* !_MUTT_H */