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 #ifdef USE_IMAP
 288   OPT_IMAPRECONNECT,
 289 #endif
 290   OPT_MFUPTO,
 291   OPT_MIMEFWD,
 292   OPT_MIMEFWDREST,
 293   OPT_MOVE,
 294   OPT_PGPTRADITIONAL, /* create old-style PGP messages */
 295 #ifdef USE_POP
 296   OPT_POPDELETE,
 297   OPT_POPRECONNECT,
 298 #endif
 299   OPT_POSTPONE,
 300   OPT_PRINT,
 301   OPT_QUIT,
 302   OPT_REPLYTO,
 303   OPT_RECALL,
 304 #if defined(USE_SSL) || defined(USE_GNUTLS)
 305   OPT_SSLSTARTTLS,
 306 #endif
 307   OPT_SUBJECT,
 308   OPT_VERIFYSIG,      /* verify PGP signatures */
 309   OPT_LISTREPLY,
 310 #ifdef USE_NNTP
 311   OPT_TOMODERATED,
 312   OPT_NNTPRECONNECT,
 313   OPT_CATCHUP,
 314   OPT_FOLLOWUPTOPOSTER,
 315 #endif /* USE_NNTP */
 316
 317   /* THIS MUST BE THE LAST VALUE. */
 318   OPT_MAX
 319 };
 320
 321 /* flags to ci_send_message() */
 322 #define SENDREPLY       (1<<0)
 323 #define SENDGROUPREPLY  (1<<1)
 324 #define SENDLISTREPLY   (1<<2)
 325 #define SENDFORWARD     (1<<3)
 326 #define SENDPOSTPONED   (1<<4)
 327 #define SENDBATCH       (1<<5)
 328 #define SENDMAILX       (1<<6)
 329 #define SENDKEY         (1<<7)
 330 #define SENDRESEND      (1<<8)
 331 #define SENDNEWS        (1<<9)
 332
 333 /* flags to _mutt_select_file() */
 334 #define M_SEL_BUFFY     (1<<0)
 335 #define M_SEL_MULTI     (1<<1)
 336 #define M_SEL_FOLDER    (1<<2)
 337
 338
 339 /* boolean vars */
 340 enum
 341 {
 342   OPTALLOW8BIT,
 343   OPTALLOWANSI,
 344   OPTARROWCURSOR,
 345   OPTASCIICHARS,
 346   OPTASKBCC,
 347   OPTASKCC,
 348   OPTASKFOLLOWUP,
 349   OPTASKXCOMMENTTO,
 350   OPTATTACHSPLIT,
 351   OPTAUTOEDIT,
 352   OPTAUTOTAG,
 353   OPTBEEP,
 354   OPTBEEPNEW,
 355   OPTBOUNCEDELIVERED,
 356   OPTCHECKNEW,
 357   OPTCOLLAPSEUNREAD,
 358   OPTCONFIRMAPPEND,
 359   OPTCONFIRMCREATE,
 360   OPTDELETEUNTAG,
 361   OPTDIGESTCOLLAPSE,
 362   OPTDUPTHREADS,
 363   OPTEDITHDRS,
 364   OPTENCODEFROM,
 365   OPTENVFROM,
 366   OPTFASTREPLY,
 367   OPTFCCATTACH,
 368   OPTFCCCLEAR,
 369   OPTFOLLOWUPTO,
 370   OPTFORCENAME,
 371   OPTFORWDECODE,
 372   OPTFORWQUOTE,
 373 #if USE_HCACHE
 374   OPTHCACHEVERIFY,
 375 #endif
 376   OPTHDRS,
 377   OPTHEADER,
 378   OPTHELP,
 379   OPTHIDDENHOST,
 380   OPTHIDELIMITED,
 381   OPTHIDEMISSING,
 382   OPTHIDETOPLIMITED,
 383   OPTHIDETOPMISSING,
 384   OPTIGNORELISTREPLYTO,
 385 #ifdef USE_IMAP
 386   OPTIMAPLSUB,
 387   OPTIMAPPASSIVE,
 388   OPTIMAPPEEK,
 389   OPTIMAPSERVERNOISE,
 390 # if defined(USE_SSL) || defined(USE_GNUTLS)
 391   OPTIMAPFORCESSL,
 392 # endif
 393 #endif
 394 #if defined(USE_SSL) || defined(USE_NSS) || defined(USE_GNUTLS)
 395 # ifndef USE_GNUTLS
 396   OPTSSLV2,
 397 # endif
 398   OPTSSLV3,
 399   OPTTLSV1,
 400 # ifndef USE_GNUTLS
 401   OPTSSLSYSTEMCERTS,
 402 # endif
 403 #endif
 404   OPTIMPLICITAUTOVIEW,
 405   OPTKEEPFLAGGED,
 406   OPTMAILCAPSANITIZE,
 407   OPTMAILDIRTRASH,
 408   OPTMARKERS,
 409   OPTMARKOLD,
 410   OPTMBOXPANE,
 411   OPTMENUSCROLL,        /* scroll menu instead of implicit next-page */
 412   OPTMETAKEY,           /* interpret ALT-x as ESC-x */
 413   OPTMETOO,
 414   OPTMHPURGE,
 415   OPTMIMEFORWDECODE,
 416 #ifdef USE_NNTP
 417   OPTMIMESUBJECT,       /* encode subject line with RFC2047 */
 418 #endif
 419   OPTNARROWTREE,
 420   OPTPAGERSTOP,
 421   OPTPIPEDECODE,
 422   OPTPIPESPLIT,
 423 #ifdef USE_POP
 424   OPTPOPAUTHTRYALL,
 425   OPTPOPLAST,
 426 #endif
 427   OPTPRINTDECODE,
 428   OPTPRINTSPLIT,
 429   OPTPROMPTAFTER,
 430   OPTQUOTEEMPTY,
 431   OPTQUOTEQUOTED,
 432   OPTREADONLY,
 433   OPTREPLYSELF,
 434   OPTRESOLVE,
 435   OPTREVALIAS,
 436   OPTREVNAME,
 437   OPTREVREAL,
 438   OPTRFC2047PARAMS,
 439   OPTSAVEADDRESS,
 440   OPTSAVEEMPTY,
 441   OPTSAVENAME,
 442   OPTSCORE,
 443   OPTSIGDASHES,
 444   OPTSIGONTOP,
 445   OPTSORTRE,
 446   OPTSTATUSONTOP,
 447   OPTSTRICTTHREADS,
 448   OPTSUSPEND,
 449   OPTTEXTFLOWED,
 450   OPTTHOROUGHSRC,
 451   OPTTHREADRECEIVED,
 452   OPTTILDE,
 453   OPTUNCOLLAPSEJUMP,
 454   OPTUSE8BITMIME,
 455   OPTUSEDOMAIN,
 456   OPTUSEFROM,
 457   OPTUSEGPGAGENT,
 458 #ifdef HAVE_GETADDRINFO
 459   OPTUSEIPV6,
 460 #endif
 461   OPTWAITKEY,
 462   OPTWEED,
 463   OPTWRAP,
 464   OPTWRAPSEARCH,
 465   OPTWRITEBCC,          /* write out a bcc header? */
 466   OPTXMAILER,
 467   OPTXTERMSETTITLES,
 468
 469   /* PGP options */
 470
 471   OPTCRYPTAUTOSIGN,
 472   OPTCRYPTAUTOENCRYPT,
 473   OPTCRYPTAUTOPGP,
 474   OPTCRYPTAUTOSMIME,
 475   OPTCRYPTREPLYENCRYPT,
 476   OPTCRYPTREPLYSIGN,
 477   OPTCRYPTREPLYSIGNENCRYPTED,
 478   OPTCRYPTTIMESTAMP,
 479   OPTSMIMEISDEFAULT,
 480   OPTASKCERTLABEL,
 481   OPTSDEFAULTDECRYPTKEY,
 482   OPTPGPIGNORESUB,
 483   OPTPGPCHECKEXIT,
 484   OPTPGPLONGIDS,
 485   OPTPGPAUTOTRAD,
 486 #if 0
 487   OPTPGPENCRYPTSELF,
 488 #endif
 489   OPTPGPRETAINABLESIG,
 490   OPTPGPSTRICTENC,
 491   OPTFORWDECRYPT,
 492   OPTPGPSHOWUNUSABLE,
 493
 494   /* news options */
 495
 496 #ifdef USE_NNTP
 497   OPTSHOWNEWNEWS,
 498   OPTSHOWONLYUNREAD,
 499   OPTSAVEUNSUB,
 500   OPTLOADDESC,
 501   OPTXCOMMENTTO,
 502 #endif /* USE_NNTP */
 503
 504   /* pseudo options */
 505
 506   OPTAUXSORT,           /* (pseudo) using auxillary sort function */
 507   OPTFORCEREFRESH,      /* (pseudo) refresh even during macros */
 508   OPTLOCALES,           /* (pseudo) set if user has valid locale definition */
 509   OPTNOCURSES,          /* (pseudo) when sending in batch mode */
 510   OPTNEEDREDRAW,        /* (pseudo) to notify caller of a submenu */
 511   OPTSEARCHREVERSE,     /* (pseudo) used by ci_search_command */
 512   OPTMSGERR,            /* (pseudo) used by mutt_error/mutt_message */
 513   OPTSEARCHINVALID,     /* (pseudo) used to invalidate the search pat */
 514   OPTSIGNALSBLOCKED,    /* (pseudo) using by mutt_block_signals () */
 515   OPTSYSSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals_system () */
 516   OPTNEEDRESORT,        /* (pseudo) used to force a re-sort */
 517   OPTRESORTINIT,        /* (pseudo) used to force the next resort to be from scratch */
 518   OPTVIEWATTACH,        /* (pseudo) signals that we are viewing attachments */
 519   OPTFORCEREDRAWINDEX,  /* (pseudo) used to force a redraw in the main index */
 520   OPTFORCEREDRAWPAGER,  /* (pseudo) used to force a redraw in the pager */
 521   OPTSORTSUBTHREADS,    /* (pseudo) used when $sort_aux changes */
 522   OPTNEEDRESCORE,       /* (pseudo) set when the `score' command is used */
 523   OPTATTACHMSG,         /* (pseudo) used by attach-message */
 524   OPTHIDEREAD,          /* (pseudo) whether or not hide read messages */
 525   OPTKEEPQUIET,         /* (pseudo) shut up the message and refresh
 526                          *          functions while we are executing an
 527                          *          external program.
 528                          */
 529   OPTMENUCALLER,        /* (pseudo) tell menu to give caller a take */
 530   OPTREDRAWTREE,        /* (pseudo) redraw the thread tree */
 531   OPTPGPCHECKTRUST,     /* (pseudo) used by pgp_select_key () */
 532   OPTDONTHANDLEPGPKEYS, /* (pseudo) used to extract PGP keys */
 533   OPTUNBUFFEREDINPUT,   /* (pseudo) don't use key buffer */
 534
 535 #ifdef USE_NNTP
 536   OPTNEWS,              /* (pseudo) used to change reader mode */
 537   OPTNEWSSEND,          /* (pseudo) used to change behavior when posting */
 538   OPTNEWSCACHE,         /* (pseudo) used to indicate if news cache exist */
 539 #endif
 540
 541   OPTMAX
 542 };
 543
 544 #define mutt_bit_alloc(n) calloc ((n + 7) / 8, sizeof (char))
 545 #define mutt_bit_set(v,n) v[n/8] |= (1 << (n % 8))
 546 #define mutt_bit_unset(v,n) v[n/8] &= ~(1 << (n % 8))
 547 #define mutt_bit_toggle(v,n) v[n/8] ^= (1 << (n % 8))
 548 #define mutt_bit_isset(v,n) (v[n/8] & (1 << (n % 8)))
 549
 550 #define set_option(x) mutt_bit_set(Options,x)
 551 #define unset_option(x) mutt_bit_unset(Options,x)
 552 #define toggle_option(x) mutt_bit_toggle(Options,x)
 553 #define option(x) mutt_bit_isset(Options,x)
 554
 555 /* Exit values used in send_msg() */
 556 #define S_ERR 127
 557 #define S_BKG 126
 558
 559 typedef struct list_t
 560 {
 561   char *data;
 562   struct list_t *next;
 563 } LIST;
 564
 565 typedef struct rx_list_t
 566 {
 567   REGEXP *rx;
 568   struct rx_list_t *next;
 569 } RX_LIST;
 570
 571 #define mutt_new_list() safe_calloc (1, sizeof (LIST))
 572 #define mutt_new_rx_list() safe_calloc (1, sizeof (RX_LIST))
 573 void mutt_free_list (LIST **);
 574 void mutt_free_rx_list (RX_LIST **);
 575 LIST *mutt_copy_list (LIST *);
 576 int mutt_matches_ignore (const char *, LIST *);
 577 /* add an element to a list */
 578 LIST *mutt_add_list (LIST *, const char *);
 579
 580 void mutt_init (int, LIST *);
 581
 582 typedef struct alias
 583 {
 584   struct alias *self;           /* XXX - ugly hack */
 585   char *name;
 586   ADDRESS *addr;
 587   struct alias *next;
 588   short tagged;
 589   short del;
 590   short num;
 591 } ALIAS;
 592
 593 typedef struct envelope
 594 {
 595   ADDRESS *return_path;
 596   ADDRESS *from;
 597   ADDRESS *to;
 598   ADDRESS *cc;
 599   ADDRESS *bcc;
 600   ADDRESS *sender;
 601   ADDRESS *reply_to;
 602   ADDRESS *mail_followup_to;
 603   char *subject;
 604   char *real_subj;              /* offset of the real subject */
 605   char *message_id;
 606   char *supersedes;
 607   char *date;
 608   char *x_label;
 609   char *organization;
 610 #ifdef USE_NNTP
 611   char *newsgroups;
 612   char *xref;
 613   char *followup_to;
 614   char *x_comment_to;
 615 #endif
 616   LIST *references;             /* message references (in reverse order) */
 617   LIST *in_reply_to;            /* in-reply-to header content */
 618   LIST *userhdrs;               /* user defined headers */
 619 } ENVELOPE;
 620
 621 typedef struct parameter
 622 {
 623   char *attribute;
 624   char *value;
 625   struct parameter *next;
 626 } PARAMETER;
 627
 628 /* Information that helps in determing the Content-* of an attachment */
 629 typedef struct content
 630 {
 631   long hibin;              /* 8-bit characters */
 632   long lobin;              /* unprintable 7-bit chars (eg., control chars) */
 633   long crlf;               /* '\r' and '\n' characters */
 634   long ascii;              /* number of ascii chars */
 635   long linemax;            /* length of the longest line in the file */
 636   unsigned int space : 1;  /* whitespace at the end of lines? */
 637   unsigned int binary : 1; /* long lines, or CR not in CRLF pair */
 638   unsigned int from : 1;   /* has a line beginning with "From "? */
 639   unsigned int dot : 1;    /* has a line consisting of a single dot? */
 640   unsigned int cr : 1;     /* has CR, even when in a CRLF pair */
 641 } CONTENT;
 642
 643 typedef struct body
 644 {
 645   char *xtype;                  /* content-type if x-unknown */
 646   char *subtype;                /* content-type subtype */
 647   PARAMETER *parameter;         /* parameters of the content-type */
 648   char *description;            /* content-description */
 649   char *form_name;              /* Content-Disposition form-data name param */
 650   long hdr_offset;              /* offset in stream where the headers begin.
 651                                  * this info is used when invoking metamail,
 652                                  * where we need to send the headers of the
 653                                  * attachment
 654                                  */
 655   long offset;                  /* offset where the actual data begins */
 656   long length;                  /* length (in bytes) of attachment */
 657   char *filename;               /* when sending a message, this is the file
 658                                  * to which this structure refers
 659                                  */
 660   char *d_filename;             /* filename to be used for the
 661                                  * content-disposition header.
 662                                  * If NULL, filename is used
 663                                  * instead.
 664                                  */
 665   CONTENT *content;             /* structure used to store detailed info about
 666                                  * the content of the attachment.  this is used
 667                                  * to determine what content-transfer-encoding
 668                                  * is required when sending mail.
 669                                  */
 670   struct body *next;            /* next attachment in the list */
 671   struct body *parts;           /* parts of a multipart or message/rfc822 */
 672   struct header *hdr;           /* header information for message/rfc822 */
 673
 674   struct attachptr *aptr;       /* Menu information, used in recvattach.c */
 675
 676   time_t stamp;                 /* time stamp of last
 677                                  * encoding update.
 678                                  */
 679
 680   unsigned int type : 4;        /* content-type primary type */
 681   unsigned int encoding : 3;    /* content-transfer-encoding */
 682   unsigned int disposition : 2; /* content-disposition */
 683   unsigned int use_disp : 1;    /* Content-Disposition uses filename= ? */
 684   unsigned int unlink : 1;      /* flag to indicate the the file named by
 685                                  * "filename" should be unlink()ed before
 686                                  * free()ing this structure
 687                                  */
 688   unsigned int tagged : 1;
 689   unsigned int deleted : 1;     /* attachment marked for deletion */
 690
 691   unsigned int noconv : 1;      /* don't do character set conversion */
 692   unsigned int force_charset : 1;
 693                                 /* send mode: don't adjust the character
 694                                  * set when in send-mode.
 695                                  */
 696
 697   unsigned int goodsig : 1;     /* good cryptographic signature */
 698   unsigned int badsig : 1;      /* bad cryptographic signature (needed to check encrypted s/mime-signatures) */
 699
 700   unsigned int collapsed : 1;   /* used by recvattach */
 701
 702 } BODY;
 703
 704 typedef struct header
 705 {
 706   unsigned int security : 9;  /* bit 0-6: flags, bit 7,8: application.
 707                                  see: crypt.h pgplib.h, smime.h */
 708
 709   unsigned int mime : 1;                /* has a Mime-Version header? */
 710   unsigned int flagged : 1;             /* marked important? */
 711   unsigned int tagged : 1;
 712   unsigned int appended : 1; /* has been saved */
 713   unsigned int purged : 1;   /* bypassing the trash folder */
 714   unsigned int deleted : 1;
 715   unsigned int changed : 1;
 716   unsigned int attach_del : 1;          /* has an attachment marked for deletion */
 717   unsigned int old : 1;
 718   unsigned int read : 1;
 719   unsigned int expired : 1;             /* already expired? */
 720   unsigned int superseded : 1;          /* got superseded? */
 721   unsigned int replied : 1;
 722   unsigned int subject_changed : 1;     /* used for threading */
 723   unsigned int threaded : 1;            /* used for threading */
 724   unsigned int display_subject : 1;     /* used for threading */
 725   unsigned int irt_changed : 1; /* In-Reply-To changed to link/break threads */
 726   unsigned int refs_changed : 1; /* References changed to break thread */
 727   unsigned int recip_valid : 1;         /* is_recipient is valid */
 728   unsigned int active : 1;              /* message is not to be removed */
 729   unsigned int trash : 1;               /* message is marked as trashed on disk.
 730                                          * This flag is used by the maildir_trash
 731                                          * option.
 732                                          */
 733
 734   /* timezone of the sender of this message */
 735   unsigned int zhours : 5;
 736   unsigned int zminutes : 6;
 737   unsigned int zoccident : 1;
 738
 739   /* bits used for caching when searching */
 740   unsigned int searched : 1;
 741   unsigned int matched : 1;
 742
 743   /* the following are used to support collapsing threads  */
 744   unsigned int collapsed : 1;   /* is this message part of a collapsed thread? */
 745   unsigned int limited : 1;     /* is this message in a limited view?  */
 746   size_t num_hidden;            /* number of hidden messages in this view */
 747
 748   short recipient;              /* user_is_recipient()'s return value, cached */
 749
 750   int pair;                     /* color-pair to use when displaying in the index */
 751
 752   time_t date_sent;             /* time when the message was sent (UTC) */
 753   time_t received;              /* time when the message was placed in the mailbox */
 754   long offset;                  /* where in the stream does this message begin? */
 755   int lines;                    /* how many lines in the body of this message? */
 756   int index;                    /* the absolute (unsorted) message number */
 757   int msgno;                    /* number displayed to the user */
 758   int virtual;                  /* virtual message number */
 759   int score;
 760   ENVELOPE *env;                /* envelope information */
 761   BODY *content;                /* list of MIME parts */
 762   char *path;
 763 #ifdef USE_NNTP
 764   int article_num;
 765 #endif
 766
 767   char *tree;                   /* character string to print thread tree */
 768   struct thread *thread;
 769
 770 #ifdef IMAP_EDIT_THREADS
 771   ENVELOPE *new_env;    /* envelope information for rethreading */
 772 #endif
 773
 774 #ifdef MIXMASTER
 775   LIST *chain;
 776 #endif
 777
 778 #ifdef USE_POP
 779   int refno;                    /* message number on server */
 780 #endif
 781
 782 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
 783   void *data;                   /* driver-specific data */
 784 #endif
 785
 786   char *maildir_flags;          /* unknown maildir flags */
 787 } HEADER;
 788
 789 typedef struct thread
 790 {
 791   unsigned int fake_thread : 1;
 792   unsigned int duplicate_thread : 1;
 793   unsigned int sort_children : 1;
 794   unsigned int check_subject : 1;
 795   unsigned int visible : 1;
 796   unsigned int deep : 1;
 797   unsigned int subtree_visible : 2;
 798   unsigned int next_subtree_visible : 1;
 799   struct thread *parent;
 800   struct thread *child;
 801   struct thread *next;
 802   struct thread *prev;
 803   HEADER *message;
 804   HEADER *sort_key;
 805 } THREAD;
 806
 807
 808 /* flag to mutt_pattern_comp() */
 809 #define M_FULL_MSG      1       /* enable body and header matching */
 810
 811 typedef enum {
 812   M_MATCH_FULL_ADDRESS = 1
 813 } pattern_exec_flag;
 814
 815 typedef struct pattern_t
 816 {
 817   short op;
 818   short not;
 819   short alladdr;
 820   int min;
 821   int max;
 822   struct pattern_t *next;
 823   struct pattern_t *child;              /* arguments to logical op */
 824   regex_t *rx;
 825 } pattern_t;
 826
 827 typedef struct
 828 {
 829   char *path;
 830   FILE *fp;
 831   time_t mtime;
 832   time_t mtime_cur;             /* used with maildir folders */
 833   off_t size;
 834   off_t vsize;
 835   char *pattern;                /* limit pattern string */
 836   pattern_t *limit_pattern;     /* compiled limit pattern */
 837   HEADER **hdrs;
 838   HEADER *last_tag;             /* last tagged msg. used to link threads */
 839   THREAD *tree;                 /* top of thread tree */
 840   HASH *id_hash;                /* hash table by msg id */
 841   HASH *subj_hash;              /* hash table by subject */
 842   HASH *thread_hash;            /* hash table for threading */
 843   int *v2r;                     /* mapping from virtual to real msgno */
 844   int hdrmax;                   /* number of pointers in hdrs */
 845   int msgcount;                 /* number of messages in the mailbox */
 846   int vcount;                   /* the number of virtual messages */
 847   int tagged;                   /* how many messages are tagged? */
 848   int new;                      /* how many new messages? */
 849   int unread;                   /* how many unread messages? */
 850   int deleted;                  /* how many deleted messages */
 851   int appended;                 /* how many saved messages? */
 852   int flagged;                  /* how many flagged messages */
 853   int msgnotreadyet;            /* which msg "new" in pager, -1 if none */
 854 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
 855   void *data;                   /* driver specific data */
 856 #endif /* USE_IMAP */
 857
 858   short magic;                  /* mailbox type */
 859
 860 #ifdef USE_COMPRESSED
 861   void *compressinfo;           /* compressed mbox module private data */
 862   char *realpath;               /* path to compressed mailbox */
 863 #endif /* USE_COMPRESSED */
 864
 865   unsigned int locked : 1;      /* is the mailbox locked? */
 866   unsigned int changed : 1;     /* mailbox has been modified */
 867   unsigned int readonly : 1;    /* don't allow changes to the mailbox */
 868   unsigned int dontwrite : 1;   /* dont write the mailbox on close */
 869   unsigned int append : 1;      /* mailbox is opened in append mode */
 870   unsigned int quiet : 1;       /* inhibit status messages? */
 871   unsigned int collapsed : 1;   /* are all threads collapsed? */
 872   unsigned int closing : 1;     /* mailbox is being closed */
 873 } CONTEXT;
 874
 875 typedef struct attachptr
 876 {
 877   BODY *content;
 878   int parent_type;
 879   char *tree;
 880   int level;
 881   int num;
 882 } ATTACHPTR;
 883
 884 typedef struct
 885 {
 886   FILE *fpin;
 887   FILE *fpout;
 888   char *prefix;
 889   int flags;
 890 } STATE;
 891
 892 /* used by enter.c */
 893
 894 typedef struct
 895 {
 896   wchar_t *wbuf;
 897   size_t wbuflen;
 898   size_t lastchar;
 899   size_t curpos;
 900   size_t begin;
 901   int    tabs;
 902 } ENTER_STATE;
 903
 904 /* flags for the STATE struct */
 905 #define M_DISPLAY       (1<<0) /* output is displayed to the user */
 906 #define M_VERIFY        (1<<1) /* perform signature verification */
 907 #define M_PENDINGPREFIX (1<<2) /* prefix to write, but character must follow */
 908 #define M_WEED          (1<<3) /* weed headers even when not in display mode */
 909 #define M_CHARCONV      (1<<4) /* Do character set conversions */
 910 #define M_PRINTING      (1<<5) /* are we printing? - M_DISPLAY "light" */
 911
 912 #define state_set_prefix(s) ((s)->flags |= M_PENDINGPREFIX)
 913 #define state_reset_prefix(s) ((s)->flags &= ~M_PENDINGPREFIX)
 914 #define state_puts(x,y) fputs(x,(y)->fpout)
 915 #define state_putc(x,y) fputc(x,(y)->fpout)
 916
 917 void state_mark_attach (STATE *);
 918 void state_attach_puts (const char *, STATE *);
 919 void state_prefix_putc (char, STATE *);
 920 int  state_printf(STATE *, const char *, ...);
 921
 922 #include "ascii.h"
 923 #include "protos.h"
 924 #include "lib.h"
 925 #include "globals.h"
 926
 927 #endif /*MUTT_H*/