mutt.h

   1 /*
   2  * Copyright (C) 1996-2002 Michael R. Elkins <me@mutt.org>
   3  *
   4  *     This program is free software; you can redistribute it and/or modify
   5  *     it under the terms of the GNU General Public License as published by
   6  *     the Free Software Foundation; either version 2 of the License, or
   7  *     (at your option) any later version.
   8  *
   9  *     This program is distributed in the hope that it will be useful,
  10  *     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  *     GNU General Public License for more details.
  13  *
  14  *     You should have received a copy of the GNU General Public License
  15  *     along with this program; if not, write to the Free Software
  16  *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  17  */
  18
  19 #ifndef MUTT_H
  20 #define MUTT_H
  21
  22 #include "config.h"
  23
  24 #include <stdio.h>
  25 #include <stdlib.h>
  26 #ifdef HAVE_UNISTD_H
  27 # include <unistd.h> /* needed for SEEK_SET */
  28 #endif
  29 #ifdef HAVE_UNIX_H
  30 # include <unix.h>   /* needed for snprintf on QNX. */
  31 #endif
  32 #include <sys/types.h>
  33 #include <sys/stat.h>
  34 #include <time.h>
  35 #include <limits.h>
  36 #include <stdarg.h>
  37 #include <signal.h>
  38 #ifdef HAVE_WCHAR_H
  39 # include <wchar.h>
  40 #endif
  41 #if defined(HAVE_WCTYPE_H) && defined(HAVE_WC_FUNCS)
  42 # include <wctype.h>
  43 #endif
  44
  45 #ifndef _POSIX_PATH_MAX
  46 #include <posix1_lim.h>
  47 #endif
  48
  49 #include <pwd.h>
  50 #include <grp.h>
  51
  52 #include "rfc822.h"
  53 #include "hash.h"
  54 #include "charset.h"
  55
  56 #ifndef HAVE_WC_FUNCS
  57 # ifdef MB_LEN_MAX
  58 #  undef MB_LEN_MAX
  59 # endif
  60 # define MB_LEN_MAX 16
  61 #endif
  62
  63 #ifdef SUBVERSION
  64 # define MUTT_VERSION (VERSION SUBVERSION)
  65 #else
  66 # define MUTT_VERSION (VERSION)
  67 #endif
  68
  69 /* nifty trick I stole from ELM 2.5alpha. */
  70 #ifdef MAIN_C
  71 #define WHERE
  72 #define INITVAL(x) = x
  73 #else
  74 #define WHERE extern
  75 #define INITVAL(x)
  76 #endif
  77
  78 #include "mutt_regex.h"
  79
  80 /* flags for mutt_copy_header() */
  81 #define CH_UPDATE       1      /* update the status and x-status fields? */
  82 #define CH_WEED         (1<<1) /* weed the headers? */
  83 #define CH_DECODE       (1<<2) /* do RFC1522 decoding? */
  84 #define CH_XMIT         (1<<3) /* transmitting this message? */
  85 #define CH_FROM         (1<<4) /* retain the "From " message separator? */
  86 #define CH_PREFIX       (1<<5) /* use Prefix string? */
  87 #define CH_NOSTATUS     (1<<6) /* supress the status and x-status fields */
  88 #define CH_REORDER      (1<<7) /* Re-order output of headers */
  89 #define CH_NONEWLINE    (1<<8) /* don't output terminating newline */
  90 #define CH_MIME         (1<<9) /* ignore MIME fields */
  91 #define CH_UPDATE_LEN   (1<<10) /* update Lines: and Content-Length: */
  92 #define CH_TXTPLAIN     (1<<11) /* generate text/plain MIME headers */
  93 #define CH_NOLEN        (1<<12) /* don't write Content-Length: and Lines: */
  94 #define CH_WEED_DELIVERED (1<<13) /* weed eventual Delivered-To headers */
  95 #define CH_FORCE_FROM   (1<<14) /* give CH_FROM precedence over CH_WEED? */
  96 #define CH_NOQFROM      (1<<15) /* give CH_FROM precedence over CH_WEED? */
  97 #define CH_UPDATE_IRT   (1<<16) /* update In-Reply-To: */
  98 #define CH_UPDATE_REFS  (1<<17) /* update References: */
  99
 100 /* flags for mutt_enter_string() */
 101 #define  M_ALIAS   1      /* do alias "completion" by calling up the alias-menu */
 102 #define  M_FILE    (1<<1) /* do file completion */
 103 #define  M_EFILE   (1<<2) /* do file completion, plus incoming folders */
 104 #define  M_CMD     (1<<3) /* do completion on previous word */
 105 #define  M_PASS    (1<<4) /* password mode (no echo) */
 106 #define  M_CLEAR   (1<<5) /* clear input if printable character is pressed */
 107 #define  M_COMMAND (1<<6) /* do command completion */
 108 #define  M_PATTERN (1<<7) /* pattern mode - only used for history classes */
 109
 110 /* flags for mutt_get_token() */
 111 #define M_TOKEN_EQUAL           1       /* treat '=' as a special */
 112 #define M_TOKEN_CONDENSE        (1<<1)  /* ^(char) to control chars (macros) */
 113 #define M_TOKEN_SPACE           (1<<2)  /* don't treat whitespace as a term */
 114 #define M_TOKEN_QUOTE           (1<<3)  /* don't interpret quotes */
 115 #define M_TOKEN_PATTERN         (1<<4)  /* !)|~ are terms (for patterns) */
 116 #define M_TOKEN_COMMENT         (1<<5)  /* don't reap comments */
 117 #define M_TOKEN_SEMICOLON       (1<<6)  /* don't treat ; as special */
 118
 119 /* flags for km_dokey() */
 120 #define M_KM_UNBUFFERED 1 /* don't read from the key buffer */
 121
 122 typedef struct
 123 {
 124   char *data;   /* pointer to data */
 125   char *dptr;   /* current read/write position */
 126   size_t dsize; /* length of data */
 127   int destroy;  /* destroy `data' when done? */
 128 } BUFFER;
 129
 130 typedef struct
 131 {
 132   int ch; /* raw key pressed */
 133   int op; /* function op */
 134 } event_t;
 135
 136 /* flags for _mutt_system() */
 137 #define M_DETACH_PROCESS        1       /* detach subprocess from group */
 138
 139 /* flags for mutt_FormatString() */
 140 typedef enum
 141 {
 142   M_FORMAT_FORCESUBJ    = (1<<0), /* print the subject even if unchanged */
 143   M_FORMAT_TREE         = (1<<1), /* draw the thread tree */
 144   M_FORMAT_MAKEPRINT    = (1<<2), /* make sure that all chars are printable */
 145   M_FORMAT_OPTIONAL     = (1<<3),
 146   M_FORMAT_STAT_FILE    = (1<<4), /* used by mutt_attach_fmt */
 147   M_FORMAT_ARROWCURSOR  = (1<<5), /* reserve space for arrow_cursor */
 148   M_FORMAT_INDEX        = (1<<6)  /* this is a main index entry */
 149 } format_flag;
 150
 151 /* types for mutt_add_hook() */
 152 #define M_FOLDERHOOK    1
 153 #define M_MBOXHOOK      (1<<1)
 154 #define M_SENDHOOK      (1<<2)
 155 #define M_FCCHOOK       (1<<3)
 156 #define M_SAVEHOOK      (1<<4)
 157 #define M_CHARSETHOOK   (1<<5)
 158 #define M_ICONVHOOK     (1<<6)
 159 #define M_MESSAGEHOOK   (1<<7)
 160 #define M_CRYPTHOOK     (1<<8)
 161 #define M_ACCOUNTHOOK   (1<<9)
 162 #define M_REPLYHOOK     (1<<10)
 163 #ifdef USE_COMPRESSED
 164 #define M_OPENHOOK      (1<<12)
 165 #define M_APPENDHOOK    (1<<13)
 166 #define M_CLOSEHOOK     (1<<14)
 167 #endif
 168
 169 /* tree characters for linearize_tree and print_enriched_string */
 170 #define M_TREE_LLCORNER         1
 171 #define M_TREE_ULCORNER         2
 172 #define M_TREE_LTEE             3
 173 #define M_TREE_HLINE            4
 174 #define M_TREE_VLINE            5
 175 #define M_TREE_SPACE            6
 176 #define M_TREE_RARROW           7
 177 #define M_TREE_STAR             8
 178 #define M_TREE_HIDDEN           9
 179 #define M_TREE_EQUALS           10
 180 #define M_TREE_TTEE             11
 181 #define M_TREE_BTEE             12
 182 #define M_TREE_MISSING          13
 183 #define M_TREE_MAX              14
 184
 185 #define M_THREAD_COLLAPSE       (1<<0)
 186 #define M_THREAD_UNCOLLAPSE     (1<<1)
 187 #define M_THREAD_GET_HIDDEN     (1<<2)
 188 #define M_THREAD_UNREAD         (1<<3)
 189 #define M_THREAD_NEXT_UNREAD    (1<<4)
 190
 191 enum
 192 {
 193   /* modes for mutt_view_attachment() */
 194   M_REGULAR = 1,
 195   M_MAILCAP,
 196   M_AS_TEXT,
 197
 198   /* action codes used by mutt_set_flag() and mutt_pattern_function() */
 199   M_ALL,
 200   M_NONE,
 201   M_NEW,
 202   M_OLD,
 203   M_REPLIED,
 204   M_READ,
 205   M_UNREAD,
 206   M_DELETE,
 207   M_UNDELETE,
 208   M_DELETED,
 209   M_APPENDED,
 210   M_PURGED,
 211   M_FLAG,
 212   M_TAG,
 213   M_UNTAG,
 214   M_LIMIT,
 215   M_EXPIRED,
 216   M_SUPERSEDED,
 217
 218   /* actions for mutt_pattern_comp/mutt_pattern_exec */
 219   M_AND,
 220   M_OR,
 221   M_TO,
 222   M_CC,
 223   M_COLLAPSED,
 224   M_SUBJECT,
 225   M_FROM,
 226   M_DATE,
 227   M_DATE_RECEIVED,
 228   M_DUPLICATED,
 229   M_ID,
 230   M_BODY,
 231   M_HEADER,
 232   M_WHOLE_MSG,
 233   M_SENDER,
 234   M_MESSAGE,
 235   M_SCORE,
 236   M_SIZE,
 237   M_REFERENCE,
 238   M_RECIPIENT,
 239   M_LIST,
 240   M_PERSONAL_RECIP,
 241   M_PERSONAL_FROM,
 242   M_ADDRESS,
 243   M_CRYPT_SIGN,
 244   M_CRYPT_VERIFIED,
 245   M_CRYPT_ENCRYPT,
 246   M_PGP_KEY,
 247   M_XLABEL,
 248 #ifdef USE_NNTP
 249   M_NEWSGROUPS,
 250 #endif
 251
 252   /* Options for Mailcap lookup */
 253   M_EDIT,
 254   M_COMPOSE,
 255   M_PRINT,
 256   M_AUTOVIEW,
 257
 258   /* options for socket code */
 259   M_NEW_SOCKET,
 260 #ifdef USE_SSL
 261   M_NEW_SSL_SOCKET,
 262 #endif
 263
 264   /* Options for mutt_save_attachment */
 265   M_SAVE_APPEND,
 266   M_SAVE_OVERWRITE
 267 };
 268
 269 /* possible arguments to set_quadoption() */
 270 enum
 271 {
 272   M_NO,
 273   M_YES,
 274   M_ASKNO,
 275   M_ASKYES
 276 };
 277
 278 /* quad-option vars */
 279 enum
 280 {
 281   OPT_ABORT,
 282   OPT_BOUNCE,
 283   OPT_COPY,
 284   OPT_DELETE,
 285   OPT_FORWEDIT,
 286   OPT_INCLUDE,
 287   OPT_MFUPTO,
 288   OPT_MIMEFWD,
 289   OPT_MIMEFWDREST,
 290   OPT_MOVE,
 291   OPT_PGPTRADITIONAL, /* create old-style PGP messages */
 292 #ifdef USE_POP
 293   OPT_POPDELETE,
 294   OPT_POPRECONNECT,
 295 #endif
 296   OPT_POSTPONE,
 297   OPT_PRINT,
 298   OPT_QUIT,
 299   OPT_REPLYTO,
 300   OPT_RECALL,
 301 #if defined(USE_SSL) || defined(USE_GNUTLS)
 302   OPT_SSLSTARTTLS,
 303 #endif
 304   OPT_SUBJECT,
 305   OPT_VERIFYSIG,      /* verify PGP signatures */
 306   OPT_LISTREPLY,
 307 #ifdef USE_NNTP
 308   OPT_TOMODERATED,
 309   OPT_NNTPRECONNECT,
 310   OPT_CATCHUP,
 311   OPT_FOLLOWUPTOPOSTER,
 312 #endif /* USE_NNTP */
 313
 314   /* THIS MUST BE THE LAST VALUE. */
 315   OPT_MAX
 316 };
 317
 318 /* flags to ci_send_message() */
 319 #define SENDREPLY       (1<<0)
 320 #define SENDGROUPREPLY  (1<<1)
 321 #define SENDLISTREPLY   (1<<2)
 322 #define SENDFORWARD     (1<<3)
 323 #define SENDPOSTPONED   (1<<4)
 324 #define SENDBATCH       (1<<5)
 325 #define SENDMAILX       (1<<6)
 326 #define SENDKEY         (1<<7)
 327 #define SENDRESEND      (1<<8)
 328 #define SENDNEWS        (1<<9)
 329
 330 /* flags to _mutt_select_file() */
 331 #define M_SEL_BUFFY     (1<<0)
 332 #define M_SEL_MULTI     (1<<1)
 333 #define M_SEL_FOLDER    (1<<2)
 334
 335
 336 /* boolean vars */
 337 enum
 338 {
 339   OPTALLOW8BIT,
 340   OPTALLOWANSI,
 341   OPTARROWCURSOR,
 342   OPTASCIICHARS,
 343   OPTASKBCC,
 344   OPTASKCC,
 345   OPTASKFOLLOWUP,
 346   OPTASKXCOMMENTTO,
 347   OPTATTACHSPLIT,
 348   OPTAUTOEDIT,
 349   OPTAUTOTAG,
 350   OPTBEEP,
 351   OPTBEEPNEW,
 352   OPTBOUNCEDELIVERED,
 353   OPTCHECKNEW,
 354   OPTCOLLAPSEUNREAD,
 355   OPTCONFIRMAPPEND,
 356   OPTCONFIRMCREATE,
 357   OPTDELETEUNTAG,
 358   OPTDIGESTCOLLAPSE,
 359   OPTDUPTHREADS,
 360   OPTEDITHDRS,
 361   OPTENCODEFROM,
 362   OPTENVFROM,
 363   OPTFASTREPLY,
 364   OPTFCCATTACH,
 365   OPTFCCCLEAR,
 366   OPTFOLLOWUPTO,
 367   OPTFORCENAME,
 368   OPTFORWDECODE,
 369   OPTFORWQUOTE,
 370   OPTHDRS,
 371   OPTHEADER,
 372   OPTHELP,
 373   OPTHIDDENHOST,
 374   OPTHIDELIMITED,
 375   OPTHIDEMISSING,
 376   OPTHIDETOPLIMITED,
 377   OPTHIDETOPMISSING,
 378   OPTIGNORELISTREPLYTO,
 379 #ifdef USE_IMAP
 380   OPTIMAPLSUB,
 381   OPTIMAPPASSIVE,
 382   OPTIMAPPEEK,
 383   OPTIMAPSERVERNOISE,
 384 # if defined(USE_SSL) || defined(USE_GNUTLS)
 385   OPTIMAPFORCESSL,
 386 # endif
 387 #endif
 388 #if defined(USE_SSL) || defined(USE_NSS) || defined(USE_GNUTLS)
 389 # ifndef USE_GNUTLS
 390   OPTSSLV2,
 391 # endif
 392   OPTSSLV3,
 393   OPTTLSV1,
 394 # ifndef USE_GNUTLS
 395   OPTSSLSYSTEMCERTS,
 396 # endif
 397 #endif
 398   OPTIMPLICITAUTOVIEW,
 399   OPTKEEPFLAGGED,
 400   OPTMAILCAPSANITIZE,
 401   OPTMAILDIRTRASH,
 402   OPTMARKERS,
 403   OPTMARKOLD,
 404   OPTMBOXPANE,
 405   OPTMENUSCROLL,        /* scroll menu instead of implicit next-page */
 406   OPTMETAKEY,           /* interpret ALT-x as ESC-x */
 407   OPTMETOO,
 408   OPTMHPURGE,
 409   OPTMIMEFORWDECODE,
 410 #ifdef USE_NNTP
 411   OPTMIMESUBJECT,       /* encode subject line with RFC2047 */
 412 #endif
 413   OPTNARROWTREE,
 414   OPTPAGERSTOP,
 415   OPTPIPEDECODE,
 416   OPTPIPESPLIT,
 417 #ifdef USE_POP
 418   OPTPOPAUTHTRYALL,
 419   OPTPOPLAST,
 420 #endif
 421   OPTPRINTDECODE,
 422   OPTPRINTSPLIT,
 423   OPTPROMPTAFTER,
 424   OPTQUOTEEMPTY,
 425   OPTQUOTEQUOTED,
 426   OPTREADONLY,
 427   OPTREPLYSELF,
 428   OPTRESOLVE,
 429   OPTREVALIAS,
 430   OPTREVNAME,
 431   OPTREVREAL,
 432   OPTRFC2047PARAMS,
 433   OPTSAVEADDRESS,
 434   OPTSAVEEMPTY,
 435   OPTSAVENAME,
 436   OPTSCORE,
 437   OPTSIGDASHES,
 438   OPTSIGONTOP,
 439   OPTSORTRE,
 440   OPTSTATUSONTOP,
 441   OPTSTRICTTHREADS,
 442   OPTSUSPEND,
 443   OPTTEXTFLOWED,
 444   OPTTHOROUGHSRC,
 445   OPTTHREADRECEIVED,
 446   OPTTILDE,
 447   OPTUNCOLLAPSEJUMP,
 448   OPTUSE8BITMIME,
 449   OPTUSEDOMAIN,
 450   OPTUSEFROM,
 451   OPTUSEGPGAGENT,
 452 #ifdef HAVE_GETADDRINFO
 453   OPTUSEIPV6,
 454 #endif
 455   OPTWAITKEY,
 456   OPTWEED,
 457   OPTWRAP,
 458   OPTWRAPSEARCH,
 459   OPTWRITEBCC,          /* write out a bcc header? */
 460   OPTXMAILER,
 461   OPTXTERMSETTITLES,
 462
 463   /* PGP options */
 464
 465   OPTCRYPTAUTOSIGN,
 466   OPTCRYPTAUTOENCRYPT,
 467   OPTCRYPTAUTOPGP,
 468   OPTCRYPTAUTOSMIME,
 469   OPTCRYPTREPLYENCRYPT,
 470   OPTCRYPTREPLYSIGN,
 471   OPTCRYPTREPLYSIGNENCRYPTED,
 472   OPTCRYPTTIMESTAMP,
 473   OPTSMIMEISDEFAULT,
 474   OPTASKCERTLABEL,
 475   OPTSDEFAULTDECRYPTKEY,
 476   OPTPGPIGNORESUB,
 477   OPTPGPCHECKEXIT,
 478   OPTPGPLONGIDS,
 479   OPTPGPAUTOTRAD,
 480 #if 0
 481   OPTPGPENCRYPTSELF,
 482 #endif
 483   OPTPGPRETAINABLESIG,
 484   OPTPGPSTRICTENC,
 485   OPTFORWDECRYPT,
 486   OPTPGPSHOWUNUSABLE,
 487
 488   /* news options */
 489
 490 #ifdef USE_NNTP
 491   OPTSHOWNEWNEWS,
 492   OPTSHOWONLYUNREAD,
 493   OPTSAVEUNSUB,
 494   OPTLOADDESC,
 495   OPTXCOMMENTTO,
 496 #endif /* USE_NNTP */
 497
 498   /* pseudo options */
 499
 500   OPTAUXSORT,           /* (pseudo) using auxillary sort function */
 501   OPTFORCEREFRESH,      /* (pseudo) refresh even during macros */
 502   OPTLOCALES,           /* (pseudo) set if user has valid locale definition */
 503   OPTNOCURSES,          /* (pseudo) when sending in batch mode */
 504   OPTNEEDREDRAW,        /* (pseudo) to notify caller of a submenu */
 505   OPTSEARCHREVERSE,     /* (pseudo) used by ci_search_command */
 506   OPTMSGERR,            /* (pseudo) used by mutt_error/mutt_message */
 507   OPTSEARCHINVALID,     /* (pseudo) used to invalidate the search pat */
 508   OPTSIGNALSBLOCKED,    /* (pseudo) using by mutt_block_signals () */
 509   OPTSYSSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals_system () */
 510   OPTNEEDRESORT,        /* (pseudo) used to force a re-sort */
 511   OPTRESORTINIT,        /* (pseudo) used to force the next resort to be from scratch */
 512   OPTVIEWATTACH,        /* (pseudo) signals that we are viewing attachments */
 513   OPTFORCEREDRAWINDEX,  /* (pseudo) used to force a redraw in the main index */
 514   OPTFORCEREDRAWPAGER,  /* (pseudo) used to force a redraw in the pager */
 515   OPTSORTSUBTHREADS,    /* (pseudo) used when $sort_aux changes */
 516   OPTNEEDRESCORE,       /* (pseudo) set when the `score' command is used */
 517   OPTATTACHMSG,         /* (pseudo) used by attach-message */
 518   OPTHIDEREAD,          /* (pseudo) whether or not hide read messages */
 519   OPTKEEPQUIET,         /* (pseudo) shut up the message and refresh
 520                          *          functions while we are executing an
 521                          *          external program.
 522                          */
 523   OPTMENUCALLER,        /* (pseudo) tell menu to give caller a take */
 524   OPTREDRAWTREE,        /* (pseudo) redraw the thread tree */
 525   OPTPGPCHECKTRUST,     /* (pseudo) used by pgp_select_key () */
 526   OPTDONTHANDLEPGPKEYS, /* (pseudo) used to extract PGP keys */
 527   OPTUNBUFFEREDINPUT,   /* (pseudo) don't use key buffer */
 528
 529 #ifdef USE_NNTP
 530   OPTNEWS,              /* (pseudo) used to change reader mode */
 531   OPTNEWSSEND,          /* (pseudo) used to change behavior when posting */
 532   OPTNEWSCACHE,         /* (pseudo) used to indicate if news cache exist */
 533 #endif
 534
 535   OPTMAX
 536 };
 537
 538 #define mutt_bit_alloc(n) calloc ((n + 7) / 8, sizeof (char))
 539 #define mutt_bit_set(v,n) v[n/8] |= (1 << (n % 8))
 540 #define mutt_bit_unset(v,n) v[n/8] &= ~(1 << (n % 8))
 541 #define mutt_bit_toggle(v,n) v[n/8] ^= (1 << (n % 8))
 542 #define mutt_bit_isset(v,n) (v[n/8] & (1 << (n % 8)))
 543
 544 #define set_option(x) mutt_bit_set(Options,x)
 545 #define unset_option(x) mutt_bit_unset(Options,x)
 546 #define toggle_option(x) mutt_bit_toggle(Options,x)
 547 #define option(x) mutt_bit_isset(Options,x)
 548
 549 /* Exit values used in send_msg() */
 550 #define S_ERR 127
 551 #define S_BKG 126
 552
 553 typedef struct list_t
 554 {
 555   char *data;
 556   struct list_t *next;
 557 } LIST;
 558
 559 typedef struct rx_list_t
 560 {
 561   REGEXP *rx;
 562   struct rx_list_t *next;
 563 } RX_LIST;
 564
 565 #define mutt_new_list() safe_calloc (1, sizeof (LIST))
 566 #define mutt_new_rx_list() safe_calloc (1, sizeof (RX_LIST))
 567 void mutt_free_list (LIST **);
 568 void mutt_free_rx_list (RX_LIST **);
 569 LIST *mutt_copy_list (LIST *);
 570 int mutt_matches_ignore (const char *, LIST *);
 571 /* add an element to a list */
 572 LIST *mutt_add_list (LIST *, const char *);
 573
 574 void mutt_init (int, LIST *);
 575
 576 typedef struct alias
 577 {
 578   struct alias *self;           /* XXX - ugly hack */
 579   char *name;
 580   ADDRESS *addr;
 581   struct alias *next;
 582   short tagged;
 583   short del;
 584   short num;
 585 } ALIAS;
 586
 587 typedef struct envelope
 588 {
 589   ADDRESS *return_path;
 590   ADDRESS *from;
 591   ADDRESS *to;
 592   ADDRESS *cc;
 593   ADDRESS *bcc;
 594   ADDRESS *sender;
 595   ADDRESS *reply_to;
 596   ADDRESS *mail_followup_to;
 597   char *subject;
 598   char *real_subj;              /* offset of the real subject */
 599   char *message_id;
 600   char *supersedes;
 601   char *date;
 602   char *x_label;
 603   char *organization;
 604 #ifdef USE_NNTP
 605   char *newsgroups;
 606   char *xref;
 607   char *followup_to;
 608   char *x_comment_to;
 609 #endif
 610   LIST *references;             /* message references (in reverse order) */
 611   LIST *in_reply_to;            /* in-reply-to header content */
 612   LIST *userhdrs;               /* user defined headers */
 613 } ENVELOPE;
 614
 615 typedef struct parameter
 616 {
 617   char *attribute;
 618   char *value;
 619   struct parameter *next;
 620 } PARAMETER;
 621
 622 /* Information that helps in determing the Content-* of an attachment */
 623 typedef struct content
 624 {
 625   long hibin;              /* 8-bit characters */
 626   long lobin;              /* unprintable 7-bit chars (eg., control chars) */
 627   long crlf;               /* '\r' and '\n' characters */
 628   long ascii;              /* number of ascii chars */
 629   long linemax;            /* length of the longest line in the file */
 630   unsigned int space : 1;  /* whitespace at the end of lines? */
 631   unsigned int binary : 1; /* long lines, or CR not in CRLF pair */
 632   unsigned int from : 1;   /* has a line beginning with "From "? */
 633   unsigned int dot : 1;    /* has a line consisting of a single dot? */
 634   unsigned int cr : 1;     /* has CR, even when in a CRLF pair */
 635 } CONTENT;
 636
 637 typedef struct body
 638 {
 639   char *xtype;                  /* content-type if x-unknown */
 640   char *subtype;                /* content-type subtype */
 641   PARAMETER *parameter;         /* parameters of the content-type */
 642   char *description;            /* content-description */
 643   char *form_name;              /* Content-Disposition form-data name param */
 644   long hdr_offset;              /* offset in stream where the headers begin.
 645                                  * this info is used when invoking metamail,
 646                                  * where we need to send the headers of the
 647                                  * attachment
 648                                  */
 649   long offset;                  /* offset where the actual data begins */
 650   long length;                  /* length (in bytes) of attachment */
 651   char *filename;               /* when sending a message, this is the file
 652                                  * to which this structure refers
 653                                  */
 654   char *d_filename;             /* filename to be used for the
 655                                  * content-disposition header.
 656                                  * If NULL, filename is used
 657                                  * instead.
 658                                  */
 659   CONTENT *content;             /* structure used to store detailed info about
 660                                  * the content of the attachment.  this is used
 661                                  * to determine what content-transfer-encoding
 662                                  * is required when sending mail.
 663                                  */
 664   struct body *next;            /* next attachment in the list */
 665   struct body *parts;           /* parts of a multipart or message/rfc822 */
 666   struct header *hdr;           /* header information for message/rfc822 */
 667
 668   struct attachptr *aptr;       /* Menu information, used in recvattach.c */
 669
 670   time_t stamp;                 /* time stamp of last
 671                                  * encoding update.
 672                                  */
 673
 674   unsigned int type : 4;        /* content-type primary type */
 675   unsigned int encoding : 3;    /* content-transfer-encoding */
 676   unsigned int disposition : 2; /* content-disposition */
 677   unsigned int use_disp : 1;    /* Content-Disposition uses filename= ? */
 678   unsigned int unlink : 1;      /* flag to indicate the the file named by
 679                                  * "filename" should be unlink()ed before
 680                                  * free()ing this structure
 681                                  */
 682   unsigned int tagged : 1;
 683   unsigned int deleted : 1;     /* attachment marked for deletion */
 684
 685   unsigned int noconv : 1;      /* don't do character set conversion */
 686   unsigned int force_charset : 1;
 687                                 /* send mode: don't adjust the character
 688                                  * set when in send-mode.
 689                                  */
 690
 691   unsigned int goodsig : 1;     /* good cryptographic signature */
 692   unsigned int badsig : 1;      /* bad cryptographic signature (needed to check encrypted s/mime-signatures) */
 693
 694   unsigned int collapsed : 1;   /* used by recvattach */
 695
 696 } BODY;
 697
 698 typedef struct header
 699 {
 700   unsigned int security : 9;  /* bit 0-6: flags, bit 7,8: application.
 701                                  see: crypt.h pgplib.h, smime.h */
 702
 703   unsigned int mime : 1;                /* has a Mime-Version header? */
 704   unsigned int flagged : 1;             /* marked important? */
 705   unsigned int tagged : 1;
 706   unsigned int appended : 1; /* has been saved */
 707   unsigned int purged : 1;   /* bypassing the trash folder */
 708   unsigned int deleted : 1;
 709   unsigned int changed : 1;
 710   unsigned int attach_del : 1;          /* has an attachment marked for deletion */
 711   unsigned int old : 1;
 712   unsigned int read : 1;
 713   unsigned int expired : 1;             /* already expired? */
 714   unsigned int superseded : 1;          /* got superseded? */
 715   unsigned int replied : 1;
 716   unsigned int subject_changed : 1;     /* used for threading */
 717   unsigned int threaded : 1;            /* used for threading */
 718   unsigned int display_subject : 1;     /* used for threading */
 719   unsigned int irt_changed : 1; /* In-Reply-To changed to link/break threads */
 720   unsigned int refs_changed : 1; /* References changed to break thread */
 721   unsigned int recip_valid : 1;         /* is_recipient is valid */
 722   unsigned int active : 1;              /* message is not to be removed */
 723   unsigned int trash : 1;               /* message is marked as trashed on disk.
 724                                          * This flag is used by the maildir_trash
 725                                          * option.
 726                                          */
 727
 728   /* timezone of the sender of this message */
 729   unsigned int zhours : 5;
 730   unsigned int zminutes : 6;
 731   unsigned int zoccident : 1;
 732
 733   /* bits used for caching when searching */
 734   unsigned int searched : 1;
 735   unsigned int matched : 1;
 736
 737   /* the following are used to support collapsing threads  */
 738   unsigned int collapsed : 1;   /* is this message part of a collapsed thread? */
 739   unsigned int limited : 1;     /* is this message in a limited view?  */
 740   size_t num_hidden;            /* number of hidden messages in this view */
 741
 742   short recipient;              /* user_is_recipient()'s return value, cached */
 743
 744   int pair;                     /* color-pair to use when displaying in the index */
 745
 746   time_t date_sent;             /* time when the message was sent (UTC) */
 747   time_t received;              /* time when the message was placed in the mailbox */
 748   long offset;                  /* where in the stream does this message begin? */
 749   int lines;                    /* how many lines in the body of this message? */
 750   int index;                    /* the absolute (unsorted) message number */
 751   int msgno;                    /* number displayed to the user */
 752   int virtual;                  /* virtual message number */
 753   int score;
 754   ENVELOPE *env;                /* envelope information */
 755   BODY *content;                /* list of MIME parts */
 756   char *path;
 757 #ifdef USE_NNTP
 758   int article_num;
 759 #endif
 760
 761   char *tree;                   /* character string to print thread tree */
 762   struct thread *thread;
 763
 764 #ifdef IMAP_EDIT_THREADS
 765   ENVELOPE *new_env;    /* envelope information for rethreading */
 766 #endif
 767
 768 #ifdef MIXMASTER
 769   LIST *chain;
 770 #endif
 771
 772 #ifdef USE_POP
 773   int refno;                    /* message number on server */
 774 #endif
 775
 776 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
 777   void *data;                   /* driver-specific data */
 778 #endif
 779
 780   char *maildir_flags;          /* unknown maildir flags */
 781 } HEADER;
 782
 783 typedef struct thread
 784 {
 785   unsigned int fake_thread : 1;
 786   unsigned int duplicate_thread : 1;
 787   unsigned int sort_children : 1;
 788   unsigned int check_subject : 1;
 789   unsigned int visible : 1;
 790   unsigned int deep : 1;
 791   unsigned int subtree_visible : 2;
 792   unsigned int next_subtree_visible : 1;
 793   struct thread *parent;
 794   struct thread *child;
 795   struct thread *next;
 796   struct thread *prev;
 797   HEADER *message;
 798   HEADER *sort_key;
 799 } THREAD;
 800
 801
 802 /* flag to mutt_pattern_comp() */
 803 #define M_FULL_MSG      1       /* enable body and header matching */
 804
 805 typedef enum {
 806   M_MATCH_FULL_ADDRESS = 1
 807 } pattern_exec_flag;
 808
 809 typedef struct pattern_t
 810 {
 811   short op;
 812   short not;
 813   short alladdr;
 814   int min;
 815   int max;
 816   struct pattern_t *next;
 817   struct pattern_t *child;              /* arguments to logical op */
 818   regex_t *rx;
 819 } pattern_t;
 820
 821 typedef struct
 822 {
 823   char *path;
 824   FILE *fp;
 825   time_t mtime;
 826   time_t mtime_cur;             /* used with maildir folders */
 827   off_t size;
 828   off_t vsize;
 829   char *pattern;                /* limit pattern string */
 830   pattern_t *limit_pattern;     /* compiled limit pattern */
 831   HEADER **hdrs;
 832   HEADER *last_tag;             /* last tagged msg. used to link threads */
 833   THREAD *tree;                 /* top of thread tree */
 834   HASH *id_hash;                /* hash table by msg id */
 835   HASH *subj_hash;              /* hash table by subject */
 836   HASH *thread_hash;            /* hash table for threading */
 837   int *v2r;                     /* mapping from virtual to real msgno */
 838   int hdrmax;                   /* number of pointers in hdrs */
 839   int msgcount;                 /* number of messages in the mailbox */
 840   int vcount;                   /* the number of virtual messages */
 841   int tagged;                   /* how many messages are tagged? */
 842   int new;                      /* how many new messages? */
 843   int unread;                   /* how many unread messages? */
 844   int deleted;                  /* how many deleted messages */
 845   int appended;                 /* how many saved messages? */
 846   int flagged;                  /* how many flagged messages */
 847   int msgnotreadyet;            /* which msg "new" in pager, -1 if none */
 848 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
 849   void *data;                   /* driver specific data */
 850 #endif /* USE_IMAP */
 851
 852   short magic;                  /* mailbox type */
 853
 854 #ifdef USE_COMPRESSED
 855   void *compressinfo;           /* compressed mbox module private data */
 856   char *realpath;               /* path to compressed mailbox */
 857 #endif /* USE_COMPRESSED */
 858
 859   unsigned int locked : 1;      /* is the mailbox locked? */
 860   unsigned int changed : 1;     /* mailbox has been modified */
 861   unsigned int readonly : 1;    /* don't allow changes to the mailbox */
 862   unsigned int dontwrite : 1;   /* dont write the mailbox on close */
 863   unsigned int append : 1;      /* mailbox is opened in append mode */
 864   unsigned int quiet : 1;       /* inhibit status messages? */
 865   unsigned int collapsed : 1;   /* are all threads collapsed? */
 866   unsigned int closing : 1;     /* mailbox is being closed */
 867 } CONTEXT;
 868
 869 typedef struct attachptr
 870 {
 871   BODY *content;
 872   int parent_type;
 873   char *tree;
 874   int level;
 875   int num;
 876 } ATTACHPTR;
 877
 878 typedef struct
 879 {
 880   FILE *fpin;
 881   FILE *fpout;
 882   char *prefix;
 883   int flags;
 884 } STATE;
 885
 886 /* used by enter.c */
 887
 888 typedef struct
 889 {
 890   wchar_t *wbuf;
 891   size_t wbuflen;
 892   size_t lastchar;
 893   size_t curpos;
 894   size_t begin;
 895   int    tabs;
 896 } ENTER_STATE;
 897
 898 /* flags for the STATE struct */
 899 #define M_DISPLAY       (1<<0) /* output is displayed to the user */
 900 #define M_VERIFY        (1<<1) /* perform signature verification */
 901 #define M_PENDINGPREFIX (1<<2) /* prefix to write, but character must follow */
 902 #define M_WEED          (1<<3) /* weed headers even when not in display mode */
 903 #define M_CHARCONV      (1<<4) /* Do character set conversions */
 904 #define M_PRINTING      (1<<5) /* are we printing? - M_DISPLAY "light" */
 905
 906 #define state_set_prefix(s) ((s)->flags |= M_PENDINGPREFIX)
 907 #define state_reset_prefix(s) ((s)->flags &= ~M_PENDINGPREFIX)
 908 #define state_puts(x,y) fputs(x,(y)->fpout)
 909 #define state_putc(x,y) fputc(x,(y)->fpout)
 910
 911 void state_mark_attach (STATE *);
 912 void state_attach_puts (const char *, STATE *);
 913 void state_prefix_putc (char, STATE *);
 914 int  state_printf(STATE *, const char *, ...);
 915
 916 #include "ascii.h"
 917 #include "protos.h"
 918 #include "lib.h"
 919 #include "globals.h"
 920
 921 #endif /*MUTT_H*/