mutt.h

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