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