common/service/gsmcal.h

   1 #ifndef __gsm_calendar_h
   2 #define __gsm_calendar_h
   3
   4 #include "../gsmcomon.h"
   5
   6 /* ---------------------------- calendar ----------------------------------- */
   7
   8 #define GSM_CALENDAR_ENTRIES            16
   9 #define MAX_CALENDAR_TEXT_LENGTH        256 /* In 6310 max. 256 chars */
  10
  11 /**
  12  * Define enums for Calendar Note types.
  13  */
  14 typedef enum {
  15         /**
  16          * Reminder or Date
  17          */
  18         GCN_REMINDER=1,
  19         /**
  20          * Call
  21          */
  22         GCN_CALL,
  23         /**
  24          * Meeting
  25          */
  26         GCN_MEETING,
  27         /**
  28          * Birthday or Anniversary or Special Occasion
  29          */
  30         GCN_BIRTHDAY,
  31         /**
  32          * Memo or Miscellaneous
  33          */
  34         GCN_MEMO,
  35         /**
  36          * Travel
  37          */
  38         GCN_TRAVEL,
  39         /**
  40          * Vacation
  41          */
  42         GCN_VACATION,
  43         /**
  44          * Training - Athletism
  45          */
  46         GCN_T_ATHL,
  47         /**
  48          * Training - Ball Games
  49          */
  50         GCN_T_BALL,
  51         /**
  52          * Training - Cycling
  53          */
  54         GCN_T_CYCL,
  55         /**
  56          * Training - Budo
  57          */
  58         GCN_T_BUDO,
  59         /**
  60          * Training - Dance
  61          */
  62         GCN_T_DANC,
  63         /**
  64          * Training - Extreme Sports
  65          */
  66         GCN_T_EXTR,
  67         /**
  68          * Training - Football
  69          */
  70         GCN_T_FOOT,
  71         /**
  72          * Training - Golf
  73          */
  74         GCN_T_GOLF,
  75         /**
  76          * Training - Gym
  77          */
  78         GCN_T_GYM,
  79         /**
  80          * Training - Horse Race
  81          */
  82         GCN_T_HORS,
  83         /**
  84          * Training - Hockey
  85          */
  86         GCN_T_HOCK,
  87         /**
  88          * Training - Races
  89          */
  90         GCN_T_RACE,
  91         /**
  92          * Training - Rugby
  93          */
  94         GCN_T_RUGB,
  95         /**
  96          * Training - Sailing
  97          */
  98         GCN_T_SAIL,
  99         /**
 100          * Training - Street Games
 101          */
 102         GCN_T_STRE,
 103         /**
 104          * Training - Swimming
 105          */
 106         GCN_T_SWIM,
 107         /**
 108          * Training - Tennis
 109          */
 110         GCN_T_TENN,
 111         /**
 112          * Training - Travels
 113          */
 114         GCN_T_TRAV,
 115         /**
 116          * Training - Winter Games
 117          */
 118         GCN_T_WINT,
 119         /**
 120          * Alarm
 121          */
 122         GCN_ALARM,
 123         /**
 124          * Alarm repeating each day.
 125          */
 126         GCN_DAILY_ALARM
 127 } GSM_CalendarNoteType;
 128
 129 /**
 130  * One value of calendar event.
 131  */
 132 typedef enum {
 133         /**
 134          * Date and time of event start.
 135          */
 136         CAL_START_DATETIME = 1,
 137         /**
 138          * Date and time of event end.
 139          */
 140         CAL_END_DATETIME,
 141         /**
 142          * Alarm date and time.
 143          */
 144         CAL_ALARM_DATETIME,
 145         /**
 146          * Date and time of silent alarm.
 147          */
 148         CAL_SILENT_ALARM_DATETIME,
 149         /**
 150          * Recurrance.
 151          */
 152         CAL_RECURRANCE,
 153         /**
 154          * Text.
 155          */
 156         CAL_TEXT,
 157         /**
 158          * Location.
 159          */
 160         CAL_LOCATION,
 161         /**
 162          * Phone number.
 163          */
 164         CAL_PHONE,
 165         /**
 166          * Whether this entry is private.
 167          */
 168          CAL_PRIVATE,
 169         /**
 170          * Related contact id.
 171          */
 172         CAL_CONTACTID,
 173         /**
 174          * Repeat each x'th day of week.
 175          */
 176         CAL_REPEAT_DAYOFWEEK,
 177         /**
 178          * Repeat each x'th day of month.
 179          */
 180         CAL_REPEAT_DAY,
 181         /**
 182          * Repeat x'th week of month.
 183          */
 184         CAL_REPEAT_WEEKOFMONTH,
 185         /**
 186          * Repeat x'th month.
 187          */
 188         CAL_REPEAT_MONTH,
 189         /**
 190          * Repeating frequency.
 191          */
 192         CAL_REPEAT_FREQUENCY,
 193         /**
 194          * Repeating start.
 195          */
 196         CAL_REPEAT_STARTDATE,
 197         /**
 198          * Repeating end.
 199          */
 200         CAL_REPEAT_STOPDATE,
 201 } GSM_CalendarType;
 202
 203 /**
 204  * One value of calendar event.
 205  */
 206 typedef struct {
 207         /**
 208          * Type of value.
 209          */
 210          GSM_CalendarType       EntryType;
 211         /**
 212          * Text of value, if applicable.
 213          */
 214          unsigned char          Text[(MAX_CALENDAR_TEXT_LENGTH + 1)*2];
 215         /**
 216          * Date and time of value, if applicable.
 217          */
 218          GSM_DateTime           Date;
 219         /**
 220          * Number of value, if applicable.
 221          */
 222          unsigned int           Number;
 223 } GSM_SubCalendarEntry;
 224
 225 /**
 226  * Calendar note values.
 227  */
 228 typedef struct {
 229         /**
 230          * Type of calendar note.
 231          */
 232         GSM_CalendarNoteType    Type;
 233         /**
 234          * Location in memory.
 235          */
 236         int                     Location;
 237         /**
 238          * Number of entries.
 239          */
 240         int                     EntriesNum;
 241         /**
 242          * Values of entries.
 243          */
 244         GSM_SubCalendarEntry    Entries[GSM_CALENDAR_ENTRIES];
 245 } GSM_CalendarEntry;
 246
 247 void GSM_CalendarFindDefaultTextTimeAlarmPhoneRecurrance(GSM_CalendarEntry *entry, int *Text, int *Time, int *Alarm, int *Phone, int *Recurrance, int *EndTime, int *Location);
 248
 249 typedef enum {
 250         Nokia_VCalendar = 1,
 251         Siemens_VCalendar,
 252         SonyEricsson_VCalendar
 253 } GSM_VCalendarVersion;
 254
 255 GSM_Error GSM_EncodeVCALENDAR(char *Buffer, int *Length, GSM_CalendarEntry *note, bool header, GSM_VCalendarVersion Version);
 256
 257 bool IsCalendarNoteFromThePast(GSM_CalendarEntry *note);
 258
 259 typedef struct {
 260         /**
 261          * Monday = 1, Tuesday = 2,...
 262          */
 263         int                  StartDay;
 264         /**
 265          * 0 = no delete, 1 = after day,...
 266          */
 267         int                  AutoDelete;
 268 } GSM_CalendarSettings;
 269
 270 /**
 271  * Structure used for returning calendar status.
 272  */
 273 typedef struct {
 274         /**
 275          * Number of used positions.
 276          */
 277         int                  Used;
 278 } GSM_CalendarStatus;
 279
 280
 281 /* ------------------------------ to-do ------------------------------------ */
 282
 283 #define GSM_TODO_ENTRIES                7
 284 #define MAX_TODO_TEXT_LENGTH            50 /* Alcatel BE5 50 chars */
 285
 286 /**
 287  * Types of to do values. In parenthesis is member of @ref GSM_SubToDoEntry,
 288  * where value is stored.
 289  */
 290 typedef enum {
 291         /**
 292          * Due date. (Date)
 293          */
 294         TODO_END_DATETIME = 1,
 295         /**
 296          * Whether is completed. (Number)
 297          */
 298         TODO_COMPLETED,
 299         /**
 300          * When should alarm be fired (Date).
 301          */
 302         TODO_ALARM_DATETIME,
 303         /**
 304          * When should silent alarm be fired (Date).
 305          */
 306         TODO_SILENT_ALARM_DATETIME,
 307         /**
 308          * Text of to do (Text).
 309          */
 310         TODO_TEXT,
 311         /**
 312          * Whether entry is private (Number).
 313          */
 314         TODO_PRIVATE,
 315         /**
 316          * Category of entry (Number).
 317          */
 318         TODO_CATEGORY,
 319         /**
 320          * Related contact ID (Number).
 321          */
 322         TODO_CONTACTID,
 323         /**
 324          * Number to call (Text).
 325          */
 326         TODO_PHONE
 327 } GSM_ToDoType;
 328
 329 /**
 330  * Priority of to do.
 331  */
 332 typedef enum {
 333         GSM_Priority_High = 1,
 334         GSM_Priority_Medium,
 335         GSM_Priority_Low
 336 } GSM_ToDo_Priority;
 337
 338 /**
 339  * Value of to do entry.
 340  */
 341 typedef struct {
 342         /**
 343          * Type of entry.
 344          */
 345         GSM_ToDoType    EntryType;
 346         /**
 347          * Text of value, if appropriate, see @ref GSM_ToDoType.
 348          */
 349         unsigned char   Text[(MAX_TODO_TEXT_LENGTH + 1)*2];
 350         /**
 351          * Date of value, if appropriate, see @ref GSM_ToDoType.
 352          */
 353         GSM_DateTime    Date;
 354         /**
 355          * Number of value, if appropriate, see @ref GSM_ToDoType.
 356          */
 357         unsigned int    Number;
 358 } GSM_SubToDoEntry;
 359
 360 /**
 361  * To do entry.
 362  */
 363 typedef struct {
 364         /**
 365          * Priority of entry.
 366          */
 367         GSM_ToDo_Priority       Priority;
 368         /**
 369          * Location in memory.
 370          */
 371         int                     Location;
 372         /**
 373          * Number of entries.
 374          */
 375         int                     EntriesNum;
 376         /**
 377          * Values of current entry.
 378          */
 379         GSM_SubToDoEntry        Entries[GSM_TODO_ENTRIES];
 380 } GSM_ToDoEntry;
 381
 382 void GSM_ToDoFindDefaultTextTimeAlarmCompleted(GSM_ToDoEntry *entry, int *Text, int *Alarm, int *Completed, int *EndTime, int *Phone);
 383
 384 typedef enum {
 385         Nokia_VToDo = 1,
 386         SonyEricsson_VToDo
 387 } GSM_VToDoVersion;
 388
 389 GSM_Error GSM_EncodeVTODO(char *Buffer, int *Length, GSM_ToDoEntry *note, bool header, GSM_VToDoVersion Version);
 390
 391 /**
 392  * Status of to do entries.
 393  */
 394 typedef struct {
 395         /**
 396          * Number of used positions.
 397          */
 398         int          Used;
 399 } GSM_ToDoStatus;
 400
 401 /* --------------------------- note ---------------------------------------- */
 402
 403 typedef struct {
 404         int          Location;
 405         char         Text[100];
 406 } GSM_NoteEntry;
 407
 408 GSM_Error GSM_EncodeVNTFile(unsigned char *Buffer, int *Length, GSM_NoteEntry *Note);
 409
 410 /* --------------------------- alarm --------------------------------------- */
 411
 412 /**
 413  * Alarm values.
 414  */
 415 typedef struct {
 416         /**
 417          * Location where it is stored.
 418          */
 419         int             Location;
 420         /**
 421          * Date and time of alarm.
 422          */
 423         GSM_DateTime    DateTime;
 424         /**
 425          * Whether it repeats each day.
 426          */
 427         bool            Repeating;
 428         /**
 429          * Text that is shown on display.
 430          */
 431         char            Text[(MAX_CALENDAR_TEXT_LENGTH + 1) * 2];
 432 } GSM_Alarm;
 433
 434 /* --------------------------- calendar & todo ----------------------------- */
 435
 436 GSM_Error GSM_DecodeVCALENDAR_VTODO(unsigned char *Buffer, int *Pos, GSM_CalendarEntry *Calendar, GSM_ToDoEntry *ToDo, GSM_VCalendarVersion CalVer, GSM_VToDoVersion ToDoVer);
 437
 438 #endif
 439
 440 /* How should editor hadle tabs in this file? Add editor commands here.
 441  * vim: noexpandtab sw=8 ts=8 sts=8:
 442  */