src/addrbook.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  * Definitions necessary to access external address book files.
  22  */
  23
  24 #ifndef __ADDRBOOK_H__
  25 #define __ADDRBOOK_H__
  26
  27 #include <stdio.h>
  28 #include <glib.h>
  29 #include <setjmp.h>
  30
  31 #include "addritem.h"
  32 #include "addrcache.h"
  33 #include "adbookbase.h"
  34
  35 /* Address book file */
  36 typedef struct _AddressBookFile AddressBookFile;
  37
  38 struct _AddressBookFile {
  39         AddressBookType type;
  40         AddressCache *addressCache;
  41         gboolean   accessFlag;
  42         gint       retVal;
  43         gchar      *path;
  44         gchar      *fileName;
  45         gint       maxValue;
  46         GList      *tempList;
  47         GHashTable *tempHash;
  48         gboolean   readFlag;
  49         gboolean   modifyFlag;
  50         jmp_buf    jumper;
  51 };
  52
  53 /* Function prototypes */
  54
  55 AddressBookFile *addrbook_create_book   ( void );
  56 void addrbook_empty_book                ( AddressBookFile *book );
  57 void addrbook_free_book                 ( AddressBookFile *book );
  58 void addrbook_print_book                ( AddressBookFile *book, FILE *stream );
  59 void addrbook_dump_hash                 ( AddressBookFile *book, FILE *stream );
  60 void addrbook_dump_book                 ( AddressBookFile *book, FILE *stream );
  61 void addrbook_set_name                  ( AddressBookFile *book, const gchar *value );
  62 void addrbook_set_path                  ( AddressBookFile *book, const gchar *value );
  63 void addrbook_set_file                  ( AddressBookFile *book, const gchar *value );
  64 void addrbook_set_accessed              ( AddressBookFile *book, const gboolean value );
  65 gboolean addrbook_get_modified          ( AddressBookFile *book );
  66 gboolean addrbook_get_accessed          ( AddressBookFile *book );
  67 gboolean addrbook_get_read_flag         ( AddressBookFile *book );
  68 gint addrbook_get_status                ( AddressBookFile *book );
  69 ItemFolder *addrbook_get_root_folder    ( AddressBookFile *book );
  70 GList *addrbook_get_list_folder         ( AddressBookFile *book );
  71 GList *addrbook_get_list_person         ( AddressBookFile *book );
  72 gchar *addrbook_get_name                ( AddressBookFile *book );
  73 gboolean addrbook_get_dirty             ( AddressBookFile *book );
  74 void addrbook_set_dirty                 ( AddressBookFile *book, const gboolean value );
  75
  76 ItemPerson *addrbook_remove_person      ( AddressBookFile *book, ItemPerson *person );
  77 ItemGroup *addrbook_remove_group        ( AddressBookFile *book, ItemGroup *group );
  78 ItemEMail *addrbook_person_remove_email ( AddressBookFile *book, ItemPerson *person,
  79                                           ItemEMail *email );
  80
  81 gint addrbook_read_data                 ( AddressBookFile *book );
  82 gint addrbook_save_data                 ( AddressBookFile *book );
  83
  84 ItemEMail *addrbook_move_email_before   ( AddressBookFile *book, ItemPerson *person,
  85                                           ItemEMail *itemMove, ItemEMail *itemTarget );
  86 ItemEMail *addrbook_move_email_after    ( AddressBookFile *book, ItemPerson *person,
  87                                           ItemEMail *itemMove, ItemEMail *itemTarget );
  88
  89 void addrbook_update_address_list       ( AddressBookFile *book, ItemPerson *person,
  90                                           GList *listEMail );
  91 ItemPerson *addrbook_add_address_list   ( AddressBookFile *book, ItemFolder *folder,
  92                                           GList *listEMail );
  93 GList *addrbook_get_available_email_list( AddressBookFile *book, ItemGroup *group );
  94 void addrbook_update_group_list         ( AddressBookFile *book, ItemGroup *group,
  95                                           GList *listEMail );
  96 ItemGroup *addrbook_add_group_list      ( AddressBookFile *book, ItemFolder *folder,
  97                                           GList *listEMail );
  98 ItemFolder *addrbook_add_new_folder     ( AddressBookFile *book, ItemFolder *parent );
  99
 100 void addrbook_update_attrib_list        ( AddressBookFile *book, ItemPerson *person, GList *listAttrib );
 101 void addrbook_add_attrib_list           ( AddressBookFile *book, ItemPerson *person, GList *listAttrib );
 102
 103 ItemFolder *addrbook_remove_folder      ( AddressBookFile *book, ItemFolder *folder );
 104 ItemFolder *addrbook_remove_folder_delete( AddressBookFile *book, ItemFolder *folder );
 105
 106 GList *addrbook_get_bookfile_list       ( AddressBookFile *book );
 107 gchar *addrbook_gen_new_file_name       ( gint fileNum );
 108 gint addrbook_test_read_file            ( AddressBookFile *book, gchar *fileName );
 109
 110 GList *addrbook_get_all_persons         ( AddressBookFile *book );
 111
 112 ItemPerson *addrbook_add_contact        ( AddressBookFile *book, ItemFolder *folder,
 113                                           const gchar *name, const gchar *address,
 114                                           const gchar *remarks );
 115
 116 #endif /* __ADDRBOOK_H__ */