src/r_task.h

   1 ///
   2 /// \file       r_task.h
   3 ///             Record parsing class for the task database.
   4 ///
   5
   6 /*
   7     Copyright (C) 2005-2008, Net Direct Inc. (http://www.netdirect.ca/)
   8     Copyright (C) 2007, Brian Edginton
   9
  10     This program is free software; you can redistribute it and/or modify
  11     it under the terms of the GNU General Public License as published by
  12     the Free Software Foundation; either version 2 of the License, or
  13     (at your option) any later version.
  14
  15     This program is distributed in the hope that it will be useful,
  16     but WITHOUT ANY WARRANTY; without even the implied warranty of
  17     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  18
  19     See the GNU General Public License in the COPYING file at the
  20     root directory of this project for more details.
  21 */
  22
  23 #ifndef __BARRY_RECORD_TASK_H__
  24 #define __BARRY_RECORD_TASK_H__
  25
  26 #include "dll.h"
  27 #include "record.h"
  28 #include <vector>
  29 #include <string>
  30 #include <stdint.h>
  31
  32 namespace Barry {
  33
  34 class BXEXPORT Task
  35 {
  36 public:
  37         typedef std::vector<UnknownField>                       UnknownsType;
  38         uint8_t RecType;
  39         uint32_t RecordId;
  40
  41         uint8_t TaskType;
  42         std::string Summary;
  43         std::string Notes;
  44         std::string Categories;
  45         std::string UID;
  46
  47         time_t StartTime;
  48         time_t DueTime;
  49         time_t AlarmTime;
  50         int TimeZoneCode;
  51
  52         enum AlarmFlagType
  53         {
  54                 Date = 1,
  55                 Relative
  56         };
  57         AlarmFlagType AlarmType;
  58
  59         unsigned short Interval;
  60         enum RecurringCodeType {
  61                 Day = 1,                //< eg. every day
  62                                         //< set: nothing
  63                 MonthByDate = 3,        //< eg. every month on the 12th
  64                                         //< set: DayOfMonth
  65                 MonthByDay = 4,         //< eg. every month on 3rd Wed
  66                                         //< set: DayOfWeek and WeekOfMonth
  67                 YearByDate = 5,         //< eg. every year on March 5
  68                                         //< set: DayOfMonth and MonthOfYear
  69                 YearByDay = 6,          //< eg. every year on 3rd Wed of Jan
  70                                         //< set: DayOfWeek, WeekOfMonth, and
  71                                         //<      MonthOfYear
  72                 Week = 12               //< eg. every week on Mon and Fri
  73                                         //< set: WeekDays
  74         };
  75         RecurringCodeType RecurringType;
  76         time_t RecurringEndTime;
  77         unsigned short                  // recurring details, depending on type
  78                 DayOfWeek,              // 0-6
  79                 WeekOfMonth,            // 1-5
  80                 DayOfMonth,             // 1-31
  81                 MonthOfYear;            // 1-12
  82         unsigned char WeekDays;         // bitmask, bit 0 = sunday
  83
  84         int ClassType;
  85         enum PriorityFlagType
  86         {
  87                 High = 0,
  88                 Normal,
  89                 Low
  90         };
  91         PriorityFlagType PriorityFlag;
  92
  93         enum StatusFlagType
  94         {
  95                 NotStarted = 0,
  96                 InProgress,
  97                 Completed,
  98                 Waiting,
  99                 Deferred
 100         };
 101         StatusFlagType StatusFlag;
 102
 103         bool Recurring;
 104         bool Perpetual;
 105         bool DueDateFlag;       // true if due date is set
 106
 107         UnknownsType Unknowns;
 108
 109 public:
 110         Task();
 111         ~Task();
 112
 113         const unsigned char* ParseField(const unsigned char *begin,
 114                 const unsigned char *end);
 115         void ParseRecurrenceData(const void *data);
 116         void BuildRecurrenceData(void *data);
 117         uint8_t GetRecType() const { return RecType; }
 118         uint32_t GetUniqueId() const { return RecordId; }
 119         void SetIds(uint8_t Type, uint32_t Id) { RecType = Type; RecordId = Id; }
 120         void ParseHeader(const Data &data, size_t &offset);
 121         void ParseFields(const Data &data, size_t &offset);
 122         void BuildHeader(Data &data, size_t &offset) const;
 123
 124         void Clear();
 125
 126         void Dump(std::ostream &os) const;
 127         bool operator<(const Task &other) const { return Summary < other.Summary; }
 128
 129         // database name
 130         static const char * GetDBName() { return "Tasks"; }
 131         static uint8_t GetDefaultRecType() { return 2; }
 132
 133 };
 134
 135 BXEXPORT inline std::ostream& operator<<(std::ostream &os, const Task &msg) {
 136         msg.Dump(os);
 137         return os;
 138 }
 139
 140 } // namespace Barry
 141
 142 #endif
 143