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