mutt.h

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