utils.h

Go to the documentation of this file.

/*
 * XetPan: a libEtPan! based Mail User Agent
 * Copyright (C) 2002-2003 Melvin Hadasht
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#ifndef UTILS_H
#define UTILS_H

#include <stdlib.h> /* size_t */
#include <time.h>   /* struct tm */

#include <libetpan.h> /* struct mailimf_date_time */

#include "uudeview.h" /* uuprogress */

#define XEP_UTILS_SIZE_BUF_MAX 6

typedef enum
  {
    XEP_Q_ENCODING,   
    XEP_B_ENCODING,   
    XEP_AUTO_ENCODING 
  } XePUtilsEncodingType;

typedef struct XePUtilsFormat_s XePUtilsFormat;

struct XePUtilsFormat_s
{
  const char *string; 
  const char token;   
};

typedef enum
  {
    XEP_OPENPGP_NONE = 0,
    XEP_OPENPGP_SIGNED = 1 << 0,
    XEP_OPENPGP_ENCRYPTED = 1 << 1
  } XePUtilsOpenPGPType;

typedef enum
  {
    XEP_INLINED_DATA_NONE,
    XEP_INLINED_DATA_UUENCODED,
    XEP_INLINED_DATA_YENCODED,
    XEP_INLINED_DATA_YENCODED2,
    XEP_INLINED_DATA_BINHEX,
    XEP_INLINED_DATA_TEXT,
    XEP_INLINED_DATA_CLEARSIGNED_TEXT,
    XEP_INLINED_DATA_ASCII_ARMORED_TEXT
  } XePUtilsInlinedDataType;

/* utils.c charset global variable depend on the ordering of this enum */
typedef enum
  {
    XEP_CHARSET_0,
    XEP_CHARSET_BIG5,
    XEP_CHARSET_EUC_JP,
    XEP_CHARSET_EUC_KR,
    XEP_CHARSET_EUC_TW,
    XEP_CHARSET_GB2312,
    XEP_CHARSET_ISIRI_3342,
    XEP_CHARSET_ISO_2022_CN,
    XEP_CHARSET_ISO_2022_CN_EXT,
    XEP_CHARSET_ISO_2022_JP,
    XEP_CHARSET_ISO_2022_JP_2,
    XEP_CHARSET_ISO_2022_KR,
    XEP_CHARSET_ISO_8859_1,
    XEP_CHARSET_ISO_8859_10,
    XEP_CHARSET_ISO_8859_11,
    XEP_CHARSET_ISO_8859_13,
    XEP_CHARSET_ISO_8859_14,
    XEP_CHARSET_ISO_8859_15,
    XEP_CHARSET_ISO_8859_16,
    XEP_CHARSET_ISO_8859_2,
    XEP_CHARSET_ISO_8859_3,
    XEP_CHARSET_ISO_8859_4,
    XEP_CHARSET_ISO_8859_5,
    XEP_CHARSET_ISO_8859_6,
    XEP_CHARSET_ISO_8859_7,
    XEP_CHARSET_ISO_8859_8,
    XEP_CHARSET_ISO_8859_8_I,
    XEP_CHARSET_ISO_8859_9,
    XEP_CHARSET_KOI8_R,
    XEP_CHARSET_KOI8_U,
    XEP_CHARSET_MAC_CYRILLIC,
    XEP_CHARSET_SHIFT_JIS,
    XEP_CHARSET_TIS_620,
    XEP_CHARSET_UTF8,
    XEP_CHARSET_VISCII,
    XEP_CHARSET_WINDOWS_1250,
    XEP_CHARSET_WINDOWS_1251,
    XEP_CHARSET_WINDOWS_1254,
    XEP_CHARSET_WINDOWS_1255,
    XEP_CHARSET_WINDOWS_1256,
    XEP_CHARSET_WINDOWS_1258
  } XePUtilsCharset;

typedef struct XePUtilsInlinedFile_s XePUtilsInlinedFile;

struct XePUtilsInlinedFile_s
{
  /* Common members with XePUtilsInlinedText and XePUtilsInlinedAny */
  XePUtilsInlinedDataType type;
  char *data;   
  size_t size;  
  const char *start;  
  void *extra;  
  /* Specific member */
  char *filename; 
};

typedef struct XePUtilsInlinedText_s XePUtilsInlinedText;

struct XePUtilsInlinedText_s
{
  /* Common members with XePUtilsInlinedFile and XePUtilsInlinedAny */
  XePUtilsInlinedDataType type;
  char *data;   
  size_t size;  
  const char *start;  
  void *extra;  
  /* Specific member */
  char *plain_text; 
  size_t plain_size;
  int privacy_sig_status;
  int privacy_enc_status;
};

typedef struct XePUtilsInlinedDataAny_s XePUtilsInlinedDataAny;

struct XePUtilsInlinedDataAny_s
{
  /* Common members with XePUtilsInlinedText and XePUtilsInlinedFile */
  XePUtilsInlinedDataType type;
  char *data;   
  size_t size;  
  const char *start;  
  void *extra;  
};

