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
  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_ACCOUNTHOOK   (1<<7)
  43 #define M_REPLYHOOK     (1<<8)
  44 #define M_SEND2HOOK     (1<<9)
  45
  46 #define M_OPENHOOK      (1<<10)
  47 #define M_APPENDHOOK    (1<<11)
  48 #define M_CLOSEHOOK     (1<<12)
  49
  50 /* tree characters for linearize_tree and print_enriched_string */
  51 #define M_TREE_LLCORNER         1
  52 #define M_TREE_ULCORNER         2
  53 #define M_TREE_LTEE             3
  54 #define M_TREE_HLINE            4
  55 #define M_TREE_VLINE            5
  56 #define M_TREE_SPACE            6
  57 #define M_TREE_RARROW           7
  58 #define M_TREE_STAR             8
  59 #define M_TREE_HIDDEN           9
  60 #define M_TREE_EQUALS           10
  61 #define M_TREE_TTEE             11
  62 #define M_TREE_BTEE             12
  63 #define M_TREE_MISSING          13
  64 #define M_TREE_MAX              14
  65
  66 #define M_THREAD_COLLAPSE       (1<<0)
  67 #define M_THREAD_UNCOLLAPSE     (1<<1)
  68 #define M_THREAD_GET_HIDDEN     (1<<2)
  69 #define M_THREAD_UNREAD         (1<<3)
  70 #define M_THREAD_NEXT_UNREAD    (1<<4)
  71
  72 enum {
  73   /* modes for mutt_view_attachment() */
  74   M_REGULAR = 1,
  75   M_MAILCAP,
  76   M_AS_TEXT,
  77
  78   /* action codes used by mutt_set_flag() and mutt_pattern_function() */
  79   M_ALL,
  80   M_NONE,
  81   M_NEW,
  82   M_OLD,
  83   M_REPLIED,
  84   M_READ,
  85   M_UNREAD,
  86   M_DELETE,
  87   M_UNDELETE,
  88   M_DELETED,
  89   M_APPENDED,
  90   M_PURGED,
  91   M_FLAG,
  92   M_TAG,
  93   M_UNTAG,
  94   M_LIMIT,
  95   M_EXPIRED,
  96   M_SUPERSEDED,
  97
  98   /* actions for mutt_pattern_comp/mutt_pattern_exec */
  99   M_AND,
 100   M_OR,
 101   M_TO,
 102   M_CC,
 103   M_COLLAPSED,
 104   M_SUBJECT,
 105   M_FROM,
 106   M_DATE,
 107   M_DATE_RECEIVED,
 108   M_DUPLICATED,
 109   M_UNREFERENCED,
 110   M_ID,
 111   M_BODY,
 112   M_HEADER,
 113   M_HORMEL,
 114   M_WHOLE_MSG,
 115   M_SENDER,
 116   M_MESSAGE,
 117   M_SCORE,
 118   M_SIZE,
 119   M_REFERENCE,
 120   M_RECIPIENT,
 121   M_LIST,
 122   M_SUBSCRIBED_LIST,
 123   M_PERSONAL_RECIP,
 124   M_PERSONAL_FROM,
 125   M_ADDRESS,
 126   M_CRYPT_SIGN,
 127   M_CRYPT_VERIFIED,
 128   M_CRYPT_ENCRYPT,
 129   M_PGP_KEY,
 130   M_XLABEL,
 131   M_MIMEATTACH,
 132 #ifdef USE_NNTP
 133   M_NEWSGROUPS,
 134 #endif
 135   M_REALNAME,
 136   M_MULTIPART,
 137
 138   /* Options for Mailcap lookup */
 139   M_EDIT,
 140   M_COMPOSE,
 141   M_PRINT,
 142   M_AUTOVIEW,
 143
 144   /* options for socket code */
 145   M_NEW_SOCKET,
 146 #ifdef USE_SSL
 147   M_NEW_SSL_SOCKET,
 148 #endif
 149
 150   /* Options for mutt_save_attachment */
 151   M_SAVE_APPEND,
 152   M_SAVE_OVERWRITE
 153 };
 154
 155 /* quad-option vars */
 156 enum {
 157   OPT_ABORT,
 158   OPT_ATTACH,
 159   OPT_BOUNCE,
 160   OPT_COPY,
 161   OPT_DELETE,
 162   OPT_FORWEDIT,
 163   OPT_INCLUDE,
 164   OPT_IMAPRECONNECT,
 165   OPT_MFUPTO,
 166   OPT_MIMEFWD,
 167   OPT_MIMEFWDREST,
 168   OPT_MOVE,
 169   OPT_POPDELETE,
 170   OPT_POPRECONNECT,
 171   OPT_POSTPONE,
 172   OPT_PRINT,
 173   OPT_REPLYTO,
 174   OPT_RECALL,
 175 #if defined(USE_SSL) || defined(USE_GNUTLS)
 176   OPT_SSLSTARTTLS,
 177 #endif
 178   OPT_SUBJECT,
 179   OPT_VERIFYSIG,                /* verify PGP signatures */
 180   OPT_LISTREPLY,
 181 #ifdef USE_NNTP
 182   OPT_TOMODERATED,
 183   OPT_NNTPRECONNECT,
 184   OPT_CATCHUP,
 185   OPT_FOLLOWUPTOPOSTER,
 186 #endif                          /* USE_NNTP */
 187
 188   /* THIS MUST BE THE LAST VALUE. */
 189   OPT_MAX
 190 };
 191
 192 /* flags to ci_send_message() */
 193 #define SENDREPLY       (1<<0)
 194 #define SENDGROUPREPLY  (1<<1)
 195 #define SENDLISTREPLY   (1<<2)
 196 #define SENDFORWARD     (1<<3)
 197 #define SENDPOSTPONED   (1<<4)
 198 #define SENDBATCH       (1<<5)
 199 #define SENDRESEND      (1<<6)
 200 #define SENDNEWS        (1<<7)
 201
 202 /* flags to _mutt_select_file() */
 203 #define M_SEL_BUFFY     (1<<0)
 204 #define M_SEL_MULTI     (1<<1)
 205 #define M_SEL_FOLDER    (1<<2)
 206
 207 /* boolean vars */
 208 enum {
 209   OPTALLOW8BIT,
 210   OPTALLOWANSI,
 211   OPTARROWCURSOR,
 212   OPTASCIICHARS,
 213   OPTASKBCC,
 214   OPTASKCC,
 215   OPTASKFOLLOWUP,
 216   OPTASKXCOMMENTTO,
 217   OPTATTACHSPLIT,
 218   OPTAUTOEDIT,
 219   OPTAUTOTAG,
 220   OPTBOUNCEDELIVERED,
 221   OPTBRAILLEFRIENDLY,
 222   OPTCHECKNEW,
 223   OPTCOLLAPSEUNREAD,
 224   OPTCONFIRMAPPEND,
 225   OPTCONFIRMCREATE,
 226   OPTDELETEUNTAG,
 227   OPTDELSP,
 228   OPTDIGESTCOLLAPSE,
 229   OPTDUPTHREADS,
 230   OPTEDITHDRS,
 231   OPTENCODEFROM,
 232   OPTFASTREPLY,
 233   OPTFCCATTACH,
 234   OPTFCCCLEAR,
 235   OPTFOLLOWUPTO,
 236   OPTFORCEBUFFYCHECK,
 237   OPTFORCENAME,
 238   OPTFORWDECODE,
 239   OPTFORWQUOTE,
 240 #ifdef USE_HCACHE
 241   OPTHCACHEVERIFY,
 242 #ifdef HAVE_QDBM
 243   OPTHCACHECOMPRESS,
 244 #endif /* HAVE_QDBM */
 245 #endif
 246   OPTHDRS,
 247   OPTHEADER,
 248   OPTHELP,
 249   OPTHIDDENHOST,
 250   OPTHIDELIMITED,
 251   OPTHIDEMISSING,
 252   OPTHIDETHREADSUBJECT,
 253   OPTHIDETOPLIMITED,
 254   OPTHIDETOPMISSING,
 255   OPTIGNORELISTREPLYTO,
 256   OPTIMAPCHECKSUBSCRIBED,
 257   OPTIMAPLSUB,
 258   OPTIMAPPASSIVE,
 259   OPTIMAPPEEK,
 260   OPTIMAPSERVERNOISE,
 261 #if defined(USE_SSL) || defined(USE_GNUTLS)
 262 # ifndef USE_GNUTLS
 263   OPTSSLSYSTEMCERTS,
 264   OPTSSLV2,
 265 # endif /* !USE_GNUTLS */
 266   OPTSSLV3,
 267   OPTTLSV1,
 268   OPTSSLFORCETLS,
 269 #endif /* USE_SSL || USE_GNUTLS */
 270   OPTIMPLICITAUTOVIEW,
 271   OPTINCLUDEONLYFIRST,
 272   OPTKEEPFLAGGED,
 273   OPTMAILDIRTRASH,
 274   OPTMARKERS,
 275   OPTMARKOLD,
 276   OPTMBOXPANE,
 277   OPTMENUSCROLL,                /* scroll menu instead of implicit next-page */
 278   OPTMENUMOVEOFF,
 279   OPTMETAKEY,                   /* interpret ALT-x as ESC-x */
 280   OPTMETOO,
 281   OPTMHPURGE,
 282   OPTMIMEFORWDECODE,
 283   OPTNARROWTREE,
 284   OPTPAGERSTOP,
 285   OPTPIPEDECODE,
 286   OPTPIPESPLIT,
 287   OPTPOPAUTHTRYALL,
 288   OPTPOPLAST,
 289   OPTPRINTDECODE,
 290   OPTPRINTSPLIT,
 291   OPTPROMPTAFTER,
 292   OPTQUOTEEMPTY,
 293   OPTQUOTEQUOTED,
 294   OPTREADONLY,
 295   OPTREPLYSELF,
 296   OPTRESOLVE,
 297   OPTREVALIAS,
 298   OPTREVNAME,
 299   OPTREVREAL,
 300   OPTSAVEADDRESS,
 301   OPTSAVEEMPTY,
 302   OPTSAVENAME,
 303   OPTSCORE,
 304   OPTSIGDASHES,
 305   OPTSORTRE,
 306   OPTSPAMSEP,
 307   OPTSTATUSONTOP,
 308   OPTSTRICTMAILTO,
 309   OPTSTRICTTHREADS,
 310   OPTSTRIPWAS,
 311   OPTSTUFFQUOTED,
 312   OPTSUSPEND,
 313   OPTTEXTFLOWED,
 314   OPTTHOROUGHSRC,
 315   OPTTHREADRECEIVED,
 316   OPTTILDE,
 317   OPTUNCOLLAPSEJUMP,
 318   OPTUSEFROM,
 319 #ifdef HAVE_LIBIDN
 320   OPTUSEIDN,
 321 #endif
 322 #ifdef HAVE_GETADDRINFO
 323   OPTUSEIPV6,
 324 #endif
 325   OPTWAITKEY,
 326   OPTWEED,
 327   OPTWRAP,
 328   OPTWRAPSEARCH,
 329   OPTWRITEBCC,                  /* write out a bcc header? */
 330   OPTXMAILER,
 331   OPTXMAILTO,                   /* 1 if $edit_header is forcebly set */
 332   OPTXTERMSETTITLES,
 333
 334   /* PGP options */
 335
 336   OPTCRYPTAUTOSIGN,
 337   OPTCRYPTAUTOENCRYPT,
 338   OPTCRYPTAUTOPGP,
 339   OPTCRYPTAUTOSMIME,
 340   OPTCRYPTREPLYENCRYPT,
 341   OPTCRYPTREPLYSIGN,
 342   OPTCRYPTREPLYSIGNENCRYPTED,
 343   OPTSMIMEISDEFAULT,
 344   OPTPGPAUTODEC,
 345   OPTPGPRETAINABLESIG,
 346   OPTFORWDECRYPT,
 347   OPTPGPSHOWUNUSABLE,
 348
 349   /* news options */
 350
 351 #ifdef USE_NNTP
 352   OPTSHOWNEWNEWS,
 353   OPTSHOWONLYUNREAD,
 354   OPTSAVEUNSUB,
 355   OPTLOADDESC,
 356   OPTXCOMMENTTO,
 357 #endif                          /* USE_NNTP */
 358
 359   /* pseudo options */
 360
 361   OPTAUXSORT,                   /* (pseudo) using auxillary sort function */
 362   OPTFORCEREFRESH,              /* (pseudo) refresh even during macros */
 363   OPTNOCURSES,                  /* (pseudo) when sending in batch mode */
 364   OPTNEEDREDRAW,                /* (pseudo) to notify caller of a submenu */
 365   OPTSEARCHREVERSE,             /* (pseudo) used by ci_search_command */
 366   OPTMSGERR,                    /* (pseudo) used by mutt_error/mutt_message */
 367   OPTSEARCHINVALID,             /* (pseudo) used to invalidate the search pat */
 368   OPTSIGNALSBLOCKED,            /* (pseudo) using by mutt_block_signals () */
 369   OPTSYSSIGNALSBLOCKED,         /* (pseudo) using by mutt_block_signals_system () */
 370   OPTNEEDRESORT,                /* (pseudo) used to force a re-sort */
 371   OPTRESORTINIT,                /* (pseudo) used to force the next resort to be from scratch */
 372   OPTVIEWATTACH,                /* (pseudo) signals that we are viewing attachments */
 373   OPTFORCEREDRAWINDEX,          /* (pseudo) used to force a redraw in the main index */
 374   OPTFORCEREDRAWPAGER,          /* (pseudo) used to force a redraw in the pager */
 375   OPTSORTSUBTHREADS,            /* (pseudo) used when $sort_aux changes */
 376   OPTNEEDRESCORE,               /* (pseudo) set when the `score' command is used */
 377   OPTATTACHMSG,                 /* (pseudo) used by attach-message */
 378   OPTHIDEREAD,                  /* (pseudo) whether or not hide read messages */
 379   OPTKEEPQUIET,                 /* (pseudo) shut up the message and refresh
 380                                  *          functions while we are executing an
 381                                  *          external program.
 382                                  */
 383   OPTMENUCALLER,                /* (pseudo) tell menu to give caller a take */
 384   OPTREDRAWTREE,                /* (pseudo) redraw the thread tree */
 385   OPTPGPCHECKTRUST,             /* (pseudo) used by pgp_select_key () */
 386   OPTUNBUFFEREDINPUT,           /* (pseudo) don't use key buffer */
 387
 388 #ifdef USE_NNTP
 389   OPTNEWS,                      /* (pseudo) used to change reader mode */
 390   OPTNEWSSEND,                  /* (pseudo) used to change behavior when posting */
 391   OPTNEWSCACHE,                 /* (pseudo) used to indicate if news cache exist */
 392 #endif
 393   OPTSHORTENHIERARCHY,          /* set when to shorten "hierarchies" in the sidebar */
 394   OPTSIDEBARNEWMAILONLY,
 395   OPTMAX
 396 };
 397
 398 #define mutt_bit_alloc(n) p_new(char, (n + 7) / 8)
 399 #define mutt_bit_set(v,n) v[n/8] |= (1 << (n % 8))
 400 #define mutt_bit_unset(v,n) v[n/8] &= ~(1 << (n % 8))
 401 #define mutt_bit_toggle(v,n) v[n/8] ^= (1 << (n % 8))
 402 #define mutt_bit_isset(v,n) (v[n/8] & (1 << (n % 8)))
 403
 404 #define set_option(x) mutt_bit_set(Options,x)
 405 #define unset_option(x) mutt_bit_unset(Options,x)
 406 #define toggle_option(x) mutt_bit_toggle(Options,x)
 407 #define option(x) mutt_bit_isset(Options,x)
 408
 409 void mutt_init (int, string_list_t *);
 410
 411 typedef struct thread {
 412   unsigned int fake_thread:1;
 413   unsigned int duplicate_thread:1;
 414   unsigned int sort_children:1;
 415   unsigned int check_subject:1;
 416   unsigned int visible:1;
 417   unsigned int deep:1;
 418   unsigned int subtree_visible:2;
 419   unsigned int next_subtree_visible:1;
 420   struct thread *parent;
 421   struct thread *child;
 422   struct thread *next;
 423   struct thread *prev;
 424   HEADER *message;
 425   HEADER *sort_key;
 426 } THREAD;
 427
 428 typedef struct compress_info compress_info;
 429 typedef struct pattern_t pattern_t;
 430
 431 typedef struct {
 432   char *path;
 433   FILE *fp;
 434   time_t mtime;
 435   time_t mtime_cur;             /* used with maildir folders */
 436   off_t size;
 437   off_t vsize;
 438   char *pattern;                /* limit pattern string */
 439   pattern_t *limit_pattern;     /* compiled limit pattern */
 440   HEADER **hdrs;
 441   HEADER *last_tag;             /* last tagged msg. used to link threads */
 442   THREAD *tree;                 /* top of thread tree */
 443   hash_t *id_hash;                /* hash table by msg id */
 444   hash_t *subj_hash;              /* hash table by subject */
 445   hash_t *thread_hash;            /* hash table for threading */
 446   int *v2r;                     /* mapping from virtual to real msgno */
 447   int hdrmax;                   /* number of pointers in hdrs */
 448   int msgcount;                 /* number of messages in the mailbox */
 449   int vcount;                   /* the number of virtual messages */
 450   int tagged;                   /* how many messages are tagged? */
 451   int new;                      /* how many new messages? */
 452   int unread;                   /* how many unread messages? */
 453   int deleted;                  /* how many deleted messages */
 454   int appended;                 /* how many saved messages? */
 455   int flagged;                  /* how many flagged messages */
 456   int msgnotreadyet;            /* which msg "new" in pager, -1 if none */
 457   void *data;                   /* driver specific data */
 458
 459   short magic;                  /* mailbox type */
 460
 461   compress_info *cinfo;         /* compressed mbox module private data */
 462   char *realpath;               /* path to compressed mailbox */
 463
 464   unsigned int locked:1;        /* is the mailbox locked? */
 465   unsigned int changed:1;       /* mailbox has been modified */
 466   unsigned int readonly:1;      /* don't allow changes to the mailbox */
 467   unsigned int dontwrite:1;     /* dont write the mailbox on close */
 468   unsigned int append:1;        /* mailbox is opened in append mode */
 469   unsigned int quiet:1;         /* inhibit status messages? */
 470   unsigned int collapsed:1;     /* are all threads collapsed? */
 471   unsigned int closing:1;       /* mailbox is being closed */
 472   unsigned int counting:1;      /* do we just want to cound? */
 473 } CONTEXT;
 474
 475 /* for attachment counter */
 476 typedef struct {
 477   char *major;
 478   int major_int;
 479   const char *minor;
 480   regex_t minor_rx;
 481 } ATTACH_MATCH;
 482
 483 /* Flags for mutt_count_body_parts() */
 484 #define M_PARTS_TOPLEVEL (1<<0) /* is the top-level part */
 485 #define M_PARTS_RECOUNT (1<<1) /* force recount */
 486
 487 #include "protos.h"
 488 #include "globals.h"
 489
 490 #endif /* !_MUTT_H */