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