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