protos.h

   1 /*
   2  * Copyright notice from original mutt:
   3  * Copyright (C) 1996-2000 Michael R. Elkins <me@mutt.org>
   4  *
   5  * This file is part of mutt-ng, see http://www.muttng.org/.
   6  * It's licensed under the GNU General Public License,
   7  * please see the file GPL in the top level source directory.
   8  */
   9
  10 #ifdef HAVE_CONFIG_H
  11 # include "config.h"
  12 #endif
  13
  14 #if HAVE_STDINT_H
  15 #include <stdint.h>
  16 #elif HAVE_INTTYPES_H
  17 #include <inttypes.h>
  18 #endif
  19
  20 #include "mbyte.h"
  21
  22 #include <lib-lib/buffer.h>
  23
  24 #define MoreArgs(p) (*p->dptr && *p->dptr != ';' && *p->dptr != '#')
  25
  26 #define mutt_make_string(A,B,C,D,E) _mutt_make_string(A,B,C,D,E,0)
  27 void _mutt_make_string (char *, size_t, const char *, CONTEXT *,
  28                         HEADER *, format_flag);
  29
  30 #define mutt_system(x) _mutt_system(x,0)
  31 int _mutt_system (const char *, int);
  32
  33 #define mutt_new_parameter() p_new(PARAMETER, 1)
  34 #define mutt_new_header() p_new(HEADER, 1)
  35 #define mutt_new_envelope() p_new(ENVELOPE, 1)
  36 #define mutt_new_enter_state() p_new(ENTER_STATE, 1)
  37
  38 typedef const char *format_t (char *, size_t, char, const char *,
  39                               const char *, const char *, const char *,
  40                               unsigned long, format_flag);
  41
  42 void mutt_FormatString (char *, size_t, const char *, format_t *,
  43                         unsigned long, format_flag);
  44 void mutt_parse_content_type (char *, BODY *);
  45 void mutt_generate_boundary (PARAMETER **);
  46 void mutt_delete_parameter (const char *attribute, PARAMETER ** p);
  47 void mutt_set_parameter (const char *, const char *, PARAMETER **);
  48
  49 FILE *mutt_open_read (const char *, pid_t *);
  50
  51 void set_quadoption (int, int);
  52 int query_quadoption (int, const char *);
  53 int quadoption (int);
  54
  55 int mutt_option_value (const char* val, char* dst, size_t dstlen);
  56
  57 ADDRESS *mutt_default_from (void);
  58 ADDRESS *mutt_remove_duplicates (ADDRESS *);
  59 ADDRESS *mutt_parse_adrlist (ADDRESS *, const char *);
  60
  61 BODY *mutt_make_file_attach (const char *);
  62 BODY *mutt_make_message_attach (CONTEXT *, HEADER *, int);
  63 BODY *mutt_remove_multipart (BODY *);
  64 BODY *mutt_make_multipart (BODY *);
  65 BODY *mutt_new_body (void);
  66 BODY *mutt_parse_multipart (FILE *, const char *, off_t, int);
  67 BODY *mutt_parse_messageRFC822 (FILE *, BODY *);
  68 BODY *mutt_read_mime_header (FILE *, int);
  69
  70 CONTENT *mutt_get_content_info (const char *fname, BODY * b);
  71
  72 LIST *mutt_make_references (ENVELOPE * e);
  73 char* mutt_read_rfc822_line (FILE*, char*, size_t*);
  74 LIST *mutt_parse_references (char *, int);
  75
  76 ENVELOPE *mutt_read_rfc822_header (FILE *, HEADER *, short, short);
  77 HEADER *mutt_dup_header (HEADER *);
  78
  79 int mutt_cmp_header (const HEADER*, const HEADER*);
  80 int mutt_cmp_addr (const ADDRESS * a, const ADDRESS * b);
  81 int mutt_cmp_list (const LIST * a, const LIST * b);
  82 int mutt_cmp_env (const ENVELOPE * e1, const ENVELOPE * e2);
  83 int mutt_cmp_param (const PARAMETER * p1, const PARAMETER * p2);
  84 int mutt_cmp_body (const BODY * b1, const BODY * b2);
  85
  86 time_t mutt_decrease_mtime (const char *, struct stat *);
  87 void mutt_set_mtime (const char*, const char*);
  88 time_t mutt_local_tz (time_t);
  89 time_t mutt_mktime (struct tm *, int);
  90 time_t mutt_parse_date (const char *, HEADER *);
  91 int is_from (const char *, char *, size_t, time_t *);
  92
  93 char *mutt_charset_hook (const char *);
  94 char *mutt_iconv_hook (const char *);
  95 char *mutt_expand_path (char *, size_t);
  96 char *_mutt_expand_path (char *, size_t, int);
  97 char *mutt_find_hook (int, const char *);
  98 char *mutt_gecos_name (char *, size_t, struct passwd *);
  99 char *mutt_gen_msgid (void);
 100 char *mutt_get_body_charset (char *, size_t, BODY *);
 101 const char *mutt_get_name (ADDRESS *);
 102 char *mutt_get_parameter (const char *, PARAMETER *);
 103 char *mutt_crypt_hook (ADDRESS *);
 104 char *mutt_make_date (char *, size_t);
 105
 106 const char *mutt_make_version (int full);
 107
 108 const char *mutt_fqdn (short);
 109
 110 void mutt_account_hook (const char *url);
 111 void mutt_add_to_reference_headers (ENVELOPE * env, ENVELOPE * curenv,
 112                                     LIST *** pp, LIST *** qq);
 113 void mutt_adv_mktemp (const char*, char*, size_t);
 114 void mutt_allow_interrupt (int);
 115 void mutt_block_signals (void);
 116 void mutt_block_signals_system (void);
 117 int mutt_bounce_message (FILE * fp, HEADER *, ADDRESS *);
 118 void mutt_canonical_charset (char *, size_t, const char *);
 119 int mutt_count_body_parts (HEADER *hdr, int flags);
 120 void mutt_check_rescore (CONTEXT *);
 121 void mutt_clear_error (void);
 122 void mutt_default_save (char *, size_t, HEADER *);
 123 void mutt_display_address (ENVELOPE *);
 124 void mutt_display_sanitize (char *);
 125 void mutt_edit_content_type (HEADER *, BODY *, FILE *);
 126 void mutt_edit_file (const char *, const char *);
 127 void mutt_edit_headers (const char *, const char *, HEADER *, char *, size_t);
 128 void mutt_curses_error (const char *, ...);
 129 void mutt_curses_message (const char *, ...);
 130 void mutt_enter_command (void);
 131 void mutt_expand_file_fmt (char *, size_t, const char *, const char *);
 132 void mutt_expand_fmt (char *, size_t, const char *, const char *);
 133 void mutt_expand_link (char *, const char *, const char *);
 134 void mutt_fix_reply_recipients (ENVELOPE * env);
 135 void mutt_folder_hook (char *);
 136 void mutt_format_string (char *, size_t, int, int, int, char, const char *,
 137                          size_t, int);
 138 void mutt_format_s (char *, size_t, const char *, const char *);
 139 void mutt_format_s_tree (char *, size_t, const char *, const char *);
 140 void mutt_forward_intro (FILE * fp, HEADER * cur);
 141 void mutt_forward_trailer (FILE * fp);
 142 void mutt_free_body (BODY **);
 143 void mutt_free_color (int fg, int bg);
 144 void mutt_free_envelope (ENVELOPE **);
 145 void mutt_free_header (HEADER **);
 146 void mutt_free_parameter (PARAMETER **);
 147 void mutt_generate_header (char *, size_t, HEADER *, int);
 148 void mutt_help (int);
 149 void mutt_draw_tree (CONTEXT *);
 150 void mutt_make_attribution (CONTEXT * ctx, HEADER * cur, FILE * out);
 151 void mutt_make_forward_subject (ENVELOPE * env, CONTEXT * ctx, HEADER * cur);
 152 void mutt_make_help (char *, size_t, char *, int, int);
 153 void mutt_make_misc_reply_headers (ENVELOPE * env, CONTEXT * ctx,
 154                                    HEADER * cur, ENVELOPE * curenv);
 155 void mutt_make_post_indent (CONTEXT * ctx, HEADER * cur, FILE * out);
 156 void mutt_merge_envelopes (ENVELOPE* base, ENVELOPE** extra);
 157 void mutt_message_to_7bit (BODY *, FILE *);
 158
 159 #define mutt_mktemp(a) _mutt_mktemp (a, __FILE__, __LINE__)
 160 void _mutt_mktemp (char *, const char *, int);
 161 void mutt_normalize_time (struct tm *);
 162 void mutt_paddstr (int, const char *);
 163 void mutt_parse_mime_message (CONTEXT * ctx, HEADER *);
 164 void mutt_parse_part (FILE *, BODY *);
 165 #define mutt_perror(a) _mutt_perror (a, __FILE__, __LINE__)
 166 void _mutt_perror (const char*, const char*,int);
 167 void mutt_prepare_envelope (ENVELOPE *, int);
 168 void mutt_unprepare_envelope (ENVELOPE *);
 169 void mutt_pretty_mailbox (char *);
 170 void mutt_pretty_size (char *, size_t, long);
 171 void mutt_pipe_message (HEADER *);
 172 void mutt_print_message (HEADER *);
 173 void mutt_query_exit (void);
 174 void mutt_query_menu (char *, size_t);
 175 void mutt_safe_path (char *s, size_t l, ADDRESS * a);
 176 void mutt_save_path (char *s, size_t l, ADDRESS * a);
 177 void mutt_score_message (CONTEXT *, HEADER *, int);
 178 void mutt_select_fcc (char *, size_t, HEADER *);
 179
 180 #define mutt_select_file(A,B,C) _mutt_select_file(A,B,C,NULL,NULL)
 181 void _mutt_select_file (char *, size_t, int, char ***, int *);
 182 void mutt_message_hook (CONTEXT *, HEADER *, int);
 183 void _mutt_set_flag (CONTEXT *, HEADER *, int, int, int);
 184
 185 #define mutt_set_flag(a,b,c,d) _mutt_set_flag(a,b,c,d,1)
 186 void mutt_set_followup_to (ENVELOPE *);
 187 void mutt_shell_escape (void);
 188 void mutt_show_error (void);
 189 void mutt_signal_init (void);
 190 void mutt_stamp_attachment (BODY * a);
 191 void mutt_tabs_to_spaces (char *);
 192 void mutt_tag_set_flag (int, int);
 193 void mutt_unblock_signals (void);
 194 void mutt_unblock_signals_system (int);
 195 void mutt_update_encoding (BODY * a);
 196 void mutt_version (void);
 197 void mutt_write_references (LIST *, FILE *);
 198 void mutt_write_address_list (ADDRESS * adr, FILE * fp, int linelen,
 199                               int display);
 200
 201 int mutt_addwch (wchar_t);
 202 int mutt_alloc_color (int fg, int bg);
 203 int mutt_any_key_to_continue (const char *);
 204 int mutt_builtin_editor (const char *, HEADER *, HEADER *);
 205 int mutt_can_decode (BODY *);
 206 int mutt_change_flag (HEADER *, int);
 207 int mutt_check_encoding (const char *);
 208 int mutt_check_key (const char *);
 209 int mutt_check_menu (const char *);
 210 int mutt_check_mime_type (const char *);
 211 int mutt_check_month (const char *);
 212 int mutt_check_overwrite (const char *, const char *, char *, size_t, int *,
 213                           char **);
 214 int mutt_check_traditional_pgp (HEADER *, int *);
 215 int mutt_command_complete (char *, size_t, int, int);
 216 int mutt_var_value_complete (char *, size_t, int);
 217 int mutt_complete (char *, size_t);
 218 int mutt_copy_body (FILE *, BODY **, BODY *);
 219
 220 int mutt_display_message (HEADER * h);
 221 int mutt_dump_variables (int full);
 222 int mutt_edit_message (CONTEXT *, HEADER *);
 223 int mutt_fetch_recips (ENVELOPE * out, ENVELOPE * in, int flags);
 224 int mutt_chscmp (const char *s, const char *chs);
 225
 226 #define mutt_is_utf8(a) mutt_chscmp (a, "utf-8")
 227 #define mutt_is_us_ascii(a) mutt_chscmp (a, "us-ascii")
 228 int mutt_prepare_template (FILE *, CONTEXT *, HEADER *, HEADER *, short);
 229 int mutt_resend_message (FILE *, CONTEXT *, HEADER *);
 230
 231 #define mutt_enter_fname(A,B,C,D,E) _mutt_enter_fname(A,B,C,D,E,0,NULL,NULL)
 232 int _mutt_enter_fname (const char *, char *, size_t, int *, int, int,
 233                        char ***, int *);
 234 #define mutt_get_field(A,B,C,D) _mutt_get_field(A,B,C,D,0,NULL,NULL)
 235 int _mutt_get_field (const char *, char *, size_t, int, int, char ***, int *);
 236 int mutt_get_field_unbuffered (char *, char *, size_t, int);
 237 int mutt_get_hook_type (const char *);
 238 int mutt_get_postponed (CONTEXT *, HEADER *, HEADER **, char *, size_t);
 239 int mutt_index_menu (void);
 240 int mutt_invoke_mta (ADDRESS *, ADDRESS *, ADDRESS *, ADDRESS *, const char *,
 241                      int);
 242 int mutt_is_mail_list (ADDRESS *);
 243 int mutt_is_list_cc (int, ADDRESS *, ADDRESS *);
 244 int mutt_is_list_recipient (int, ADDRESS *, ADDRESS *);
 245 int mutt_is_subscribed_list (ADDRESS *);
 246 int mutt_is_text_part (BODY *);
 247 int mutt_is_valid_mailbox (const char *);
 248 int mutt_lookup_mime_type (BODY *, const char *);
 249 int mutt_match_spam_list (const char *, SPAM_LIST *, char *, int);
 250 int mutt_multi_choice (char *prompt, char *letters);
 251 int mutt_needs_mailcap (BODY *);
 252 int mutt_num_postponed (int);
 253 int mutt_parse_bind (BUFFER *, BUFFER *, unsigned long, BUFFER *);
 254 int mutt_parse_exec (BUFFER *, BUFFER *, unsigned long, BUFFER *);
 255 int mutt_parse_color (BUFFER *, BUFFER *, unsigned long, BUFFER *);
 256 int mutt_parse_uncolor (BUFFER *, BUFFER *, unsigned long, BUFFER *);
 257 int mutt_parse_hook (BUFFER *, BUFFER *, unsigned long, BUFFER *);
 258 int mutt_parse_macro (BUFFER *, BUFFER *, unsigned long, BUFFER *);
 259 int mutt_parse_mono (BUFFER *, BUFFER *, unsigned long, BUFFER *);
 260 int mutt_parse_unmono (BUFFER *, BUFFER *, unsigned long, BUFFER *);
 261 int mutt_parse_push (BUFFER *, BUFFER *, unsigned long, BUFFER *);
 262 int mutt_parse_rc_line ( /* const */ char *, BUFFER *, BUFFER *);
 263 int mutt_parse_rfc822_line (ENVELOPE * e, HEADER * hdr, char *line, char *p,
 264                             short user_hdrs, short weed, short do_2047,
 265                             LIST ** lastp);
 266 int mutt_parse_score (BUFFER *, BUFFER *, unsigned long, BUFFER *);
 267 int mutt_parse_unscore (BUFFER *, BUFFER *, unsigned long, BUFFER *);
 268 int mutt_parse_unhook (BUFFER *, BUFFER *, unsigned long, BUFFER *);
 269 int mutt_pattern_func (int, char *);
 270 int mutt_query_complete (char *, size_t);
 271 int mutt_query_variables (LIST * queries);
 272 int _mutt_save_message (HEADER *, CONTEXT *, int, int, int);
 273 int mutt_save_message (HEADER *, int, int, int, int *);
 274 int mutt_search_command (int, int);
 275 int mutt_skipchars (const char *, const char *);
 276 int mutt_strwidth (const char *);
 277 int mutt_compose_menu (HEADER *, char *, size_t, HEADER *);
 278 int mutt_thread_set_flag (HEADER *, int, int, int);
 279 int mutt_user_is_recipient (HEADER *);
 280 void mutt_update_num_postponed (void);
 281 int mutt_wait_filter (pid_t);
 282 int mutt_which_case (const char *);
 283 int mutt_write_fcc (const char *path, HEADER * hdr, const char *msgid, int,
 284                     char *);
 285 int mutt_write_mime_body (BODY *, FILE *);
 286 int mutt_write_mime_header (BODY *, FILE *);
 287 int mutt_write_rfc822_header (FILE *, ENVELOPE *, BODY *, int, int);
 288 int mutt_yesorno (const char *, int);
 289 void mutt_set_header_color (CONTEXT *, HEADER *);
 290 void mutt_sleep (short);
 291 int mutt_save_confirm (const char *, struct stat *);
 292
 293 int mh_valid_message (const char *);
 294
 295 pid_t mutt_create_filter (const char *, FILE **, FILE **, FILE **);
 296 pid_t mutt_create_filter_fd (const char *, FILE **, FILE **, FILE **, int,
 297                              int, int);
 298
 299 /* base64.c */
 300 void mutt_to_base64 (unsigned char *, const unsigned char *, size_t, size_t);
 301 int mutt_from_base64 (char *, const char *);
 302
 303 /* utf8.c */
 304 int mutt_wctoutf8 (char *s, unsigned int c);
 305
 306 #ifdef LOCALES_HACK
 307 #define IsPrint(c) (isprint((unsigned char)(c)) || \
 308         ((unsigned char)(c) >= 0xa0))
 309 #define IsWPrint(wc) (iswprint(wc) || wc >= 0xa0)
 310 #else
 311 #define IsPrint(c) (isprint((unsigned char)(c)) || \
 312         (option (OPTLOCALES) ? 0 : \
 313         ((unsigned char)(c) >= 0xa0)))
 314 #define IsWPrint(wc) (iswprint(wc) || \
 315         (option (OPTLOCALES) ? 0 : (wc >= 0xa0)))
 316 #endif
 317
 318 #define new_pattern() p_new(pattern_t, 1)
 319
 320 int mutt_pattern_exec (struct pattern_t *pat, pattern_exec_flag flags,
 321                        CONTEXT * ctx, HEADER * h);
 322 pattern_t *mutt_pattern_comp ( /* const */ char *s, int flags, BUFFER * err);
 323 void mutt_check_simple (char *s, size_t len, const char *simple);
 324 void mutt_pattern_free (pattern_t ** pat);
 325
 326 /* ----------------------------------------------------------------------------
 327  * Prototypes for broken systems
 328  */
 329
 330 #ifdef HAVE_SRAND48
 331 #define LRAND lrand48
 332 #define SRAND srand48
 333 #define DRAND drand48
 334 #else
 335 #define LRAND rand
 336 #define SRAND srand
 337 #define DRAND (double)rand
 338 #endif /* HAVE_SRAND48 */
 339
 340 /* HP-UX, ConvexOS and UNIXware don't have this macro */
 341 #ifndef S_ISLNK
 342 #define S_ISLNK(x) (((x) & S_IFMT) == S_IFLNK ? 1 : 0)
 343 #endif
 344
 345 int getdnsdomainname (char *, size_t);
 346
 347 /* According to SCO support, this is how to detect SCO */
 348 #if defined (_M_UNIX) || defined (M_OS)
 349 #define SCO
 350 #endif
 351
 352 /* SCO Unix uses chsize() instead of ftruncate() */
 353 #ifndef HAVE_FTRUNCATE
 354 #define ftruncate chsize
 355 #endif
 356
 357 #ifndef HAVE_SNPRINTF
 358 extern int snprintf (char *, size_t, const char *, ...);
 359 #endif
 360
 361 #ifndef HAVE_VSNPRINTF
 362 extern int vsnprintf (char *, size_t, const char *, va_list);
 363 #endif
 364
 365 #ifndef HAVE_STRERROR
 366 #ifndef STDC_HEADERS
 367 extern int sys_nerr;
 368 extern char *sys_errlist[];
 369 #endif
 370
 371 #define strerror(x) ((x) > 0 && (x) < sys_nerr) ? sys_errlist[(x)] : 0
 372 #endif /* !HAVE_STRERROR */
 373
 374 #ifndef HAVE_MEMMOVE
 375 #define memmove(d,s,n) bcopy((s),(d),(n))
 376 #endif
 377
 378 #ifdef _AIX
 379 /* AIX doesn't define these in any headers (sigh) */
 380 int strcasecmp (const char *, const char *);
 381 int strncasecmp (const char *, const char *, size_t);
 382
 383 int setegid (gid_t);
 384 #endif /* _AIX */
 385
 386 #ifndef STDC_HEADERS
 387 extern FILE *fdopen ();
 388 extern int system ();
 389 extern int puts ();
 390 extern int fputs ();
 391 extern int fputc ();
 392 extern int fseeko ();
 393 extern char *strchr ();
 394 extern int getopt ();
 395 extern int fputs ();
 396 extern int fputc ();
 397 extern int fclose ();
 398 extern int fprintf ();
 399 extern int printf ();
 400 extern int fgetc ();
 401 extern int tolower ();
 402 extern int toupper ();
 403 extern int sscanf ();
 404 extern size_t fread ();
 405 extern size_t fwrite ();
 406 extern int system ();
 407 extern int rename ();
 408 extern time_t time ();
 409 extern struct tm *localtime ();
 410 extern char *asctime ();
 411 extern char *strpbrk ();
 412 extern int fflush ();
 413 extern long lrand48 ();
 414 extern void srand48 ();
 415 extern time_t mktime ();
 416 extern int vsprintf ();
 417 extern int ungetc ();
 418 extern char *mktemp ();
 419 extern int ftruncate ();
 420 extern void *memset ();
 421 extern int pclose ();
 422 extern int socket ();
 423 extern int connect ();
 424 extern size_t strftime ();
 425 extern int lstat ();
 426 extern void rewind ();
 427 extern int readlink ();
 428
 429 /* IRIX barfs on empty var decls because the system include file uses elipsis
 430    in the declaration.  So declare all the args to avoid compiler errors.  This
 431    should be harmless on other systems.  */
 432 int ioctl (int, int, ...);
 433
 434 #endif
 435
 436 /* unsorted */
 437 void ci_bounce_message (HEADER *, int *);
 438 int ci_send_message (int, HEADER *, char *, CONTEXT *, HEADER *);