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