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