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