gammu-memory.h

Go to the documentation of this file.

#ifndef __gammu_memory_h
#define __gammu_memory_h

#ifdef  __cplusplus
extern "C" {
#endif

#include <gammu-datetime.h>
#include <gammu-limits.h>
#include <gammu-bitmap.h>
#include <gammu-debug.h>

typedef enum {
        MEM_ME = 1,
        MEM_SM,
        MEM_ON,
        MEM_DC,
        MEM_RC,
        MEM_MC,
        MEM_MT,
        MEM_FD,

        MEM_VM,

        MEM_SL,

        MEM_QD,

        MEM_INVALID
} GSM_MemoryType;

#define GSM_MemoryTypeToString(x) \
        ((x) == MEM_ME ? "ME" : \
        ((x) == MEM_SM ? "SM" : \
        ((x) == MEM_ON ? "ON" : \
        ((x) == MEM_DC ? "DC" : \
        ((x) == MEM_RC ? "RC" : \
        ((x) == MEM_MC ? "MC" : \
        ((x) == MEM_MT ? "MT" : \
        ((x) == MEM_FD ? "FD" : \
        ((x) == MEM_VM ? "VM" : \
        ((x) == MEM_QD ? "QD" : \
        ((x) == MEM_SL ? "SL" : "XX")))))))))))

GSM_MemoryType GSM_StringToMemoryType(const char *s);

typedef struct {
        int MemoryUsed;
        GSM_MemoryType MemoryType;
        int MemoryFree;
} GSM_MemoryStatus;

typedef enum {
        PBK_Number_General = 1,
        PBK_Number_Mobile,
        PBK_Number_Fax,
        PBK_Number_Pager,
        PBK_Number_Other,
        PBK_Text_Note,
        PBK_Text_Postal,
        PBK_Text_Email,
        /*
         * Second email. (Text)
         */
        PBK_Text_Email2,
        PBK_Text_URL,
        PBK_Date,
        PBK_Caller_Group,
        PBK_Text_Name,
        PBK_Text_LastName,
        PBK_Text_FirstName,
        PBK_Text_Company,
        PBK_Text_JobTitle,
        PBK_Category,
        PBK_Private,
        PBK_Text_StreetAddress,
        PBK_Text_City,
        PBK_Text_State,
        PBK_Text_Zip,
        PBK_Text_Country,
        PBK_Text_Custom1,
        PBK_Text_Custom2,
        PBK_Text_Custom3,
        PBK_Text_Custom4,
        PBK_RingtoneID,
        PBK_PictureID,
        PBK_Text_UserID,
        PBK_CallLength,
        PBK_Text_LUID,
        PBK_LastModified,
        PBK_Text_NickName,
        PBK_Text_FormalName,
        PBK_Text_PictureName,
        PBK_PushToTalkID,
        PBK_Number_Messaging,
        PBK_Photo,
        PBK_Text_SecondName,
        PBK_Text_VOIP,
        PBK_Text_SIP,
        PBK_Text_DTMF,
        PBK_Number_Video,
        PBK_Text_SWIS,
        PBK_Text_WVID,
        PBK_Text_NamePrefix,
        PBK_Text_NameSuffix,
} GSM_EntryType;

typedef enum {
        PBK_Location_Unknown = 0,
        PBK_Location_Home,
        PBK_Location_Work,
} GSM_EntryLocation;

typedef struct {
        GSM_EntryType EntryType;
        GSM_EntryLocation Location;
        GSM_DateTime Date;
        int Number;
        int VoiceTag;
        int SMSList[20];
        int CallLength;

        GSM_Error AddError;
        unsigned char Text[(GSM_PHONEBOOK_TEXT_LENGTH + 1) * 2];
        GSM_BinaryPicture Picture;
} GSM_SubMemoryEntry;

typedef struct {
        GSM_MemoryType MemoryType;
        int Location;
        int EntriesNum;
        GSM_SubMemoryEntry Entries[GSM_PHONEBOOK_ENTRIES];
} GSM_MemoryEntry;

typedef struct {
        int Location;
        int MemoryNumberID;
        GSM_MemoryType MemoryType;
        int MemoryLocation;
} GSM_SpeedDial;

GSM_Error GSM_GetMemoryStatus(GSM_StateMachine * s, GSM_MemoryStatus * status);

GSM_Error GSM_GetMemory(GSM_StateMachine * s, GSM_MemoryEntry * entry);

GSM_Error GSM_GetNextMemory(GSM_StateMachine * s, GSM_MemoryEntry * entry,
                            gboolean start);

GSM_Error GSM_SetMemory(GSM_StateMachine * s, GSM_MemoryEntry * entry);

GSM_Error GSM_AddMemory(GSM_StateMachine * s, GSM_MemoryEntry * entry);

GSM_Error GSM_DeleteMemory(GSM_StateMachine * s, GSM_MemoryEntry * entry);

GSM_Error GSM_DeleteAllMemory(GSM_StateMachine * s, GSM_MemoryType MemoryType);

GSM_Error GSM_GetSpeedDial(GSM_StateMachine * s, GSM_SpeedDial * Speed);

GSM_Error GSM_SetSpeedDial(GSM_StateMachine * s, GSM_SpeedDial * Speed);

unsigned char *GSM_PhonebookGetEntryName(const GSM_MemoryEntry * entry);

void GSM_PhonebookFindDefaultNameNumberGroup(const GSM_MemoryEntry * entry,
                                             int *Name, int *Number,
                                             int *Group);
typedef enum {
        Nokia_VCard10 = 1,
        Nokia_VCard21,
        SonyEricsson_VCard10,
        SonyEricsson_VCard21,
        SonyEricsson_VCard21_Phone,
} GSM_VCardVersion;

GSM_Error GSM_EncodeVCARD(GSM_Debug_Info * di, char *Buffer,
                          const size_t buff_len, size_t * Pos,
                          GSM_MemoryEntry * pbk, const gboolean header,
                          const GSM_VCardVersion Version);

GSM_Error GSM_DecodeVCARD(GSM_Debug_Info * di, char *Buffer, size_t * Pos,
                          GSM_MemoryEntry * Pbk,
                          const GSM_VCardVersion Version);

void GSM_FreeMemoryEntry(GSM_MemoryEntry * Entry);
#ifdef  __cplusplus
}
#endif
#endif

/* Editor configuration
 * vim: noexpandtab sw=8 ts=8 sts=8 tw=72:
 */