mutt.h

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