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   OPTSTUFFQUOTED,
 465   OPTSUSPEND,
 466   OPTTEXTFLOWED,
 467   OPTTHOROUGHSRC,
 468   OPTTHREADRECEIVED,
 469   OPTTILDE,
 470   OPTUNCOLLAPSEJUMP,
 471   OPTUSE8BITMIME,
 472   OPTUSEDOMAIN,
 473   OPTUSEFROM,
 474   OPTUSEGPGAGENT,
 475 #ifdef HAVE_LIBIDN
 476   OPTUSEIDN,
 477 #endif
 478 #ifdef HAVE_GETADDRINFO
 479   OPTUSEIPV6,
 480 #endif
 481   OPTWAITKEY,
 482   OPTWEED,
 483   OPTWRAP,
 484   OPTWRAPSEARCH,
 485   OPTWRITEBCC,          /* write out a bcc header? */
 486   OPTXMAILER,
 487   OPTXTERMSETTITLES,
 488
 489   OPTCRYPTUSEGPGME,
 490
 491   /* PGP options */
 492
 493   OPTCRYPTAUTOSIGN,
 494   OPTCRYPTAUTOENCRYPT,
 495   OPTCRYPTAUTOPGP,
 496   OPTCRYPTAUTOSMIME,
 497   OPTCRYPTREPLYENCRYPT,
 498   OPTCRYPTREPLYSIGN,
 499   OPTCRYPTREPLYSIGNENCRYPTED,
 500   OPTCRYPTTIMESTAMP,
 501   OPTSMIMEISDEFAULT,
 502   OPTASKCERTLABEL,
 503   OPTSDEFAULTDECRYPTKEY,
 504   OPTPGPIGNORESUB,
 505   OPTPGPCHECKEXIT,
 506   OPTPGPLONGIDS,
 507   OPTPGPAUTODEC,
 508 #if 0
 509   OPTPGPENCRYPTSELF,
 510 #endif
 511   OPTPGPRETAINABLESIG,
 512   OPTPGPSTRICTENC,
 513   OPTFORWDECRYPT,
 514   OPTPGPSHOWUNUSABLE,
 515   OPTPGPAUTOINLINE,
 516   OPTPGPREPLYINLINE,
 517
 518   /* news options */
 519
 520 #ifdef USE_NNTP
 521   OPTSHOWNEWNEWS,
 522   OPTSHOWONLYUNREAD,
 523   OPTSAVEUNSUB,
 524   OPTLOADDESC,
 525   OPTXCOMMENTTO,
 526 #endif /* USE_NNTP */
 527
 528   /* pseudo options */
 529
 530   OPTAUXSORT,           /* (pseudo) using auxillary sort function */
 531   OPTFORCEREFRESH,      /* (pseudo) refresh even during macros */
 532   OPTLOCALES,           /* (pseudo) set if user has valid locale definition */
 533   OPTNOCURSES,          /* (pseudo) when sending in batch mode */
 534   OPTNEEDREDRAW,        /* (pseudo) to notify caller of a submenu */
 535   OPTSEARCHREVERSE,     /* (pseudo) used by ci_search_command */
 536   OPTMSGERR,            /* (pseudo) used by mutt_error/mutt_message */
 537   OPTSEARCHINVALID,     /* (pseudo) used to invalidate the search pat */
 538   OPTSIGNALSBLOCKED,    /* (pseudo) using by mutt_block_signals () */
 539   OPTSYSSIGNALSBLOCKED, /* (pseudo) using by mutt_block_signals_system () */
 540   OPTNEEDRESORT,        /* (pseudo) used to force a re-sort */
 541   OPTRESORTINIT,        /* (pseudo) used to force the next resort to be from scratch */
 542   OPTVIEWATTACH,        /* (pseudo) signals that we are viewing attachments */
 543   OPTFORCEREDRAWINDEX,  /* (pseudo) used to force a redraw in the main index */
 544   OPTFORCEREDRAWPAGER,  /* (pseudo) used to force a redraw in the pager */
 545   OPTSORTSUBTHREADS,    /* (pseudo) used when $sort_aux changes */
 546   OPTNEEDRESCORE,       /* (pseudo) set when the `score' command is used */
 547   OPTATTACHMSG,         /* (pseudo) used by attach-message */
 548   OPTHIDEREAD,          /* (pseudo) whether or not hide read messages */
 549   OPTKEEPQUIET,         /* (pseudo) shut up the message and refresh
 550                          *          functions while we are executing an
 551                          *          external program.
 552                          */
 553   OPTMENUCALLER,        /* (pseudo) tell menu to give caller a take */
 554   OPTREDRAWTREE,        /* (pseudo) redraw the thread tree */
 555   OPTPGPCHECKTRUST,     /* (pseudo) used by pgp_select_key () */
 556   OPTDONTHANDLEPGPKEYS, /* (pseudo) used to extract PGP keys */
 557   OPTUNBUFFEREDINPUT,   /* (pseudo) don't use key buffer */
 558
 559 #ifdef USE_NNTP
 560   OPTNEWS,              /* (pseudo) used to change reader mode */
 561   OPTNEWSSEND,          /* (pseudo) used to change behavior when posting */
 562   OPTNEWSCACHE,         /* (pseudo) used to indicate if news cache exist */
 563 #endif
 564   OPTSHORTENHIERARCHY, /* set when to shorten "hierarchies" in the sidebar */
 565
 566   OPTMAX
 567 };
 568
 569 #define mutt_bit_alloc(n) calloc ((n + 7) / 8, sizeof (char))
 570 #define mutt_bit_set(v,n) v[n/8] |= (1 << (n % 8))
 571 #define mutt_bit_unset(v,n) v[n/8] &= ~(1 << (n % 8))
 572 #define mutt_bit_toggle(v,n) v[n/8] ^= (1 << (n % 8))
 573 #define mutt_bit_isset(v,n) (v[n/8] & (1 << (n % 8)))
 574
 575 #define set_option(x) mutt_bit_set(Options,x)
 576 #define unset_option(x) mutt_bit_unset(Options,x)
 577 #define toggle_option(x) mutt_bit_toggle(Options,x)
 578 #define option(x) mutt_bit_isset(Options,x)
 579
 580 /* Exit values used in send_msg() */
 581 #define S_ERR 127
 582 #define S_BKG 126
 583
 584 typedef struct list_t
 585 {
 586   char *data;
 587   struct list_t *next;
 588 } LIST;
 589
 590 typedef struct rx_list_t
 591 {
 592   REGEXP *rx;
 593   struct rx_list_t *next;
 594 } RX_LIST;
 595
 596 typedef struct spam_list_t
 597 {
 598   REGEXP *rx;
 599   int     nmatch;
 600   char   *template;
 601   struct spam_list_t *next;
 602 } SPAM_LIST;
 603
 604
 605 #define mutt_new_list() safe_calloc (1, sizeof (LIST))
 606 #define mutt_new_spam_list() safe_calloc (1, sizeof (SPAM_LIST))
 607 #define mutt_new_rx_list() safe_calloc (1, sizeof (RX_LIST))
 608 void mutt_free_list (LIST **);
 609 void mutt_free_rx_list (RX_LIST **);
 610 void mutt_free_spam_list (SPAM_LIST **);
 611 LIST *mutt_copy_list (LIST *);
 612 int mutt_matches_ignore (const char *, LIST *);
 613 /* add an element to a list */
 614 LIST *mutt_add_list (LIST *, const char *);
 615
 616 void mutt_init (int, LIST *);
 617
 618 typedef struct alias
 619 {
 620   struct alias *self;           /* XXX - ugly hack */
 621   char *name;
 622   ADDRESS *addr;
 623   struct alias *next;
 624   short tagged;
 625   short del;
 626   short num;
 627 } ALIAS;
 628
 629 typedef struct envelope
 630 {
 631   ADDRESS *return_path;
 632   ADDRESS *from;
 633   ADDRESS *to;
 634   ADDRESS *cc;
 635   ADDRESS *bcc;
 636   ADDRESS *sender;
 637   ADDRESS *reply_to;
 638   ADDRESS *mail_followup_to;
 639   char *list_post;              /* this stores a mailto URL, or nothing */
 640   char *subject;
 641   char *real_subj;              /* offset of the real subject */
 642   char *message_id;
 643   char *supersedes;
 644   char *date;
 645   char *x_label;
 646   char *organization;
 647 #ifdef USE_NNTP
 648   char *newsgroups;
 649   char *xref;
 650   char *followup_to;
 651   char *x_comment_to;
 652 #endif
 653   BUFFER *spam;
 654   LIST *references;             /* message references (in reverse order) */
 655   LIST *in_reply_to;            /* in-reply-to header content */
 656   LIST *userhdrs;               /* user defined headers */
 657 } ENVELOPE;
 658
 659 typedef struct parameter
 660 {
 661   char *attribute;
 662   char *value;
 663   struct parameter *next;
 664 } PARAMETER;
 665
 666 /* Information that helps in determing the Content-* of an attachment */
 667 typedef struct content
 668 {
 669   long hibin;              /* 8-bit characters */
 670   long lobin;              /* unprintable 7-bit chars (eg., control chars) */
 671   long crlf;               /* '\r' and '\n' characters */
 672   long ascii;              /* number of ascii chars */
 673   long linemax;            /* length of the longest line in the file */
 674   unsigned int space : 1;  /* whitespace at the end of lines? */
 675   unsigned int binary : 1; /* long lines, or CR not in CRLF pair */
 676   unsigned int from : 1;   /* has a line beginning with "From "? */
 677   unsigned int dot : 1;    /* has a line consisting of a single dot? */
 678   unsigned int cr : 1;     /* has CR, even when in a CRLF pair */
 679 } CONTENT;
 680
 681 typedef struct body
 682 {
 683   char *xtype;                  /* content-type if x-unknown */
 684   char *subtype;                /* content-type subtype */
 685   PARAMETER *parameter;         /* parameters of the content-type */
 686   char *description;            /* content-description */
 687   char *form_name;              /* Content-Disposition form-data name param */
 688   long hdr_offset;              /* offset in stream where the headers begin.
 689                                  * this info is used when invoking metamail,
 690                                  * where we need to send the headers of the
 691                                  * attachment
 692                                  */
 693   long offset;                  /* offset where the actual data begins */
 694   long length;                  /* length (in bytes) of attachment */
 695   char *filename;               /* when sending a message, this is the file
 696                                  * to which this structure refers
 697                                  */
 698   char *d_filename;             /* filename to be used for the
 699                                  * content-disposition header.
 700                                  * If NULL, filename is used
 701                                  * instead.
 702                                  */
 703   char *file_charset;           /* charset of attached file */
 704   CONTENT *content;             /* structure used to store detailed info about
 705                                  * the content of the attachment.  this is used
 706                                  * to determine what content-transfer-encoding
 707                                  * is required when sending mail.
 708                                  */
 709   struct body *next;            /* next attachment in the list */
 710   struct body *parts;           /* parts of a multipart or message/rfc822 */
 711   struct header *hdr;           /* header information for message/rfc822 */
 712
 713   struct attachptr *aptr;       /* Menu information, used in recvattach.c */
 714
 715   time_t stamp;                 /* time stamp of last
 716                                  * encoding update.
 717                                  */
 718
 719   unsigned int type : 4;        /* content-type primary type */
 720   unsigned int encoding : 3;    /* content-transfer-encoding */
 721   unsigned int disposition : 2; /* content-disposition */
 722   unsigned int use_disp : 1;    /* Content-Disposition uses filename= ? */
 723   unsigned int unlink : 1;      /* flag to indicate the the file named by
 724                                  * "filename" should be unlink()ed before
 725                                  * free()ing this structure
 726                                  */
 727   unsigned int tagged : 1;
 728   unsigned int deleted : 1;     /* attachment marked for deletion */
 729
 730   unsigned int noconv : 1;      /* don't do character set conversion */
 731   unsigned int force_charset : 1;
 732                                 /* send mode: don't adjust the character
 733                                  * set when in send-mode.
 734                                  */
 735   unsigned int is_signed_data : 1; /* A lot of MUAs don't indicate
 736                                       S/MIME signed-data correctly,
 737                                       e.g. they use foo.p7m even for
 738                                       the name of signed data.  This
 739                                       flag is used to keep track of
 740                                       the actual message type.  It
 741                                       gets set during the verification
 742                                       (which is done if the encryption
 743                                       try failed) and check by the
 744                                       function to figure the type of
 745                                       the message. */
 746
 747   unsigned int goodsig : 1;     /* good cryptographic signature */
 748   unsigned int warnsig : 1;     /* maybe good signature */
 749   unsigned int badsig : 1;      /* bad cryptographic signature (needed to check encrypted s/mime-signatures) */
 750
 751   unsigned int collapsed : 1;   /* used by recvattach */
 752
 753 } BODY;
 754
 755 typedef struct header
 756 {
 757   unsigned int security : 11;  /* bit 0-6: flags, bit 7,8: application.
 758                                  see: crypt.h pgplib.h, smime.h */
 759
 760   unsigned int mime : 1;                /* has a Mime-Version header? */
 761   unsigned int flagged : 1;             /* marked important? */
 762   unsigned int tagged : 1;
 763   unsigned int appended : 1; /* has been saved */
 764   unsigned int purged : 1;   /* bypassing the trash folder */
 765   unsigned int deleted : 1;
 766   unsigned int changed : 1;
 767   unsigned int attach_del : 1;          /* has an attachment marked for deletion */
 768   unsigned int old : 1;
 769   unsigned int read : 1;
 770   unsigned int expired : 1;             /* already expired? */
 771   unsigned int superseded : 1;          /* got superseded? */
 772   unsigned int replied : 1;
 773   unsigned int subject_changed : 1;     /* used for threading */
 774   unsigned int threaded : 1;            /* used for threading */
 775   unsigned int display_subject : 1;     /* used for threading */
 776   unsigned int irt_changed : 1; /* In-Reply-To changed to link/break threads */
 777   unsigned int refs_changed : 1; /* References changed to break thread */
 778   unsigned int recip_valid : 1;         /* is_recipient is valid */
 779   unsigned int active : 1;              /* message is not to be removed */
 780   unsigned int trash : 1;               /* message is marked as trashed on disk.
 781                                          * This flag is used by the maildir_trash
 782                                          * option.
 783                                          */
 784
 785   /* timezone of the sender of this message */
 786   unsigned int zhours : 5;
 787   unsigned int zminutes : 6;
 788   unsigned int zoccident : 1;
 789
 790   /* bits used for caching when searching */
 791   unsigned int searched : 1;
 792   unsigned int matched : 1;
 793
 794   /* the following are used to support collapsing threads  */
 795   unsigned int collapsed : 1;   /* is this message part of a collapsed thread? */
 796   unsigned int limited : 1;     /* is this message in a limited view?  */
 797   size_t num_hidden;            /* number of hidden messages in this view */
 798
 799   short recipient;              /* user_is_recipient()'s return value, cached */
 800
 801   int pair;                     /* color-pair to use when displaying in the index */
 802
 803   time_t date_sent;             /* time when the message was sent (UTC) */
 804   time_t received;              /* time when the message was placed in the mailbox */
 805   long offset;                  /* where in the stream does this message begin? */
 806   int lines;                    /* how many lines in the body of this message? */
 807   int index;                    /* the absolute (unsorted) message number */
 808   int msgno;                    /* number displayed to the user */
 809   int virtual;                  /* virtual message number */
 810   int score;
 811   ENVELOPE *env;                /* envelope information */
 812   BODY *content;                /* list of MIME parts */
 813   char *path;
 814 #ifdef USE_NNTP
 815   int article_num;
 816 #endif
 817
 818   char *tree;                   /* character string to print thread tree */
 819   struct thread *thread;
 820
 821   ENVELOPE *new_env;    /* envelope information for rethreading */
 822
 823 #ifdef MIXMASTER
 824   LIST *chain;
 825 #endif
 826
 827 #ifdef USE_POP
 828   int refno;                    /* message number on server */
 829 #endif
 830
 831 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
 832   void *data;                   /* driver-specific data */
 833 #endif
 834
 835   char *maildir_flags;          /* unknown maildir flags */
 836 } HEADER;
 837
 838 typedef struct thread
 839 {
 840   unsigned int fake_thread : 1;
 841   unsigned int duplicate_thread : 1;
 842   unsigned int sort_children : 1;
 843   unsigned int check_subject : 1;
 844   unsigned int visible : 1;
 845   unsigned int deep : 1;
 846   unsigned int subtree_visible : 2;
 847   unsigned int next_subtree_visible : 1;
 848   struct thread *parent;
 849   struct thread *child;
 850   struct thread *next;
 851   struct thread *prev;
 852   HEADER *message;
 853   HEADER *sort_key;
 854 } THREAD;
 855
 856
 857 /* flag to mutt_pattern_comp() */
 858 #define M_FULL_MSG      1       /* enable body and header matching */
 859
 860 typedef enum {
 861   M_MATCH_FULL_ADDRESS = 1
 862 } pattern_exec_flag;
 863
 864 typedef struct pattern_t
 865 {
 866   short op;
 867   short not;
 868   short alladdr;
 869   int min;
 870   int max;
 871   struct pattern_t *next;
 872   struct pattern_t *child;              /* arguments to logical op */
 873   regex_t *rx;
 874 } pattern_t;
 875
 876 typedef struct
 877 {
 878   char *path;
 879   FILE *fp;
 880   time_t mtime;
 881   time_t mtime_cur;             /* used with maildir folders */
 882   off_t size;
 883   off_t vsize;
 884   char *pattern;                /* limit pattern string */
 885   pattern_t *limit_pattern;     /* compiled limit pattern */
 886   HEADER **hdrs;
 887   HEADER *last_tag;             /* last tagged msg. used to link threads */
 888   THREAD *tree;                 /* top of thread tree */
 889   HASH *id_hash;                /* hash table by msg id */
 890   HASH *subj_hash;              /* hash table by subject */
 891   HASH *thread_hash;            /* hash table for threading */
 892   int *v2r;                     /* mapping from virtual to real msgno */
 893   int hdrmax;                   /* number of pointers in hdrs */
 894   int msgcount;                 /* number of messages in the mailbox */
 895   int vcount;                   /* the number of virtual messages */
 896   int tagged;                   /* how many messages are tagged? */
 897   int new;                      /* how many new messages? */
 898   int unread;                   /* how many unread messages? */
 899   int deleted;                  /* how many deleted messages */
 900   int appended;                 /* how many saved messages? */
 901   int flagged;                  /* how many flagged messages */
 902   int msgnotreadyet;            /* which msg "new" in pager, -1 if none */
 903 #if defined USE_POP || defined USE_IMAP || defined USE_NNTP
 904   void *data;                   /* driver specific data */
 905 #endif /* USE_IMAP */
 906
 907   short magic;                  /* mailbox type */
 908
 909 #ifdef USE_COMPRESSED
 910   void *compressinfo;           /* compressed mbox module private data */
 911   char *realpath;               /* path to compressed mailbox */
 912 #endif /* USE_COMPRESSED */
 913
 914   unsigned int locked : 1;      /* is the mailbox locked? */
 915   unsigned int changed : 1;     /* mailbox has been modified */
 916   unsigned int readonly : 1;    /* don't allow changes to the mailbox */
 917   unsigned int dontwrite : 1;   /* dont write the mailbox on close */
 918   unsigned int append : 1;      /* mailbox is opened in append mode */
 919   unsigned int quiet : 1;       /* inhibit status messages? */
 920   unsigned int collapsed : 1;   /* are all threads collapsed? */
 921   unsigned int closing : 1;     /* mailbox is being closed */
 922 } CONTEXT;
 923
 924 typedef struct attachptr
 925 {
 926   BODY *content;
 927   int parent_type;
 928   char *tree;
 929   int level;
 930   int num;
 931 } ATTACHPTR;
 932
 933 typedef struct
 934 {
 935   FILE *fpin;
 936   FILE *fpout;
 937   char *prefix;
 938   int flags;
 939 } STATE;
 940
 941 /* used by enter.c */
 942
 943 typedef struct
 944 {
 945   wchar_t *wbuf;
 946   size_t wbuflen;
 947   size_t lastchar;
 948   size_t curpos;
 949   size_t begin;
 950   int    tabs;
 951 } ENTER_STATE;
 952
 953 /* flags for the STATE struct */
 954 #define M_DISPLAY       (1<<0) /* output is displayed to the user */
 955 #define M_VERIFY        (1<<1) /* perform signature verification */
 956 #define M_PENDINGPREFIX (1<<2) /* prefix to write, but character must follow */
 957 #define M_WEED          (1<<3) /* weed headers even when not in display mode */
 958 #define M_CHARCONV      (1<<4) /* Do character set conversions */
 959 #define M_PRINTING      (1<<5) /* are we printing? - M_DISPLAY "light" */
 960 #define M_REPLYING      (1<<6) /* are we replying? */
 961 #define M_FIRSTDONE     (1<<7) /* the first attachment has been done */
 962
 963 #define state_set_prefix(s) ((s)->flags |= M_PENDINGPREFIX)
 964 #define state_reset_prefix(s) ((s)->flags &= ~M_PENDINGPREFIX)
 965 #define state_puts(x,y) fputs(x,(y)->fpout)
 966 #define state_putc(x,y) fputc(x,(y)->fpout)
 967
 968 void state_mark_attach (STATE *);
 969 void state_attach_puts (const char *, STATE *);
 970 void state_prefix_putc (char, STATE *);
 971 int  state_printf(STATE *, const char *, ...);
 972
 973 #include "ascii.h"
 974 #include "protos.h"
 975 #include "lib.h"
 976 #include "globals.h"
 977
 978 #endif /*MUTT_H*/