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