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