src/mgutils.h

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 2001 Match Grun
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * General definitions for common address book entries.
  22  */
  23
  24 #ifndef __MGUTILS_H__
  25 #define __MGUTILS_H__
  26
  27 #include <time.h>
  28 #include <stdio.h>
  29 #include <glib.h>
  30
  31 #include "addressitem.h"
  32
  33 // Error codes
  34 #define MGU_SUCCESS        0
  35 #define MGU_BAD_ARGS       -1
  36 #define MGU_NO_FILE        -2
  37 #define MGU_OPEN_FILE      -3
  38 #define MGU_ERROR_READ     -4
  39 #define MGU_EOF            -5
  40 #define MGU_OO_MEMORY      -6
  41 #define MGU_BAD_FORMAT     -7
  42 #define MGU_LDAP_CONNECT   -8
  43 #define MGU_LDAP_INIT      -9
  44 #define MGU_LDAP_BIND      -10
  45 #define MGU_LDAP_SEARCH    -11
  46 #define MGU_LDAP_TIMEOUT   -12
  47 #define MGU_LDAP_CRITERIA  -13
  48 #define MGU_LDAP_NOENTRIES -14
  49
  50 // Address cache
  51 typedef struct _AddressCache AddressCache;
  52 struct _AddressCache {
  53         GList    *addressList;
  54         gboolean dataRead;
  55         gboolean modified;
  56         time_t   modifyTime;
  57 };
  58
  59 // Function prototypes
  60 AddressItem *mgu_create_address_item( AddressObjectType type );
  61 AddressItem *mgu_create_address( void );
  62 AddressItem *mgu_copy_address_item( AddressItem *item );
  63 void mgu_free_address( AddressItem *item );
  64 void mgu_free_address_list( GList *addrList );
  65 void mgu_refresh_cache( AddressCache *cache );
  66 void mgu_clear_cache( AddressCache *cache );
  67 void mgu_clear_cache_null( AddressCache *cache );
  68 AddressCache *mgu_create_cache( void );
  69 void mgu_free_cache( AddressCache *cache );
  70 void mgu_print_address( AddressItem *item, FILE *stream );
  71 void mgu_print_address_list( GList *addrList, FILE *stream );
  72 void mgu_print_cache( AddressCache *cache, FILE *stream );
  73 void mgu_print_list( GSList *list, FILE *stream );
  74 void mgu_print_dlist( GList *list, FILE *stream );
  75 gboolean mgu_check_file( AddressCache *cache, gchar *path );
  76 gboolean mgu_mark_cache( AddressCache *cache, gchar *path );
  77 void mgu_free_list( GSList *list );
  78 void mgu_free_dlist( GList *list );
  79 gchar *mgu_list_coalesce( GSList *list );
  80 void mgu_add_cache( AddressCache *cache, AddressItem *addrItem );
  81 gchar *mgu_error2string( gint err );
  82
  83 #endif /* __MGUTILS_H__ */