common/service/gsmpbk.h

   1
   2 #ifndef __gsm_phonebook_h
   3 #define __gsm_phonebook_h
   4
   5 #include <stdlib.h>
   6
   7 #include "../gsmcomon.h"
   8 #include "gsmmisc.h"
   9
  10 /**
  11  * This structure contains info about number of used/free entries in phonebook
  12  * memory
  13  */
  14 typedef struct {
  15         /**
  16          * Memory type
  17          */
  18         GSM_MemoryType  MemoryType;
  19         /**
  20          * Number of used entries
  21          */
  22         int             Used;
  23         /**
  24          * Number of free entries
  25          */
  26         int             Free;
  27 } GSM_MemoryStatus;
  28
  29 /**
  30  * Type of specific phonebook entry. In parenthesis is specified in which
  31  * member of @ref GSM_SubMemoryEntry value is stored.
  32  */
  33 /* Originally created for MyGnokii */
  34 typedef enum {
  35         /**
  36          * General number. (Text)
  37          */
  38         PBK_Number_General = 1,
  39         /**
  40          * Mobile number. (Text)
  41          */
  42         PBK_Number_Mobile,
  43         /**
  44          * Work number. (Text)
  45          */
  46         PBK_Number_Work,
  47         /**
  48          * Fax number. (Text)
  49          */
  50         PBK_Number_Fax,
  51         /**
  52          * Home number. (Text)
  53          */
  54         PBK_Number_Home,
  55         /**
  56          * Pager number. (Text)
  57          */
  58         PBK_Number_Pager,
  59         /**
  60          * Other number. (Text)
  61          */
  62         PBK_Number_Other,
  63         /**
  64          * Note. (Text)
  65          */
  66         PBK_Text_Note,
  67         /**
  68          * Complete postal address. (Text)
  69          */
  70         PBK_Text_Postal,
  71         /**
  72          * Email. (Text)
  73          */
  74         PBK_Text_Email,
  75         /**
  76          * Second email. (Text)
  77          */
  78         PBK_Text_Email2,
  79         /**
  80          * URL (Text)
  81          */
  82         PBK_Text_URL,
  83         /**
  84          * Date and time. FIXME: describe better (Date)
  85          */
  86         PBK_Date,
  87         /**
  88          * Caller group. (Text)
  89          */
  90         PBK_Caller_Group,
  91         /**
  92          * Name (Text)
  93          */
  94         PBK_Text_Name,
  95         /**
  96          * Last name. (Text)
  97          */
  98         PBK_Text_LastName,
  99         /**
 100          * First name. (Text)
 101          */
 102         PBK_Text_FirstName,
 103         /**
 104          * Company. (Text)
 105          */
 106         PBK_Text_Company,
 107         /**
 108          * Job title. (Text)
 109          */
 110         PBK_Text_JobTitle,
 111         /**
 112          * Category. (Number)
 113          */
 114         PBK_Category,
 115         /**
 116          * Whether entry is private. (Number)
 117          */
 118         PBK_Private,
 119         /**
 120          * Street address. (Text)
 121          */
 122         PBK_Text_StreetAddress,
 123         /**
 124          * City. (Text)
 125          */
 126         PBK_Text_City,
 127         /**
 128          * State. (Text)
 129          */
 130         PBK_Text_State,
 131         /**
 132          * Zip code. (Text)
 133          */
 134         PBK_Text_Zip,
 135         /**
 136          * Country. (Text)
 137          */
 138         PBK_Text_Country,
 139         /**
 140          * Custom information 1. (Text)
 141          */
 142         PBK_Text_Custom1,
 143         /**
 144          * Custom information 2. (Text)
 145          */
 146         PBK_Text_Custom2,
 147         /**
 148          * Custom information 3. (Text)
 149          */
 150         PBK_Text_Custom3,
 151         /**
 152          * Custom information 4. (Text)
 153          */
 154         PBK_Text_Custom4,
 155         /**
 156          * Ringtone ID. (Text)
 157          */
 158         PBK_RingtoneID,
 159         /**
 160          * Picture ID. (Number)
 161          */
 162         PBK_PictureID
 163 } GSM_EntryType;
 164
 165 #define GSM_PHONEBOOK_TEXT_LENGTH       (200)
 166 #define GSM_PHONEBOOK_ENTRIES           (26)
 167
 168 /**
 169  * One value of memory entry.
 170  */
 171 typedef struct {
 172         /**
 173          * Type of entry.
 174          */
 175         GSM_EntryType           EntryType;
 176         /**
 177          * Text of entry (if applicable, see @ref GSM_EntryType).
 178          */
 179         unsigned char           Text[(GSM_PHONEBOOK_TEXT_LENGTH+1)*2];
 180         /**
 181          * Text of entry (if applicable, see @ref GSM_EntryType).
 182          */
 183         GSM_DateTime            Date;
 184         /**
 185          * Number of entry (if applicable, see @ref GSM_EntryType).
 186          */
 187         int                     Number;
 188         /**
 189          * Voice dialling tag.
 190          */
 191         int                     VoiceTag;
 192 } GSM_SubMemoryEntry;
 193
 194 /* Define datatype for phonebook entry
 195  * used for getting/writing phonebook entries.
 196  */
 197 typedef struct {
 198         /**
 199          * Type of memory.
 200          */
 201         GSM_MemoryType          MemoryType;
 202         /**
 203          * Location.
 204          */
 205         int                     Location;
 206         /**
 207          * Number of entries.
 208          */
 209         int                     EntriesNum;
 210         /**
 211          * Whether to prefer unicode for storing this entry.
 212          */
 213         bool                    PreferUnicode;
 214         /**
 215          * Values for this entry.
 216          */
 217         GSM_SubMemoryEntry      Entries[GSM_PHONEBOOK_ENTRIES];
 218 } GSM_MemoryEntry;
 219
 220 typedef enum {
 221         Nokia_VCard10 = 1,
 222         Nokia_VCard21,
 223         SonyEricsson_VCard10,
 224         SonyEricsson_VCard21
 225 } GSM_VCardVersion;
 226
 227 void GSM_PhonebookFindDefaultNameNumberGroup(GSM_MemoryEntry *entry, int *Name, int *Number, int *Group);
 228 unsigned char *GSM_PhonebookGetEntryName (GSM_MemoryEntry *entry);
 229
 230 void      GSM_EncodeVCARD(char *Buffer, int *Length, GSM_MemoryEntry *pbk, bool header, GSM_VCardVersion Version);
 231 GSM_Error GSM_DecodeVCARD(unsigned char *Buffer, int *Pos, GSM_MemoryEntry *Pbk, GSM_VCardVersion Version);
 232
 233 void DecodeVCARD21Text(char *VCard, GSM_MemoryEntry *pbk);
 234
 235 /**
 236  * Define datatype for saving speed dials
 237  */
 238 typedef struct {
 239         /**
 240          * Specify number of speed dial
 241          */
 242         int             Location;
 243         /**
 244          * Memory, where is saved used phonebook entry
 245          */
 246         GSM_MemoryType  MemoryType;
 247         /**
 248          * Location in memory, where is saved used phonebook entry
 249          */
 250         int             MemoryLocation;
 251         /**
 252          * ID of phone number used in phonebook entry
 253          */
 254         int             MemoryNumberID;
 255 } GSM_SpeedDial;
 256
 257 #endif
 258
 259 /* How should editor hadle tabs in this file? Add editor commands here.
 260  * vim: noexpandtab sw=8 ts=8 sts=8:
 261  */