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