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