typedef union XePUtilsInlinedData_u XePUtilsInlinedData;

union XePUtilsInlinedData_u
{
  XePUtilsInlinedDataAny any;
  XePUtilsInlinedText text;
  XePUtilsInlinedFile file;
};

  
typedef struct XePUtilsPair_s XePUtilsPair;

struct XePUtilsPair_s
{
  void *name;
  void *value;
};

typedef struct XePUtilsTriplet_s XePUtilsTriplet;

struct XePUtilsTriplet_s
{
  void *data1;
  void *data2;
  void *data3;
};

typedef struct XePUtilsCharsetMapping_s XePUtilsCharsetMapping;
struct  XePUtilsCharsetMapping_s
{
  XePUtilsCharset charset_id;
  const char *charset;
};

extern XePUtilsCharsetMapping xetpan_charsets[];

char *
a_Utils_printf(char *template, XePUtilsFormat *format);

char *
a_Utils_append(char *dest, ...);

void
a_Utils_string_unfold(char *string);

char *
a_Utils_magic_data_mime_type(const char *data, size_t size);

char *
a_Utils_magic_file_mime_type(const char *filename);

char *
a_Utils_magic_get_charset(const char *magic_mime_type);

void
a_Utils_format_size(char *buffer, size_t size);

int
a_Utils_write(int fd, const char *data, size_t size);

int
a_Utils_read(int fd, char **data, size_t *size);


char *
a_Utils_save_temp(const char *data, size_t size);

int
a_Utils_load_file(const char *filename, char **data, size_t *size);

int
a_Utils_file_backup(const char *filename);

XePUtilsInlinedData *
a_Utils_inlined_text_new(XePUtilsInlinedDataType type,
                         const char *data,
                         size_t size,
                         const char *plain_text,
                         size_t plain_size,
                         int privacy_sig_status,
                         int privacy_enc_status,
                         void *extra);

XePUtilsInlinedData *
a_Utils_inlined_file_new(XePUtilsInlinedDataType type,
                         const char *data, 
                         size_t size, 
                         const char *filename, 
                         void *extra);
void
a_Utils_inlined_list_free(clist *inlined_list);

void
a_Utils_inlined_data_free(XePUtilsInlinedData *inlined_data);

int
a_Utils_inlined_file_decode_as(XePUtilsInlinedData *inlined_data,
                               const char *save_as);

char *
a_Utils_uulib_decode_file(const char *filename,
                          void (*msg_cb)(void *adata, 
                                         const char *msg,
                                         int msg_type),
                          void (*busy_cb)(void *adata,
                                          uuprogress *aprogress),
                          void *data);

XePUtilsInlinedData *
a_Utils_data_has_uuencoded(const char *data, size_t size);

XePUtilsInlinedData *
a_Utils_data_has_yencoded(const char *data, size_t size);

XePUtilsInlinedData *
a_Utils_data_has_yencoded2(const char *data, size_t size);

XePUtilsInlinedData *
a_Utils_data_has_binhex(const char *data, size_t size);

int
a_Utils_orig_date_to_localtime(struct mailimf_date_time *date_time,
                               struct tm *local_tm);

void *
a_Utils_memmem(const void *haystack, 
               size_t haystack_len, 
               const void *needle,
               size_t needle_len);

int
a_Utils_quote_text_for_reply(const char *text,
                             size_t text_size,
                             const char *source_charset,
                             char **quoted_text);

char *
a_Utils_create_quoted_printable(const char *text,
                                const char *text_charset);

clist *
a_Utils_parse_mailto(const char *mailto);

int
a_Utils_exec_cmd(char *cmd, int fd_in, int fd_out, int fd_err, int *fd_mon, 
                 pid_t *_pid, int sync);


char *
a_Utils_basename(const char* path);

char *
a_Utils_magic_get_bare_mime_type(const char *mime_type);

void
a_Utils_to_b_encoding(const char *s, size_t *is, char *t, size_t *it);

void
a_Utils_to_q_encoding(const char *s, size_t *is, char *t, size_t *it, 
                      int is_phrase,
                      int is_comment);

char *
a_Utils_encode_8bit_header(const char *text, 
                           const char *charset,
                           XePUtilsEncodingType encoding, 
                           int is_phrase, 
                           int is_comment);

char *
a_Utils_encode_8bit_subject(const char *subject, 
                            const char *charset, 
                            XePUtilsEncodingType encoding);

int
a_Utils_has_8bit(const char *text, size_t size);

clist *
a_Utils_parse_body_text(const char *text, size_t size);

const char *
a_Utils_inlined_data_type_as_string(XePUtilsInlinedDataType type);

int
a_Utils_text_new_copy_with_rfc2822_lines(const char *text, 
                                         size_t size,
                                         char **rfc2822_text,
                                         size_t *rfc2822_size);
#endif

---